Adds support to restrict HTTP response sizes #23440
Merged
Conversation
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
There was a problem hiding this comment.
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
server/routerlicious/packages/services-utils/src/responseSizeMiddleware.ts:18
- [nitpick] The error message 'Invalid JSON string in response body' could be more descriptive. Consider changing it to 'Response body is not a valid JSON string'.
Lumberjack.error("Invalid JSON string in response body");
server/routerlicious/packages/services-utils/src/test/responseSizeMiddleware.spec.ts
Outdated
Show resolved
Hide resolved
…SizeMiddleware.spec.ts Co-authored-by: Copilot <[email protected]>
pradeepvairamani
approved these changes
Jan 3, 2025
| // eslint-disable-next-line @typescript-eslint/no-misused-promises | ||
| return async (req, res, next) => { | ||
| const originalSend = res.send; | ||
| res.send = (body) => { |
There was a problem hiding this comment.
Looks good overall! One small suggestion is to try not to mutate res.send if possible. I am not sure if there are easy ways to do that, but if there are it might be worth considering.
There was a problem hiding this comment.
Okay lemme look into more implementations
There was a problem hiding this comment.
I was unable to find a way to carry out this operation without mutating the send object. However, most SO posts seem to suggest this approach
server/routerlicious/packages/services-utils/src/responseSizeMiddleware.ts
Outdated
Show resolved
Hide resolved
yunho-microsoft
approved these changes
Jan 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds a new module -
ResponseSizeMiddleware. This class has a method to validate response sizes to ensure that their byte sizes is below a given amaxResponseSizeInMegaBytes. If the response body is greater thanmaxResponseSizeInMegaBytes, anHTTP 413is sent as a response, else the original response is sent back to the client. This is introduced to primarily enforce response sizes in the storage stack (Historian and Gitrest). A future PR will add this module to both Gitrest and Historian after the r11 changes are merged.Historian and Gitrest both have request size limitations. Hence, this PR just adds support to limit response sizes. This is added to reduce the chances of Gitrest returning very large responses that could result in Historian running OOM.