redis 4.0.1 → 4.0.3

data/lib/redis/client.rb

@@ -18,6 +18,8 @@ class Redis
       :id => nil,
       :tcp_keepalive => 0,
       :reconnect_attempts => 1,
+      :reconnect_delay => 0,
+      :reconnect_delay_max => 0.5,
       :inherit_socket => false
     }
 
@@ -84,11 +86,14 @@ class Redis
 
       @pending_reads = 0
 
-      if options.include?(:sentinels)
-        @connector = Connector::Sentinel.new(@options)
-      else
-        @connector = Connector.new(@options)
-      end
+      @connector =
+        if options.include?(:sentinels)
+          Connector::Sentinel.new(@options)
+        elsif options.include?(:connector) && options[:connector].respond_to?(:new)
+          options.delete(:connector).new(@options)
+        else
+          Connector.new(@options)
+        end
     end
 
     def connect
@@ -150,9 +155,12 @@ class Redis
     end
 
     def call_pipeline(pipeline)
+      commands = pipeline.commands
+      return [] if commands.empty?
+
       with_reconnect pipeline.with_reconnect? do
         begin
-          pipeline.finish(call_pipelined(pipeline.commands)).tap do
+          pipeline.finish(call_pipelined(commands)).tap do
             self.db = pipeline.db if pipeline.db
           end
         rescue ConnectionError => e
@@ -183,13 +191,10 @@ class Redis
         exception = nil
 
         process(commands) do
-          result[0] = read
-
-          @reconnect = false
-
-          (commands.size - 1).times do |i|
+          commands.size.times do |i|
             reply = read
-            result[i + 1] = reply
+            result[i] = reply
+            @reconnect = false
             exception = reply if exception.nil? && reply.is_a?(CommandError)
           end
         end
@@ -334,6 +339,7 @@ class Redis
       @connection = @options[:driver].connect(@options)
       @pending_reads = 0
     rescue TimeoutError,
+           SocketError,
            Errno::ECONNREFUSED,
            Errno::EHOSTDOWN,
            Errno::EHOSTUNREACH,
@@ -368,6 +374,10 @@ class Redis
         disconnect
 
         if attempts <= @options[:reconnect_attempts] && @reconnect
+          sleep_t = [(@options[:reconnect_delay] * 2**(attempts-1)),
+                     @options[:reconnect_delay_max]].min
+
+          Kernel.sleep(sleep_t)
           retry
         else
           raise
@@ -444,6 +454,10 @@ class Redis
       options[:read_timeout]    = Float(options[:read_timeout])
       options[:write_timeout]   = Float(options[:write_timeout])
 
+      options[:reconnect_attempts] = options[:reconnect_attempts].to_i
+      options[:reconnect_delay] = options[:reconnect_delay].to_f
+      options[:reconnect_delay_max] = options[:reconnect_delay_max].to_f
+
       options[:db] = options[:db].to_i
       options[:driver] = _parse_driver(options[:driver]) || Connection.drivers.last
 

data/lib/redis/cluster.rb

@@ -0,0 +1,285 @@
+# 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)
+      available_node_urls = NodeKey.to_node_urls(available_slots.keys, secure: option.secure?)
+      option.update_node(available_node_urls)
+      [Node.new(option.per_node_key, node_flags, option.use_replica?),
+       Slot.new(available_slots, node_flags, option.use_replica?)]
+    ensure
+      node.map(&: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 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
+        @node.call_all(command, &block).first
+      when 'flushall', 'flushdb'
+        @node.call_master(command, &block).first
+      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')
+        assign_redirection_node(err.message).public_send(method_name, *args, &block)
+      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
+    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