Instrument Netty addTask to ensure complete coverage of async Runnables #1348
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
Newer versions of Netty introduce variants like execute(Runnable, boolean) which aren't covered by the core execute(Runnable) instrumentation. Fortunately they all flow through to addTask(Runnable), which allows us to carry the context through properly.
johnbley
requested review from
anuraaga,
iNikem,
jkwatson,
mateuszrzeszutek,
trask and
tylerbenson
as code owners
johnbley
changed the title
iNikem
reviewed
Oct 8, 2020
| @@ -27,7 +27,7 @@ muzzle { | |||
| } | |||
|
|
|||
| dependencies { | |||
| library group: 'io.netty', name: 'netty-codec-http', version: '4.1.0.Final' | |||
| library group: 'io.netty', name: 'netty-codec-http', version: '4.1.52.Final' | |||
There was a problem hiding this comment.
Wouldn't it be enough to have later versions in latestDepTest? I think we still want to test with the oldest supported version.
There was a problem hiding this comment.
Yep, thanks for that. Confirmed that with -PtestLatestDeps=true and the addTask instrumentation commented out the test fails, so reverting the gradle file.
|
For reference, we have this pattern if you need to be able to branch in the test based on whether it's normal or latest dep |
trask
approved these changes
Oct 9, 2020
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.
We found that certain code paths in RxNetty through vanilla Netty exposed an issue where Netty WriteTasks weren't capturing the correct/any context during submission. Turns out that newer 4.1 variants of Netty have a backchannel "lazy" execution that uses
execute(Runnable, boolean), bypassing the standardexecute(Runnable). Fortunately, all the variants flow through toaddTask(Runnable).Without the addTask instrumentation addition, the added unit test fails with 3 traces (the second client request shows up under a brand new 3rd trace without any inherited context).