redis-cluster-client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad96d02be39509b6df863c42e630940f053b6aea6cb478fe1fbec26fb5464e7c
+  data.tar.gz: '09983aedc4498a48f0fa2d7882e0df4b0998cd3ffd9d2ef13940abe50606a3e9'
+SHA512:
+  metadata.gz: '098a5674c2aa837fc26287c599b8dfd3d849af73ba5267a63b0741411c60312b15a819dc8fe0acd48e5a0d1696f610bb1c7196461ac12c6a49000a13c702836b'
+  data.tar.gz: 5134b1fd9f789166f29555abece7ef888c9a4c9e73a3ea04c0e06ed93a872ca908fa9a17a0f86746c7fe532d14a8a307f457115cf9b6f989c24d2b26938f38e4

data/lib/redis_client/cluster/command.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'redis_client'
+require 'redis_client/cluster/errors'
+
+class RedisClient
+  class Cluster
+    class Command
+      class << self
+        def load(nodes)
+          errors = nodes.map do |node|
+            details = fetch_command_details(node)
+            return ::RedisClient::Cluster::Command.new(details)
+          rescue ::RedisClient::ConnectionError, ::RedisClient::CommandError => e
+            e
+          end
+
+          raise ::RedisClient::Cluster::InitialSetupError, errors
+        end
+
+        private
+
+        def fetch_command_details(node)
+          node.call('COMMAND').to_h do |reply|
+            [reply[0], { arity: reply[1], flags: reply[2], first: reply[3], last: reply[4], step: reply[5] }]
+          end
+        end
+      end
+
+      def initialize(details)
+        @details = pick_details(details)
+      end
+
+      def extract_first_key(command)
+        i = determine_first_key_position(command)
+        return '' if i == 0
+
+        key = command[i].to_s
+        hash_tag = extract_hash_tag(key)
+        hash_tag.empty? ? key : hash_tag
+      end
+
+      def should_send_to_primary?(command)
+        dig_details(command, :write)
+      end
+
+      def should_send_to_replica?(command)
+        dig_details(command, :readonly)
+      end
+
+      private
+
+      def pick_details(details)
+        details.transform_values do |detail|
+          {
+            first_key_position: detail[:first],
+            write: detail[:flags].include?('write'),
+            readonly: detail[:flags].include?('readonly')
+          }
+        end
+      end
+
+      def dig_details(command, key)
+        name = command.first.to_s
+        return unless @details.key?(name)
+
+        @details.fetch(name).fetch(key)
+      end
+
+      def determine_first_key_position(command)
+        case command.first.to_s.downcase
+        when 'eval', 'evalsha', 'migrate', 'zinterstore', 'zunionstore' then 3
+        when 'object' then 2
+        when 'memory'
+          command[1].to_s.casecmp('usage').zero? ? 2 : 0
+        when 'xread', 'xreadgroup'
+          determine_optional_key_position(command, 'streams')
+        else
+          dig_details(command, :first_key_position).to_i
+        end
+      end
+
+      def determine_optional_key_position(command, option_name)
+        idx = command.map(&:to_s).map(&:downcase).index(option_name)
+        idx.nil? ? 0 : idx + 1
+      end
+
+      # @see https://redis.io/topics/cluster-spec#keys-hash-tags Keys hash tags
+      def extract_hash_tag(key)
+        s = key.index('{')
+        e = key.index('}', s.to_i + 1)
+
+        return '' if s.nil? || e.nil?
+
+        key[s + 1..e - 1]
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/errors.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'redis_client'
+
+class RedisClient
+  class Cluster
+    # Raised when client connected to redis as cluster mode
+    # and failed to fetch cluster state information by commands.
+    class InitialSetupError < ::RedisClient::Error
+      # @param errors [Array<Redis::BaseError>]
+      def initialize(errors)
+        super("Redis client could not fetch cluster information: #{errors.map(&:message).uniq.join(',')}")
+      end
+    end
+
+    # Raised when client connected to redis as cluster mode
+    # and some cluster subcommands were called.
+    class OrchestrationCommandNotSupported < ::RedisClient::Error
+      def initialize(command, subcommand = '')
+        str = [command, subcommand].map(&:to_s).reject(&:empty?).join(' ').upcase
+        msg = "#{str} command should be used with care "\
+              'only by applications orchestrating Redis Cluster, like redis-trib, '\
+              'and the command if used out of the right context can leave the cluster '\
+              'in a wrong state or cause data loss.'
+        super(msg)
+      end
+    end
+
+    # Raised when error occurs on any node of cluster.
+    class CommandErrorCollection < ::RedisClient::Error
+      attr_reader :errors
+
+      # @param errors [Hash{String => Redis::CommandError}]
+      # @param error_message [String]
+      def initialize(errors, error_message = 'Command errors were replied on any node')
+        @errors = errors
+        super(error_message)
+      end
+    end
+
+    # Raised when cluster client can't select node.
+    class AmbiguousNodeError < ::RedisClient::Error
+      def initialize(command)
+        super("Cluster client doesn't know which node the #{command} command should be sent to.")
+      end
+    end
+
+    # Raised when commands in pipelining include cross slot keys.
+    class CrossSlotPipeliningError < ::RedisClient::Error
+      def initialize(keys)
+        super("Cluster client couldn't send pipelining to single node. "\
+              "The commands include cross slot keys. #{keys}")
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/key_slot_converter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class RedisClient
+  class Cluster
+    module KeySlotConverter
+      XMODEM_CRC16_LOOKUP = [
+        0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
+        0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
+        0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
+        0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
+        0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
+        0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
+        0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
+        0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
+        0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
+        0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
+        0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
+        0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
+        0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
+        0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
+        0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
+        0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
+        0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
+        0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
+        0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
+        0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
+        0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
+        0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
+        0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
+        0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
+        0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
+        0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
+        0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
+        0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
+        0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
+        0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
+        0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
+        0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
+      ].freeze
+
+      HASH_SLOTS = 16_384
+
+      module_function
+
+      def convert(key)
+        crc = 0
+        key.each_byte do |b|
+          crc = ((crc << 8) & 0xffff) ^ XMODEM_CRC16_LOOKUP[((crc >> 8) ^ b) & 0xff]
+        end
+
+        crc % HASH_SLOTS
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/node.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require 'redis_client'
+require 'redis_client/cluster/errors'
+
+class RedisClient
+  class Cluster
+    class Node
+      include Enumerable
+
+      SLOT_SIZE = 16_384
+      ReloadNeeded = Class.new(::RedisClient::Error)
+
+      class << self
+        def load_info(options, **kwargs)
+          tmp_nodes = ::RedisClient::Cluster::Node.new(options, **kwargs)
+
+          errors = tmp_nodes.map do |tmp_node|
+            reply = tmp_node.call('CLUSTER', 'NODES')
+            return parse_node_info(reply)
+          rescue ::RedisClient::ConnectionError, ::RedisClient::CommandError => e
+            e
+          end
+
+          raise ::RedisClient::Cluster::InitialSetupError, errors
+        ensure
+          tmp_nodes&.each(&:close)
+        end
+
+        private
+
+        # @see https://redis.io/commands/cluster-nodes/
+        def parse_node_info(info) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+          rows = info.split("\n").map(&:split)
+          rows.each { |arr| arr[2] = arr[2].split(',') }
+          rows.select! { |arr| arr[7] == 'connected' && (arr[2] & %w[fail? fail handshake noaddr noflags]).empty? }
+          rows.each do |arr|
+            arr[1] = arr[1].split('@').first
+            arr[2] = (arr[2] & %w[master slave]).first
+            arr[8] = arr[8].nil? ? [] : arr[8].split(',').map { |r| r.split('-').map { |s| Integer(s) } }
+          end
+
+          rows.map do |arr|
+            { id: arr[0], node_key: arr[1], role: arr[2], primary_id: arr[3], ping_sent: arr[4],
+              pong_recv: arr[5], config_epoch: arr[6], link_state: arr[7], slots: arr[8] }
+          end
+        end
+      end
+
+      def initialize(options, node_info = [], pool = nil, with_replica: false, **kwargs)
+        @with_replica = with_replica
+        @slots = build_slot_node_mappings(node_info)
+        @replications = build_replication_mappings(node_info)
+        @clients = build_clients(options, pool, **kwargs)
+      end
+
+      def inspect
+        @clients.keys.sort.to_s
+      end
+
+      def each(&block)
+        @clients.values.each(&block)
+      end
+
+      def sample
+        @clients.values.sample
+      end
+
+      def find_by(node_key)
+        @clients.fetch(node_key)
+      rescue KeyError
+        raise ReloadNeeded
+      end
+
+      def call_all(method, *command, **kwargs, &block)
+        try_map { |_, client| client.send(method, *command, **kwargs, &block) }.values
+      end
+
+      def call_primary(method, *command, **kwargs, &block)
+        try_map do |node_key, client|
+          next if replica?(node_key)
+
+          client.send(method, *command, **kwargs, &block)
+        end.values
+      end
+
+      def call_replica(method, *command, **kwargs, &block)
+        return call_primary(method, *command, **kwargs, &block) if replica_disabled?
+
+        try_map do |node_key, client|
+          next if primary?(node_key)
+
+          client.send(method, *command, **kwargs, &block)
+        end.values
+      end
+
+      # TODO: impl
+      def process_all(commands, &block)
+        try_map { |_, client| client.process(commands, &block) }.values
+      end
+
+      def scale_reading_clients
+        reading_clients = []
+
+        @clients.each do |node_key, client|
+          next unless replica_disabled? ? primary?(node_key) : replica?(node_key)
+
+          reading_clients << client
+        end
+
+        reading_clients
+      end
+
+      def slot_exists?(slot)
+        !@slots[slot].nil?
+      end
+
+      def find_node_key_of_primary(slot)
+        @slots[slot]
+      end
+
+      def find_node_key_of_replica(slot)
+        return @slots[slot] if replica_disabled? || @replications[@slots[slot]].size.zero?
+
+        @replications[@slots[slot]].sample
+      end
+
+      def update_slot(slot, node_key)
+        @slots[slot] = node_key
+      end
+
+      private
+
+      def replica_disabled?
+        !@with_replica
+      end
+
+      def primary?(node_key)
+        !replica?(node_key)
+      end
+
+      def replica?(node_key)
+        !(@replications.nil? || @replications.size.zero?) && @replications[node_key].size.zero?
+      end
+
+      def build_clients(options, pool, **kwargs)
+        options.filter_map do |node_key, option|
+          next if replica_disabled? && replica?(node_key)
+
+          config = ::RedisClient.config(**option)
+          client = pool.nil? ? config.new_client(**kwargs) : config.new_pool(**pool, **kwargs)
+          client.call('READONLY') if replica?(node_key) # FIXME: Send every pooled conns
+
+          [node_key, client]
+        end.to_h
+      end
+
+      def build_slot_node_mappings(node_info)
+        slots = Array.new(SLOT_SIZE)
+        node_info.each do |info|
+          next if info[:slots].nil? || info[:slots].empty?
+
+          info[:slots].each { |start, last| (start..last).each { |i| slots[i] = info[:node_key] } }
+        end
+
+        slots
+      end
+
+      def build_replication_mappings(node_info)
+        dict = node_info.to_h { |info| [info[:id], info] }
+        node_info.each_with_object(Hash.new { |h, k| h[k] = [] }) do |info, acc|
+          primary_info = dict[info[:primary_id]]
+          acc[primary_info[:node_key]] << info[:node_key] unless primary_info.nil?
+          acc[info[:node_key]]
+        end
+      end
+
+      def try_map # rubocop:disable Metrics/MethodLength
+        errors = {}
+        results = {}
+
+        @clients.each do |node_key, client|
+          reply = yield(node_key, client)
+          results[node_key] = reply unless reply.nil?
+        rescue ::RedisClient::CommandError => e
+          errors[node_key] = e
+          next
+        end
+
+        return results if errors.empty?
+
+        raise ::RedisClient::Cluster::CommandErrorCollection, errors
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/node_key.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class RedisClient
+  class Cluster
+    # Node key's format is `<ip>:<port>`.
+    # It is different from node id.
+    # Node id is internal identifying code in Redis Cluster.
+    module NodeKey
+      DELIMITER = ':'
+
+      module_function
+
+      def hashify(node_key)
+        host, port = split(node_key)
+        { host: host, port: port }
+      end
+
+      def split(node_key)
+        node_key.split(DELIMITER)
+      end
+
+      def build_from_uri(uri)
+        "#{uri.host}#{DELIMITER}#{uri.port}"
+      end
+
+      def build_from_host_port(host, port)
+        "#{host}#{DELIMITER}#{port}"
+      end
+    end
+  end
+end

