redis-cluster-client 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d1591b89859ddc92dc6ca349ff211d0a6ac14c68ad72e920cc9725d82587b4
-  data.tar.gz: fcfeceffddc9201f8b8c5d6999d3e7aa8581c9f24f0d823b029a5561ef82887d
+  metadata.gz: 97383b0daf1dcc2e5fcd8e50640e9ecbd903562a10cca0f4996ada1807469f80
+  data.tar.gz: 675ae25f2fbf2d9d67234b4e1ad81894656f11a32fe4cd1ebf8ae73c90c67509
 SHA512:
-  metadata.gz: d51aefc48e64ef0cdbded8b5c8e4b005dcfd103d9fa4ecfa0dff1d9aa4fed5d6f6aefd4dca4ac53e89867b5276812bc6c7f8cf3cb41c1184bd9d8f19ea601471
-  data.tar.gz: 548da631726b4881f0a7712186f656733cb6941aef9ca3415498a6f048f59170fb74a59c30da68d655cee5e5773732d9d781c489f6cda2f0c92a341f1b28b892
+  metadata.gz: 851565ace738fb9bf51d1211ece97767520c94a7b02e49b053732de351d77a30e7104ae1f8143a0ee3903a2b99de39b298b3eec80c2fb94b08fb4747180bb03d
+  data.tar.gz: 0a0b6ada72bccfcdb7cecda533f8f31761f15f991e359bc211a4d54ba973b2c68983efd3a9a594e7baab11b614fecb058de98b71f1890f7e52150f40e2c34d1b

data/lib/redis_client/cluster/command.rb

@@ -97,6 +97,12 @@ class RedisClient
         @commands.key?(::RedisClient::Cluster::NormalizedCmdName.instance.get_by_name(name))
       end
 
+      def determine_key_step(command)
+        name = ::RedisClient::Cluster::NormalizedCmdName.instance.get_by_command(command)
+        # Some commands like EVALSHA have zero as the step in COMMANDS somehow.
+        @commands[name].key_step == 0 ? 1 : @commands[name].key_step
+      end
+
       private
 
       def determine_first_key_position(command) # rubocop:disable Metrics/CyclomaticComplexity
@@ -143,12 +149,6 @@ class RedisClient
         end
       end
 
-      def determine_key_step(command)
-        name = ::RedisClient::Cluster::NormalizedCmdName.instance.get_by_command(command)
-        # Some commands like EVALSHA have zero as the step in COMMANDS somehow.
-        @commands[name].key_step == 0 ? 1 : @commands[name].key_step
-      end
-
       def determine_optional_key_position(command, option_name) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         idx = command&.flatten&.map(&:to_s)&.map(&:downcase)&.index(option_name&.downcase)
         idx.nil? ? 0 : idx + 1

data/lib/redis_client/cluster/node/base_topology.rb

@@ -5,6 +5,9 @@ class RedisClient
     class Node
       class BaseTopology
         IGNORE_GENERIC_CONFIG_KEYS = %i[url host port path].freeze
+        EMPTY_HASH = {}.freeze
+        EMPTY_ARRAY = [].freeze
+
         attr_reader :clients, :primary_clients, :replica_clients
 
         def initialize(pool, concurrent_worker, **kwargs)

data/lib/redis_client/cluster/node.rb

@@ -92,13 +92,7 @@ class RedisClient
         end
       end
 
-      def initialize(
-        concurrent_worker,
-        config:,
-        pool: nil,
-        **kwargs
-      )
-
+      def initialize(concurrent_worker, config:, pool: nil, **kwargs)
         @concurrent_worker = concurrent_worker
         @slots = build_slot_node_mappings(EMPTY_ARRAY)
         @replications = build_replication_mappings(EMPTY_ARRAY)
@@ -106,6 +100,7 @@ class RedisClient
         @topology = klass.new(pool, @concurrent_worker, **kwargs)
         @config = config
         @mutex = Mutex.new
+        @last_reloaded_at = nil
       end
 
       def inspect

data/lib/redis_client/cluster/router.rb

@@ -10,6 +10,7 @@ require 'redis_client/cluster/node_key'
 require 'redis_client/cluster/normalized_cmd_name'
 require 'redis_client/cluster/transaction'
 require 'redis_client/cluster/optimistic_locking'
+require 'redis_client/cluster/pipeline'
 require 'redis_client/cluster/error_identification'
 
 class RedisClient
@@ -17,6 +18,11 @@ class RedisClient
     class Router
       ZERO_CURSOR_FOR_SCAN = '0'
       TSF = ->(f, x) { f.nil? ? x : f.call(x) }.curry
+      MULTIPLE_KEYS_COMMAND_TO_PIPELINE = {
+        'mset' => 'set',
+        'mget' => 'get',
+        'del' => 'del'
+      }.freeze
 
       def initialize(config, concurrent_worker, pool: nil, **kwargs)
         @config = config.dup
@@ -48,6 +54,8 @@ class RedisClient
         when 'script'   then send_script_command(method, command, args, &block)
         when 'pubsub'   then send_pubsub_command(method, command, args, &block)
         when 'watch'    then send_watch_command(command, &block)
+        when 'mset', 'mget', 'del'
+          send_multiple_keys_command(cmd, method, command, args, &block)
         when 'acl', 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
           @node.call_all(method, command, args).first.then(&TSF.call(block))
         when 'flushall', 'flushdb'
@@ -314,7 +322,6 @@ class RedisClient
         end
       end
 
