Repository navigation
CAMEL-25917: docs - upgrade guide entries for the camel-undertow WebSocket consumer handlers in 4.22.3 and 4.18.6 - #28507
Conversation
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
oscerd
left a comment
There was a problem hiding this comment.
Reviewed — clean, and correctly placed. In the 4.22 guide the new "camel-undertow … connection opened before a consumer with custom handlers started" entry lands in the newest section ("Upgrading from 4.22.2 to 4.22.3"), and in the 4.18 guide it extends the existing undertow note in the "4.18.5 to 4.18.6" section — both on main, as the convention wants for a backported change. The prose is a clear migration note: the previous behaviour (a connection opened while only the producer served the path kept being served after the consumer started, bypassing the consumer's handlers), the new behaviour (such a connection is no longer served and is closed), and the action (clients opening in that window must reconnect after the consumer starts). No blockers.
(The full build checks are still completing; this is a docs-only change.)
Claude Code on behalf of oscerd
|
🧪 CI tested the following changed modules:
🔬 Scalpel shadow comparison — Scalpel: 0 of 707 tested, 0 compile-only — current: 0 all testedMaveniverse Scalpel detected 0 affected modules (current approach: 0). Skip-tests mode would test 0 modules (1 direct + 0 downstream), skip tests for 0 (generated code, meta-modules) Modules Scalpel would test (0)
|
davsclaus
left a comment
There was a problem hiding this comment.
Thanks @Croway. The 4.22 note sits at the end of "Upgrading from 4.22.2 to 4.22.3" and matches the 4.24 text. Extending the existing 4.18.6 camel-undertow WebSocket note is the right call: the WebSocket security options first ship in 4.18.6 on that line, so there is no 4.18.5 behaviour to describe a change from. The new paragraph also matches the code, since every peer that no longer passes the path checks is closed when the consumer starts.
One merge note: #28504 adds its camel-cometd note at the same spot in camel-4x-upgrade-guide-4_22.adoc, so whichever of the two merges second will need a rebase.
Reviewed with Claude Code on behalf of davsclaus. This review was generated by an AI agent and may contain inaccuracies; please verify all suggestions before applying.
|
@Croway thanks! The backports #28505 and #28506 are merged, and #28504 is in main now. This one conflicts with it in Claude Code on behalf of davsclaus |
…ocket consumer handlers in 4.22.3 and 4.18.6 The fix is backported to camel-4.22.x and camel-4.18.x. Add the 4.24 entry under "Upgrading from 4.22.2 to 4.22.3". On 4.18.x the handlers, allowedRoles and security provider options apply to WebSocket endpoints from 4.18.6 on, so extend the existing 4.18.6 camel-undertow WebSocket entry instead of adding a separate one.
5e5f431 to
14a2f0c
Compare
|
@davsclaus thanks, rebased on main: the 4.22.3 section now has the camel-cometd entry followed by the camel-undertow one. The 4.18 guide was unchanged. |
gnodet-bot
left a comment
There was a problem hiding this comment.
LGTM. No issues found.
Documentation-only PR adding upgrade guide entries for the camel-undertow WebSocket consumer handlers behavior change (CAMEL-25917). Both sections are accurate:
- 4.22 guide: new section under "Upgrading from 4.22.2 to 4.22.3" correctly describes the previous behavior (connection bypasses consumer
handlerswhen opened before consumer starts), the new behavior (connection no longer served once consumer starts), and the remediation (reconnect after consumer starts). - 4.18 guide: paragraph correctly extends the existing undertow WebSocket note in the "4.18.5 to 4.18.6" section; fits the existing context and accurately describes the handlers gap.
Placement and prose are correct.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
Jira: https://issues.apache.org/jira/browse/CAMEL-25917
Follow-up of #28237: the fix is backported to
camel-4.22.x(#28505) andcamel-4.18.x(#28506), so this adds the matching upgrade guide entries onmain:camel-4x-upgrade-guide-4_22.adoc, under "Upgrading from 4.22.2 to 4.22.3": the same text as the 4.24 entry added by CAMEL-25917: camel-undertow - a WebSocket connection accepted while only a producer served the path is not treated as having passed a later consumer's custom handlers #28237.camel-4x-upgrade-guide-4_18.adoc, under "Upgrading from 4.18.5 to 4.18.6": on this line thehandlers,allowedRolesand security provider options apply to WebSocket endpoints from 4.18.6 on (CAMEL-25375), so the behaviour is described as a paragraph of the existing "camel-undertow - WebSocket endpoints apply the security provider, allowed roles and handlers" entry rather than as a change from 4.18.5.Documentation only.