redis-client 0.26.4 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154a0c259fc2b3ccd21836d769541db74daef95be9d2e235a36c15b8b6d68d3b
-  data.tar.gz: 5f27693c2903da092547ad8f4362a1573e8527d9ef38266074c389574523971b
+  metadata.gz: 286c927e4067dd45e1fcee65daab6e11af6d3b4d79604e1fc0b2a7a930f75201
+  data.tar.gz: 899fab7bb4ce71f7bbf68ce00f9a008816690ff0ea8302b92edc2333a478d9e3
 SHA512:
-  metadata.gz: ca23aa033f2142cd608cf6197a35b0e32c89f1240344853be148b9eefbec330bbf1a8507277c822482455a8e7198abec888ce73c1f842382d5ebc826c417c5d2
-  data.tar.gz: e5f2086185d04e12462dc176a3c90084d7a7b04c520f906dcdb6024a1a42a6d7b418d5c94951628062a746ed0a0426add0970d877587f6b3d25843baf2c0a780
+  metadata.gz: 4c900ff2f7bea9662273bcb0666c78a44adb6c7b34fa1d7e10d5d56cac6e2f868de8811d769f42ea52a8b70304cacf650dea7aadcc31b3ee88a4eb2dfc6f28bc
+  data.tar.gz: fa6093d8d2101a120164f6d86857343d84cc69c077290ce6b41b80626918165045190ae3a004e8defc1f61c5fc72c623d0acf121a3b2efe32a4d14fb71787f74

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Unreleased
 
+# 0.27.0
+
+- Added `idle_timeout` to revalidate connections that haven't been successfuly used in a long time. Defaults to 60 seconds.
+- Added `driver_info` configuration, to issue `CLIENT SETINFO` during connection prelude.
+
 # 0.26.4
 
-- Further improve `rediss://` URLs used with Redis sentinel. Now avoid override explictly set `ssl:` paramter.
+- Further improve `rediss://` URLs used with Redis sentinel. Now avoid override explictly set `ssl:` parameter.
 - Fix compatibility with `redis-rb` in sentinel mode.
 
 # 0.26.3

data/README.md

@@ -83,6 +83,7 @@ redis.call("GET", "mykey")
 - `connect_timeout`: The connection timeout, takes precedence over the general timeout when connecting to the server.
 - `read_timeout`: The read timeout, takes precedence over the general timeout when reading responses from the server.
 - `write_timeout`: The write timeout, takes precedence over the general timeout when sending commands to the server.
