Adding special handling of client_tracking_on and client_tracking_off for cluster clients. Marking those two functions as deprecated for cluster - embedded client-side caching feature should be used instead.#3858
Merged
petyaslavova merged 8 commits intomasterfrom Dec 3, 2025
Conversation
… for cluster clients. Marking those two functions as deprecated for cluster - embedded client-side caching feature should be used instead.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds support for client_tracking_on and client_tracking_off functions to RedisCluster, enabling their use with OSS clusters through the target_nodes parameter. Both functions are marked as deprecated since the built-in client-side caching feature should be used instead.
Key Changes:
- Added cluster-specific implementations of
client_tracking_onandclient_tracking_offwithtarget_nodessupport - Modified
determine_slot()to returnOptional[int]and handle CLIENT TRACKING as a special case - Updated
client_tracking()in core.py to forward**kwargsfor cluster support
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| redis/commands/core.py | Added **kwargs forwarding to client_tracking() to support target_nodes parameter |
| redis/commands/cluster.py | Added sync and async versions of client_tracking_on/off with deprecation warnings and cluster support |
| redis/cluster.py | Modified determine_slot() return type to Optional[int] and added special handling for CLIENT TRACKING commands |
| tests/test_cluster.py | Added comprehensive tests for CLIENT TRACKING functionality in cluster mode |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
vladvildanov
approved these changes
Dec 3, 2025
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
2 participants
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.
In this PR, the functions
client_tracking_onandclient_tracking_offare exposed inRedisCluster, with support for the additionaltarget_nodesparameter so they can be used with OSS clusters.Keep in mind that using these functions is not recommended—the
client-side caching feature should be used instead. For this reason, both functions are marked as deprecated.Another important detail for cluster setups: when you provide a
clientid, thetarget_nodesparameter may include only the node that owns the connection for that client ID. If any other node is specified, the server will return an error.Fixes #2592