redis-clustering 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0390ca44d9f71661f4cfb1a7f8d1a396a84e204e992cf8a5d0755af4232cb7ac'
-  data.tar.gz: 923cffa3fc0a5a2aaecb4d669ea685e25047c7dc70f932f3e807e6e381fc3ecb
+  metadata.gz: f7060eff856ef3d21ddeff60bfd2a0b6d741d04fd9b233f5b36eee50812b88bc
+  data.tar.gz: 07d96f3179db08a80f054542474ef0d69a3db1cfce92b80b729a9f2b04bf9e1f
 SHA512:
-  metadata.gz: b4c5f9903044360cd0317a2ad75d0c41cbd8627c34da86c9cca3471ef78e0256778c15f997f0073386b8dbfa38ca906ab03b31efb3b7c190b7412a0d6bdd1987
-  data.tar.gz: 4e331655c8142429b1fbee72eec3c1fd26b42f5fa4e33156a0f3415151bd7bc3b9da85e604d464b4db33c2425d6a2b910718a6b6108ede5e7bc30635371ea33f
+  metadata.gz: 05b728ef68b71a9dc1f370cb2c03cc5fb7bc01c9a3278b160cebf0f6de3a6b42ad5cb3c9c9a30e9a49f9f4cffad16ec926825796941e2d0d99b09fad964a0773
+  data.tar.gz: 6b16c0354a7a8bfbef6124186e98d28e183e00e614471543e51acfca01585a44a35f1157b75b815c6bb156ca4be975c39c1eb4ce9d0aa248db4834040023d77c

data/README.md

