redis 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e0d0ba2328aca583c0f487729779c2b10b12c7b
-  data.tar.gz: 4a411cfa3512bafe7c2c12ac8a02c02bc87065aa
+  metadata.gz: fb5e8fcd26f9729131009cc0c25bed4cdf1009f5
+  data.tar.gz: 9ed7be2cc83d01dcb6c69002680105dc544e659a
 SHA512:
-  metadata.gz: 3af7dc63dc7bdc243da306817583db9b6989c21a0714c6652b4a443bfd9c46b2afba0707b028d708a74148bbeedd09d4ec207a0459b3559cb19b95f2f030bb07
-  data.tar.gz: 98d5aed456ebcd3ccdc50980879a3c14be4c8a1874c6febae95579d2fb3828bda2e82b05e62dc6a4966e178993d4a2a20dc3dedd9f8583cd731851eab2f8e164
+  metadata.gz: b39badbb4689a4ea93cbc65ad00f0c967f24dadcc41e7750ab82977176236d6d8609d8e7b74e13a3829ce008c4a5de90930e265f6b6e03af710811419da6ccf6
+  data.tar.gz: 3ede92146cb181328657a4713e94473f86661dffe0a66d23f48edaa2c7a6c52543a7e7036794baa9dcc2945bc3f9e5eebd9192b70510bda1ad9c0d6e67253830

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+# Unreleased
+
+# 4.1.0
+
+* Add Redis Cluster support. See #716.
+* Add streams support. See #799 and #811.
+* Add ZPOP* support. See #812.
+* Fix issues with integer-like objects as BPOP timeout
+
+# 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.
+
+* `Redis.new` now accept a custom connector via `:connector`. See #591.
+
+* `Redis#multi` no longer perform empty transactions. See #747.
+
+* `Redis#hdel` now accepts hash keys as multiple arguments like `#del`. See #755.
+
+* Allow to skip SSL verification. See #745.
+
+* Add Geo commands: `geoadd`, `geohash`, `georadius`, `georadiusbymember`, `geopos`, `geodist`. See #730.
+
 # 4.0.1
 
 * `Redis::Distributed` now supports `mget` and `mapped_mget`. See #687.
@@ -21,6 +50,15 @@
 
 * Dropped official support for Ruby < 2.2.2.
 
+# 3.3.5
+
+* Fixed Ruby 1.8 compatibility after backporting `Redis#connection`. See #719.
+
+# 3.3.4 (yanked)
+
+* `Redis#connection` returns a hash with connection information.
+  You shouldn't need to call `Redis#_client`, ever.
+
 # 3.3.3
 
 * Improved timeout handling after dropping Timeout module.

data/README.md

@@ -176,7 +176,7 @@ it can't connect to the server a `Redis::CannotConnectError` error will be raise
 ```ruby
 begin
   redis.ping
-rescue Exception => e
+rescue StandardError => e
   e.inspect
 # => #<Redis::CannotConnectError: Timed out connecting to Redis on 10.0.1.1:6380>
 
@@ -220,6 +220,51 @@ end
 
 If no message is received after 5 seconds, the client will unsubscribe.
 
+## Reconnections
+
+The client allows you to configure how many `reconnect_attempts` it should
+complete before declaring a connection as failed. Furthermore, you may want
+to control the maximum duration between reconnection attempts with
+`reconnect_delay` and `reconnect_delay_max`.
+
+```ruby
+Redis.new(
+  :reconnect_attempts => 10,
+  :reconnect_delay => 1.5,
+  :reconnect_delay_max => 10.0,
+)
+```
+
+The delay values are specified in seconds. With the above configuration, the
+client would attempt 10 reconnections, exponentially increasing the duration
+between each attempt but it never waits longer than `reconnect_delay_max`.
+
+This is the retry algorithm:
+
+```ruby
+attempt_wait_time = [(reconnect_delay * 2**(attempt-1)), reconnect_delay_max].min
+```
+
+**By default**, this gem will only **retry a connection once** and then fail, but with the
+above configuration the reconnection attempt would look like this:
+
+#|Attempt wait time|Total wait time
+:-:|:-:|:-:
+1|1.5s|1.5s
+2|3.0s|4.5s
+3|6.0s|10.5s
+4|10.0s|20.5s
+5|10.0s|30.5s
+6|10.0s|40.5s
+7|10.0s|50.5s
+8|10.0s|60.5s
+9|10.0s|70.5s
+10|10.0s|80.5s
+
+So if the reconnection attempt #10 succeeds 70 seconds have elapsed trying
+to reconnect, this is likely fine in long-running background processes, but if
+you use Redis to drive your website you might want to have a lower
+`reconnect_delay_max` or have less `reconnect_attempts`.
 
 ## SSL/TLS Support
 

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
@@ -272,12 +277,15 @@ class Redis
 
     def with_socket_timeout(timeout)
       connect unless connected?
+      original = @options[:read_timeout]
 
       begin
         connection.timeout = timeout
+        @options[:read_timeout] = timeout # for reconnection
         yield
       ensure
         connection.timeout = self.timeout if connected?
+        @options[:read_timeout] = original
       end
     end
 
@@ -334,6 +342,7 @@ class Redis
       @connection = @options[:driver].connect(@options)
       @pending_reads = 0
     rescue TimeoutError,
+           SocketError,
            Errno::ECONNREFUSED,
            Errno::EHOSTDOWN,
            Errno::EHOSTUNREACH,
@@ -368,6 +377,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 +457,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/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

data/lib/redis/cluster/node.rb

@@ -0,0 +1,104 @@
+# 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)
+
+          client = Client.new(option)
+          client.call(%i[readonly]) if slave?(node_key)
+          [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,35 @@
+# 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
+      DEFAULT_SCHEME = 'redis'
+      SECURE_SCHEME = 'rediss'
+      DELIMITER = ':'
+
+      module_function
+
+      def to_node_urls(node_keys, secure:)
+        scheme = secure ? SECURE_SCHEME : DEFAULT_SCHEME
+        node_keys
+          .map { |k| k.split(DELIMITER) }
+          .map { |k| URI::Generic.build(scheme: scheme, host: k[0], port: k[1].to_i).to_s }
+      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,77 @@
+# 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_uris = build_node_uris(node_addrs)
+        @replica = options.delete(:replica) == true
+        @options = options
+      end
+
+      def per_node_key
+        @node_uris.map { |uri| [NodeKey.build_from_uri(uri), @options.merge(url: uri.to_s)] }
+                  .to_h
+      end
+
+      def secure?
+        @node_uris.any? { |uri| uri.scheme == SECURE_SCHEME } || @options[:ssl_params] || false
+      end
+
+      def use_replica?
+        @replica
+      end
+
+      def update_node(addrs)
+        @node_uris = build_node_uris(addrs)
+      end
+
+      def add_node(host, port)
+        @node_uris << parse_node_hash(host: host, port: port)
+      end
+
+      private
+
+      def build_node_uris(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_hash(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)
+        uri
+      rescue URI::InvalidURIError => err
+        raise InvalidClientOptionError, err.message
+      end
+
+      def parse_node_hash(addr)
+        addr = addr.map { |k, v| [k.to_sym, v] }.to_h
+        raise InvalidClientOptionError, 'Redis option of `cluster` must includes `:host` and `:port` keys' if addr.values_at(:host, :port).any?(&:nil?)
+        URI::Generic.build(scheme: DEFAULT_SCHEME, host: addr[:host], port: addr[:port].to_i)
+      end
+    end
+  end
+end