Fix #schedule_eofed documented with a default FIFO fallback it does not have - #983
Open
coipond-writer[bot] wants to merge 1 commit into
Open
Fix #schedule_eofed documented with a default FIFO fallback it does not have#983coipond-writer[bot] wants to merge 1 commit into
coipond-writer[bot] wants to merge 1 commit into
Conversation
…ot have pro/processing/schedulers/base.rb:126-129 aliases schedule_revocation/ shutdown/idle/periodic to schedule_fifo, but never defines on_schedule_eofed - only the concrete Default subclass adds that alias (schedulers/default.rb:86). connection/listener.rb:421 calls @scheduler.on_schedule_eofed unconditionally. A user who subclasses Base directly and skips schedule_eofed hits NoMethodError the first time eofed jobs arrive, unlike every other job type in this table. Fixed the Required column and description to reflect this asymmetry. Fixes #44184.
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
`Pro/Consumer-Groups/Scheduling-API.md:142-146`'s `#schedule_eofed` table row said implementation is optional "as a default FIFO implementation is done," matching the phrasing used for `#schedule_revocation`/`#schedule_shutdown`/`#schedule_idle`/`#schedule_periodic`.
Why it's wrong
`pro/processing/schedulers/base.rb:126-129` aliases `schedule_revocation`/`schedule_shutdown`/`schedule_idle`/`schedule_periodic` to `schedule_fifo`, but never defines `on_schedule_eofed` -- only the concrete `Default` subclass adds that alias (`schedulers/default.rb:86`). `connection/listener.rb:421` calls `@scheduler.on_schedule_eofed` unconditionally.
A user who subclasses `Base` directly (the documented extension point) and skips `schedule_eofed` hits `NoMethodError` the first time eofed jobs arrive -- unlike every other job type in this table.
Fixed the `Required` column and description to reflect this asymmetry.
Fixes #44184 (Redmine).