data/lib/redis_client/cluster.rb

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+require 'redis_client/cluster/command'
+require 'redis_client/cluster/errors'
+require 'redis_client/cluster/key_slot_converter'
+require 'redis_client/cluster/node'
+require 'redis_client/cluster/node_key'
+
+class RedisClient
+  class Cluster
+    def initialize(config, pool: nil, **kwargs)
+      @config = config.dup
+      @pool = pool
+      @client_kwargs = kwargs
+      @node = fetch_cluster_info!(@config, @pool, **@client_kwargs)
+      @command = ::RedisClient::Cluster::Command.load(@node)
+    end
+
+    def inspect
+      @node.inspect
+    end
+
+    def call(*command, **kwargs, &block)
+      send_command(:call, *command, **kwargs, &block)
+    end
+
+    def call_once(*command, **kwargs, &block)
+      send_command(:call_once, *command, **kwargs, &block)
+    end
+
+    def blocking_call(timeout, *command, **kwargs, &block)
+      node = assign_node(*command)
+      try_send(node, :blocking_call, timeout, *command, **kwargs, &block)
+    end
+
+    def scan(*args, **kwargs, &block)
+      _scan(:scan, *args, **kwargs, &block)
+    end
+
+    def sscan(key, *args, **kwargs, &block)
+      node = assign_node('SSCAN', key)
+      try_send(node, :sscan, key, *args, **kwargs, &block)
+    end
+
+    def hscan(key, *args, **kwargs, &block)
+      node = assign_node('HSCAN', key)
+      try_send(node, :hscan, key, *args, **kwargs, &block)
+    end
+
+    def zscan(key, *args, **kwargs, &block)
+      node = assign_node('ZSCAN', key)
+      try_send(node, :zscan, key, *args, **kwargs, &block)
+    end
+
+    def pipelined
+      # TODO: impl
+    end
+
+    def multi
+      # TODO: impl
+    end
+
+    def pubsub
+      # TODO: impl
+    end
+
+    def size
+      # TODO: impl
+    end
+
+    def with(options = {})
+      # TODO: impl
+    end
+    alias then with
+
+    def id
+      @node.flat_map(&:id).sort.join(' ')
+    end
+
+    def connected?
+      @node.any?(&:connected?)
+    end
+
+    def close
+      @node.each(&:close)
+      true
+    end
+
+    # TODO: remove
+    def call_pipeline(pipeline)
+      node_keys = pipeline.commands.filter_map { |cmd| find_node_key(cmd, primary_only: true) }.uniq
+      if node_keys.size > 1
+        raise(CrossSlotPipeliningError,
+              pipeline.commands.map { |cmd| @command.extract_first_key(cmd) }.reject(&:empty?).uniq)
+      end
+
+      try_send(find_node(node_keys.first), :call_pipeline, pipeline)
+    end
+
+    # TODO: remove
+    def process(commands, &block)
+      if commands.size == 1 &&
+         %w[unsubscribe punsubscribe].include?(commands.first.first.to_s.downcase) &&
+         commands.first.size == 1
+
+        # Node is indeterminate. We do just a best-effort try here.
+        @node.process_all(commands, &block)
+      else
+        node = assign_node(commands.first)
+        try_send(node, :process, commands, &block)
+      end
+    end
+
+    private
+
+    def fetch_cluster_info!(config, pool, **kwargs)
+      node_info = ::RedisClient::Cluster::Node.load_info(config.per_node_key, **kwargs)
+      node_addrs = node_info.map { |info| ::RedisClient::Cluster::NodeKey.hashify(info[:node_key]) }
+      config.update_node(node_addrs)
+      ::RedisClient::Cluster::Node.new(config.per_node_key, node_info, pool, with_replica: config.use_replica?, **kwargs)
+    end
+
+    def send_command(method, *command, **kwargs, &block) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      cmd = command.first.to_s.downcase
+      case cmd
+      when 'acl', 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
+        @node.call_all(method, *command, **kwargs, &block).first
+      when 'flushall', 'flushdb'
+        @node.call_primary(method, *command, **kwargs, &block).first
+      when 'wait'     then @node.call_primary(method, *command, **kwargs, &block).sum
+      when 'keys'     then @node.call_replica(method, *command, **kwargs, &block).flatten.sort
+      when 'dbsize'   then @node.call_replica(method, *command, **kwargs, &block).sum
+      when 'scan'     then _scan(method, *command, **kwargs, &block)
+      when 'lastsave' then @node.call_all(method, *command, **kwargs, &block).sort
+      when 'role'     then @node.call_all(method, *command, **kwargs, &block)
+      when 'config'   then send_config_command(method, *command, **kwargs, &block)
+      when 'client'   then send_client_command(method, *command, **kwargs, &block)
+      when 'cluster'  then send_cluster_command(method, *command, **kwargs, &block)
+      when 'readonly', 'readwrite', 'shutdown'
+        raise ::RedisClient::Cluster::OrchestrationCommandNotSupported, cmd
+      when 'memory'   then send_memory_command(method, *command, **kwargs, &block)
+      when 'script'   then send_script_command(method, *command, **kwargs, &block)
+      when 'pubsub'   then send_pubsub_command(method, *command, **kwargs, &block)
+      when 'discard', 'exec', 'multi', 'unwatch'
+        raise ::RedisClient::Cluster::AmbiguousNodeError, cmd
+      else
+        node = assign_node(*command)
+        try_send(node, method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_config_command(method, *command, **kwargs, &block)
+      case command[1].to_s.downcase
+      when 'resetstat', 'rewrite', 'set'
+        @node.call_all(method, *command, **kwargs, &block).first
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_memory_command(method, *command, **kwargs, &block)
+      case command[1].to_s.downcase
+      when 'stats' then @node.call_all(method, *command, **kwargs, &block)
+      when 'purge' then @node.call_all(method, *command, **kwargs, &block).first
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_client_command(method, *command, **kwargs, &block)
+      case command[1].to_s.downcase
+      when 'list' then @node.call_all(method, *command, **kwargs, &block).flatten
+      when 'pause', 'reply', 'setname'
+        @node.call_all(method, *command, **kwargs, &block).first
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_cluster_command(method, *command, **kwargs, &block)
+      subcommand = command[1].to_s.downcase
+      case subcommand
+      when 'addslots', 'delslots', 'failover', 'forget', 'meet', 'replicate',
+           'reset', 'set-config-epoch', 'setslot'
+        raise ::RedisClient::Cluster::OrchestrationCommandNotSupported, 'cluster', subcommand
+      when 'saveconfig' then @node.call_all(method, *command, **kwargs, &block).first
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_script_command(method, *command, **kwargs, &block)
+      case command[1].to_s.downcase
+      when 'debug', 'kill'
+        @node.call_all(method, *command, **kwargs, &block).first
+      when 'flush', 'load'
+        @node.call_primary(method, *command, **kwargs, &block).first
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    def send_pubsub_command(method, *command, **kwargs, &block) # rubocop:disable Metircs/AbcSize, Metrics/CyclomaticComplexity
+      case command[1].to_s.downcase
+      when 'channels' then @node.call_all(method, *command, **kwargs, &block).flatten.uniq.sort
+      when 'numsub'
+        @node.call_all(method, *command, **kwargs, &block).reject(&:empty?).map { |e| Hash[*e] }
+             .reduce({}) { |a, e| a.merge(e) { |_, v1, v2| v1 + v2 } }
+      when 'numpat' then @node.call_all(method, *command, **kwargs, &block).sum
+      else assign_node(*command).send(method, *command, **kwargs, &block)
+      end
+    end
+
+    # @see https://redis.io/topics/cluster-spec#redirection-and-resharding
+    #   Redirection and resharding
+    def try_send(node, method, *args, retry_count: 3, **kwargs, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      node.send(method, *args, **kwargs, &block)
+    rescue ::RedisClient::CommandError => e
+      if e.message.start_with?('MOVED')
+        raise if retry_count <= 0
+
+        node = assign_redirection_node(e.message)
+        retry_count -= 1
+        retry
+      elsif e.message.start_with?('ASK')
+        raise if retry_count <= 0
+
+        node = assign_asking_node(e.message)
+        node.call('ASKING')
+        retry_count -= 1
+        retry
+      else
+        raise
+      end
+    rescue ::RedisClient::ConnectionError
+      update_cluster_info!
+      raise
+    end
+
+    def _scan(method, *command, **kwargs, &block) # rubocop:disable Metrics/MethodLength
+      input_cursor = Integer(command[1])
+
+      client_index = input_cursor % 256
+      raw_cursor = input_cursor >> 8
+
+      clients = @node.scale_reading_clients
+
+      client = clients[client_index]
+      return ['0', []] unless client
+
+      command[1] = raw_cursor.to_s
+
+      result_cursor, result_keys = client.send(method, *command, **kwargs, &block)
+      result_cursor = Integer(result_cursor)
+
+      client_index += 1 if result_cursor == 0
+
+      [((result_cursor << 8) + client_index).to_s, result_keys]
+    end
+
+    def assign_redirection_node(err_msg)
+      _, slot, node_key = err_msg.split
+      slot = slot.to_i
+      @node.update_slot(slot, node_key)
+      find_node(node_key)
+    end
+
+    def assign_asking_node(err_msg)
+      _, _, node_key = err_msg.split
+      find_node(node_key)
+    end
+
+    def assign_node(*command)
+      node_key = find_node_key(command)
+      find_node(node_key)
+    end
+
+    def find_node_key(command, primary_only: false)
+      key = @command.extract_first_key(command)
+      return if key.empty?
+
+      slot = ::RedisClient::Cluster::KeySlotConverter.convert(key)
+      return unless @node.slot_exists?(slot)
+
+      if @command.should_send_to_primary?(command) || primary_only
+        @node.find_node_key_of_primary(slot)
+      else
+        @node.find_node_key_of_replica(slot)
+      end
+    end
+
+    def find_node(node_key)
+      return @node.sample if node_key.nil?
+
+      @node.find_by(node_key)
+    rescue ::RedisClient::Cluster::Node::ReloadNeeded
+      update_cluster_info!(node_key)
+      @node.find_by(node_key)
+    end
+
+    def update_cluster_info!(node_key = nil)
+      unless node_key.nil?
+        host, port = ::RedisClient::Cluster::NodeKey.split(node_key)
+        @config.add_node(host, port)
+      end
+
+      @node.each(&:close)
+      @node = fetch_cluster_info!(@config, @pool, **@client_kwargs)
+    end
+  end
+end

data/lib/redis_client/cluster_config.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'redis_client'
+require 'redis_client/config'
+require 'redis_client/cluster'
+require 'redis_client/cluster/node_key'
+
+class RedisClient
+  class ClusterConfig
+    include ::RedisClient::Config::Common
+
+    DEFAULT_SCHEME = 'redis'
+    SECURE_SCHEME = 'rediss'
+    VALID_SCHEMES = [DEFAULT_SCHEME, SECURE_SCHEME].freeze
+    InvalidClientConfigError = Class.new(::RedisClient::Error)
+
+    def initialize(nodes:, replica: false, fixed_hostname: nil, **client_config)
+      @replica = replica
+      @fixed_hostname = fixed_hostname
+      @client_config = client_config.dup
+      @node_configs = build_node_configs(nodes.dup)
+      add_common_node_config_if_needed(@client_config, @node_configs, :ssl)
+      add_common_node_config_if_needed(@client_config, @node_configs, :username)
+      add_common_node_config_if_needed(@client_config, @node_configs, :password)
+      super(**@client_config)
+    end
+
+    def inspect
+      per_node_key.to_s
+    end
+
+    def new_pool(size: 5, timeout: 5, **kwargs)
+      ::RedisClient::Cluster.new(self, pool: { size: size, timeout: timeout }, **kwargs)
+    end
+
+    def new_client(**kwargs)
+      ::RedisClient::Cluster.new(self, **kwargs)
+    end
+
+    def per_node_key
+      @node_configs.to_h do |config|
+        node_key = ::RedisClient::Cluster::NodeKey.build_from_host_port(config[:host], config[:port])
+        config = @client_config.merge(config)
+        config = config.merge(host: @fixed_hostname) if @fixed_hostname && !@fixed_hostname.empty?
+        [node_key, config]
+      end
+    end
+
+    def use_replica?
+      @replica
+    end
+
+    def update_node(addrs)
+      @node_configs = build_node_configs(addrs)
+    end
+
+    def add_node(host, port)
+      @node_configs << { host: host, port: port }
+    end
+
+    def dup
+      self.class.new(nodes: @node_configs, replica: @replica, fixed_hostname: @fixed_hostname, **@client_config)
+    end
+
+    private
+
+    def build_node_configs(addrs)
+      raise InvalidClientConfigError, 'Redis option of `cluster` must be an Array' unless addrs.is_a?(Array)
+
+      addrs.map { |addr| parse_node_addr(addr) }
+    end
+
+    def parse_node_addr(addr)
+      case addr
+      when String
+        parse_node_url(addr)
+      when Hash
+        parse_node_option(addr)
+      else
+        raise InvalidClientConfigError, 'Redis option of `cluster` must includes String or Hash'
+      end
+    end
+
+    def parse_node_url(addr) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      uri = URI(addr)
+      raise InvalidClientConfigError, "Invalid uri scheme #{addr}" unless VALID_SCHEMES.include?(uri.scheme)
+
+      db = uri.path.split('/')[1]&.to_i
+      username = uri.user ? URI.decode_www_form_component(uri.user) : nil
+      password = uri.password ? URI.decode_www_form_component(uri.password) : nil
+
+      {
+        host: uri.host,
+        port: uri.port,
+        username: username,
+        password: password,
+        db: db,
+        ssl: uri.scheme == SECURE_SCHEME
+      }.reject { |_, v| v.nil? || v == '' }
+    rescue URI::InvalidURIError => e
+      raise InvalidClientConfigError, e.message
+    end
+
+    def parse_node_option(addr)
+      addr = addr.transform_keys(&:to_sym)
+      raise InvalidClientConfigError, 'Redis option of `cluster` must includes `:host` and `:port` keys' if addr.values_at(:host, :port).any?(&:nil?)
+
+      addr
+    end
+
+    def add_common_node_config_if_needed(client_config, node_configs, key)
+      return client_config if client_config[key].nil? && node_configs.first[key].nil?
+
+      client_config[key] ||= node_configs.first[key]
+    end
+  end
+end

data/lib/redis_cluster_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'redis_client/cluster_config'
+
+class RedisClient
+  class << self
+    def cluster(**kwargs)
+      ClusterConfig.new(**kwargs)
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: redis-cluster-client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Taishi
+- Kasuga
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description:
+email:
+- proxy0721@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis_client/cluster.rb
+- lib/redis_client/cluster/command.rb
+- lib/redis_client/cluster/errors.rb
+- lib/redis_client/cluster/key_slot_converter.rb
+- lib/redis_client/cluster/node.rb
+- lib/redis_client/cluster/node_key.rb
+- lib/redis_client/cluster_config.rb
+- lib/redis_cluster_client.rb
+homepage: https://github.com/redis-rb/redis-cluster-client
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.13
+signing_key:
+specification_version: 4
+summary: A Redis cluster client for Ruby
+test_files: []