redis 3.0.0 → 4.2.2

data/lib/redis/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Redis
   # Base error for all redis-rb errors.
   class BaseError < RuntimeError
@@ -37,4 +39,50 @@ class Redis
   # Raised when the connection was inherited by a child process.
   class InheritedError < BaseConnectionError
   end
+
+  # Raised when client options are invalid.
+  class InvalidClientOptionError < BaseError
+  end
+
+  class Cluster
+    # Raised when client connected to redis as cluster mode
+    # and some cluster subcommands were called.
+    class OrchestrationCommandNotSupported < BaseError
+      def initialize(command, subcommand = '')
+        str = [command, subcommand].map(&:to_s).reject(&:empty?).join(' ').upcase
+        msg = "#{str} command should be used with care "\
+              'only by applications orchestrating Redis Cluster, like redis-trib, '\
+              'and the command if used out of the right context can leave the cluster '\
+              'in a wrong state or cause data loss.'
+        super(msg)
+      end
+    end
+
+    # Raised when error occurs on any node of cluster.
+    class CommandErrorCollection < BaseError
+      attr_reader :errors
+
+      # @param errors [Hash{String => Redis::CommandError}]
+      # @param error_message [String]
+      def initialize(errors, error_message = 'Command errors were replied on any node')
+        @errors = errors
+        super(error_message)
+      end
+    end
+
+    # Raised when cluster client can't select node.
+    class AmbiguousNodeError < BaseError
+      def initialize(command)
+        super("Cluster client doesn't know which node the #{command} command should be sent to.")
+      end
+    end
+
+    # Raised when commands in pipelining include cross slot keys.
+    class CrossSlotPipeliningError < BaseError
+      def initialize(keys)
+        super("Cluster client couldn't send pipelining to single node. "\
+              "The commands include cross slot keys. #{keys}")
+      end
+    end
+  end
 end

data/lib/redis/hash_ring.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'zlib'
 
 class Redis
   class HashRing
-
     POINTS_PER_SERVER = 160 # this is the default in libmemcached
 
     attr_reader :ring, :sorted_keys, :replicas, :nodes
@@ -10,7 +11,7 @@ class Redis
     # nodes is a list of objects that have a proper to_s representation.
     # replicas indicates how many virtual points should be used pr. node,
     # replicas are required to improve the distribution.
-    def initialize(nodes=[], replicas=POINTS_PER_SERVER)
+    def initialize(nodes = [], replicas = POINTS_PER_SERVER)
       @replicas = replicas
       @ring = {}
       @nodes = []
@@ -32,11 +33,11 @@ class Redis
     end
 
     def remove_node(node)
-      @nodes.reject!{|n| n.id == node.id}
+      @nodes.reject! { |n| n.id == node.id }
       @replicas.times do |i|
         key = Zlib.crc32("#{node.id}:#{i}")
         @ring.delete(key)
-        @sorted_keys.reject! {|k| k == key}
+        @sorted_keys.reject! { |k| k == key }
       end
     end
 
@@ -46,86 +47,43 @@ class Redis
     end
 
     def get_node_pos(key)
-      return [nil,nil] if @ring.size == 0
+      return [nil, nil] if @ring.empty?
+
       crc = Zlib.crc32(key)
       idx = HashRing.binary_search(@sorted_keys, crc)
-      return [@ring[@sorted_keys[idx]], idx]
+      [@ring[@sorted_keys[idx]], idx]
     end
 
     def iter_nodes(key)
-      return [nil,nil] if @ring.size == 0
+      return [nil, nil] if @ring.empty?
+
       _, pos = get_node_pos(key)
-      @sorted_keys[pos..-1].each do |k|
-        yield @ring[k]
+      @ring.size.times do |n|
+        yield @ring[@sorted_keys[(pos + n) % @ring.size]]
       end
     end
 
