redis-client 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4699c416da87ac3ed64b078ac60643a3baaa7fc2e3884feb58cc86aeb619083
-  data.tar.gz: 5305b72684041089b57c12f493b16e81901718654058e2a5f920b18bb2b83792
+  metadata.gz: 27142ef61a44133a72e2a087afc39986ebcfe5fae30a7ee5f6eb3f702ef35ad2
+  data.tar.gz: f078880a52dec2f62d3b68188cfea8108ec433742f2f7e697def7a7bece332ac
 SHA512:
-  metadata.gz: 119c4cf4e1a0eed4f9e67ad2be84fc6a63404cde61519a697efd85b643779cb41b30b32f765ec3308ccaf7fa4903684c9dab1ecb86b1289db2566b1943ac7010
-  data.tar.gz: dbcba8c22c20d4ac33d1e7a495bf95cb30bca7a8b63d98d8944f2c61abfefbf4a40fc3d3222591a85ab8936c5b9e83c946095458b9b31748fe3e3e4e4e37db9e
+  metadata.gz: 76c7b23cb0ba419fdb9505e5cd4eb58c1c6d38d2e2fcd82778429b346dfa02a94ce4a9077c28252d8c71d1667cc45270bfc0790190e42b0d37341493bbb105f5
+  data.tar.gz: 071ec50fabaa72512101d0f408154e432e5f9950927607d8d6bcf8c7f3d5d4c9f49f40de3a24aa6957019751a598b70ae9db525002c03d7beb05312fc082e053

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 # Unreleased
 
+# 0.10.0
+
+- Added instance scoped middlewares. See: #53
+- Allow subclasses of accepted types as command arguments. Fix: #51
+- Improve hiredis driver error messages.
+
+# 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 still very much discouraged to use).
+- 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.8.1)
+    redis-client (0.10.0)
       connection_pool
 
 GEM

data/README.md

@@ -343,12 +343,13 @@ end
 
 ## Production
 
-### Instrumentation
+### Instrumentation and Middlewares
 
-`redis-client` offers a public instrumentation API monitoring tools.
+`redis-client` offers a public middleware API to aid in monitoring and library extension. Middleware can be registered
+either globally or on a given configuration instance.
 
 ```ruby
-module MyRedisInstrumentation
+module MyGlobalRedisInstrumentation
   def connect(redis_config)
     MyMonitoringService.instrument("redis.connect") { super }
   end
@@ -361,10 +362,17 @@ module MyRedisInstrumentation
     MyMonitoringService.instrument("redis.pipeline") { super }
   end
 end
-RedisClient.register(MyRedisInstrumentation)
+RedisClient.register(MyGlobalRedisInstrumentation)
 ```
 
-Note that this instrumentation is global.
+Note that `RedisClient.register` is global and apply to all `RedisClient` instances.
+
+To add middlewares to only a single client, you can provide them when creating the config:
+
+```ruby
+redis_config = RedisClient.config(middlewares: [AnotherRedisInstrumentation])
+redis_config.new_client
+```
 
 ### Timeouts
 
@@ -437,15 +445,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/Rakefile

@@ -67,12 +67,15 @@ namespace :hiredis do
   end
 end
 
+benchmark_suites = %w(single pipelined)
+benchmark_modes = %i[ruby yjit hiredis]
 namespace :benchmark do
-  task :record do
-    system("rm -rf tmp/*.benchmark")
-    %w(single pipelined).each do |suite|
-      %i[ruby yjit hiredis].each do |mode|
-        output_path = "benchmark/#{suite}_#{mode}.md"
+  benchmark_suites.each do |suite|
+    benchmark_modes.each do |mode|
+      name = "#{suite}_#{mode}"
+      task name do
+        output_path = "benchmark/#{name}.md"
+        sh "rm", "-f", output_path
         File.open(output_path, "w+") do |output|
           output.puts("ruby: `#{RUBY_DESCRIPTION}`\n\n")
           output.puts("redis-server: `#{`redis-server -v`.strip}`\n\n")
@@ -103,6 +106,8 @@ namespace :benchmark do
       end
     end
   end
+
+  task all: benchmark_suites.flat_map { |s| benchmark_modes.flat_map { |m| "#{s}_#{m}" } }
 end
 
 if hiredis_supported

data/lib/redis_client/config.rb

@@ -12,8 +12,9 @@ class RedisClient
     DEFAULT_DB = 0
 
     module Common
-      attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder,
-        :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol
+      attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
+        :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol,
+        :middlewares_stack
 
       alias_method :ssl?, :ssl
 
@@ -32,7 +33,9 @@ class RedisClient
         protocol: 3,
         client_implementation: RedisClient,
         command_builder: CommandBuilder,
-        reconnect_attempts: false
+        inherit_socket: false,
+        reconnect_attempts: false,
+        middlewares: false
       )
         @username = username
         @password = password
@@ -54,10 +57,20 @@ 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
         @connection_prelude = build_connection_prelude
+
+        middlewares_stack = Middlewares
+        if middlewares && !middlewares.empty?
+          middlewares_stack = Class.new(Middlewares)
+          middlewares.each do |mod|
+            middlewares_stack.include(mod)
+          end
+        end
+        @middlewares_stack = middlewares_stack
       end
 
       def username

data/lib/redis_client/middlewares.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 class RedisClient
-  module Middlewares
-    extend self
+  class BasicMiddleware
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
 
     def connect(_config)
       yield
@@ -13,4 +17,7 @@ class RedisClient
     end
     alias_method :call_pipelined, :call
   end
