redis 4.2.0 → 4.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9796f6646b7d3aaeeb5ef37629fb1a43422285724d8d2901a219ef4f2882eff5
-  data.tar.gz: b89f4f1d6a3c9ee93202ce08cdcd3ed184694b5693f7461be7cf7e517139a278
+  metadata.gz: 862e8133262fead707e4ca317b29d0e35425e3a7861ea1a52033bc91ba61bf6d
+  data.tar.gz: 5b2b32250d783fe58b0af54cc386f2568241644a0badc0b7247bb29b1ac94a93
 SHA512:
-  metadata.gz: be709e1aad1acee8d7c3e121e946060ce9b693ac80e25af200e2a579988f3952d6522cb9855917dc76628ae2038365bb8754b49a7cc6e90395706ba30fc87a86
-  data.tar.gz: 00102b01b4b37daab76fc90990f980a4710bec0e797a70d65a7544ef304f01f9b9babbdcc680da71513dd8f79649bd5f529e6804e71297b26978625bea746367
+  metadata.gz: 2aab289f4f22b2f3a804ca7b0da4cf95e352a8d246611490d8d803edebbbc7e7c299355cd0b90e6f3ac8bc0d11e9bf3792a328c95847d32e1d984729afe66ed2
+  data.tar.gz: d9ec8ba4d314d099e909cdddf6dfb4c3c14b853b46f45c4909ac3ba10fb1880bd9a7b0465257fa91f9a4ea6c9f82723c16c177810ac15c89fab3790d7af31ad0

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Unreleased
 
+# 4.2.5
+
+* Optimize the ruby connector write buffering. See #964.
+
+# 4.2.4
+
+* Fix bytesize calculations in the ruby connector, and work on a copy of the buffer. Fix #961, #962.
+
+# 4.2.3
+
+* Use io/wait instead of IO.select in the ruby connector. See #960.
+* Use exception free non blocking IOs in the ruby connector. See #926.
+* Prevent corruption of the client when an interrupt happen during inside a pipeline block. See #945.
+
+# 4.2.2
+
+* Fix `WATCH` support for `Redis::Distributed`. See #941.
+* Fix handling of empty stream responses. See #905, #929.
+
+# 4.2.1
+
+* Fix `exists?` returning an actual boolean when called with multiple keys. See #918.
+* Setting `Redis.exists_returns_integer = false` disables warning message about new behaviour. See #920.
+
 # 4.2.0
 
 * Convert commands to accept keyword arguments rather than option hashes. This both help catching typos, and reduce needless allocations.
@@ -12,6 +36,7 @@
 * Optimized initialization of Redis::Cluster. See #912.
 * Accept sentinel options even with string key. See #599.
 * Verify TLS connections by default. See #900.
+* Make `Redis#hset` variadic. It now returns an integer, not a boolean. See #910.
 
 # 4.1.4
 

data/README.md

@@ -265,6 +265,7 @@ All timeout values are specified in seconds.
 When using pub/sub, you can subscribe to a channel using a timeout as well:
 
 ```ruby
+redis = Redis.new(reconnect_attempts: 0)
 redis.subscribe_with_timeout(5, "news") do |on|
   on.message do |channel, message|
     # ...

data/lib/redis.rb

@@ -5,7 +5,20 @@ require_relative "redis/errors"
 
 class Redis
   class << self
-    attr_accessor :exists_returns_integer
+    attr_reader :exists_returns_integer
+
+    def exists_returns_integer=(value)
+      unless value
+        message = "`Redis#exists(key)` will return an Integer by default in redis-rb 4.3. The option to explicitly " \
+          "disable this behaviour via `Redis.exists_returns_integer` will be removed in 5.0. You should use " \
+          "`exists?` instead."
+
+        ::Kernel.warn(message)
+      end
+
+      @exists_returns_integer = value
+    end
+
     attr_writer :current
   end
 
@@ -561,11 +574,16 @@ class Redis
   # @return [Integer]
   def exists(*keys)
     if !Redis.exists_returns_integer && keys.size == 1
-      message = "`Redis#exists(key)` will return an Integer in redis-rb 4.3, if you want to keep the old behavior, " \
-        "use `exists?` instead. To opt-in to the new behavior now you can set Redis.exists_returns_integer = true. " \
-        "(#{::Kernel.caller(1, 1).first})\n"
+      if Redis.exists_returns_integer.nil?
+        message = "`Redis#exists(key)` will return an Integer in redis-rb 4.3. `exists?` returns a boolean, you " \
+          "should use it instead. To opt-in to the new behavior now you can set Redis.exists_returns_integer =  " \
+          "true. To disable this message and keep the current (boolean) behaviour of 'exists' you can set " \
+          "`Redis.exists_returns_integer = false`, but this option will be removed in 5.0. " \
+          "(#{::Kernel.caller(1, 1).first})\n"
+
+        ::Kernel.warn(message)
+      end
 
-      ::Kernel.warn(message)
       exists?(*keys)
     else
       _exists(*keys)
@@ -584,7 +602,9 @@ class Redis
   # @return [Boolean]
   def exists?(*keys)
     synchronize do |client|
