redis-client 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e7b7923ecb86353521db31036b3c5678683fcb6ed8ec5799c1ca6c6b5fcd44
-  data.tar.gz: 9e782f9884b2f12eb0c58ca701da62e8945a14a1eca27c3052adbb0a1e4fe428
+  metadata.gz: 95dd96eda7210df59b85fafb8d2df5fa46cf0d3d2da10ad1ebf60137b8ec2652
+  data.tar.gz: d417951e19d9a20b7f96a2d4e520d433cd52c38209d8c46499ddfc0d6d4be941
 SHA512:
-  metadata.gz: c77d09a8330bbcc4e8b2329a1ff9e660bb2c5ddf35cccafcf89f0b37ef9d89f579fa32b9ec7a7f64eecff12941ac835e4424dcf7ab9fdef12fc01ae73250959f
-  data.tar.gz: 4c16639282ca539e04d07d363c28e663a5e409f6c6d9deef856158fe8d46a1e20669b44c025e978dc04965106148e1fd7fcd82cc1d50abc8c27fb4694b825e2e
+  metadata.gz: 0dd66a81c969a08abbb89140187e6a3a31aadcb258845082bf84bba792304ebc3d27852635fa4519805139eeecb7f405033b2b0c6acc4d39f7823873cd91dbdc
+  data.tar.gz: 4a9f5b79ffc8d195a3fac2cd439750d43124bb78583eef840564262d25565b2e585d8d77eb3f9d2096ec938fa4db7fe7a775c5ba5f80c4e2bd91f2b121901a98

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.9.0
+
+- Automatically reconnect if the process was forked.
+
+# 0.8.1
+
+- Make the client resilient to `Timeout.timeout` or `Thread#kill` use (it still is very much discouraged to use either).
+  Use of async interrupts could cause responses to be interleaved.
+- hiredis: handle commands returning a top-level `false` (no command does this today, but some extensions might). 
+- Workaround a bug in Ruby 2.6 causing a crash if the `debug` gem is enabled when `redis-client` is being required. Fix: #48
+
 # 0.8.0
 
 - Add a `connect` interface to the instrumentation API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.8.0)
+    redis-client (0.9.0)
       connection_pool
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     benchmark-ips (2.10.0)
     byebug (11.1.3)
-    connection_pool (2.2.5)
+    connection_pool (2.3.0)
     hiredis (0.6.3)
     hiredis (0.6.3-java)
     minitest (5.15.0)

data/README.md

@@ -437,15 +437,6 @@ Contrary to the `redis` gem, `redis-client` doesn't protect against concurrent a
 To use `redis-client` in concurrent environments, you MUST use a connection pool, or
 have one client per Thread or Fiber.
 
