Handle ResponseAccumulator not being able to buffer large response in memory #631
Conversation
This file contains hidden or 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
… memory ## Motivation If the response being buffered by the `ResponseAccumulator` is too large (larger than `UInt32.max`), a crash will occur. ## Modifications * Check that the number of bytes being written won't cause the buffer to go over the limit. If it does, return a failed future from `didReceiveBodyPart(task:_:)` * Created a new `ResponseTooBigError` to be used with the failed future. ## Result Will now fail graciously if too big a response is buffered in memory via the `ResponseAccumulator`.
|
Can one of the admins verify this patch? |
5 similar comments
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
Lukasa
reviewed
Oct 4, 2022
|
@swift-server-bot add to allowlist |
dnadoba
requested changes
Oct 5, 2022
| @@ -397,6 +403,10 @@ public class ResponseAccumulator: HTTPClientResponseDelegate { | |||
| case .head(let head): | |||
| self.state = .body(head, part) | |||
| case .body(let head, var body): | |||
| if body.writerIndex + part.readableBytes > UInt32.max { | |||
There was a problem hiding this comment.
UInt32.max is a bit magic. I think the best solution would be to add a static property in swift-nio to ByteBuffer with the max size it can handle. But we can also just give this constant a descriptive name here and document it.
|
closing in favor of #637 |
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.
Motivation
If the response being buffered by the
ResponseAccumulatoris too large (larger thanUInt32.max), a crash will occur.Modifications
didReceiveBodyPart(task:_:)ResponseTooBigErrorto be used with the failed future.Result
Will now fail graciously if too big a response is buffered in memory via the
ResponseAccumulator.