+
+  class Middlewares < BasicMiddleware
+  end
 end

data/lib/redis_client/ruby_connection/resp3.rb

@@ -10,12 +10,12 @@ class RedisClient
 
     EOL = "\r\n".b.freeze
     EOL_SIZE = EOL.bytesize
-    DUMP_TYPES = {
+    DUMP_TYPES = { # rubocop:disable Style/MutableConstant
       String => :dump_string,
       Symbol => :dump_symbol,
       Integer => :dump_numeric,
       Float => :dump_numeric,
-    }.freeze
+    }
     PARSER_TYPES = {
       '#' => :parse_boolean,
       '$' => :parse_blob,
@@ -55,8 +55,12 @@ class RedisClient
     end
 
     def dump_any(object, buffer)
-      method = DUMP_TYPES.fetch(object.class) do
-        raise TypeError, "Unsupported command argument type: #{object.class}"
+      method = DUMP_TYPES.fetch(object.class) do |unexpected_class|
+        if superclass = DUMP_TYPES.keys.find { |t| t > unexpected_class }
+          DUMP_TYPES[unexpected_class] = DUMP_TYPES[superclass]
+        else
+          raise TypeError, "Unsupported command argument type: #{unexpected_class}"
+        end
       end
       send(method, object, buffer)
     end

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.8.1"
+  VERSION = "0.10.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)
@@ -144,7 +145,7 @@ class RedisClient
     end
 
     def register(middleware)
-      Middlewares.extend(middleware)
+      Middlewares.include(middleware)
     end
   end
 
@@ -152,6 +153,7 @@ class RedisClient
 
   def initialize(config, **)
     super
+    @middlewares = config.middlewares_stack.new(self)
     @raw_connection = nil
     @disable_reconnection = false
   end
@@ -194,7 +196,7 @@ class RedisClient
   def call(*command, **kwargs)
     command = @command_builder.generate(command, kwargs)
     result = ensure_connected do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
@@ -209,7 +211,7 @@ class RedisClient
   def call_v(command)
     command = @command_builder.generate(command)
     result = ensure_connected do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
@@ -224,7 +226,7 @@ class RedisClient
   def call_once(*command, **kwargs)
     command = @command_builder.generate(command, kwargs)
     result = ensure_connected(retryable: false) do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
@@ -239,7 +241,7 @@ class RedisClient
   def call_once_v(command)
     command = @command_builder.generate(command)
     result = ensure_connected(retryable: false) do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, nil)
       end
     end
@@ -255,7 +257,7 @@ class RedisClient
     command = @command_builder.generate(command, kwargs)
     error = nil
     result = ensure_connected do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, timeout)
       end
     rescue ReadTimeoutError => error
@@ -275,7 +277,7 @@ class RedisClient
     command = @command_builder.generate(command)
     error = nil
     result = ensure_connected do |connection|
-      Middlewares.call(command, config) do
+      @middlewares.call(command, config) do
         connection.call(command, timeout)
       end
     rescue ReadTimeoutError => error
@@ -346,7 +348,7 @@ class RedisClient
     else
       results = ensure_connected(retryable: pipeline._retryable?) do |connection|
         commands = pipeline._commands
-        Middlewares.call_pipelined(commands, config) do
+        @middlewares.call_pipelined(commands, config) do
           connection.call_pipelined(commands, pipeline._timeouts)
         end
       end
@@ -366,7 +368,7 @@ class RedisClient
         begin
           if transaction = build_transaction(&block)
             commands = transaction._commands
-            results = Middlewares.call_pipelined(commands, config) do
+            results = @middlewares.call_pipelined(commands, config) do
               connection.call_pipelined(commands, nil)
             end.last
           else
@@ -385,7 +387,7 @@ class RedisClient
       else
         ensure_connected(retryable: transaction._retryable?) do |connection|
           commands = transaction._commands
-          Middlewares.call_pipelined(commands, config) do
+          @middlewares.call_pipelined(commands, config) do
             connection.call_pipelined(commands, nil)
           end.last
         end
@@ -416,7 +418,7 @@ class RedisClient
     end
 
     def close
-      raw_connection&.close
+      @raw_connection&.close
       @raw_connection = nil
       self
     end
@@ -597,6 +599,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 +618,6 @@ class RedisClient
           connection
         end
       rescue ConnectionError, ProtocolError => error
-        connection&.close
         close
 
         if !@disable_reconnection && config.retry_connecting?(tries, error)
@@ -631,7 +634,6 @@ class RedisClient
         @disable_reconnection = true
         yield connection
       rescue ConnectionError, ProtocolError
-        connection&.close
         close
         raise
       ensure
@@ -646,7 +648,9 @@ class RedisClient
   end
 
   def connect
-    connection = Middlewares.connect(config) do
+    @pid = Process.pid
+
+    connection = @middlewares.connect(config) do
       config.driver.new(
         config,
         connect_timeout: connect_timeout,
@@ -664,13 +668,13 @@ class RedisClient
     # The connection prelude is deliberately not sent to Middlewares
     if config.sentinel?
       prelude << ["ROLE"]
-      role, = Middlewares.call_pipelined(prelude, config) do
+      role, = @middlewares.call_pipelined(prelude, config) do
         connection.call_pipelined(prelude, nil).last
       end
       config.check_role!(role)
     else
       unless prelude.empty?
-        Middlewares.call_pipelined(prelude, config) do
+        @middlewares.call_pipelined(prelude, config) do
           connection.call_pipelined(prelude, nil)
         end
       end

metadata

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