-    class << self
-
-      # gem install RubyInline to use this code
-      # Native extension to perform the binary search within the hashring.
-      # There's a pure ruby version below so this is purely optional
-      # for performance.  In testing 20k gets and sets, the native
-      # binary search shaved about 12% off the runtime (9sec -> 8sec).
-      begin
-        require 'inline'
-        inline do |builder|
-          builder.c <<-EOM
-          int binary_search(VALUE ary, unsigned int r) {
-              int upper = RARRAY_LEN(ary) - 1;
-              int lower = 0;
-              int idx = 0;
-
-              while (lower <= upper) {
-                  idx = (lower + upper) / 2;
-
-                  VALUE continuumValue = RARRAY_PTR(ary)[idx];
-                  unsigned int l = NUM2UINT(continuumValue);
-                  if (l == r) {
-                      return idx;
-                  }
-                  else if (l > r) {
-                      upper = idx - 1;
-                  }
-                  else {
-                      lower = idx + 1;
-                  }
-              }
-              if (upper < 0) {
-                upper = RARRAY_LEN(ary) - 1;
-              }
-              return upper;
-          }
-          EOM
+    # Find the closest index in HashRing with value <= the given value
+    def self.binary_search(ary, value)
+      upper = ary.size - 1
+      lower = 0
+      idx = 0
+
+      while lower <= upper
+        idx = (lower + upper) / 2
+        comp = ary[idx] <=> value
+
+        if comp == 0
+          return idx
+        elsif comp > 0
+          upper = idx - 1
+        else
+          lower = idx + 1
         end
-      rescue Exception
-        # Find the closest index in HashRing with value <= the given value
-        def binary_search(ary, value, &block)
-          upper = ary.size - 1
-          lower = 0
-          idx = 0
-
-          while(lower <= upper) do
-            idx = (lower + upper) / 2
-            comp = ary[idx] <=> value
-
-            if comp == 0
-              return idx
-            elsif comp > 0
-              upper = idx - 1
-            else
-              lower = idx + 1
-            end
-          end
-
-          if upper < 0
-            upper = ary.size - 1
-          end
-          return upper
-        end
-
       end
-    end
 
+      upper = ary.size - 1 if upper < 0
+      upper
+    end
   end
 end

data/lib/redis/pipeline.rb

@@ -1,19 +1,23 @@
-class Redis
-  unless defined?(::BasicObject)
-    class BasicObject
-      instance_methods.each { |meth| undef_method(meth) unless meth =~ /\A(__|instance_eval)/ }
-    end
-  end
+# frozen_string_literal: true
 
+class Redis
   class Pipeline
+    attr_accessor :db
+    attr_reader :client
+
     attr :futures
 
-    def initialize
+    def initialize(client)
+      @client = client.is_a?(Pipeline) ? client.client : client
       @with_reconnect = true
       @shutdown = false
       @futures = []
     end
 
+    def timeout
+      client.timeout
+    end
+
     def with_reconnect?
       @with_reconnect
     end
@@ -26,26 +30,39 @@ class Redis
       @shutdown
     end
 
-    def call(command, &block)
+    def empty?
+      @futures.empty?
+    end
+
+    def call(command, timeout: nil, &block)
       # A pipeline that contains a shutdown should not raise ECONNRESET when
       # the connection is gone.
       @shutdown = true if command.first == :shutdown
-      future = Future.new(command, block)
+      future = Future.new(command, block, timeout)
       @futures << future
       future
     end
 
+    def call_with_timeout(command, timeout, &block)
+      call(command, timeout: timeout, &block)
+    end
+
     def call_pipeline(pipeline)
       @shutdown = true if pipeline.shutdown?
       @futures.concat(pipeline.futures)
+      @db = pipeline.db
       nil
     end
 
     def commands
-      @futures.map { |f| f._command }
+      @futures.map(&:_command)
     end
 
-    def with_reconnect(val=true)
+    def timeouts
+      @futures.map(&:timeout)
+    end
+
+    def with_reconnect(val = true)
       @with_reconnect = false unless val
       yield
     end
