redis 3.3.5 → 4.3.1

data/lib/redis/cluster.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+require_relative 'errors'
+require_relative 'client'
+require_relative 'cluster/command'
+require_relative 'cluster/command_loader'
+require_relative 'cluster/key_slot_converter'
+require_relative 'cluster/node'
+require_relative 'cluster/node_key'
+require_relative 'cluster/node_loader'
+require_relative 'cluster/option'
+require_relative 'cluster/slot'
+require_relative 'cluster/slot_loader'
+
+class Redis
+  # Redis Cluster client
+  #
+  # @see https://github.com/antirez/redis-rb-cluster POC implementation
+  # @see https://redis.io/topics/cluster-spec Redis Cluster specification
+  # @see https://redis.io/topics/cluster-tutorial Redis Cluster tutorial
+  #
+  # Copyright (C) 2013 Salvatore Sanfilippo <antirez@gmail.com>
+  class Cluster
+    def initialize(options = {})
+      @option = Option.new(options)
+      @node, @slot = fetch_cluster_info!(@option)
+      @command = fetch_command_details(@node)
+    end
+
+    def id
+      @node.map(&:id).sort.join(' ')
+    end
+
+    # db feature is disabled in cluster mode
+    def db
+      0
+    end
+
+    # db feature is disabled in cluster mode
+    def db=(_db); end
+
+    def timeout
+      @node.first.timeout
+    end
+
+    def connected?
+      @node.any?(&:connected?)
+    end
+
+    def disconnect
+      @node.each(&:disconnect)
+      true
+    end
+
+    def connection_info
+      @node.sort_by(&:id).map do |client|
+        {
+          host: client.host,
+          port: client.port,
+          db: client.db,
+          id: client.id,
+          location: client.location
+        }
+      end
+    end
+
+    def with_reconnect(val = true, &block)
+      try_send(@node.sample, :with_reconnect, val, &block)
+    end
+
+    def call(command, &block)
+      send_command(command, &block)
+    end
+
+    def call_loop(command, timeout = 0, &block)
+      node = assign_node(command)
+      try_send(node, :call_loop, command, timeout, &block)
+    end
+
+    def call_pipeline(pipeline)
+      node_keys, command_keys = extract_keys_in_pipeline(pipeline)
+      raise CrossSlotPipeliningError, command_keys if node_keys.size > 1
+
+      node = find_node(node_keys.first)
+      try_send(node, :call_pipeline, pipeline)
+    end
+
+    def call_with_timeout(command, timeout, &block)
+      node = assign_node(command)
+      try_send(node, :call_with_timeout, command, timeout, &block)
+    end
+
+    def call_without_timeout(command, &block)
+      call_with_timeout(command, 0, &block)
+    end
+
+    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!(option)
+      node = Node.new(option.per_node_key)
+      available_slots = SlotLoader.load(node)
+      node_flags = NodeLoader.load_flags(node)
+      option.update_node(available_slots.keys.map { |k| NodeKey.optionize(k) })
+      [Node.new(option.per_node_key, node_flags, option.use_replica?),
+       Slot.new(available_slots, node_flags, option.use_replica?)]
+    ensure
+      node&.each(&:disconnect)
+    end
+
+    def fetch_command_details(nodes)
+      details = CommandLoader.load(nodes)
+      Command.new(details)
+    end
+
+    def send_command(command, &block)
+      cmd = command.first.to_s.downcase
+      case cmd
+      when 'acl', 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
+        @node.call_all(command, &block).first
+      when 'flushall', 'flushdb'
+        @node.call_master(command, &block).first
+      when 'wait'     then @node.call_master(command, &block).reduce(:+)
+      when 'keys'     then @node.call_slave(command, &block).flatten.sort
+      when 'dbsize'   then @node.call_slave(command, &block).reduce(:+)
+      when 'lastsave' then @node.call_all(command, &block).sort
+      when 'role'     then @node.call_all(command, &block)
+      when 'config'   then send_config_command(command, &block)
+      when 'client'   then send_client_command(command, &block)
+      when 'cluster'  then send_cluster_command(command, &block)
+      when 'readonly', 'readwrite', 'shutdown'
+        raise OrchestrationCommandNotSupported, cmd
+      when 'memory'   then send_memory_command(command, &block)
+      when 'script'   then send_script_command(command, &block)
+      when 'pubsub'   then send_pubsub_command(command, &block)
+      when 'discard', 'exec', 'multi', 'unwatch'
+        raise AmbiguousNodeError, cmd
+      else
+        node = assign_node(command)
+        try_send(node, :call, command, &block)
+      end
+    end
+
+    def send_config_command(command, &block)
+      case command[1].to_s.downcase
+      when 'resetstat', 'rewrite', 'set'
+        @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_memory_command(command, &block)
+      case command[1].to_s.downcase
+      when 'stats' then @node.call_all(command, &block)
+      when 'purge' then @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_client_command(command, &block)
+      case command[1].to_s.downcase
+      when 'list' then @node.call_all(command, &block).flatten
+      when 'pause', 'reply', 'setname'
+        @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_cluster_command(command, &block)
+      subcommand = command[1].to_s.downcase
+      case subcommand
+      when 'addslots', 'delslots', 'failover', 'forget', 'meet', 'replicate',
+           'reset', 'set-config-epoch', 'setslot'
+        raise OrchestrationCommandNotSupported, 'cluster', subcommand
+      when 'saveconfig' then @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_script_command(command, &block)
+      case command[1].to_s.downcase
+      when 'debug', 'kill'
+        @node.call_all(command, &block).first
+      when 'flush', 'load'
+        @node.call_master(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_pubsub_command(command, &block)
+      case command[1].to_s.downcase
+      when 'channels' then @node.call_all(command, &block).flatten.uniq.sort
+      when 'numsub'
+        @node.call_all(command, &block).reject(&:empty?).map { |e| Hash[*e] }
+             .reduce({}) { |a, e| a.merge(e) { |_, v1, v2| v1 + v2 } }
+      when 'numpat' then @node.call_all(command, &block).reduce(:+)
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    # @see https://redis.io/topics/cluster-spec#redirection-and-resharding
+    #   Redirection and resharding
+    def try_send(node, method_name, *args, retry_count: 3, &block)
+      node.public_send(method_name, *args, &block)
+    rescue CommandError => err
+      if err.message.start_with?('MOVED')
+        raise if retry_count <= 0
+
+        node = assign_redirection_node(err.message)
+        retry_count -= 1
+        retry
+      elsif err.message.start_with?('ASK')
+        raise if retry_count <= 0
+
+        node = assign_asking_node(err.message)
+        node.call(%i[asking])
+        retry_count -= 1
+        retry
+      else
+        raise
+      end
+    rescue CannotConnectError
+      update_cluster_info!
+      raise
+    end
+
+    def assign_redirection_node(err_msg)
+      _, slot, node_key = err_msg.split(' ')
+      slot = slot.to_i
+      @slot.put(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)
+      key = @command.extract_first_key(command)
+      return if key.empty?
+
+      slot = KeySlotConverter.convert(key)
+      return unless @slot.exists?(slot)
+
+      if @command.should_send_to_master?(command)
+        @slot.find_node_key_of_master(slot)
+      else
+        @slot.find_node_key_of_slave(slot)
+      end
+    end
+
+    def find_node(node_key)
+      return @node.sample if node_key.nil?
+
+      @node.find_by(node_key)
+    rescue 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 = NodeKey.split(node_key)
+        @option.add_node(host, port)
+      end
+
+      @node.map(&:disconnect)
+      @node, @slot = fetch_cluster_info!(@option)
+    end
+
+    def extract_keys_in_pipeline(pipeline)
+      node_keys = pipeline.commands.map { |cmd| find_node_key(cmd) }.compact.uniq
+      command_keys = pipeline.commands.map { |cmd| @command.extract_first_key(cmd) }.reject(&:empty?)
+      [node_keys, command_keys]
+    end
+  end
+end

data/lib/redis/cluster/command.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Keep details about Redis commands for Redis Cluster Client.
+    # @see https://redis.io/commands/command
+    class Command
+      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_master?(command)
+        dig_details(command, :write)
+      end
+
+      def should_send_to_slave?(command)
+        dig_details(command, :readonly)
+      end
+
+      private
+
+      def pick_details(details)
+        details.map do |command, detail|
+          [command, {
+            first_key_position: detail[:first],
+            write: detail[:flags].include?('write'),
+            readonly: detail[:flags].include?('readonly')
+          }]
+        end.to_h
+      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 'scan', 'sscan', 'hscan', 'zscan'
+          determine_optional_key_position(command, 'match')
+        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/cluster/command_loader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Load details about Redis commands for Redis Cluster Client
+    # @see https://redis.io/commands/command
+    module CommandLoader
+      module_function
+
+      def load(nodes)
+        details = {}
+
+        nodes.each do |node|
+          details = fetch_command_details(node)
+          details.empty? ? next : break
+        end
+
+        details
+      end
+
+      def fetch_command_details(node)
+        node.call(%i[command]).map do |reply|
+          [reply[0], { arity: reply[1], flags: reply[2], first: reply[3], last: reply[4], step: reply[5] }]
+        end.to_h
+      rescue CannotConnectError, ConnectionError, CommandError
+        {} # can retry on another node
+      end
+
+      private_class_method :fetch_command_details
+    end
+  end
+end

data/lib/redis/cluster/key_slot_converter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class Redis
+  class Cluster
+    # Key to slot converter for Redis Cluster Client
+    #
+    # We can test it by `CLUSTER KEYSLOT` command.
+    #
+    # @see https://github.com/antirez/redis-rb-cluster
+    #   Reference implementation in Ruby
+    # @see https://redis.io/topics/cluster-spec#appendix
+    #   Reference implementation in ANSI C
+    # @see https://redis.io/commands/cluster-keyslot
+    #   CLUSTER KEYSLOT command reference
+    #
+    # Copyright (C) 2013 Salvatore Sanfilippo <antirez@gmail.com>
+    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
+
+      # Convert key into slot.
+      #
+      # @param key [String] the key of the redis command
+      #
+      # @return [Integer] slot number
+      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