optional max payload size for ByteToMessageDecoder #957
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
weissi
requested changes
Apr 8, 2019
weissi
reviewed
Apr 9, 2019
weissi
reviewed
Apr 9, 2019
weissi
reviewed
Apr 10, 2019
|
@weissi updated |
Motivation: ByteToMessageDecoder aggregate data in memory as part of their normal operation. the ability to limit how much they aggregate is critical in many real-life applications Modifications: * add optional maximumBufferSize argument to ByteToMessageDecoder initializer * test for buffer size when maximumBufferSize is set and throw ByteToMessageDecoderError.payloadTooLarge error Result: users can limit how much memory ByteToMessageDecoder takes and handle the exception on their end
tomerd
force-pushed
the
master
branch
2 times, most recently
from
c6b1073 to
e8220b6
Compare
Lukasa
approved these changes
Apr 11, 2019
weissi
added a commit
to weissi/swift-nio
that referenced
this pull request
May 17, 2019
Motivation: In apple#957 we accidentally broke the API just a little bit. We turned the `ByteToMessageHandler.init` from public init(_ decoder: Decoder) into public init(_ decoder: Decoder, maximumBufferSize: Int? = nil) This looks totally benign and in almost all cases because of the default argument, you wouldn't notice the API breakage. However, it's possible to write code that works in NIO 2.0.0 but breaks in NIO 2.1.0. For example let g: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init let h: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init(_:) Modifications: According to SemVer, this releases a patch that unbreaks the public API. Result: No API breakages (checked with `swift-api-digester` which also found the breakage in the first place).
weissi
added a commit
that referenced
this pull request
May 17, 2019
Motivation: In #957 we accidentally broke the API just a little bit. We turned the `ByteToMessageHandler.init` from public init(_ decoder: Decoder) into public init(_ decoder: Decoder, maximumBufferSize: Int? = nil) This looks totally benign and in almost all cases because of the default argument, you wouldn't notice the API breakage. However, it's possible to write code that works in NIO 2.0.0 but breaks in NIO 2.1.0. For example let g: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init let h: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init(_:) Modifications: According to SemVer, this releases a patch that unbreaks the public API. Result: No API breakages (checked with `swift-api-digester` which also found the breakage in the first place).
weissi
added a commit
that referenced
this pull request
May 17, 2019
Motivation: In #957 we accidentally broke the API just a little bit. We turned the `ByteToMessageHandler.init` from public init(_ decoder: Decoder) into public init(_ decoder: Decoder, maximumBufferSize: Int? = nil) This looks totally benign and in almost all cases because of the default argument, you wouldn't notice the API breakage. However, it's possible to write code that works in NIO 2.0.0 but breaks in NIO 2.1.0. For example let g: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init let h: (Dummy) -> ByteToMessageHandler<Dummy> = ByteToMessageHandler<Dummy>.init(_:) Modifications: According to SemVer, this releases a patch that unbreaks the public API. Result: No API breakages (checked with `swift-api-digester` which also found the breakage in the first place).
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:
ByteToMessageDecoder aggregate data in memory as part of their normal operation. the ability to limit how much they aggregate is critical in many real-life applications
Modifications:
Result:
users can limit how much memory ByteToMessageDecoder takes and handle the exception on their end