+- `idle_timeout`: Amount of time after which an idle connection has to be revalidated with a PING command. Defaults to `60` seconds.
 - `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.
 - `circuit_breaker`: A Hash with circuit breaker configuration. Defaults to `nil`. See the [circuit breaker section](#circuit-breaker) for details.
 - `protocol:` The version of the RESP protocol to use. Default to `3`.

data/lib/redis_client/config.rb

@@ -10,11 +10,12 @@ class RedisClient
     DEFAULT_PORT = 6379
     DEFAULT_USERNAME = "default"
     DEFAULT_DB = 0
+    DEFAULT_IDLE_TIMEOUT = 30.0
 
     module Common
       attr_reader :db, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
         :connect_timeout, :read_timeout, :write_timeout, :driver, :protocol,
-        :middlewares_stack, :custom, :circuit_breaker
+        :middlewares_stack, :custom, :circuit_breaker, :driver_info, :idle_timeout
 
       alias_method :ssl?, :ssl
 
@@ -27,6 +28,7 @@ class RedisClient
         read_timeout: timeout,
         write_timeout: timeout,
         connect_timeout: timeout,
+        idle_timeout: DEFAULT_IDLE_TIMEOUT,
         ssl: nil,
         custom: {},
         ssl_params: nil,
@@ -37,7 +39,8 @@ class RedisClient
         inherit_socket: false,
         reconnect_attempts: false,
         middlewares: false,
-        circuit_breaker: nil
+        circuit_breaker: nil,
+        driver_info: nil
       )
         @username = username
         @password = password && !password.respond_to?(:call) ? ->(_) { password } : password
@@ -54,6 +57,7 @@ class RedisClient
         @connect_timeout = connect_timeout
         @read_timeout = read_timeout
         @write_timeout = write_timeout
+        @idle_timeout = idle_timeout
 
         @driver = driver ? RedisClient.driver(driver) : RedisClient.default_driver
 
@@ -84,6 +88,8 @@ class RedisClient
           end
         end
         @middlewares_stack = middlewares_stack
+
+        @driver_info = driver_info
       end
 
       def connection_prelude
@@ -107,6 +113,13 @@ class RedisClient
           prelude << ["SELECT", @db.to_s]
         end
 
+        # Add CLIENT SETINFO commands for lib-name and lib-ver
+        # These commands are supported in Redis 7.2+
+        if @driver_info
+          prelude << ["CLIENT", "SETINFO", "LIB-NAME", build_lib_name]
+          prelude << ["CLIENT", "SETINFO", "LIB-VER", RedisClient::VERSION]
+        end
+
         # Deep freeze all the strings and commands
         prelude.map! do |commands|
           commands = commands.map { |str| str.frozen? ? str : str.dup.freeze }
@@ -123,6 +136,25 @@ class RedisClient
         @username || DEFAULT_USERNAME
       end
 
+      # Build the library name for CLIENT SETINFO LIB-NAME.
+      #
+      # @param driver_info [String, Array<String>, nil] Upstream driver info
+      # @return [String] Library name with optional upstream driver info
+      # @raise [ArgumentError] if driver_info is not a String or Array
+      def build_lib_name
+        return "redis-client" if @driver_info.nil?
+
+        info = case @driver_info
+        when String then @driver_info
+        when Array then @driver_info.join(";")
+               else raise ArgumentError, "driver_info must be a String or Array of Strings"
+        end
+
+        return "redis-client" if info.empty?
+
+        "redis-client(#{info})"
+      end
+
       def resolved?
         true
       end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -269,6 +269,10 @@ class RedisClient
     config.read_timeout
   end
 
+  def idle_timeout
+    config.idle_timeout
+  end
+
   def db
     config.db
   end
@@ -758,7 +762,9 @@ class RedisClient
         @retry_attempt = config.retriable?(tries) ? tries : nil
         connection = raw_connection
         if block_given?
-          yield connection
+          result = yield connection
+          @last_used_at = RedisClient.now
+          result
         else
           connection
         end
@@ -785,7 +791,9 @@ class RedisClient
       begin
         @disable_reconnection = true
         @raw_connection.retry_attempt = nil
-        yield connection
+        result = yield connection
+        @last_used_at = RedisClient.now
+        result
       rescue ConnectionError, ProtocolError
         close
         raise
@@ -799,6 +807,16 @@ class RedisClient
     if @raw_connection.nil? || !@raw_connection.revalidate
       connect
     end
+
+    if config.idle_timeout && (@last_used_at + config.idle_timeout) < RedisClient.now
+      @middlewares.call(["PING"], config) do
+        @raw_connection.call(["PING"], nil)
+      rescue ConnectionError, ProtocolError
+        close
+        connect
+      end
+    end
+
     @raw_connection.retry_attempt = @retry_attempt
     @raw_connection
   end
@@ -820,6 +838,7 @@ class RedisClient
         )
       end
     end
+    @last_used_at = RedisClient.now
     @raw_connection.retry_attempt = @retry_attempt
 
     prelude = config.connection_prelude.dup
@@ -856,6 +875,9 @@ class RedisClient
     if error.message.match?(/ERR unknown command ['`]HELLO['`]/)
       raise UnsupportedServer,
         "redis-client requires Redis 6+ with HELLO command available (#{config.server_url})"
+    # Ignore CLIENT SETINFO errors (Redis < 7.2 doesn't support it)
+    elsif error.message.match?(/unknown subcommand.*setinfo/i)
+      # Silently ignore - CLIENT SETINFO is not supported on Redis < 7.2
     else
       raise
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.26.4
+  version: 0.27.0
 platform: ruby
 authors:
 - Jean Boussier