redis-cluster-client 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071a90a4437e12104fba1359e1a88fd64a0aa253f53ec1fdfd5c8b1fa62c63a5
-  data.tar.gz: 773243dc28547cc114730cbef7f0f971dd7bb178d4ea9a8cb2e8c4924f99bf40
+  metadata.gz: 158cfc3693b4057ae42249cbddcca2e5bd53bb19bb62416e44f1d1358b55c711
+  data.tar.gz: 59917a893698b9d0fec7235821e4f9680b9e3ab4ebfd74554c48c50455a87186
 SHA512:
-  metadata.gz: d345690443bc35cf19935ae9e886e0833bee49b772f21abdfb4752629b7c436100e6a367b730055fbd155d59924cfd4d76ad3df2ee1a0ed3aff65f097a82a208
-  data.tar.gz: d76e747b3eec56184f253f40f82599f492338fe86d4d3c3d30e9cda22df087e6817673b7bf9f02c07192b77322efd7d204ff60ced77be7fe2e8764cf9d104f63
+  metadata.gz: 116c7f397e557fc0b6a336e3481cc3e5458bac590afe454ecbfbfcafddc67ea3641f9cd020ab7b9f2cb41f3fe54188a13d4324b9496e43a27b1f58f97163363d
+  data.tar.gz: e7ada90bdb11f0d113093792b627853a429d182c1e531d6c968fff530bbd34ed8df76655fd40223b91bc3c5d6524316302fa435438e731a8de1dcb0bc5c4ad24

data/lib/redis_client/cluster/node_key.rb

@@ -31,6 +31,10 @@ class RedisClient
       def build_from_host_port(host, port)
         "#{host}#{DELIMITER}#{port}"
       end
+
+      def build_from_client(client)
+        "#{client.config.host}#{DELIMITER}#{client.config.port}"
+      end
     end
   end
 end

data/lib/redis_client/cluster/optimistic_locking.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'redis_client'
+require 'redis_client/cluster/key_slot_converter'
+require 'redis_client/cluster/transaction'
+
+class RedisClient
+  class Cluster
+    class OptimisticLocking
+      def initialize(keys, router)
+        @node = find_node!(keys, router)
+        @keys = keys
+      end
+
+      def watch
+        @node.with do |c|
+          c.call('WATCH', *@keys)
+          reply = yield(c)
+          c.call('UNWATCH')
+          reply
+        end
+      end
+
+      private
+
+      def find_node!(keys, router)
+        raise ::RedisClient::Cluster::Transaction::ConsistencyError, "unsafe watch: #{keys.join(' ')}" unless safe?(keys)
+
+        node_key = router.find_primary_node_key(['WATCH', *keys])
+        raise ::RedisClient::Cluster::Transaction::ConsistencyError, "couldn't determine the node" if node_key.nil?
+
+        router.find_node(node_key)
+      end
+
+      def safe?(keys)
+        return false if keys.empty?
+
+        slots = keys.map do |k|
+          return false if k.nil? || k.empty?
+
+          ::RedisClient::Cluster::KeySlotConverter.convert(k)
+        end
+
+        slots.uniq.size == 1
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/transaction.rb

@@ -2,21 +2,21 @@
 
 require 'redis_client'
 require 'redis_client/cluster/pipeline'
-require 'redis_client/cluster/key_slot_converter'
+require 'redis_client/cluster/node_key'
 
 class RedisClient
   class Cluster
     class Transaction
       ConsistencyError = Class.new(::RedisClient::Error)
 
-      def initialize(router, command_builder, watch)
+      def initialize(router, command_builder, node = nil)
         @router = router
         @command_builder = command_builder
-        @watch = watch
         @retryable = true
         @pipeline = ::RedisClient::Pipeline.new(@command_builder)
-        @buffer = []
-        @node = nil
+        @pending_commands = []
+        @node = node
+        prepare_tx unless @node.nil?
       end
 
       def call(*command, **kwargs, &block)
@@ -24,7 +24,7 @@ class RedisClient
         if prepare(command)
           @pipeline.call_v(command, &block)
         else
-          @buffer << -> { @pipeline.call_v(command, &block) }
+          defer { @pipeline.call_v(command, &block) }
         end
       end
 
@@ -33,7 +33,7 @@ class RedisClient
         if prepare(command)
           @pipeline.call_v(command, &block)
         else
-          @buffer << -> { @pipeline.call_v(command, &block) }
+          defer { @pipeline.call_v(command, &block) }
         end
       end
 
@@ -43,7 +43,7 @@ class RedisClient
         if prepare(command)
           @pipeline.call_once_v(command, &block)
         else
-          @buffer << -> { @pipeline.call_once_v(command, &block) }
+          defer { @pipeline.call_once_v(command, &block) }
         end
       end
 
@@ -53,39 +53,24 @@ class RedisClient
         if prepare(command)
           @pipeline.call_once_v(command, &block)
         else
