redis 3.3.5 → 4.5.1

data/lib/redis/cluster/node.rb

@@ -0,0 +1,108 @@
+# 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
+
+      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,37 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Load and hashify node info for Redis Cluster Client
+    module NodeLoader
+      module_function
+
+      def load_flags(nodes)
+        info = {}
+
+        nodes.each do |node|
+          info = fetch_node_info(node)
+          info.empty? ? next : break
+        end
+
+        return info unless info.empty?
+
+        raise CannotConnectError, 'Redis client could not connect to any cluster nodes'
+      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
+      rescue CannotConnectError, ConnectionError, CommandError
+        {} # can retry on another node
+      end
+
+      private_class_method :fetch_node_info
+    end
+  end
+end

data/lib/redis/cluster/option.rb

@@ -0,0 +1,93 @@
+# 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
+        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 { |opt| [NodeKey.build_from_host_port(opt[:host], opt[:port]), @options.merge(opt)] }
+                  .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
+
+        { scheme: uri.scheme, username: uri.user, password: uri.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,49 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+require_relative 'node_key'
+
+class Redis
+  class Cluster
+    # Load and hashify slot info for Redis Cluster Client
+    module SlotLoader
+      module_function
+
+      def load(nodes)
+        info = {}
+
+        nodes.each do |node|
+          info = fetch_slot_info(node)
+          info.empty? ? next : break
+        end
+
+        return info unless info.empty?
+
+        raise CannotConnectError, 'Redis client could not connect to any cluster nodes'
+      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] }
+      rescue CannotConnectError, ConnectionError, CommandError
+        {} # can retry on another node
+      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

data/lib/redis/cluster.rb

@@ -0,0 +1,291 @@
+# 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 = pipeline.commands.map { |cmd| find_node_key(cmd, primary_only: true) }.compact.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
+
+    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, primary_only: false)
+      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) || primary_only
+        @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
+  end
+end