@@ -68,14 +85,20 @@ class Redis
 
     class Multi < self
       def finish(replies)
-        return if replies.last.nil? # The transaction failed because of WATCH.
+        exec = replies.last
+
+        return if exec.nil? # The transaction failed because of WATCH.
 
-        if replies.last.size < futures.size - 2
+        # EXEC command failed.
+        raise exec if exec.is_a?(CommandError)
+
+        if exec.size < futures.size
           # Some command wasn't recognized by Redis.
-          raise replies.detect { |r| r.kind_of?(::RuntimeError) }
+          command_error = replies.detect { |r| r.is_a?(CommandError) }
+          raise command_error
         end
 
-        super(replies.last) do |reply|
+        super(exec) do |reply|
           # Because an EXEC returns nested replies, hiredis won't be able to
           # convert an error reply to a CommandError instance itself. This is
           # specific to MULTI/EXEC, so we solve this here.
@@ -83,8 +106,20 @@ class Redis
         end
       end
 
+      def timeouts
+        if empty?
+          []
+        else
+          [nil, *super, nil]
+        end
+      end
+
       def commands
-        [[:multi]] + super + [[:exec]]
+        if empty?
+          []
+        else
+          [[:multi]] + super + [[:exec]]
+        end
       end
     end
   end
@@ -98,12 +133,25 @@ class Redis
   class Future < BasicObject
     FutureNotReady = ::Redis::FutureNotReady.new
 
-    def initialize(command, transformation)
+    attr_reader :timeout
+
+    def initialize(command, transformation, timeout)
       @command = command
       @transformation = transformation
+      @timeout = timeout
       @object = FutureNotReady
     end
 
+    def ==(_other)
+      message = +"The methods == and != are deprecated for Redis::Future and will be removed in 4.2.0"
+      message << " - You probably meant to call .value == or .value !="
+      message << " (#{::Kernel.caller(1, 1).first})\n"
+
+      ::Kernel.warn(message)
+
+      super
+    end
+
     def inspect
       "<Redis::Future #{@command.inspect}>"
     end
@@ -118,8 +166,16 @@ class Redis
     end
 
     def value
-      ::Kernel.raise(@object) if @object.kind_of?(::RuntimeError)
+      ::Kernel.raise(@object) if @object.is_a?(::RuntimeError)
       @object
     end
+
+    def is_a?(other)
+      self.class.ancestors.include?(other)
+    end
+
+    def class
+      Future
+    end
   end
 end

data/lib/redis/subscribe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Redis
   class SubscribedClient
     def initialize(client)
@@ -12,32 +14,41 @@ class Redis
       subscription("subscribe", "unsubscribe", channels, block)
     end
 
+    def subscribe_with_timeout(timeout, *channels, &block)
+      subscription("subscribe", "unsubscribe", channels, block, timeout)
+    end
+
     def psubscribe(*channels, &block)
       subscription("psubscribe", "punsubscribe", channels, block)
     end
 
+    def psubscribe_with_timeout(timeout, *channels, &block)
+      subscription("psubscribe", "punsubscribe", channels, block, timeout)
+    end
+
     def unsubscribe(*channels)
-      call [:unsubscribe, *channels]
+      call([:unsubscribe, *channels])
     end
 
     def punsubscribe(*channels)
-      call [:punsubscribe, *channels]
+      call([:punsubscribe, *channels])
     end
 
-  protected
+    protected
 
-    def subscription(start, stop, channels, block)
+    def subscription(start, stop, channels, block, timeout = 0)
       sub = Subscription.new(&block)
 
-      begin
-        @client.call_loop([start, *channels]) do |line|
-          type, *rest = line
-          sub.callbacks[type].call(*rest)
-          break if type == stop && rest.last == 0
-        end
-      ensure
-        send(stop)
+      unsubscribed = false
+
+      @client.call_loop([start, *channels], timeout) do |line|
+        type, *rest = line
+        sub.callbacks[type].call(*rest)
+        unsubscribed = type == stop && rest.last == 0
+        break if unsubscribed
       end