-      client.call([:exists, *keys], &Boolify)
+      client.call([:exists, *keys]) do |value|
+        value > 0
+      end
     end
   end
 
@@ -2418,14 +2438,13 @@ class Redis
   end
 
   def pipelined
-    synchronize do |_client|
+    synchronize do |prior_client|
       begin
-        pipeline = Pipeline.new(@client)
-        original, @client = @client, pipeline
+        @client = Pipeline.new(prior_client)
         yield(self)
-        original.call_pipeline(@client)
+        prior_client.call_pipeline(@client)
       ensure
-        @client = original
+        @client = prior_client
       end
     end
   end
@@ -2461,17 +2480,16 @@ class Redis
   # @see #watch
   # @see #unwatch
   def multi
-    synchronize do |client|
+    synchronize do |prior_client|
       if !block_given?
-        client.call([:multi])
+        prior_client.call([:multi])
       else
         begin
-          pipeline = Pipeline::Multi.new(@client)
-          original, @client = @client, pipeline
+          @client = Pipeline::Multi.new(prior_client)
           yield(self)
-          original.call_pipeline(pipeline)
+          prior_client.call_pipeline(@client)
         ensure
-          @client = original
+          @client = prior_client
         end
       end
     end
@@ -3403,8 +3421,11 @@ class Redis
     end
   }
 
+  EMPTY_STREAM_RESPONSE = [nil].freeze
+  private_constant :EMPTY_STREAM_RESPONSE
+
   HashifyStreamEntries = lambda { |reply|
-    reply.map do |entry_id, values|
+    reply.compact.map do |entry_id, values|
       [entry_id, values.each_slice(2).to_h]
     end
   }

data/lib/redis/client.rb

@@ -6,12 +6,16 @@ require "cgi"
 
 class Redis
   class Client
+    # Defaults are also used for converting string keys to symbols.
     DEFAULTS = {
       url: -> { ENV["REDIS_URL"] },
       scheme: "redis",
       host: "127.0.0.1",
       port: 6379,
       path: nil,
+      read_timeout: nil,
+      write_timeout: nil,
+      connect_timeout: nil,
       timeout: 5.0,
       password: nil,
       db: 0,
@@ -22,6 +26,7 @@ class Redis
       reconnect_delay: 0,
       reconnect_delay_max: 0.5,
       inherit_socket: false,
+      logger: nil,
       sentinels: nil,
       role: nil
     }.freeze

data/lib/redis/connection/ruby.rb

@@ -49,57 +49,50 @@ class Redis
       end
 
       def _read_from_socket(nbytes)
-        begin
-          read_nonblock(nbytes)
-        rescue IO::WaitReadable
-          if IO.select([self], nil, nil, @timeout)
-            retry
-          else
-            raise Redis::TimeoutError
-          end
-        rescue IO::WaitWritable
-          if IO.select(nil, [self], nil, @timeout)
-            retry
-          else
-            raise Redis::TimeoutError
-          end
-        end
-      rescue EOFError
-        raise Errno::ECONNRESET
-      end
-
-      def _write_to_socket(data)
-        begin
-          write_nonblock(data)
-        rescue IO::WaitWritable
-          if IO.select(nil, [self], nil, @write_timeout)
-            retry
-          else
-            raise Redis::TimeoutError
-          end
-        rescue IO::WaitReadable
-          if IO.select([self], nil, nil, @write_timeout)
-            retry
-          else
-            raise Redis::TimeoutError
+        loop do
+          case chunk = read_nonblock(nbytes, exception: false)
+          when :wait_readable
+            unless wait_readable(@timeout)
+              raise Redis::TimeoutError
+            end
+          when :wait_writable
+            unless wait_writable(@timeout)
+              raise Redis::TimeoutError
+            end
+          when nil
+            raise Errno::ECONNRESET
+          when String
+            return chunk
           end
         end
-      rescue EOFError
-        raise Errno::ECONNRESET
       end
 
-      def write(data)
-        return super(data) unless @write_timeout
+      def write(buffer)
+        return super(buffer) unless @write_timeout
 
-        length = data.bytesize
-        total_count = 0
+        bytes_to_write = buffer.bytesize
+        total_bytes_written = 0
         loop do
-          count = _write_to_socket(data)
+          case bytes_written = write_nonblock(buffer, exception: false)
+          when :wait_readable
+            unless wait_readable(@write_timeout)
+              raise Redis::TimeoutError
+            end
+          when :wait_writable
+            unless wait_writable(@write_timeout)
+              raise Redis::TimeoutError
+            end
+          when nil
+            raise Errno::ECONNRESET
+          when Integer
+            total_bytes_written += bytes_written
 
-          total_count += count
-          return total_count if total_count >= length
+            if total_bytes_written >= bytes_to_write
+              return total_bytes_written
+            end
 
-          data = data.byteslice(count..-1)
+            buffer = buffer.byteslice(bytes_written..-1)
+          end
         end
       end
     end
@@ -135,7 +128,7 @@ class Redis
             raise TimeoutError
           end
 