@@ -75,3 +75,34 @@ Redis::Cluster.new(nodes: %w[rediss://foo-endpoint.example.com:6379], fixed_host
 ```
 
 In case of the above architecture, if you don't pass the `fixed_hostname` option to the client and servers return IP addresses of nodes, the client may fail to verify certificates.
+
+## Transaction with an optimistic locking
+Since Redis cluster is a distributed system, several behaviors are different from a standalone server.
+Client libraries can make them compatible up to a point, but a part of features needs some restrictions.
+Especially, some cautions are needed to use the transaction feature with an optimistic locking.
+
+```ruby
+# The client is an instance of the internal adapter for the optimistic locking
+redis.watch("{my}key") do |client|
+  if client.get("{my}key") == "some value"
+    # The tx is an instance of the internal adapter for the transaction
+    client.multi do |tx|
+      tx.set("{my}key", "other value")
+      tx.incr("{my}counter")
+    end
+  else
+    client.unwatch
+  end
+end
+```
+
+In a cluster mode client, you need to pass a block if you call the watch method and you need to specify an argument to the block.
+Also, you should use the block argument as a receiver to call commands in the block.
+Although the above restrictions are needed, this implementations is compatible with a standalone client.
+
+## MGET, MSET and DEL
+This gem allows you to use MGET, MSET and DEL specifying multiple keys without a hash tag.
+Cross-slot errors are prevented by an internal dedicated implementation.
+The underlying library makes the behavior possible.
+(ref. [redis-cluster-client](https://github.com/redis-rb/redis-cluster-client))
+That said, we recommend to use a hash tag for these commands to the better performance.

data/lib/redis/cluster/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'redis-cluster-client'
+require 'redis/cluster/transaction_adapter'
 
 class Redis
   class Cluster
@@ -53,11 +54,11 @@ class Redis
       ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
 
       def id
-        @router.node_keys.join(' ')
+        server_url.join(' ')
       end
 
       def server_url
-        @router.node_keys
+        @router.nil? ? @config.startup_nodes.keys : router.node_keys
       end
 
       def connected?
@@ -98,6 +99,34 @@ class Redis
         handle_errors { super(watch: watch, &block) }
       end
 
+      def watch(*keys, &block)
+        unless block_given?
+          raise(
+            Redis::Cluster::TransactionConsistencyError,
+            'A block is required if you use the cluster client.'
+          )
+        end
+
+        unless block.arity == 1
+          raise(
+            Redis::Cluster::TransactionConsistencyError,
+            'Given block needs an argument if you use the cluster client.'
+          )
+        end
+
+        handle_errors do
+          RedisClient::Cluster::OptimisticLocking.new(router).watch(keys) do |c, slot, asking|
+            transaction = Redis::Cluster::TransactionAdapter.new(
+              self, router, @command_builder, node: c, slot: slot, asking: asking
+            )
+
+            result = yield transaction
+            c.call('UNWATCH') unless transaction.lock_released?
+            result
+          end
+        end
+      end
+
       private
 
       def handle_errors

data/lib/redis/cluster/transaction_adapter.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'redis_client/cluster/transaction'
+
+class Redis
+  class Cluster
+    class TransactionAdapter
+      class Internal < RedisClient::Cluster::Transaction
+        def initialize(client, router, command_builder, node: nil, slot: nil, asking: false)
+          @client = client
+          super(router, command_builder, node: node, slot: slot, asking: asking)
+        end
+
+        def multi
+          raise(Redis::Cluster::TransactionConsistencyError, "Can't nest multi transaction")
+        end
+
+        def exec
+          # no need to do anything
+        end
+
+        def discard
+          # no need to do anything
+        end
+
+        def watch(*_)
+          raise(Redis::Cluster::TransactionConsistencyError, "Can't use watch in a transaction")
+        end
+
+        def unwatch
+          # no need to do anything
+        end
+
+        private
+
+        def method_missing(name, *args, **kwargs, &block)
+          return call(name, *args, **kwargs, &block) if @client.respond_to?(name)
+
+          super
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          return true if @client.respond_to?(name)
+
+          super
+        end
+      end
+
+      def initialize(client, router, command_builder, node: nil, slot: nil, asking: false)
+        @client = client
+        @router = router
+        @command_builder = command_builder
+        @node = node
+        @slot = slot
+        @asking = asking
+        @lock_released = false
+      end
+
+      def lock_released?
+        @lock_released
+      end
+
+      def multi
+        @lock_released = true
+        transaction = Redis::Cluster::TransactionAdapter::Internal.new(
+          @client, @router, @command_builder, node: @node, slot: @slot, asking: @asking
+        )
+        yield transaction
+        transaction.execute
+      end
+
+      def exec
+        # no need to do anything
+      end
+
+      def discard
+        # no need to do anything
+      end
+
+      def watch(*_)
+        raise(Redis::Cluster::TransactionConsistencyError, "Can't nest watch command if you use the cluster client")
+      end
+
+      def unwatch
+        @lock_released = true
+        @node.call('UNWATCH')
+      end
+
+      private
+
+      def method_missing(name, *args, **kwargs, &block)
+        return @client.public_send(name, *args, **kwargs, &block) if @client.respond_to?(name)
+
+        super
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        return true if @client.respond_to?(name)
+
+        super
+      end
+    end
+  end
+end

data/lib/redis/cluster.rb

@@ -96,8 +96,33 @@ class Redis
       send_command([:cluster, subcommand] + args, &block)
     end
 
+    # Watch the given keys to determine execution of the MULTI/EXEC block.
+    #
+    # Using a block is required for a cluster client. It's different from a standalone client.
+    # And you should use the block argument as a receiver if you call commands.
+    #
+    # An `#unwatch` is automatically issued if an exception is raised within the
+    # block that is a subclass of StandardError and is not a ConnectionError.
+    #
+    # @param keys [String, Array<String>] one or more keys to watch
+    # @return [Object] returns the return value of the block
+    #
+    # @example A typical use case.
+    #   # The client is an instance of the internal adapter for the optimistic locking
+    #   redis.watch("{my}key") do |client|
+    #     if client.get("{my}key") == "some value"
+    #       # The tx is an instance of the internal adapter for the transaction
+    #       client.multi do |tx|
+    #         tx.set("{my}key", "other value")
+    #         tx.incr("{my}counter")
+    #       end
+    #     else
+    #       client.unwatch
+    #     end
+    #   end
+    #   #=> ["OK", 6]
     def watch(*keys, &block)
-      synchronize { |c| c.call_v([:watch] + keys, &block) }
+      synchronize { |c| c.watch(*keys, &block) }
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-clustering
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Ezra Zygmuntowicz
@@ -13,10 +13,9 @@ authors:
 - Michel Martens
 - Damian Janowski
 - Pieter Noordhuis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,28 +23,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: redis-cluster-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.11
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.11
+        version: 0.10.0
 description: |2
     A Ruby client that tries to match Redis' Cluster API one-to-one, while still
       providing an idiomatic interface.
@@ -61,6 +60,7 @@ files:
 - lib/redis-clustering.rb
 - lib/redis/cluster.rb
 - lib/redis/cluster/client.rb
+- lib/redis/cluster/transaction_adapter.rb
 - lib/redis/cluster/version.rb
 homepage: https://github.com/redis/redis-rb/blob/master/cluster
 licenses:
@@ -68,10 +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.2.0
+  documentation_uri: https://www.rubydoc.info/gems/redis/5.4.0
   homepage_uri: https://github.com/redis/redis-rb/blob/master/cluster
-  source_code_uri: https://github.com/redis/redis-rb/tree/v5.2.0/cluster
-post_install_message:
+  source_code_uri: https://github.com/redis/redis-rb/tree/v5.4.0/cluster
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby client library for Redis Cluster
 test_files: []