Fix buffer leak regression in HttpClientCodec #12762
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
Motivation: netty#12709 changed HttpObjectEncoder to override the write method of MessageToMessageEncoder, with slightly changed semantics: The `msg` argument to `encode` is not released anymore. To accommodate this change, netty#12709 also update `HttpObjectEncoder.encode` to release the `msg`. However, `HttpClientCodec.Encoder` overrides `encode` and simply forwards the message if a HTTP upgrade has been completed. This code path was not updated to release the input message. This leads to a memory leak. Modifications: Changed the `encode` implementation to not retain the message that is forwarded. Added a test case to verify that the refCnt to the data passed through is unchanged. Result: The buffer retains its correct refCnt and will be released properly.
1 task
franz1981
approved these changes
Sep 1, 2022
|
We don't really have benchmarks that could tell the difference unfortunately |
normanmaurer
approved these changes
Sep 1, 2022
normanmaurer
approved these changes
Sep 1, 2022
|
Hi there, From my understanding, 4.1.80 is basically burnt because of this regression. Cheers! |
|
release should happen within the next days. |
|
Awesome! Thanks a lot @normanmaurer ! |
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:
#12709 changed HttpObjectEncoder to override the write method of MessageToMessageEncoder, with slightly changed semantics: The
msgargument toencodeis not released anymore. To accommodate this change, #12709 also updateHttpObjectEncoder.encodeto release themsg. However,HttpClientCodec.Encoderoverridesencodeand simply forwards the message if a HTTP upgrade has been completed. This code path was not updated to release the input message. This leads to a memory leak.Modifications:
Changed the
encodeimplementation to not retain the message that is forwarded. Added a test case to verify that the refCnt to the data passed through is unchanged.Result:
The buffer retains its correct refCnt and will be released properly.