redis-client 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95dd96eda7210df59b85fafb8d2df5fa46cf0d3d2da10ad1ebf60137b8ec2652
-  data.tar.gz: d417951e19d9a20b7f96a2d4e520d433cd52c38209d8c46499ddfc0d6d4be941
+  metadata.gz: 7f28d878a923f684e1ddade2a735339dc7ae55d3091b3d21b812fcf1b232b8fe
+  data.tar.gz: 5cc874fa373695185c4b5f040e8368be66550596838faadab8b3e57e45f8c0b0
 SHA512:
-  metadata.gz: 0dd66a81c969a08abbb89140187e6a3a31aadcb258845082bf84bba792304ebc3d27852635fa4519805139eeecb7f405033b2b0c6acc4d39f7823873cd91dbdc
-  data.tar.gz: 4a9f5b79ffc8d195a3fac2cd439750d43124bb78583eef840564262d25565b2e585d8d77eb3f9d2096ec938fa4db7fe7a775c5ba5f80c4e2bd91f2b121901a98
+  metadata.gz: ba5313f360e675d1e751f6c5138290facab7e3ea043d5328b14556050ceb44155947ad670077e22b1fb04b2aa5738a6d6b77454b5d31e0a4641c1e705f3ba545
+  data.tar.gz: 45463aae9b8d188cc5d1a2c0604962001bafcd266fb526fecb7ddee5081fbc28a9a5a27b8a09525b515d69266cf7740424a50408e62cf2361debe1ffb52b3d9e

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.11.0
+
+- hiredis: do not eagerly close the connection on read timeout, let the caller decide if a timeout is final.
+- Add `Config#custom` to store configuration metadata. It can be used for per server middleware configuration.
+
+# 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.9.0)
+    redis-client (0.11.0)
       connection_pool
 
 GEM
@@ -38,7 +38,7 @@ GEM
     rubocop-minitest (0.19.1)
       rubocop (>= 0.90, < 2.0)
     ruby-progressbar (1.11.0)
-    stackprof (0.2.21)
+    stackprof (0.2.22)
     toxiproxy (2.0.2)
     unicode-display_width (2.2.0)
 

data/README.md

@@ -82,6 +82,7 @@ redis.call("GET", "mykey")
 - `write_timeout`: The write timeout, takes precedence over the general timeout when sending commands to the server.
 - `reconnect_attempts`: Specify how many times the client should retry to send queries. Defaults to `0`. Makes sure to read the [reconnection section](#reconnection) before enabling it.
 - `protocol:` The version of the RESP protocol to use. Default to `3`.
+- `custom`: A user owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user specific metadatas.
 
 ### Sentinel support
 
@@ -343,12 +344,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,11 +363,38 @@ 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
+```
+
+If middlewares need a client specific configuration, `Config#custom` can be used
+
+```ruby
+module MyGlobalRedisInstrumentation
+  def connect(redis_config)
+    MyMonitoringService.instrument("redis.connect", tags: redis_config.custom[:tags]) { super }
+  end
+
+  def call(command, redis_config)
+    MyMonitoringService.instrument("redis.query", tags: redis_config.custom[:tags]) { super }
+  end
+
+  def call_pipelined(commands, redis_config)
+    MyMonitoringService.instrument("redis.pipeline", tags: redis_config.custom[:tags]) { super }
+  end
+end
+RedisClient.register(MyGlobalRedisInstrumentation)
+
+redis_config = RedisClient.config(custom: { tags: { "environment": Rails.env }})
+```
 ### Timeouts
 
 The client allows you to configure connect, read, and write timeouts.

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

@@ -13,7 +13,8 @@ class RedisClient
 
     module Common
       attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
-        :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol
+        :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol,
+        :middlewares_stack, :custom
 
       alias_method :ssl?, :ssl
 
@@ -27,13 +28,15 @@ class RedisClient
         write_timeout: timeout,
         connect_timeout: timeout,
         ssl: nil,
+        custom: {},
         ssl_params: nil,
         driver: nil,
         protocol: 3,
         client_implementation: RedisClient,
         command_builder: CommandBuilder,
         inherit_socket: false,
-        reconnect_attempts: false
+        reconnect_attempts: false,
+        middlewares: false
       )
         @username = username
         @password = password
@@ -48,6 +51,8 @@ class RedisClient
 
         @driver = driver ? RedisClient.driver(driver) : RedisClient.default_driver
 
+        @custom = custom
+
         @client_implementation = client_implementation
         @protocol = protocol
         unless protocol == 2 || protocol == 3
@@ -60,6 +65,15 @@ class RedisClient
         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.9.0"
+  VERSION = "0.11.0"
 end

data/lib/redis_client.rb

@@ -145,7 +145,7 @@ class RedisClient
     end
 
     def register(middleware)
-      Middlewares.extend(middleware)
+      Middlewares.include(middleware)
     end
   end
 
@@ -153,6 +153,7 @@ class RedisClient
 
   def initialize(config, **)
     super
+    @middlewares = config.middlewares_stack.new(self)
     @raw_connection = nil
     @disable_reconnection = false
   end
@@ -195,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
@@ -210,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
@@ -225,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
@@ -240,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
@@ -256,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
@@ -276,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
@@ -347,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
@@ -367,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
@@ -386,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
@@ -649,7 +650,7 @@ class RedisClient
   def connect
     @pid = Process.pid
 
-    connection = Middlewares.connect(config) do
+    connection = @middlewares.connect(config) do
       config.driver.new(
         config,
         connect_timeout: connect_timeout,
@@ -667,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.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool