redis 3.3.5 → 4.7.0

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

data/lib/redis/cluster/node.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Keep client list of node for Redis Cluster Client
+    class Node
+      include Enumerable
+
+      ReloadNeeded = Class.new(StandardError)
+
+      ROLE_SLAVE = 'slave'
+
+      def initialize(options, node_flags = {}, with_replica = false)
+        @with_replica = with_replica
+        @node_flags = node_flags
+        @clients = build_clients(options)
+      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(command, &block)
+        try_map { |_, client| client.call(command, &block) }.values
+      end
+
+      def call_master(command, &block)
+        try_map do |node_key, client|
+          next if slave?(node_key)
+
+          client.call(command, &block)
+        end.values
+      end
+
+      def call_slave(command, &block)
+        return call_master(command, &block) if replica_disabled?
+
+        try_map do |node_key, client|
+          next if master?(node_key)
+
+          client.call(command, &block)
+        end.values
+      end
+
+      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? ? master?(node_key) : slave?(node_key)
+
+          reading_clients << client
+        end
+
+        reading_clients
+      end
+
+      private
+
+      def replica_disabled?
+        !@with_replica
+      end
+
+      def master?(node_key)
+        !slave?(node_key)
+      end
+
+      def slave?(node_key)
+        @node_flags[node_key] == ROLE_SLAVE
+      end
+
+      def build_clients(options)
+        clients = options.map do |node_key, option|
+          next if replica_disabled? && slave?(node_key)
+
+          option = option.merge(readonly: true) if slave?(node_key)
+
+          client = Client.new(option)
+          [node_key, client]
+        end
+
+        clients.compact.to_h
+      end
+
+      def try_map
+        errors = {}
+        results = {}
+
+        @clients.each do |node_key, client|
+          begin
+            reply = yield(node_key, client)
+            results[node_key] = reply unless reply.nil?
+          rescue CommandError => err
+            errors[node_key] = err
+            next
+          end
+        end
+
+        return results if errors.empty?
+
+        raise CommandErrorCollection, errors
+      end
+    end
+  end
+end

