-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add requestLogger middleware #70
Open
tanuj-shardeum
wants to merge
3
commits into
dev
Choose a base branch
from
GOLD-289-ts
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
import { Request, Response, NextFunction } from 'express' | ||
import { CONFIG as config } from '../config' | ||
|
||
const requestLogger = (req: Request, res: Response, next: NextFunction): void => { | ||
if (config.enableRequestLogger) { | ||
const reqTime = Date.now() | ||
const senderIp = req.ip | ||
const userAgent = req.headers['user-agent'] || 'Unknown' | ||
|
||
const responseChunks: Buffer[] = [] | ||
|
||
const originalWrite = res.write.bind(res) | ||
res.write = function ( | ||
chunk: any, | ||
encodingOrCallback?: BufferEncoding | ((error: Error | null | undefined) => void), | ||
callback?: (error: Error | null | undefined) => void | ||
) { | ||
responseChunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)) | ||
|
||
if (typeof encodingOrCallback === 'function') { | ||
return originalWrite(chunk, encodingOrCallback) | ||
} else { | ||
return originalWrite(chunk, encodingOrCallback as BufferEncoding, callback) | ||
} | ||
} | ||
|
||
const originalEnd = res.end.bind(res) | ||
res.end = function (chunk?: any, ...args: any[]) { | ||
const responseBody = Buffer.concat(responseChunks).toString('utf8') | ||
res.locals.responseBody = responseBody | ||
return originalEnd(chunk, ...args) | ||
} | ||
|
||
const originalJson = res.json.bind(res) | ||
res.json = function (body) { | ||
res.locals.responseBody = body | ||
return originalJson(body) | ||
} | ||
|
||
const originalSend = res.send.bind(res) | ||
res.send = function (body) { | ||
res.locals.responseBody = body | ||
return originalSend(body) | ||
} | ||
|
||
res.on('finish', () => { | ||
const resTime = Date.now() | ||
|
||
console.log( | ||
`Request URL: ${req.originalUrl} ||` + | ||
` Response Status Code: ${res.statusCode} ||` + | ||
` Sender IP: ${senderIp} ||` + | ||
` Request Timestamp: ${new Date(reqTime).toISOString()} ||` + | ||
` Response Timestamp: ${new Date(resTime).toISOString()} ||` + | ||
` Request Method: ${req.method} ||` + | ||
` Response Time: ${resTime - reqTime}ms ||` + | ||
` User Agent: ${userAgent}` | ||
) | ||
|
||
const responseBody = res.locals.responseBody | ||
if (res.statusCode !== 200) { | ||
console.log( | ||
`Request Failed with ${res.statusCode} ||` + | ||
`Request Body: ${JSON.stringify(req.body)} ||` + | ||
` Response Body: ${res.locals.responseBody}` | ||
) | ||
} else if (responseBody) { | ||
try { | ||
const parsedBody = JSON.parse(responseBody) | ||
if (parsedBody && 'error' in parsedBody) { | ||
console.log( | ||
`RPC Request Failed with Error ||` + | ||
` Request Body: ${JSON.stringify(req.body)} ||` + | ||
` Response Body: ${res.locals.responseBody}` | ||
) | ||
} | ||
} catch (e) { | ||
// Silently fail if parsing fails, no logging here | ||
} | ||
} | ||
}) | ||
} | ||
next() | ||
} | ||
|
||
export default requestLogger |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check warning
Code scanning / CodeQL
Log injection Medium
Copilot Autofix AI 4 months ago
To fix the log injection issue, we need to sanitize the
userAgent
value before logging it. Specifically, we should remove any newline characters from theuserAgent
string to prevent log injection attacks. This can be done using theString.prototype.replace
method to remove any newline characters (\n
and\r
).