+      # No need to unsubscribe here. The real client closes the connection
+      # whenever an exception is raised (see #ensure_connected).
     end
   end
 
@@ -46,7 +57,7 @@ class Redis
 
     def initialize
       @callbacks = Hash.new do |hash, key|
-        hash[key] = lambda { |*_| }
+        hash[key] = ->(*_) {}
       end
 
       yield(self)

data/lib/redis/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Redis
-  VERSION = "3.0.0"
+  VERSION = '4.2.2'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis
 version: !ruby/object:Gem::Version
-  version: 3.0.0
-  prerelease: 
+  version: 4.2.2
 platform: ruby
 authors:
 - Ezra Zygmuntowicz
@@ -14,60 +13,77 @@ authors:
 - Michel Martens
 - Damian Janowski
 - Pieter Noordhuis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: em-synchrony
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    A Ruby client that tries to match Redis' API one-to-one, while
-  still\n    providing an idiomatic interface. It features thread-safety,\n    client-side
-  sharding, pipelining, and an obsession for performance.\n"
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A Ruby client that tries to match Redis' API one-to-one, while still
+      providing an idiomatic interface.
 email:
 - redis-db@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .order
-- .travis.yml
-- .travis/Gemfile
-- .yardopts
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- benchmarking/logging.rb
-- benchmarking/pipeline.rb
-- benchmarking/speed.rb
-- benchmarking/suite.rb
-- benchmarking/worker.rb
-- examples/basic.rb
-- examples/dist_redis.rb
-- examples/incr-decr.rb
-- examples/list.rb
-- examples/pubsub.rb
-- examples/sets.rb
-- examples/unicorn/config.ru
-- examples/unicorn/unicorn.rb
 - lib/redis.rb
 - lib/redis/client.rb
+- lib/redis/cluster.rb
+- lib/redis/cluster/command.rb
+- lib/redis/cluster/command_loader.rb
+- lib/redis/cluster/key_slot_converter.rb
+- lib/redis/cluster/node.rb
+- lib/redis/cluster/node_key.rb
+- lib/redis/cluster/node_loader.rb
+- lib/redis/cluster/option.rb
+- lib/redis/cluster/slot.rb
+- lib/redis/cluster/slot_loader.rb
 - lib/redis/connection.rb
 - lib/redis/connection/command_helper.rb
 - lib/redis/connection/hiredis.rb
@@ -80,145 +96,32 @@ files:
 - lib/redis/pipeline.rb
 - lib/redis/subscribe.rb
 - lib/redis/version.rb
