redis-cluster-client 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2465b865cd79c78cca3a1e7e3950989cce94f6675b0497763e03e261d3fa9c6f
-  data.tar.gz: df607279a58171aca75835b767f3bf5965256db0fcb7b540bfcb3a8f302eb638
+  metadata.gz: 5d90c095f5058e808331eaa9219fb52b9d4a27de639a9c54d194c68ecb253611
+  data.tar.gz: 8cd8092db87c7cfa42e00c6cabd30747bdea74130d8eb1e19b971b95637665fa
 SHA512:
-  metadata.gz: bfb9031660b642bb14768dc8edc66fb15073be9ca23ddc061d279a351c497a83ff8a3aad21903e2d0a37aa6824da35761188ba4dc1fe8ae0182b54584edaa5e5
-  data.tar.gz: 9fab63d0595bfb7dac85a07c255a41573ab8d44598605919fd4182e99cf3da585bf931abe63da9e2f470815c6ef0d34ab24a5b7f2de346ba29870fb894c556ee
+  metadata.gz: 4821b78b0d5766566fa3943f65271908d3e52e3f82269bd2ea0a789e571df7818b5e0275c88d8833eb7b449c7c0eb3ed672034c1caf03fac35528114f31adb73
+  data.tar.gz: a4bb1d4a766cd742645c61342c2822e2bd337c792fb67b9793bfbb06ec0a889185eaa8b3ed34f96591f9e57997ecfe83cc901ce65451577b7e8f13d7d23f64b3

data/lib/redis_client/cluster/command.rb

