redis-client 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27142ef61a44133a72e2a087afc39986ebcfe5fae30a7ee5f6eb3f702ef35ad2
-  data.tar.gz: f078880a52dec2f62d3b68188cfea8108ec433742f2f7e697def7a7bece332ac
+  metadata.gz: 7f28d878a923f684e1ddade2a735339dc7ae55d3091b3d21b812fcf1b232b8fe
+  data.tar.gz: 5cc874fa373695185c4b5f040e8368be66550596838faadab8b3e57e45f8c0b0
 SHA512:
-  metadata.gz: 76c7b23cb0ba419fdb9505e5cd4eb58c1c6d38d2e2fcd82778429b346dfa02a94ce4a9077c28252d8c71d1667cc45270bfc0790190e42b0d37341493bbb105f5
-  data.tar.gz: 071ec50fabaa72512101d0f408154e432e5f9950927607d8d6bcf8c7f3d5d4c9f49f40de3a24aa6957019751a598b70ae9db525002c03d7beb05312fc082e053
+  metadata.gz: ba5313f360e675d1e751f6c5138290facab7e3ea043d5328b14556050ceb44155947ad670077e22b1fb04b2aa5738a6d6b77454b5d31e0a4641c1e705f3ba545
+  data.tar.gz: 45463aae9b8d188cc5d1a2c0604962001bafcd266fb526fecb7ddee5081fbc28a9a5a27b8a09525b515d69266cf7740424a50408e62cf2361debe1ffb52b3d9e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.10.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
 
@@ -374,6 +375,26 @@ 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/lib/redis_client/config.rb

@@ -14,7 +14,7 @@ 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,
-        :middlewares_stack
+        :middlewares_stack, :custom
 
       alias_method :ssl?, :ssl
 
@@ -28,6 +28,7 @@ class RedisClient
         write_timeout: timeout,
         connect_timeout: timeout,
         ssl: nil,
+        custom: {},
         ssl_params: nil,
         driver: nil,
         protocol: 3,
@@ -50,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

data/lib/redis_client/version.rb

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

metadata

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