redis-clustering 5.4.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7060eff856ef3d21ddeff60bfd2a0b6d741d04fd9b233f5b36eee50812b88bc
-  data.tar.gz: 07d96f3179db08a80f054542474ef0d69a3db1cfce92b80b729a9f2b04bf9e1f
+  metadata.gz: 2e9c31d780e291ac7df46dc423f6460bdd92e357d490c13a45ec83094dd078f3
+  data.tar.gz: 5125a590e44be00d49640e82354dbffc7baf8d819219c512a2896809aabab3c7
 SHA512:
-  metadata.gz: 05b728ef68b71a9dc1f370cb2c03cc5fb7bc01c9a3278b160cebf0f6de3a6b42ad5cb3c9c9a30e9a49f9f4cffad16ec926825796941e2d0d99b09fad964a0773
-  data.tar.gz: 6b16c0354a7a8bfbef6124186e98d28e183e00e614471543e51acfca01585a44a35f1157b75b815c6bb156ca4be975c39c1eb4ce9d0aa248db4834040023d77c
+  metadata.gz: 86f573a8390cba746e75d4585101e05070f4a709c2e9eddc22130189379d8e2b7580dd7595d54b80842a121a8f17ebe693a3b7664e1bc4f791d07e1a8c1a489f
+  data.tar.gz: 221e1b270ee3838413598d3dc2280e3021c627daabddbb0454fd32fd2e5cab11507e1fa16b940163379b362bb9945230ffc5237ece4d7705d648b22f9255c77a

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# 6.0.0
+
+## Breaking changes
+
+- Route commands by their server-declared command tips (redis-cluster-client 0.16.6+):
+  `SLOWLOG GET` now returns one entry list per master; `SLOWLOG LEN` and `LATENCY RESET` return
+  the sum across all masters; `FUNCTION LOAD`/`DELETE`/`FLUSH`/`RESTORE` now execute on all
+  masters; commands with keys in subcommands (e.g. `XINFO STREAM`) route to the key's slot owner.
+- Use RESP3 (`HELLO 3`) by default; pass `protocol: 2` to keep RESP2. `GEOPOS` and
+  `GEOSEARCH`/`GEORADIUS` with `WITHCOORD` now return coordinates as `Float` instead of `String`.
+  See [the RESP3 migration guide](../specs/migration-resp3.md). (#1351)
+- Require Ruby 3.2+. (#1353, #1365)
+
+## New features
+
+- Identify the client to every node via `CLIENT SETINFO` (`lib-name=redis-rb`,
+  `lib-ver=<version>`). Extend the reported name with `driver_info:`, or disable with
+  `driver_info: false`. (#1369)
+
+## Experimental
+
+- Add `himport_prepare`, `himport_set`, `himport_discard` and `himport_discard_all`
+  (Redis 8.10 `HIMPORT`). Prepare/discard fan out to all masters; `himport_set` routes by its
+  key's hash slot. Lost fieldsets are re-prepared and retried automatically; disable with
+  `himport_auto_prepare: false`. The API may change in a future minor release. (#1364)
+
+## Maintenance
+
+- Pin `redis-cluster-client` to the exact version `0.16.7`.

data/lib/redis/cluster/client.rb

@@ -16,18 +16,18 @@ class Redis
       )
 
       class << self
-        def config(**kwargs)
-          super(protocol: 2, **kwargs)
+        def config(protocol: 3, **kwargs)
+          super(protocol: protocol, **kwargs)
         end
 
-        def sentinel(**kwargs)
-          super(protocol: 2, **kwargs)
+        def sentinel(protocol: 3, **kwargs)
+          super(protocol: protocol, **kwargs)
         end
 
         def translate_error!(error, mapping: ERROR_MAPPING)
           case error
           when RedisClient::Cluster::ErrorCollection
-            error.errors.each do |_node, node_error|
+            error.errors.each_value do |node_error|
               if node_error.is_a?(RedisClient::AuthenticationError)
                 raise mapping.fetch(node_error.class), node_error.message, node_error.backtrace
               end
@@ -132,6 +132,10 @@ class Redis
       def handle_errors
         yield
       rescue ::RedisClient::Error => error
+        # Let RESP3-unsupported errors (e.g. a node without HELLO) propagate untranslated so
+        # Redis#send_command can transparently fall back to RESP2.
+        raise if Redis::Client.resp3_unsupported?(error)
+
         Redis::Cluster::Client.translate_error!(error)
       end
     end

data/lib/redis/cluster.rb

@@ -63,9 +63,13 @@ class Redis
     # @option options [String] :fixed_hostname Specify a FQDN if cluster mode enabled and
     #   client has to connect nodes via single endpoint with SSL/TLS
     # @option options [Class] :connector Class of custom connector
+    # @option options [String, Array<String>, false] :driver_info Identity a library built on top of
+    #   `redis-rb` reports to every node via `CLIENT SETINFO`, shown as `lib-name=redis-rb(<driver_info>)`
+    #   in `CLIENT LIST`. The recommended format is `<name>_v<version>`; an Array is joined with `;`.
+    #   Pass `false` to disable client identification entirely.
     #
     # @return [Redis::Cluster] a new client instance
-    def initialize(*) # rubocop:disable Lint/UselessMethodDefinition
+    def initialize(*)
       super
     end
     ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
@@ -125,10 +129,48 @@ class Redis
       synchronize { |c| c.watch(*keys, &block) }
     end
 
+    # HIMPORT on cluster: redis-cluster-client (>= 0.16.6) routes the whole family natively from
+    # the server's command metadata — PREPARE/DISCARD/DISCARDALL fan out to all primaries per
+    # their request_policy:all_shards tip (fieldsets are per-connection session state, so every
+    # primary's connection needs its own copy), and SET routes by its key's slot via the
+    # per-subcommand key spec. HIMPORT defines no response_policy today, so fan-out replies
+    # arrive as one-per-primary arrays; these overrides aggregate them for standalone/cluster
+    # API parity: PREPARE returns the first "OK" (all-or-raise), the discards return the max
+    # across primaries — per-node integers can legitimately diverge when a node joined after
+    # the PREPARE. The Array guard keeps the user-facing contract ("OK" / Integer) stable if a
+    # future server release adds a response_policy: the driver then aggregates the fan-out
+    # itself and hands us a scalar, which we pass through instead of crashing on String#first.
+    # Partial fan-out failures raise Redis::Cluster::CommandErrorCollection whose #errors hash
+    # tells you which nodes failed; nodes that replied OK keep their fieldsets.
+    #
+    # The fieldset registry, monitor atomicity and loss-recovery (on "no such fieldset" the
+    # last prepared schema is re-fanned out — through these overrides — and the SET retried
+    # once) are inherited from the Redis superclass unchanged; `himport_set` needs no override.
+
+    def himport_prepare(fieldset_name, *fields)
+      reply = super
+      reply.is_a?(Array) ? reply.first : reply
+    end
+
+    def himport_discard(fieldset_name)
+      reply = super
+      reply.is_a?(Array) ? reply.max : reply
+    end
+
+    def himport_discard_all
+      reply = super
+      reply.is_a?(Array) ? reply.max : reply
+    end
+
     private
 
     def initialize_client(options)
-      cluster_config = RedisClient.cluster(**options, protocol: 2, client_implementation: ::Redis::Cluster::Client)
+      # protocol defaults to 3 (RESP3) but a caller-provided protocol: in options overrides it.
+      cluster_config = RedisClient.cluster(
+        protocol: 3, **options,
+        driver_info: ::Redis::LibIdentity.driver_info(options[:driver_info]),
+        client_implementation: ::Redis::Cluster::Client
+      )
       cluster_config.new_client
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-clustering
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Ezra Zygmuntowicz
@@ -15,7 +15,7 @@ authors:
 - Pieter Noordhuis
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2026-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -23,28 +23,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: redis-cluster-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.16.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.16.7
 description: |2
     A Ruby client that tries to match Redis' Cluster API one-to-one, while still
       providing an idiomatic interface.
@@ -68,9 +68,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/redis/redis-rb/issues
   changelog_uri: https://github.com/redis/redis-rb/blob/master/cluster/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/redis/5.4.0
+  documentation_uri: https://www.rubydoc.info/gems/redis/6.0.0
   homepage_uri: https://github.com/redis/redis-rb/blob/master/cluster
-  source_code_uri: https://github.com/redis/redis-rb/tree/v5.4.0/cluster
+  source_code_uri: https://github.com/redis/redis-rb/tree/v6.0.0/cluster
 rdoc_options: []
 require_paths:
 - lib
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="