-          @buffer << -> { @pipeline.call_once_v(command, &block) }
+          defer { @pipeline.call_once_v(command, &block) }
         end
       end
 
       def execute
-        @buffer.each(&:call)
+        @pending_commands.each(&:call)
 
         raise ArgumentError, 'empty transaction' if @pipeline._empty?
         raise ConsistencyError, "couldn't determine the node: #{@pipeline._commands}" if @node.nil?
-        raise ConsistencyError, "unsafe watch: #{@watch.join(' ')}" unless safe_watch?
 
         settle
       end
 
       private
 
-      def watch?
-        !@watch.nil? && !@watch.empty?
-      end
-
-      def safe_watch?
-        return true unless watch?
-        return false if @node.nil?
-
-        slots = @watch.map do |k|
-          return false if k.nil? || k.empty?
-
-          ::RedisClient::Cluster::KeySlotConverter.convert(k)
-        end
-
-        return false if slots.uniq.size != 1
-
-        @router.find_primary_node_by_slot(slots.first) == @node
+      def defer(&block)
+        @pending_commands << block
+        nil
       end
 
       def prepare(command)
@@ -95,16 +80,18 @@ class RedisClient
         return false if node_key.nil?
 
         @node = @router.find_node(node_key)
-        @pipeline.call('WATCH', *@watch) if watch?
-        @pipeline.call('MULTI')
-        @buffer.each(&:call)
-        @buffer.clear
+        prepare_tx
         true
       end
 
+      def prepare_tx
+        @pipeline.call('MULTI')
+        @pending_commands.each(&:call)
+        @pending_commands.clear
+      end
+
       def settle
         @pipeline.call('EXEC')
-        @pipeline.call('UNWATCH') if watch?
         send_transaction(@node, redirect: true)
       end
 
@@ -128,11 +115,12 @@ class RedisClient
           end
         end
 
-        offset = watch? ? 2 : 1
-        coerce_results!(replies[-offset], offset)
+        return if replies.last.nil?
+
+        coerce_results!(replies.last)
       end
 
-      def coerce_results!(results, offset)
+      def coerce_results!(results, offset: 1)
         results.each_with_index do |result, index|
           if result.is_a?(::RedisClient::CommandError)
             result._set_command(@pipeline._commands[index + offset])
@@ -162,12 +150,12 @@ class RedisClient
       end
 
       def ensure_the_same_node!(commands)
+        expected_node_key = NodeKey.build_from_client(@node)
+
         commands.each do |command|
           node_key = @router.find_primary_node_key(command)
           next if node_key.nil?
-
-          node = @router.find_node(node_key)
-          next if @node == node
+          next if node_key == expected_node_key
 
           raise ConsistencyError, "the transaction should be executed to a slot in a node: #{commands}"
         end

data/lib/redis_client/cluster.rb

@@ -6,6 +6,7 @@ require 'redis_client/cluster/pub_sub'
 require 'redis_client/cluster/router'
 require 'redis_client/cluster/transaction'
 require 'redis_client/cluster/pinning_node'
+require 'redis_client/cluster/optimistic_locking'
 
 class RedisClient
   class Cluster
@@ -91,9 +92,18 @@ class RedisClient
     end
 
     def multi(watch: nil)
-      transaction = ::RedisClient::Cluster::Transaction.new(@router, @command_builder, watch)
-      yield transaction
-      transaction.execute
+      if watch.nil? || watch.empty?
+        transaction = ::RedisClient::Cluster::Transaction.new(@router, @command_builder)
+        yield transaction
+        transaction.execute
+      else
+        locking = ::RedisClient::Cluster::OptimisticLocking.new(watch, @router)
+        locking.watch do |c|
+          transaction = ::RedisClient::Cluster::Transaction.new(@router, @command_builder, c)
+          yield transaction
+          transaction.execute
+        end
+      end
     end
 
     def pubsub
@@ -102,12 +112,11 @@ class RedisClient
 
     # TODO: This isn't an official public interface yet. Don't use in your production environment.
     # @see https://github.com/redis-rb/redis-cluster-client/issues/299
-    def with(key: nil, hashtag: nil, write: true, _retry_count: 0, &_)
+    def with(key: nil, hashtag: nil, write: true)
       key = process_with_arguments(key, hashtag)
-
       node_key = @router.find_node_key_by_key(key, primary: write)
       node = @router.find_node(node_key)
-      yield ::RedisClient::Cluster::PinningNode.new(node)
+      node.with { |c| yield ::RedisClient::Cluster::PinningNode.new(c) }
     end
 
     def close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-client
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -49,6 +49,7 @@ files:
 - lib/redis_client/cluster/node/random_replica_or_primary.rb
 - lib/redis_client/cluster/node_key.rb
 - lib/redis_client/cluster/normalized_cmd_name.rb
+- lib/redis_client/cluster/optimistic_locking.rb
 - lib/redis_client/cluster/pinning_node.rb
 - lib/redis_client/cluster/pipeline.rb
 - lib/redis_client/cluster/pub_sub.rb