data/lib/redis/cluster/node_key.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Redis
+  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 optionize(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/cluster/node_loader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'redis/errors'
+
+class Redis
+  class Cluster
+    # Load and hashify node info for Redis Cluster Client
+    module NodeLoader
+      module_function
+
+      def load_flags(nodes)
+        errors = nodes.map do |node|
+          begin
+            return fetch_node_info(node)
+          rescue CannotConnectError, ConnectionError, CommandError => error
+            error
+          end
+        end
+
+        raise InitialSetupError, errors
+      end
+
+      def fetch_node_info(node)
+        node.call(%i[cluster nodes])
+            .split("\n")
+            .map { |str| str.split(' ') }
+            .map { |arr| [arr[1].split('@').first, (arr[2].split(',') & %w[master slave]).first] }
+            .to_h
+      end
+
+      private_class_method :fetch_node_info
+    end
+  end
+end

data/lib/redis/cluster/option.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+require_relative 'node_key'
+require 'uri'
+
+class Redis
+  class Cluster
+    # Keep options for Redis Cluster Client
+    class Option
+      DEFAULT_SCHEME = 'redis'
+      SECURE_SCHEME = 'rediss'
+      VALID_SCHEMES = [DEFAULT_SCHEME, SECURE_SCHEME].freeze
+
+      def initialize(options)
+        options = options.dup
+        node_addrs = options.delete(:cluster)
+        @node_opts = build_node_options(node_addrs)
+        @replica = options.delete(:replica) == true
+        @fixed_hostname = options.delete(:fixed_hostname)
+        add_common_node_option_if_needed(options, @node_opts, :scheme)
+        add_common_node_option_if_needed(options, @node_opts, :username)
+        add_common_node_option_if_needed(options, @node_opts, :password)
+        @options = options
+      end
+
+      def per_node_key
+        @node_opts.map do |opt|
+          node_key = NodeKey.build_from_host_port(opt[:host], opt[:port])
+          options = @options.merge(opt)
+          options = options.merge(host: @fixed_hostname) if @fixed_hostname && !@fixed_hostname.empty?
+          [node_key, options]
+        end.to_h
+      end
+
+      def use_replica?
+        @replica
+      end
+
+      def update_node(addrs)
+        @node_opts = build_node_options(addrs)
+      end
+
+      def add_node(host, port)
+        @node_opts << { host: host, port: port }
+      end
+
+      private
+
+      def build_node_options(addrs)
+        raise InvalidClientOptionError, '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 InvalidClientOptionError, 'Redis option of `cluster` must includes String or Hash'
+        end
+      end
+
+      def parse_node_url(addr)
+        uri = URI(addr)
+        raise InvalidClientOptionError, "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
+
+        { scheme: uri.scheme, username: username, password: password, host: uri.host, port: uri.port, db: db }
+          .reject { |_, v| v.nil? || v == '' }
+      rescue URI::InvalidURIError => err
+        raise InvalidClientOptionError, err.message
+      end
+
+      def parse_node_option(addr)
+        addr = addr.map { |k, v| [k.to_sym, v] }.to_h
+        if addr.values_at(:host, :port).any?(&:nil?)
+          raise InvalidClientOptionError, 'Redis option of `cluster` must includes `:host` and `:port` keys'
+        end
+
+        addr
+      end
+
+      # Redis cluster node returns only host and port information.
+      # So we should complement additional information such as:
+      #   scheme, username, password and so on.
+      def add_common_node_option_if_needed(options, node_opts, key)
+        return options if options[key].nil? && node_opts.first[key].nil?
+
+        options[key] ||= node_opts.first[key]
+      end
+    end
+  end
+end

data/lib/redis/cluster/slot.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+class Redis
+  class Cluster
+    # Keep slot and node key map for Redis Cluster Client
+    class Slot
+      ROLE_SLAVE = 'slave'
+
+      def initialize(available_slots, node_flags = {}, with_replica = false)
+        @with_replica = with_replica
+        @node_flags = node_flags
+        @map = build_slot_node_key_map(available_slots)
+      end
+
+      def exists?(slot)
+        @map.key?(slot)
+      end
+
+      def find_node_key_of_master(slot)
+        return nil unless exists?(slot)
+
+        @map[slot][:master]
+      end
+
+      def find_node_key_of_slave(slot)
+        return nil unless exists?(slot)
+        return find_node_key_of_master(slot) if replica_disabled?
+
+        @map[slot][:slaves].sample
+      end
+
+      def put(slot, node_key)
+        # Since we're sharing a hash for build_slot_node_key_map, duplicate it
+        # if it already exists instead of preserving as-is.
+        @map[slot] = @map[slot] ? @map[slot].dup : { master: nil, slaves: [] }
+
+        if master?(node_key)
+          @map[slot][:master] = node_key
+        elsif !@map[slot][:slaves].include?(node_key)
+          @map[slot][:slaves] << node_key
+        end
+
+        nil
+      end
+
+      private
+
+      def replica_disabled?
+        !@with_replica
+      end
+
+      def master?(node_key)
+        !slave?(node_key)
+      end
+
+      def slave?(node_key)
+        @node_flags[node_key] == ROLE_SLAVE
+      end
+
+      # available_slots is mapping of node_key to list of slot ranges
+      def build_slot_node_key_map(available_slots)
+        by_ranges = {}
+        available_slots.each do |node_key, slots_arr|
+          by_ranges[slots_arr] ||= { master: nil, slaves: [] }
+
+          if master?(node_key)
+            by_ranges[slots_arr][:master] = node_key
+          elsif !by_ranges[slots_arr][:slaves].include?(node_key)
+            by_ranges[slots_arr][:slaves] << node_key
+          end
+        end
+
+        by_slot = {}
+        by_ranges.each do |slots_arr, nodes|
+          slots_arr.each do |slots|
+            slots.each do |slot|
+              by_slot[slot] = nodes
+            end
+          end
+        end
+
+        by_slot
+      end
+    end
+  end
+end

data/lib/redis/cluster/slot_loader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'redis/errors'
+require 'redis/cluster/node_key'
+
+class Redis
+  class Cluster
+    # Load and hashify slot info for Redis Cluster Client
+    module SlotLoader
+      module_function
+
+      def load(nodes)
+        errors = nodes.map do |node|
+          begin
+            return fetch_slot_info(node)
+          rescue CannotConnectError, ConnectionError, CommandError => error
+            error
+          end
+        end
+
+        raise InitialSetupError, errors
+      end
+
+      def fetch_slot_info(node)
+        hash_with_default_arr = Hash.new { |h, k| h[k] = [] }
+        node.call(%i[cluster slots])
+            .flat_map { |arr| parse_slot_info(arr, default_ip: node.host) }
+            .each_with_object(hash_with_default_arr) { |arr, h| h[arr[0]] << arr[1] }
+      end
+
+      def parse_slot_info(arr, default_ip:)
+        first_slot, last_slot = arr[0..1]
+        slot_range = (first_slot..last_slot).freeze
+        arr[2..-1].map { |addr| [stringify_node_key(addr, default_ip), slot_range] }
+      end
+
+      def stringify_node_key(arr, default_ip)
+        ip, port = arr
+        ip = default_ip if ip.empty? # When cluster is down
+        NodeKey.build_from_host_port(ip, port)
+      end
+
+      private_class_method :fetch_slot_info, :parse_slot_info, :stringify_node_key
+    end
+  end
+end