ChannelInitializer: correct misleading comment on exceptionCaught route#16847
Merged
normanmaurer merged 1 commit intoMay 28, 2026
Merged
Conversation
Motivation: The catch block in initChannel(ChannelHandlerContext) currently attributes the explicit exceptionCaught(...) call to two reasons that are not accurate against the current code: it claims the handler was removed before initChannel(...) was called, but removal actually happens in the finally block below; and it credits this block with preventing multiple initChannel(...) calls, while re-entrance is in fact guarded by the initMap.add(ctx) check at the top of the method. netty#16846 flags the confusion. Modification: Rewrite the two-line comment to name the actual mechanisms: the call is to route the failure into the pipeline, re-entrance is guarded by initMap.add(ctx) above, and handler removal happens in the finally block below. No code change. Result: Future readers of initChannel(ChannelHandlerContext) can trust the comment instead of having to cross-check it against the surrounding code. Fixes netty#16846.
Contributor
|
Auto-port PR for 4.2: #16853 |
Contributor
|
Auto-port PR for 5.0: #16854 |
normanmaurer
pushed a commit
that referenced
this pull request
May 28, 2026
…ptionCaught route (#16854) Auto-port of #16847 to 5.0 Cherry-picked commit: 22d1be6 --- Motivation: The catch block in `ChannelInitializer.initChannel(ChannelHandlerContext)` currently attributes the explicit `exceptionCaught(...)` call to two reasons that don't match the current code: ```java } catch (Throwable cause) { // Explicitly call exceptionCaught(...) as we removed the handler before calling initChannel(...). // We do so to prevent multiple calls to initChannel(...). exceptionCaught(ctx, cause); } finally { if (!ctx.isRemoved()) { ctx.pipeline().remove(this); } } ``` - The handler is **not** removed before `initChannel(...)` is called — removal happens in the `finally` block immediately below. - Re-entrance is guarded by the `initMap.add(ctx)` check at the top of the method, **not** by this catch block. Both clauses of the comment mislead a reader trying to understand why the catch block exists. Modification: Rewrite the two-line comment to name the actual mechanisms: - the `exceptionCaught(...)` call routes the failure into the pipeline; - re-entrance is guarded by `initMap.add(ctx)` above; - handler removal happens in the `finally` block below. No code change. Result: Future readers of `initChannel(ChannelHandlerContext)` can trust the comment instead of having to cross-check it against the surrounding code. Fixes #16846. The same wording exists on 4.1, 4.2, and 5.0; targeting 4.1 so auto-port carries it forward. Co-authored-by: Guimu <[email protected]>
normanmaurer
added a commit
that referenced
this pull request
May 28, 2026
…ptionCaught route (#16853) Auto-port of #16847 to 4.2 Cherry-picked commit: 22d1be6 --- Motivation: The catch block in `ChannelInitializer.initChannel(ChannelHandlerContext)` currently attributes the explicit `exceptionCaught(...)` call to two reasons that don't match the current code: ```java } catch (Throwable cause) { // Explicitly call exceptionCaught(...) as we removed the handler before calling initChannel(...). // We do so to prevent multiple calls to initChannel(...). exceptionCaught(ctx, cause); } finally { if (!ctx.isRemoved()) { ctx.pipeline().remove(this); } } ``` - The handler is **not** removed before `initChannel(...)` is called — removal happens in the `finally` block immediately below. - Re-entrance is guarded by the `initMap.add(ctx)` check at the top of the method, **not** by this catch block. Both clauses of the comment mislead a reader trying to understand why the catch block exists. Modification: Rewrite the two-line comment to name the actual mechanisms: - the `exceptionCaught(...)` call routes the failure into the pipeline; - re-entrance is guarded by `initMap.add(ctx)` above; - handler removal happens in the `finally` block below. No code change. Result: Future readers of `initChannel(ChannelHandlerContext)` can trust the comment instead of having to cross-check it against the surrounding code. Fixes #16846. The same wording exists on 4.1, 4.2, and 5.0; targeting 4.1 so auto-port carries it forward. Co-authored-by: Guimu <[email protected]> Co-authored-by: Norman Maurer <[email protected]>
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
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:
The catch block in
ChannelInitializer.initChannel(ChannelHandlerContext)currently attributes the explicitexceptionCaught(...)call to two reasons that don't match the current code:initChannel(...)is called — removal happens in thefinallyblock immediately below.initMap.add(ctx)check at the top of the method, not by this catch block.Both clauses of the comment mislead a reader trying to understand why the catch block exists.
Modification:
Rewrite the two-line comment to name the actual mechanisms:
exceptionCaught(...)call routes the failure into the pipeline;initMap.add(ctx)above;finallyblock below.No code change.
Result:
Future readers of
initChannel(ChannelHandlerContext)can trust the comment instead of having to cross-check it against the surrounding code.Fixes #16846.
The same wording exists on 4.1, 4.2, and 5.0; targeting 4.1 so auto-port carries it forward.