-      # for redis-rb
       def send_watch_command(command)
         raise ::RedisClient::Cluster::Transaction::ConsistencyError, 'A block required. And you need to use the block argument as a client for the transaction.' unless block_given?
 
@@ -327,6 +334,40 @@ class RedisClient
         end
       end
 
+      def send_multiple_keys_command(cmd, method, command, args, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        key_step = @command.determine_key_step(cmd)
+        if command.size <= key_step + 1 || !::RedisClient::Cluster::KeySlotConverter.extract_hash_tag(command[1]).empty? # rubocop:disable Style/IfUnlessModifier
+          return try_send(assign_node(command), method, command, args, &block)
+        end
+
+        seed = @config.use_replica? && @config.replica_affinity == :random ? nil : Random.new_seed
+        pipeline = ::RedisClient::Cluster::Pipeline.new(self, @command_builder, @concurrent_worker, exception: true, seed: seed)
+
+        # This implementation is prioritized to lessen memory consumption rather than readability.
+        single_key_cmd = MULTIPLE_KEYS_COMMAND_TO_PIPELINE[cmd]
+        single_command = Array.new(key_step + 1)
+        single_command[0] = single_key_cmd
+        if key_step == 1
+          command[1..].each do |key|
+            single_command[1] = key
+            pipeline.call_v(single_command)
+          end
+        else
+          command[1..].each_slice(key_step) do |v|
+            key_step.times { |i| single_command[i + 1] = v[i] }
+            pipeline.call_v(single_command)
+          end
+        end
+
+        replies = pipeline.execute
+        result = case cmd
+                 when 'mset' then replies.first
+                 when 'del' then replies.sum
+                 else replies
+                 end
+        block_given? ? yield(result) : result
+      end
+
       def update_cluster_info!
         @node.reload!
       end

data/lib/redis_client/cluster/transaction.rb

@@ -8,6 +8,7 @@ class RedisClient
     class Transaction
       ConsistencyError = Class.new(::RedisClient::Error)
       MAX_REDIRECTION = 2
+      EMPTY_ARRAY = [].freeze
 
       def initialize(router, command_builder, node: nil, slot: nil, asking: false)
         @router = router
@@ -62,10 +63,10 @@ class RedisClient
       def execute
         @pending_commands.each(&:call)
 
-        raise ArgumentError, 'empty transaction' if @pipeline._empty?
+        return EMPTY_ARRAY if @pipeline._empty?
         raise ConsistencyError, "couldn't determine the node: #{@pipeline._commands}" if @node.nil?
 
-        settle
+        commit
       end
 
       private
@@ -92,8 +93,17 @@ class RedisClient
         @pending_commands.clear
       end
 
-      def settle
+      def commit
         @pipeline.call('EXEC')
+        settle
+      end
+
+      def cancel
+        @pipeline.call('DISCARD')
+        settle
+      end
+
+      def settle
         # If we needed ASKING on the watch, we need ASKING on the multi as well.
         @node.call('ASKING') if @asking
         # Don't handle redirections at this level if we're in a watch (the watcher handles redirections

data/lib/redis_client/cluster.rb

@@ -5,7 +5,6 @@ require 'redis_client/cluster/pipeline'
 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
@@ -118,13 +117,8 @@ class RedisClient
       ::RedisClient::Cluster::PubSub.new(@router, @command_builder)
     end
 
-    # 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)
-      key = process_with_arguments(key, hashtag)
-      node_key = @router.find_node_key_by_key(key, primary: write)
-      node = @router.find_node(node_key)
-      node.with { |c| yield ::RedisClient::Cluster::PinningNode.new(c) }
+    def with(...)
+      raise NotImplementedError, 'No way to use'
     end
 
     def close
@@ -135,19 +129,6 @@ class RedisClient
 
     private
 
-    def process_with_arguments(key, hashtag) # rubocop:disable Metrics/CyclomaticComplexity
-      raise ArgumentError, 'Only one of key or hashtag may be provided' if key && hashtag
-
-      if hashtag
-        # The documentation says not to wrap your hashtag in {}, but people will probably
-        # do it anyway and it's easy for us to fix here.
-        key = hashtag&.match?(/^{.*}$/) ? hashtag : "{#{hashtag}}"
-      end
-      raise ArgumentError, 'One of key or hashtag must be provided' if key.nil? || key.empty?
-
-      key
-    end
-
     def method_missing(name, *args, **kwargs, &block)
       if @router.command_exists?(name)
         args.unshift(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-client
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -50,7 +50,6 @@ files:
 - 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
 - lib/redis_client/cluster/router.rb
@@ -78,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: A Redis cluster client for Ruby

data/lib/redis_client/cluster/pinning_node.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-class RedisClient
-  class Cluster
-    class PinningNode
-      def initialize(client)
-        @client = client
-      end
-
-      def call(*args, **kwargs, &block)
-        @client.call(*args, **kwargs, &block)
-      end
-
-      def call_v(args, &block)
-        @client.call_v(args, &block)
-      end
-
-      def call_once(*args, **kwargs, &block)
-        @client.call_once(*args, **kwargs, &block)
-      end
-
-      def call_once_v(args, &block)
-        @client.call_once_v(args, &block)
-      end
-
-      def blocking_call(timeout, *args, **kwargs, &block)
-        @client.blocking_call(timeout, *args, **kwargs, &block)
-      end
-
-      def blocking_call_v(timeout, args, &block)
-        @client.blocking_call_v(timeout, args, &block)
-      end
-    end
-  end
-end