redis-cluster-client 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be05e560aaf9384463913ded42ed7af2be53c9439a80529bbfabc96b523d077e
-  data.tar.gz: cf0b7ef156f19f240107c29bbb803949f9b7034052e0e9bffb668923bcf62322
+  metadata.gz: 8f07e3f65dcf4125b72089921a28fc2048d98bc95763d7ec2a5f0702e3ba542d
+  data.tar.gz: a69bdc239562da7c18b6b8eedfbb16b51879416f0093eb472b35f212080ae29e
 SHA512:
-  metadata.gz: a3bb611795108e0870668c86470a9eedce8a84bc7e80d6df974a5a35bde64de1c74fdd031969299c42f1861404b73cb02506bf83dc4ea82264548b058641c6fc
-  data.tar.gz: 7ec956a5e98ed22bf9a7dd7428d3b4e55694a824c5d6b3acba558ac40855014eebcf3ddd286863d7393ca3356d97b1fa25c42edec8533d42750401dd93101de0
+  metadata.gz: 7afe4938ca64ebbcd4607144b0fb634a26c3ba99a463ded614da7f7b2a52e59a607c27949bcf4e746ce7ed31d71e3d37d204b054ffef6c8b35ed8f72a83f632e
+  data.tar.gz: 876cc376f32d4c3d6d4b3c8c413e360fd91260bf173d80a90202428b7cef6923057da54df490111950cc278de49026a3f7726483d71bb24fd14e897e6c6f3f03

data/lib/redis_client/cluster/command.rb

@@ -21,11 +21,14 @@ class RedisClient
       )
 
       class << self
-        def load(nodes)
+        def load(nodes, slow_command_timeout: -1)
           cmd = errors = nil
 
           nodes&.each do |node|
+            regular_timeout = node.read_timeout
+            node.read_timeout = slow_command_timeout > 0.0 ? slow_command_timeout : regular_timeout
             reply = node.call('COMMAND')
+            node.read_timeout = regular_timeout
             commands = parse_command_reply(reply)
             cmd = ::RedisClient::Cluster::Command.new(commands)
             break

data/lib/redis_client/cluster/node.rb

@@ -13,11 +13,15 @@ class RedisClient
     class Node
       include Enumerable
 
+      # It affects to strike a balance between load and stability in initialization or changed states.
+      MAX_STARTUP_SAMPLE = Integer(ENV.fetch('REDIS_CLIENT_MAX_STARTUP_SAMPLE', 3))
+
+      # less memory consumption, but slow
+      USE_CHAR_ARRAY_SLOT = Integer(ENV.fetch('REDIS_CLIENT_USE_CHAR_ARRAY_SLOT', 1)) == 1
+
       SLOT_SIZE = 16_384
       MIN_SLOT = 0
       MAX_SLOT = SLOT_SIZE - 1
-      MAX_STARTUP_SAMPLE = Integer(ENV.fetch('REDIS_CLIENT_MAX_STARTUP_SAMPLE', 3))
-      USE_CHAR_ARRAY_SLOT = Integer(ENV.fetch('REDIS_CLIENT_USE_CHAR_ARRAY_SLOT', 1)) == 1 # less memory consumption, but slow
       IGNORE_GENERIC_CONFIG_KEYS = %i[url host port path].freeze
       DEAD_FLAGS = %w[fail? fail handshake noaddr noflags].freeze
       ROLE_FLAGS = %w[master slave].freeze
@@ -89,7 +93,7 @@ class RedisClient
       end
 
       class << self
-        def load_info(options, concurrent_worker, **kwargs) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def load_info(options, concurrent_worker, slow_command_timeout: -1, **kwargs) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           raise ::RedisClient::Cluster::InitialSetupError, [] if options.nil? || options.empty?
 
           startup_size = options.size > MAX_STARTUP_SAMPLE ? MAX_STARTUP_SAMPLE : options.size
@@ -99,7 +103,10 @@ class RedisClient
 
           startup_nodes.each_with_index do |raw_client, i|
             work_group.push(i, raw_client) do |client|
+              regular_timeout = client.read_timeout
+              client.read_timeout = slow_command_timeout > 0.0 ? slow_command_timeout : regular_timeout
               reply = client.call('CLUSTER', 'NODES')
+              client.read_timeout = regular_timeout
               parse_cluster_node_reply(reply)
             rescue StandardError => e
               e
@@ -209,10 +216,6 @@ class RedisClient
         @topology.clients.each_value(&block)
       end
 
-      def shuffled_nodes
-        @topology.clients.values.shuffle
-      end
-
       def sample
         @topology.clients.values.sample
       end
