redis-client 0.7.4 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6fbe9260e43212ff9c501d95cf262f0c34e4db3cbc4dc6bebef3e8d2f98fc52
-  data.tar.gz: d8356c2d342ae51f70e33b28f5e5679bea021ed31240b35c055ea5ad5625e9a4
+  metadata.gz: e4699c416da87ac3ed64b078ac60643a3baaa7fc2e3884feb58cc86aeb619083
+  data.tar.gz: 5305b72684041089b57c12f493b16e81901718654058e2a5f920b18bb2b83792
 SHA512:
-  metadata.gz: 7ad5fdf44a060e90f3d9a4b350733d208a745e625fa95764c7288047bfa4138e9e882a6608634374c66b3fa595037d8603eb902f431603c8c94048bacfbf8184
-  data.tar.gz: c09bea07473c08a6d67b0615811484e50199da37ceb25a977129f616595fc7692d24aa46851272129b4a41c735f83a22dae0922a09bc74f6be72fe28dda2576d
+  metadata.gz: 119c4cf4e1a0eed4f9e67ad2be84fc6a63404cde61519a697efd85b643779cb41b30b32f765ec3308ccaf7fa4903684c9dab1ecb86b1289db2566b1943ac7010
+  data.tar.gz: dbcba8c22c20d4ac33d1e7a495bf95cb30bca7a8b63d98d8944f2c61abfefbf4a40fc3d3222591a85ab8936c5b9e83c946095458b9b31748fe3e3e4e4e37db9e

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.8.1
+
+- Make the client resilient to `Timeout.timeout` or `Thread#kill` use (it still still very much discouraged to use).
+  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.
+
 # 0.7.4
 
 - Properly parse script errors on pre 7.0 redis server.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.7.4)
+    redis-client (0.8.1)
       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

@@ -349,6 +349,10 @@ end
 
 ```ruby
 module MyRedisInstrumentation
+  def connect(redis_config)
+    MyMonitoringService.instrument("redis.connect") { super }
+  end
+
   def call(command, redis_config)
     MyMonitoringService.instrument("redis.query") { super }
   end

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/middlewares.rb

@@ -4,6 +4,10 @@ class RedisClient
   module Middlewares
     extend self
 
+    def connect(_config)
+      yield
+    end
+
     def call(command, _config)
       yield command
     end

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.7.4"
+  VERSION = "0.8.1"
 end

data/lib/redis_client.rb

@@ -641,16 +641,19 @@ class RedisClient
   end
 
   def raw_connection
+    @raw_connection = @raw_connection&.revalidate
     @raw_connection ||= connect
   end
 
   def connect
-    connection = config.driver.new(
-      config,
-      connect_timeout: connect_timeout,
-      read_timeout: read_timeout,
-      write_timeout: write_timeout,
-    )
+    connection = Middlewares.connect(config) do
+      config.driver.new(
+        config,
+        connect_timeout: connect_timeout,
+        read_timeout: read_timeout,
+        write_timeout: write_timeout,
+      )
+    end
 
     prelude = config.connection_prelude.dup
 

metadata

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