Add support for PubSub subscriptions with binary channel names and handlers#4068
Open
petyaslavova wants to merge 3 commits into
Open
Add support for PubSub subscriptions with binary channel names and handlers#4068petyaslavova wants to merge 3 commits into
petyaslavova wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 570af56. Configure here.
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
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.

Summary
This PR adds a public
Subscription(name, handler=None)value type for PubSub subscriptions and accepts it positionally insubscribe,psubscribe, andssubscribeacross sync, async, and cluster PubSub paths.The new input form removes the kwargs-only limitation for handler-backed subscriptions.
Since Python keyword argument keys must be text strings, users previously could not attach handlers to arbitrary binary channel, pattern, or shard channel names.
Subscriptionkeeps the existing APIs intact while adding a binary-safe way to bind handlers.Reconnect replay now preserves handler-backed binary subscriptions by replaying them as positional
Subscriptionobjects instead of decoding names into kwargs.Cluster sharded PubSub forwarding and shard migration paths were updated similarly, so handler associations survive reconnects and slot movement without requiring text-decodable channel names.
Docs now show the new
Subscriptionform, mixed positional usage, and compatibility with the existing kwargs handler style.Type hints were updated for the affected subscribe methods, and
Subscriptionis re-exported from bothredisandredis.asyncio.Tests cover sync and async binary channel, pattern, and shard channel handlers, reconnect replay with handlers, and cluster shard routing/migration behavior.
Note
Medium Risk
Touches core PubSub subscribe/resubscribe paths (sync, asyncio, and cluster sharded pubsub), so regressions could break reconnect behavior or handler dispatching, especially around mixed positional/keyword subscriptions.
Overview
Adds a new public
Subscription(name, handler=None)value type and re-exports it fromredisandredis.asyncio, enabling handler-backed PubSub subscriptions for channel/pattern names that can’t be expressed as Python kwargs (including arbitrarybytes).Updates
subscribe/psubscribe/ssubscribeacross sync, asyncio, cluster, and multidb clients to accept positionalSubscriptionobjects (and mix them with existing kwargs), centralizing argument parsing in new helper functions and changing reconnect resubscription to replay handler-backed entries asSubscriptionobjects (avoiding decoding into kwarg keys). Docs and tests are expanded to cover binary names with handlers, reconnect replay, and cluster shard-channel routing/migration with handlers preserved.Reviewed by Cursor Bugbot for commit 19ecee2. Bugbot is set up for automated code reviews on this repo. Configure here.