redis 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8fe8cb80ceaefd35f21b3ae06bdfa7594a1878a
-  data.tar.gz: ec9c330b13ac9639b6033c96b9e92da659eede4e
+  metadata.gz: 1ec178932a6874e8ac7a4f6cfa4390c8223367ec
+  data.tar.gz: 986e6c5d1729b9ec8f7d66900e5d9ad9437e29f9
 SHA512:
-  metadata.gz: 215cf01a2c7987aafb818959f1dd70688099b48f51fbc55d0bacc2ebddc27d45f7a60aca57e412a80f94dc6d9316312fa29be1e1077092a92657bd75103cae2a
-  data.tar.gz: f26724045477ec4d5d5351611266489c13f778fe2eed7ace4824f37dcadfc378a69271abe22166fc2da16da0ac0b5236448828d36a0c44146a22dfe0d886045e
+  metadata.gz: 14db8cb42f08014ebd942c39b5f119a68a8ec50fec046572bb3afc7708634589311b9bea0d4153bfd1d7cb1c46a94a00d77613872b2cb8c10c33f132755cd62d
+  data.tar.gz: efe0db683450fcb30b6d23b8c9448d6925b5c5d95b847f9563405a61cc7e667bbf8aea22642dcc9d8a1b716dc9c8cb55c562c86a08223e020991f69eff7df7f7

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 /tmp/
 /.idea
 /.yardoc