-### Fork Safety
-
-`redis-client` doesn't try to detect forked processes. You MUST disconnect all clients before forking your process.
-
-```ruby
-redis.close
-Process.fork ...
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/redis_client/config.rb

@@ -12,7 +12,7 @@ class RedisClient
     DEFAULT_DB = 0
 
     module Common
-      attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder,
+      attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
         :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol
 
       alias_method :ssl?, :ssl
@@ -32,6 +32,7 @@ class RedisClient
         protocol: 3,
         client_implementation: RedisClient,
         command_builder: CommandBuilder,
+        inherit_socket: false,
         reconnect_attempts: false
       )
         @username = username
@@ -54,6 +55,7 @@ class RedisClient
         end
 
         @command_builder = command_builder
+        @inherit_socket = inherit_socket
 
         reconnect_attempts = Array.new(reconnect_attempts, 0).freeze if reconnect_attempts.is_a?(Integer)
         @reconnect_attempts = reconnect_attempts

data/lib/redis_client/connection_mixin.rb

@@ -2,9 +2,21 @@
 
 class RedisClient
   module ConnectionMixin
+    def initialize
+      @pending_reads = 0
+    end
+
+    def revalidate
+      if @pending_reads == 0 && connected?
+        self
+      end
+    end
+
     def call(command, timeout)
+      @pending_reads += 1
       write(command)
       result = read(timeout)
+      @pending_reads -= 1
       if result.is_a?(CommandError)
         result._set_command(command)
         raise result
@@ -18,11 +30,13 @@ class RedisClient
 
       size = commands.size
       results = Array.new(commands.size)
+      @pending_reads += size
       write_multi(commands)
 
       size.times do |index|
         timeout = timeouts && timeouts[index]
         result = read(timeout)
+        @pending_reads -= 1
         if result.is_a?(CommandError)
           result._set_command(commands[index])
           exception ||= result

data/lib/redis_client/pooled.rb

@@ -51,46 +51,26 @@ class RedisClient
 
     methods = %w(pipelined multi pubsub call call_v call_once call_once_v blocking_call blocking_call_v)
     iterable_methods = %w(scan sscan hscan zscan)
-    begin
-      methods.each do |method|
-        class_eval <<~RUBY, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            with { |r| r.#{method}(...) }
-          end
-        RUBY
-      end
-
-      iterable_methods.each do |method|
-        class_eval <<~RUBY, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            unless block_given?
-              return to_enum(__callee__, ...)
-            end
+    methods.each do |method|
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          with { |r| r.#{method}(*args, &block) }
+        end
+        ruby2_keywords :#{method} if respond_to?(:ruby2_keywords, true)
+      RUBY
+    end
 
-            with { |r| r.#{method}(...) }
-          end
-        RUBY
-      end
-    rescue SyntaxError
-      methods.each do |method|
-        class_eval <<~RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            with { |r| r.#{method}(*args, &block) }
+    iterable_methods.each do |method|
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          unless block_given?
+            return to_enum(__callee__, *args)
           end
-        RUBY
-      end
-
-      iterable_methods.each do |method|
-        class_eval <<~RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            unless block_given?
-              return to_enum(__callee__, *args)
-            end
 
-            with { |r| r.#{method}(*args, &block) }
-          end
-        RUBY
-      end
+          with { |r| r.#{method}(*args, &block) }
+        end
+        ruby2_keywords :#{method} if respond_to?(:ruby2_keywords, true)
+      RUBY
     end
 
     private

data/lib/redis_client/ruby_connection.rb

@@ -41,6 +41,7 @@ class RedisClient
     SUPPORTS_RESOLV_TIMEOUT = Socket.method(:tcp).parameters.any? { |p| p.last == :resolv_timeout }
 
     def initialize(config, connect_timeout:, read_timeout:, write_timeout:)
+      super()
       socket = if config.path
         UNIXSocket.new(config.path)
       else

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/redis_client.rb

@@ -67,6 +67,7 @@ class RedisClient
       @read_timeout = read_timeout
       @write_timeout = write_timeout
       @command_builder = config.command_builder
+      @pid = Process.pid
     end
 
     def timeout=(timeout)
@@ -416,7 +417,7 @@ class RedisClient
     end
 
     def close
-      raw_connection&.close
+      @raw_connection&.close
       @raw_connection = nil
       self
     end
@@ -597,6 +598,8 @@ class RedisClient
   end
 
   def ensure_connected(retryable: true)
+    close if !config.inherit_socket && @pid != Process.pid
+
     if @disable_reconnection
       if block_given?
         yield @raw_connection
@@ -614,7 +617,6 @@ class RedisClient
           connection
         end
       rescue ConnectionError, ProtocolError => error
-        connection&.close
         close
 
         if !@disable_reconnection && config.retry_connecting?(tries, error)
@@ -631,7 +633,6 @@ class RedisClient
         @disable_reconnection = true
         yield connection
       rescue ConnectionError, ProtocolError
-        connection&.close
         close
         raise
       ensure
@@ -641,10 +642,13 @@ class RedisClient
   end
 
   def raw_connection
+    @raw_connection = @raw_connection&.revalidate
     @raw_connection ||= connect
   end
 
   def connect
+    @pid = Process.pid
+
     connection = Middlewares.connect(config) do
       config.driver.new(
         config,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool