Add per-topic pause API removal to 2.6 Breaking Changes and checklist - #992
Open
coipond-writer[bot] wants to merge 1 commit into
Open
Add per-topic pause API removal to 2.6 Breaking Changes and checklist#992coipond-writer[bot] wants to merge 1 commit into
coipond-writer[bot] wants to merge 1 commit into
Conversation
CHANGELOG.md 2.6.0 documents a separate breaking change from the global config.pause_timeout removal already covered on this page: the per-topic flat accessors topic.pause_timeout, topic.pause_max_timeout, topic.pause_with_exponential_backoff are also removed in favor of nested topic.pause.*, topic.to_h now emits a nested pause: hash instead of flat keys, and topic.pausing/topic.pausing? are renamed to topic.pause/topic.pause?. Confirmed removed in routing/topic.rb and pro/routing/features/pausing/topic.rb. Unlike the global setting, this one was not previously deprecated with a warning period, so it was entirely missing from the Breaking Changes section and will break silently for anyone using the old flat per-topic accessors. Added a new subsection and updated the "Summary of Actions Required" checklist. Fixes #44804.
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.
What
`Upgrades/Karafka/2.6.md`'s Breaking Changes section only covered the global `config.pause_timeout`/etc removal, omitting a separate breaking change entirely.
Why it matters
`CHANGELOG.md` 2.6.0 documents a second, distinct breaking change: the per-topic flat accessors `topic.pause_timeout`, `topic.pause_max_timeout`, `topic.pause_with_exponential_backoff` are also removed (replaced by nested `topic.pause.*`), `topic.to_h` now emits a nested `pause:` hash instead of flat keys, and `topic.pausing`/`topic.pausing?` are renamed to `topic.pause`/`topic.pause?`. Confirmed removed in `routing/topic.rb` and `pro/routing/features/pausing/topic.rb`.
Unlike the global setting, this one was not previously deprecated with a warning period -- it breaks silently for anyone using the old flat per-topic accessors, and wasn't mentioned anywhere on the upgrade page.
Fix
Added a new "Per-Topic Pause Configuration Nested, Flat Readers Removed" subsection right after the existing global-config one, and updated the "Summary of Actions Required" checklist.
Fixes #44804 (Redmine).