redis-cluster-client 0.8.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7986c9cc2ea7af5a128397b327e1a4b001740ac6a49af09d8f3ed507665b39d9
-  data.tar.gz: fcb8ef4cbc7095b8b57f9570b24dd4dc4d9b4a517b0e9d2451aa9c740c676989
+  metadata.gz: 75b8f7550c743c813f79d15ba60d5e78fe5e81c751854b5600cc1984b56256fa
+  data.tar.gz: c560f4fb9a3e5e044a64c8b8c0da8bf51413d384dd19d069994f14f44e4d4055
 SHA512:
-  metadata.gz: d2624fa1a7ff96f625816beb5f53cac2727c1649f44cb4170f2c744b60f8f4b03eb4ba764cfaba41d867f73807b24965c3fbd2938b3875d0cabf37ccf69bcf32
-  data.tar.gz: b062efff7fea22cda0379c8749c00315d949ad82d491b93307f3c8f42f2af0b563d3af270a1c63bb7b497c9e826f33369618e5dd93fe58415b6097eea9f600b9
+  metadata.gz: 5165edd2f2ae4c27680be76227cc73ed1b5e5c17914dc08eb6f9015199d29bb14f0c4961f5a291c3e764b78dfee3892e6666fff6aca95bc466eab144d4ce43d4
+  data.tar.gz: 91f09f17897dcd974f11001cd2ea0445a384cb83134d8b51835ad197835ee4710935253e024fd6c938f12fa10bb8daea56465ac7f522a6e2484ec25f942fcb0d

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/key_slot_converter.rb

@@ -70,6 +70,17 @@ class RedisClient
 
         key[s + 1..e - 1]
       end
+
+      def hash_tag_included?(key)
+        key = key.to_s
+        s = key.index(LEFT_BRACKET)
+        return false if s.nil?
+
+        e = key.index(RIGHT_BRACKET, s + 1)
+        return false if e.nil?
+
+        s + 1 < e
+      end
     end
   end
 end

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)

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.hash_tag_included?(command[1]) # 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.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.2
+  version: 0.9.1
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-05-04 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