-          # JRuby raises Errno::EAGAIN on #read_nonblock even when IO.select
+          # JRuby raises Errno::EAGAIN on #read_nonblock even when it
           # says it is readable (1.6.6, in both 1.8 and 1.9 mode).
           # Use the blocking #readpartial method instead.
 
@@ -160,7 +153,7 @@ class Redis
           begin
             sock.connect_nonblock(sockaddr)
           rescue Errno::EINPROGRESS
-            raise TimeoutError if IO.select(nil, [sock], nil, timeout).nil?
+            raise TimeoutError unless sock.wait_writable(timeout)
 
             begin
               sock.connect_nonblock(sockaddr)
@@ -215,7 +208,7 @@ class Redis
           begin
             sock.connect_nonblock(sockaddr)
           rescue Errno::EINPROGRESS
-            raise TimeoutError if IO.select(nil, [sock], nil, timeout).nil?
+            raise TimeoutError unless sock.wait_writable(timeout)
 
             begin
               sock.connect_nonblock(sockaddr)
@@ -233,6 +226,18 @@ class Redis
       class SSLSocket < ::OpenSSL::SSL::SSLSocket
         include SocketMixin
 
+        unless method_defined?(:wait_readable)
+          def wait_readable(timeout = nil)
+            to_io.wait_readable(timeout)
+          end
+        end
+
+        unless method_defined?(:wait_writable)
+          def wait_writable(timeout = nil)
+            to_io.wait_writable(timeout)
+          end
+        end
+
         def self.connect(host, port, timeout, ssl_params)
           # Note: this is using Redis::Connection::TCPSocket
           tcp_sock = TCPSocket.connect(host, port, timeout)
@@ -254,13 +259,13 @@ class Redis
             # Instead, you have to retry.
             ssl_sock.connect_nonblock
           rescue Errno::EAGAIN, Errno::EWOULDBLOCK, IO::WaitReadable
-            if IO.select([ssl_sock], nil, nil, timeout)
+            if ssl_sock.wait_readable(timeout)
               retry
             else
               raise TimeoutError
             end
           rescue IO::WaitWritable
-            if IO.select(nil, [ssl_sock], nil, timeout)
+            if ssl_sock.wait_writable(timeout)
               retry
             else
               raise TimeoutError

data/lib/redis/distributed.rb

@@ -24,10 +24,14 @@ class Redis
       @default_options = options.dup
       node_configs.each { |node_config| add_node(node_config) }
       @subscribed_node = nil
+      @watch_key = nil
     end
 
     def node_for(key)
-      @ring.get_node(key_tag(key.to_s) || key.to_s)
+      key = key_tag(key.to_s) || key.to_s
+      raise CannotDistribute, :watch if @watch_key && @watch_key != key
+
+      @ring.get_node(key)
     end
 
     def nodes
@@ -799,13 +803,26 @@ class Redis
     end
 
     # Watch the given keys to determine execution of the MULTI/EXEC block.
-    def watch(*_keys)
-      raise CannotDistribute, :watch
+    def watch(*keys, &block)
+      ensure_same_node(:watch, keys) do |node|
+        @watch_key = key_tag(keys.first) || keys.first.to_s
+
+        begin
+          node.watch(*keys, &block)
+        rescue StandardError
+          @watch_key = nil
+          raise
+        end
+      end
     end
 
     # Forget about all watched keys.
     def unwatch
-      raise CannotDistribute, :unwatch
+      raise CannotDistribute, :unwatch unless @watch_key
+
+      result = node_for(@watch_key).unwatch
+      @watch_key = nil
+      result
     end
 
     def pipelined
@@ -813,18 +830,30 @@ class Redis
     end
 
     # Mark the start of a transaction block.
-    def multi
-      raise CannotDistribute, :multi
+    def multi(&block)
+      raise CannotDistribute, :multi unless @watch_key
+
+      result = node_for(@watch_key).multi(&block)
+      @watch_key = nil if block_given?
+      result
     end
 
     # Execute all commands issued after MULTI.
     def exec
-      raise CannotDistribute, :exec
+      raise CannotDistribute, :exec unless @watch_key
+
+      result = node_for(@watch_key).exec
+      @watch_key = nil
+      result
     end
 
     # Discard all commands issued after MULTI.
     def discard
-      raise CannotDistribute, :discard
+      raise CannotDistribute, :discard unless @watch_key
+
+      result = node_for(@watch_key).discard
+      @watch_key = nil
+      result
     end
 
     # Control remote script registry.

data/lib/redis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Redis
-  VERSION = '4.2.0'
+  VERSION = '4.2.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.5
 platform: ruby
 authors:
 - Ezra Zygmuntowicz
@@ -13,10 +13,10 @@ authors:
 - Michel Martens
 - Damian Janowski
 - Pieter Noordhuis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-synchrony
@@ -99,8 +99,13 @@ files:
 homepage: https://github.com/redis/redis-rb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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.5
+  homepage_uri: https://github.com/redis/redis-rb
+  source_code_uri: https://github.com/redis/redis-rb/tree/v4.2.5
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A Ruby client library for Redis
 test_files: []