@@ -252,6 +255,10 @@ class RedisClient
         @topology.clients_for_scanning(seed: seed).values.sort_by { |c| "#{c.config.host}-#{c.config.port}" }
       end
 
+      def replica_clients
+        @topology.replica_clients.values
+      end
+
       def find_node_key_of_primary(slot)
         return if slot.nil?
 

data/lib/redis_client/cluster/pub_sub.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'redis_client'
+require 'redis_client/cluster/normalized_cmd_name'
 
 class RedisClient
   class Cluster

data/lib/redis_client/cluster/router.rb

@@ -18,11 +18,13 @@ class RedisClient
 
       def initialize(config, concurrent_worker, pool: nil, **kwargs)
         @config = config.dup
+        @original_config = config.dup if config.connect_with_original_config
+        @connect_with_original_config = config.connect_with_original_config
         @concurrent_worker = concurrent_worker
         @pool = pool
         @client_kwargs = kwargs
         @node = fetch_cluster_info(@config, @concurrent_worker, pool: @pool, **@client_kwargs)
-        @command = ::RedisClient::Cluster::Command.load(@node.shuffled_nodes)
+        @command = ::RedisClient::Cluster::Command.load(@node.replica_clients.shuffle, slow_command_timeout: config.slow_command_timeout)
         @mutex = Mutex.new
         @command_builder = @config.command_builder
       end
@@ -305,7 +307,7 @@ class RedisClient
       end
 
       def fetch_cluster_info(config, concurrent_worker, pool: nil, **kwargs)
-        node_info_list = ::RedisClient::Cluster::Node.load_info(config.per_node_key, concurrent_worker, **kwargs)
+        node_info_list = ::RedisClient::Cluster::Node.load_info(config.per_node_key, concurrent_worker, slow_command_timeout: config.slow_command_timeout, **kwargs)
         node_addrs = node_info_list.map { |i| ::RedisClient::Cluster::NodeKey.hashify(i.node_key) }
         config.update_node(node_addrs)
         ::RedisClient::Cluster::Node.new(
@@ -329,6 +331,7 @@ class RedisClient
             # ignore
           end
 
+          @config = @original_config.dup if @connect_with_original_config
           @node = fetch_cluster_info(@config, @concurrent_worker, pool: @pool, **@client_kwargs)
         end
       end

data/lib/redis_client/cluster_config.rb

@@ -18,18 +18,22 @@ class RedisClient
     MERGE_CONFIG_KEYS = %i[ssl username password].freeze
     IGNORE_GENERIC_CONFIG_KEYS = %i[url host port path].freeze
     MAX_WORKERS = Integer(ENV.fetch('REDIS_CLIENT_MAX_THREADS', 5))
+    # It's used with slow queries of fetching meta data like CLUSTER NODES, COMMAND and so on.
+    SLOW_COMMAND_TIMEOUT = Float(ENV.fetch('REDIS_CLIENT_SLOW_COMMAND_TIMEOUT', -1))
 
     InvalidClientConfigError = Class.new(::RedisClient::Error)
 
-    attr_reader :command_builder, :client_config, :replica_affinity
+    attr_reader :command_builder, :client_config, :replica_affinity, :slow_command_timeout, :connect_with_original_config
 
-    def initialize(
+    def initialize( # rubocop:disable Metrics/AbcSize
       nodes: DEFAULT_NODES,
       replica: false,
       replica_affinity: :random,
       fixed_hostname: '',
       concurrency: nil,
+      connect_with_original_config: false,
       client_implementation: ::RedisClient::Cluster, # for redis gem
+      slow_command_timeout: SLOW_COMMAND_TIMEOUT,
       **client_config
     )
 
@@ -41,7 +45,9 @@ class RedisClient
       @command_builder = client_config.fetch(:command_builder, ::RedisClient::CommandBuilder)
       @client_config = merge_generic_config(client_config, @node_configs)
       @concurrency = merge_concurrency_option(concurrency)
+      @connect_with_original_config = connect_with_original_config
       @client_implementation = client_implementation
+      @slow_command_timeout = slow_command_timeout
       @mutex = Mutex.new
     end
 
@@ -52,7 +58,9 @@ class RedisClient
         replica_affinity: @replica_affinity,
         fixed_hostname: @fixed_hostname,
         concurrency: @concurrency,
+        connect_with_original_config: @connect_with_original_config,
         client_implementation: @client_implementation,
+        slow_command_timeout: @slow_command_timeout,
         **@client_config
       )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-client
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client