-- redis.gemspec
-- test/blocking_commands_test.rb
-- test/command_map_test.rb
-- test/commands_on_hashes_test.rb
-- test/commands_on_lists_test.rb
-- test/commands_on_sets_test.rb
-- test/commands_on_sorted_sets_test.rb
-- test/commands_on_strings_test.rb
-- test/commands_on_value_types_test.rb
-- test/connection_handling_test.rb
-- test/db/.gitignore
-- test/distributed_blocking_commands_test.rb
-- test/distributed_commands_on_hashes_test.rb
-- test/distributed_commands_on_lists_test.rb
-- test/distributed_commands_on_sets_test.rb
-- test/distributed_commands_on_sorted_sets_test.rb
-- test/distributed_commands_on_strings_test.rb
-- test/distributed_commands_on_value_types_test.rb
-- test/distributed_commands_requiring_clustering_test.rb
-- test/distributed_connection_handling_test.rb
-- test/distributed_internals_test.rb
-- test/distributed_key_tags_test.rb
-- test/distributed_persistence_control_commands_test.rb
-- test/distributed_publish_subscribe_test.rb
-- test/distributed_remote_server_control_commands_test.rb
-- test/distributed_scripting_test.rb
-- test/distributed_sorting_test.rb
-- test/distributed_test.rb
-- test/distributed_transactions_test.rb
-- test/encoding_test.rb
-- test/error_replies_test.rb
-- test/helper.rb
-- test/helper_test.rb
-- test/internals_test.rb
-- test/lint/blocking_commands.rb
-- test/lint/hashes.rb
-- test/lint/lists.rb
-- test/lint/sets.rb
-- test/lint/sorted_sets.rb
-- test/lint/strings.rb
-- test/lint/value_types.rb
-- test/persistence_control_commands_test.rb
-- test/pipelining_commands_test.rb
-- test/publish_subscribe_test.rb
-- test/remote_server_control_commands_test.rb
-- test/scripting_test.rb
-- test/sorting_test.rb
-- test/support/connection/hiredis.rb
-- test/support/connection/ruby.rb
-- test/support/connection/synchrony.rb
-- test/support/redis_mock.rb
-- test/support/wire/synchrony.rb
-- test/support/wire/thread.rb
-- test/synchrony_driver.rb
-- test/test.conf
-- test/thread_safety_test.rb
-- test/transactions_test.rb
-- test/unknown_commands_test.rb
-- test/url_param_test.rb
 homepage: https://github.com/redis/redis-rb
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/redis/redis-rb/issues
+  changelog_uri: https://github.com/redis/redis-rb/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/redis/4.2.2
+  homepage_uri: https://github.com/redis/redis-rb
+  source_code_uri: https://github.com/redis/redis-rb/tree/v4.2.2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: A Ruby client library for Redis
-test_files:
-- test/blocking_commands_test.rb
-- test/command_map_test.rb
-- test/commands_on_hashes_test.rb
-- test/commands_on_lists_test.rb
-- test/commands_on_sets_test.rb
-- test/commands_on_sorted_sets_test.rb
-- test/commands_on_strings_test.rb
-- test/commands_on_value_types_test.rb
-- test/connection_handling_test.rb
-- test/db/.gitignore
-- test/distributed_blocking_commands_test.rb
-- test/distributed_commands_on_hashes_test.rb
-- test/distributed_commands_on_lists_test.rb
-- test/distributed_commands_on_sets_test.rb
-- test/distributed_commands_on_sorted_sets_test.rb
-- test/distributed_commands_on_strings_test.rb
-- test/distributed_commands_on_value_types_test.rb
-- test/distributed_commands_requiring_clustering_test.rb
-- test/distributed_connection_handling_test.rb
-- test/distributed_internals_test.rb
-- test/distributed_key_tags_test.rb
-- test/distributed_persistence_control_commands_test.rb
-- test/distributed_publish_subscribe_test.rb
-- test/distributed_remote_server_control_commands_test.rb
-- test/distributed_scripting_test.rb
-- test/distributed_sorting_test.rb
-- test/distributed_test.rb
-- test/distributed_transactions_test.rb
-- test/encoding_test.rb
-- test/error_replies_test.rb
-- test/helper.rb
-- test/helper_test.rb
-- test/internals_test.rb
-- test/lint/blocking_commands.rb
-- test/lint/hashes.rb
-- test/lint/lists.rb
-- test/lint/sets.rb
-- test/lint/sorted_sets.rb
-- test/lint/strings.rb
-- test/lint/value_types.rb
-- test/persistence_control_commands_test.rb
-- test/pipelining_commands_test.rb
-- test/publish_subscribe_test.rb
-- test/remote_server_control_commands_test.rb
-- test/scripting_test.rb
-- test/sorting_test.rb
-- test/support/connection/hiredis.rb
-- test/support/connection/ruby.rb
-- test/support/connection/synchrony.rb
-- test/support/redis_mock.rb
-- test/support/wire/synchrony.rb
-- test/support/wire/thread.rb
-- test/synchrony_driver.rb
-- test/test.conf
-- test/thread_safety_test.rb
-- test/transactions_test.rb
-- test/unknown_commands_test.rb
-- test/url_param_test.rb
+test_files: []