+/.bundle
 /coverage/*
 /doc/
 /examples/sentinel/sentinel.conf
@@ -14,3 +15,5 @@ Gemfile.lock
 /redis/*
 /test/db
 /test/test.conf
+appendonly.aof
+temp-rewriteaof-*.aof

data/.travis.yml

@@ -6,7 +6,7 @@ before_install:
   - gem update --system 2.6.14
   - gem --version
 
-script: make test
+script: make
 
 rvm:
   - 2.2.2
@@ -25,7 +25,7 @@ before_script:
 env:
   global:
     - VERBOSE=true
-    - TIMEOUT=1
+    - TIMEOUT=9
   matrix:
     - DRIVER=ruby      REDIS_BRANCH=3.0
     - DRIVER=ruby      REDIS_BRANCH=3.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 4.0.3
+
+* Fix raising command error for first command in pipeline. See #788.
+* Fix the gemspec to stop exposing a `build` executable. See #785.
+* Add `:reconnect_delay` and `:reconnect_delay_max` options. See #778.
+
 # 4.0.2
 
 * Added `Redis#unlink`. See #766.

data/lib/redis.rb

@@ -31,11 +31,16 @@ class Redis
   # @option options [Boolean] :inherit_socket (false) Whether to use socket in forked process or not
   # @option options [Array] :sentinels List of sentinels to contact
   # @option options [Symbol] :role (:master) Role to fetch via Sentinel, either `:master` or `:slave`
+  # @option options [Array<String, Hash{Symbol => String, Integer}>] :cluster List of cluster nodes to contact
+  # @option options [Boolean] :replica Whether to use readonly replica nodes in Redis Cluster or not
+  # @option options [Class] :connector Class of custom connector
   #
   # @return [Redis] a new client instance
   def initialize(options = {})
     @options = options.dup
-    @original_client = @client = Client.new(options)
+    @cluster_mode = options.key?(:cluster)
+    client = @cluster_mode ? Cluster : Client
+    @original_client = @client = client.new(options)
     @queue = Hash.new { |h, k| h[k] = [] }
 
     super() # Monitor#initialize
@@ -273,9 +278,7 @@ class Redis
     synchronize do |client|
       client.call([:info, cmd].compact) do |reply|
         if reply.kind_of?(String)
-          reply = Hash[reply.split("\r\n").map do |line|
-            line.split(":", 2) unless line =~ /^(#|$)/
-          end.compact]
+          reply = HashifyInfo.call(reply)
 
           if cmd && cmd.to_s == "commandstats"
             # Extract nested hashes for INFO COMMANDSTATS
@@ -2827,6 +2830,41 @@ class Redis
     end
   end
 
+  # Sends `CLUSTER *` command to random node and returns its reply.
+  #
+  # @see https://redis.io/commands#cluster Reference of cluster command
+  #
+  # @param subcommand [String, Symbol] the subcommand of cluster command
+  #   e.g. `:slots`, `:nodes`, `:slaves`, `:info`
+  #
+  # @return [Object] depends on the subcommand
+  def cluster(subcommand, *args)
+    subcommand = subcommand.to_s.downcase
+    block = case subcommand
+            when 'slots'  then HashifyClusterSlots
+            when 'nodes'  then HashifyClusterNodes
+            when 'slaves' then HashifyClusterSlaves
+            when 'info'   then HashifyInfo
+            else Noop
+            end
+
+    # @see https://github.com/antirez/redis/blob/unstable/src/redis-trib.rb#L127 raw reply expected
+    block = Noop unless @cluster_mode
+
+    synchronize do |client|
+      client.call([:cluster, subcommand] + args, &block)
+    end
+  end
+
+  # Sends `ASKING` command to random node and returns its reply.
+  #
+  # @see https://redis.io/topics/cluster-spec#ask-redirection ASK redirection
+  #
+  # @return [String] `'OK'`
+  def asking
+    synchronize { |client| client.call(%i[asking]) }
+  end
+
   def id
     @original_client.id
   end
@@ -2840,6 +2878,8 @@ class Redis
   end
 
   def connection
+    return @original_client.connection_info if @cluster_mode
+
     {
       host:     @original_client.host,
       port:     @original_client.port,
@@ -2896,15 +2936,61 @@ private
 
   FloatifyPairs =
     lambda { |result|
-      if result.respond_to?(:each_slice)
-        result.each_slice(2).map do |member, score|
-          [member, Floatify.call(score)]
-        end
-      else
-        result
+      result.each_slice(2).map do |member, score|
+        [member, Floatify.call(score)]
+      end
+    }
+
+  HashifyInfo =
+    lambda { |reply|
+      Hash[reply.split("\r\n").map do |line|
+        line.split(':', 2) unless line =~ /^(#|$)/
+      end.compact]
+    }
+
+  HashifyClusterNodeInfo =
+    lambda { |str|
+      arr = str.split(' ')
+      {
+        'node_id'        => arr[0],
+        'ip_port'        => arr[1],
+        'flags'          => arr[2].split(','),
+        'master_node_id' => arr[3],
+        'ping_sent'      => arr[4],
+        'pong_recv'      => arr[5],
+        'config_epoch'   => arr[6],
+        'link_state'     => arr[7],
+        'slots'          => arr[8].nil? ? nil : Range.new(*arr[8].split('-'))
+      }
+    }
+
+  HashifyClusterSlots =
+    lambda { |reply|
+      reply.map do |arr|
+        first_slot, last_slot = arr[0..1]
+        master = { 'ip' => arr[2][0], 'port' => arr[2][1], 'node_id' => arr[2][2] }
+        replicas = arr[3..-1].map { |r| { 'ip' => r[0], 'port' => r[1], 'node_id' => r[2] } }
+        {
+          'start_slot' => first_slot,
+          'end_slot'   => last_slot,
+          'master'     => master,
+          'replicas'   => replicas
+        }
       end
     }
 
+  HashifyClusterNodes =
+    lambda { |reply|
+      reply.split(/[\r\n]+/).map { |str| HashifyClusterNodeInfo.call(str) }
+    }
+
+  HashifyClusterSlaves =
+    lambda { |reply|
+      reply.map { |str| HashifyClusterNodeInfo.call(str) }
+    }
+
+  Noop = ->(reply) { reply }
+
   def _geoarguments(*args, options: nil, sort: nil, count: nil)
     args.push sort if sort
     args.push 'count', count if count
@@ -2927,11 +3013,11 @@ private
       @client = original
     end
   end
-
 end
 
 require_relative "redis/version"
 require_relative "redis/connection"
 require_relative "redis/client"
+require_relative "redis/cluster"
 require_relative "redis/pipeline"
 require_relative "redis/subscribe"

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
@@ -186,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
@@ -372,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
@@ -449,6 +455,8 @@ class Redis
       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