Merged
Conversation
router.md showed `TimersRouter(prefix="my-service:")` in the first example without ever explaining what `prefix` does. This is the only mechanism for sharing one Redis between multiple services without key collision, so it warrants explicit coverage. Add a "How `prefix` works" section that: - spells out that `prefix` is concatenated into each subscriber's and publisher's full topic, and shows the resulting Redis keys (`timers_timeline:my-service:invoices` etc.) - recommends per-service prefixes for shared-Redis isolation - explains that `broker.publish` / `broker.cancel_timer` / `has_pending` / `get_pending_timers` / `cancel_all` do *not* see the router's prefix — callers must pass the prefixed topic explicitly, or use a publisher scoped to the router (which applies the prefix automatically).
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
1 participant
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.
router.md showed
TimersRouter(prefix="my-service:")in the first example without ever explaining whatprefixdoes. This is the only mechanism for sharing one Redis between multiple services without key collision, so it warrants explicit coverage.Add a "How
prefixworks" section that:prefixis concatenated into each subscriber's and publisher's full topic, and shows the resulting Redis keys (timers_timeline:my-service:invoicesetc.)broker.publish/broker.cancel_timer/has_pending/get_pending_timers/cancel_alldo not see the router's prefix — callers must pass the prefixed topic explicitly, or use a publisher scoped to the router (which applies the prefix automatically).