@@ -17,7 +17,6 @@ class RedisClient
       Detail = Struct.new(
         'RedisCommand',
         :first_key_position,
-        :last_key_position,
         :key_step,
         :write?,
         :readonly?,
@@ -54,7 +53,6 @@ class RedisClient
 
             acc[row[0].downcase] = ::RedisClient::Cluster::Command::Detail.new(
               first_key_position: row[3],
-              last_key_position: row[4],
               key_step: row[5],
               write?: row[2].include?('write'),
               readonly?: row[2].include?('readonly')
@@ -71,18 +69,7 @@ class RedisClient
         i = determine_first_key_position(command)
         return EMPTY_STRING if i == 0
 
-        (command[i].is_a?(Array) ? command[i].flatten.first : command[i]).to_s
-      end
-
-      def extract_all_keys(command)
-        keys_start = determine_first_key_position(command)
-        keys_end = determine_last_key_position(command, keys_start)
-        keys_step = determine_key_step(command)
-        return EMPTY_ARRAY if [keys_start, keys_end, keys_step].any?(&:zero?)
-
-        keys_end = [keys_end, command.size - 1].min
-        # use .. inclusive range because keys_end is a valid index.
-        (keys_start..keys_end).step(keys_step).map { |i| command[i] }
+        command[i]
       end
 
       def should_send_to_primary?(command)
@@ -116,45 +103,10 @@ class RedisClient
         end
       end
 
-      # IMPORTANT: this determines the last key position INCLUSIVE of the last key -
-      # i.e. command[determine_last_key_position(command)] is a key.
-      # This is in line with what Redis returns from COMMANDS.
-      def determine_last_key_position(command, keys_start) # rubocop:disable Metrics/AbcSize
-        case name = ::RedisClient::Cluster::NormalizedCmdName.instance.get_by_command(command)
-        when 'eval', 'evalsha', 'zinterstore', 'zunionstore'
-          # EVALSHA sha1 numkeys [key [key ...]] [arg [arg ...]]
-          # ZINTERSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE <SUM | MIN | MAX>]
-          command[2].to_i + 2
-        when 'object', 'memory'
-          # OBJECT [ENCODING | FREQ | IDLETIME | REFCOUNT] key
-          # MEMORY USAGE key [SAMPLES count]
-          keys_start
-        when 'migrate'
-          # MIGRATE host port <key | ""> destination-db timeout [COPY] [REPLACE] [AUTH password | AUTH2 username password] [KEYS key [key ...]]
-          command[3].empty? ? (command.length - 1) : 3
-        when 'xread', 'xreadgroup'
-          # XREAD [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] id [id ...]
-          keys_start + ((command.length - keys_start) / 2) - 1
-        else
-          # If there is a fixed, non-variable number of keys, don't iterate past that.
-          if @commands[name].last_key_position >= 0
-            @commands[name].last_key_position
-          else
-            command.length + @commands[name].last_key_position
-          end
-        end
-      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)
+      def determine_optional_key_position(command, option_name)
+        idx = command.map { |e| e.to_s.downcase }.index(option_name&.downcase)
         idx.nil? ? 0 : idx + 1
       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
     end
   end
 end

data/lib/redis_client/cluster/errors.rb

@@ -34,11 +34,14 @@ class RedisClient
     end
 
     class ErrorCollection < Error
+      EMPTY_HASH = {}.freeze
+
+      private_constant :EMPTY_HASH
       attr_reader :errors
 
       def self.with_errors(errors)
         if !errors.is_a?(Hash) || errors.empty?
-          new(errors.to_s).with_errors({})
+          new(errors.to_s).with_errors(EMPTY_HASH)
         else
           messages = errors.map { |node_key, error| "#{node_key}: (#{error.class}) #{error.message}" }
           new(messages.join(', ')).with_errors(errors)

data/lib/redis_client/cluster/noop_command_builder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class RedisClient
+  class Cluster
+    module NoopCommandBuilder
+      module_function
+
+      def generate(args, _kwargs = nil)
+        args
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/pipeline.rb

@@ -2,6 +2,7 @@
 
 require 'redis_client'
 require 'redis_client/cluster/errors'
+require 'redis_client/cluster/noop_command_builder'
 require 'redis_client/connection_mixin'
 require 'redis_client/middlewares'
 require 'redis_client/pooled'
@@ -229,7 +230,7 @@ class RedisClient
 
       def append_pipeline(node_key)
         @pipelines ||= {}
-        @pipelines[node_key] ||= ::RedisClient::Cluster::Pipeline::Extended.new(@command_builder)
+        @pipelines[node_key] ||= ::RedisClient::Cluster::Pipeline::Extended.new(::RedisClient::Cluster::NoopCommandBuilder)
         @pipelines[node_key].add_outer_index(@size)
         @size += 1
         @pipelines[node_key]

data/lib/redis_client/cluster/router.rb

@@ -104,12 +104,6 @@ class RedisClient
         end
       end
 
-      def try_delegate(node, method, *args, retry_count: 3, **kwargs, &block)
-        handle_redirection(node, nil, retry_count: retry_count) do |on_node|
-          on_node.public_send(method, *args, **kwargs, &block)
-        end
-      end
-
       def handle_redirection(node, command, retry_count:) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         yield node
       rescue ::RedisClient::CircuitBreaker::OpenCircuitError
@@ -153,9 +147,7 @@ class RedisClient
         raise
       end
 
-      def scan(*command, seed: nil, **kwargs) # rubocop:disable Metrics/AbcSize
-        command = @command_builder.generate(command, kwargs)
-
+      def scan(command, seed: nil) # rubocop:disable Metrics/AbcSize
         command[1] = ZERO_CURSOR_FOR_SCAN if command.size == 1
         input_cursor = Integer(command[1])
 
@@ -180,6 +172,16 @@ class RedisClient
         raise
       end
 
+      def scan_single_key(command, arity:, &block)
+        node = assign_node(command)
+        loop do
+          cursor, values = handle_redirection(node, nil, retry_count: 3) { |n| n.call_v(command) }
+          command[2] = cursor
+          arity < 2 ? values.each(&block) : values.each_slice(arity, &block)
+          break if cursor == ZERO_CURSOR_FOR_SCAN
+        end
+      end
+
       def assign_node(command)
         handle_node_reload_error do
           node_key = find_node_key(command)
@@ -365,17 +367,20 @@ class RedisClient
         end
       end
 
-      MULTIPLE_KEYS_COMMAND_TO_SINGLE = {
-        'mget' => ['get', 1].freeze,
-        'mset' => ['set', 2].freeze,
-        'del' => ['del', 1].freeze
-      }.freeze
-
-      private_constant :MULTIPLE_KEYS_COMMAND_TO_SINGLE
-
       def send_multiple_keys_command(cmd, method, command, args, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         # This implementation is prioritized performance rather than readability or so.
-        single_key_cmd, keys_step = MULTIPLE_KEYS_COMMAND_TO_SINGLE.fetch(cmd)
+        case cmd
+        when 'mget'
+          single_key_cmd = 'get'
+          keys_step = 1
+        when 'mset'
+          single_key_cmd = 'set'
+          keys_step = 2
+        when 'del'
+          single_key_cmd = 'del'
+          keys_step = 1
+        else raise NotImplementedError, cmd
+        end
 
         return try_send(assign_node(command), method, command, args, &block) if command.size <= keys_step + 1 || ::RedisClient::Cluster::KeySlotConverter.hash_tag_included?(command[1])
 

data/lib/redis_client/cluster/transaction.rb

@@ -2,6 +2,7 @@
 
 require 'redis_client'
 require 'redis_client/cluster/errors'
+require 'redis_client/cluster/noop_command_builder'
 require 'redis_client/cluster/pipeline'
 
 class RedisClient
@@ -18,7 +19,7 @@ class RedisClient
         @router = router
         @command_builder = command_builder
         @retryable = true
-        @pipeline = ::RedisClient::Pipeline.new(@command_builder)
+        @pipeline = ::RedisClient::Pipeline.new(::RedisClient::Cluster::NoopCommandBuilder)
         @pending_commands = []
         @node = node
         prepare_tx unless @node.nil?

data/lib/redis_client/cluster.rb

@@ -62,30 +62,37 @@ class RedisClient
     end
 
     def scan(*args, **kwargs, &block)
-      raise ArgumentError, 'block required' unless block
+      return to_enum(__callee__, *args, **kwargs) unless block_given?
 
+      command = @command_builder.generate(['SCAN', ZERO_CURSOR_FOR_SCAN] + args, kwargs)
       seed = Random.new_seed
-      cursor = ZERO_CURSOR_FOR_SCAN
       loop do
-        cursor, keys = router.scan('SCAN', cursor, *args, seed: seed, **kwargs)
+        cursor, keys = router.scan(command, seed: seed)
+        command[1] = cursor
         keys.each(&block)
         break if cursor == ZERO_CURSOR_FOR_SCAN
       end
     end
 
     def sscan(key, *args, **kwargs, &block)
-      node = router.assign_node(['SSCAN', key])
-      router.try_delegate(node, :sscan, key, *args, **kwargs, &block)
+      return to_enum(__callee__, key, *args, **kwargs) unless block_given?
+
+      command = @command_builder.generate(['SSCAN', key, ZERO_CURSOR_FOR_SCAN] + args, kwargs)
+      router.scan_single_key(command, arity: 1, &block)
     end
 
     def hscan(key, *args, **kwargs, &block)
-      node = router.assign_node(['HSCAN', key])
-      router.try_delegate(node, :hscan, key, *args, **kwargs, &block)
+      return to_enum(__callee__, key, *args, **kwargs) unless block_given?
+
+      command = @command_builder.generate(['HSCAN', key, ZERO_CURSOR_FOR_SCAN] + args, kwargs)
+      router.scan_single_key(command, arity: 2, &block)
     end
 
     def zscan(key, *args, **kwargs, &block)
-      node = router.assign_node(['ZSCAN', key])
-      router.try_delegate(node, :zscan, key, *args, **kwargs, &block)
+      return to_enum(__callee__, key, *args, **kwargs) unless block_given?
+
+      command = @command_builder.generate(['ZSCAN', key, ZERO_CURSOR_FOR_SCAN] + args, kwargs)
+      router.scan_single_key(command, arity: 2, &block)
     end
 
     def pipelined(exception: true)

data/lib/redis_client/cluster_config.rb

@@ -5,6 +5,7 @@ require 'redis_client'
 require 'redis_client/cluster'
 require 'redis_client/cluster/errors'
 require 'redis_client/cluster/node_key'
+require 'redis_client/cluster/noop_command_builder'
 require 'redis_client/command_builder'
 
 class RedisClient
@@ -64,7 +65,7 @@ class RedisClient
     end
 
     def inspect
-      "#<#{self.class.name} #{startup_nodes.values}>"
+      "#<#{self.class.name} #{startup_nodes.values.map { |v| v.reject { |k| k == :command_builder } }}>"
     end
 
     def read_timeout
@@ -187,6 +188,7 @@ class RedisClient
     def augment_client_config(config)
       config = @client_config.merge(config)
       config = config.merge(host: @fixed_hostname) unless @fixed_hostname.empty?
+      config[:command_builder] = ::RedisClient::Cluster::NoopCommandBuilder # prevent twice call
       config
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -48,6 +48,7 @@ files:
 - lib/redis_client/cluster/node/random_replica.rb
 - lib/redis_client/cluster/node/random_replica_or_primary.rb
 - lib/redis_client/cluster/node_key.rb
+- lib/redis_client/cluster/noop_command_builder.rb
 - lib/redis_client/cluster/normalized_cmd_name.rb
 - lib/redis_client/cluster/optimistic_locking.rb
 - lib/redis_client/cluster/pipeline.rb