redis-client 0.26.2 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f75c9f8b8e4542079642b30d284bd0fbda23d27249e7846bc65c0b002ce61732
-  data.tar.gz: cdc1d818e27551467b14e53692b5e61da762d1f21de78be00d6650830fdb9d13
+  metadata.gz: 2fc78ecaeaed568c9917391585a7a185c90f8d7d569b8443c0fb2f0e918c2ca6
+  data.tar.gz: f9c7cbcb9c39267853681e926a71c27c3619bf0683fa5cd86885c585f2dfa239
 SHA512:
-  metadata.gz: 15d23f1645fc7bc86c3f58ff0bfebcce62a3aec4783fd5434123277c0445a8d7553fea6f7fc89a36c23c433d7fcd5716b88a79d5131d3a3452d58707e61b965d
-  data.tar.gz: 7447f4f33e056072445d5d0dad650f3e648af69f1a0690505cb6913d525c32b29f5954349e0ca4852b3bd8d47434ada0e8e1ffde09f8966a664cff08acc5a443
+  metadata.gz: 3738437f5876f4f8c09f82a19e4e75462779dae006ed37ac06d3d0ca997bb0190fc676b705e5f6186a5854caff4d98dddc8b035c0fbaa854f9d77b179cb01c94
+  data.tar.gz: 4f9788a5547647cee34ddf01f60400e9645ca2c73f5329155b58670019733ec945331674f94b5a7720754ea2dd12b85d62040060166145beaea9b462514e6500

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Unreleased
 
+# 0.28.0
+
+- Added `RedisClient::HashRing` for horizontal sharing (compatible with `Redis::Distributed` from `redis-rb`).
+
+# 0.27.0
+
+- Added `idle_timeout` to revalidate connections that haven't been successfuly used in a long time. Defaults to 30 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:` parameter.
+- Fix compatibility with `redis-rb` in sentinel mode.
+
+# 0.26.3
+
+- Fix `rediss://` (ssl) URLs used with Redis sentinel.
+- Handle Ruby 4.0 connection timeout raising an `IO::Timeout` instead of `Errno::ETIMEDOUT`.
+- Entirely close the connection on authentication failures.
+
 # 0.26.2
 
 - Fix compatibility with `connection_pool` version 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 `30` 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`.
@@ -143,6 +144,31 @@ redis_config = RedisClient.sentinel(name: 'mymaster', sentinel_username: 'appuse
 If you specify a username and/or password at the top level for your main Redis instance, Sentinel *will not* using thouse credentials
 
 ```ruby
+
+### Consistent Hashing
+
+To horizontally shard keys across multiple servers without relying on clustering, a `RedisClient::HashRing` class is provided:
+
+```ruby
+ring = RedisClient.ring(
+  RedisClient.config(host: "10.0.1.1", port: 6380).new_pool(timeout: 0.5, size: 3),
+  RedisClient.config(host: "10.0.1.2", port: 6380).new_pool(timeout: 0.5, size: 3),
+  RedisClient.config(host: "10.0.1.3", port: 6380).new_pool(timeout: 0.5, size: 3),
+)
+
+ring.node_for("cache_key").call("GET", "cache_key") # => "value"
+
+ring.nodes_for("key1", "key2", "key3").each do |node, keys|
+  node.call("DEL", *keys)
+end
+
+ring.nodes.each do |node|
+  node.close
+end
+```
+
+Note that regular clients do respond to `node_for`, `nodes_for` and `nodes`, so that code that support `RedisClient.ring` is also usable with a single server.
+
 # Use 'mysecret' to authenticate against the mymaster instance, but skip authentication for the sentinels:
 SENTINELS = [{ host: '127.0.0.1', port: 26380 },
              { host: '127.0.0.1', port: 26381 }]

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'zlib'
+
+class RedisClient
+  class HashRing
+    POINTS_PER_SERVER = 160
+
+    class << self
+      attr_writer :digest
+
+      def digest
+        @digest ||= begin
+          require 'digest/md5'
+          Digest::MD5
+        end
+      end
+    end
+
+    attr_reader :nodes
+
+    def initialize(nodes = [], replicas: POINTS_PER_SERVER, digest: self.class.digest)
+      @replicas = replicas
+      @ring = {}
+      @digest = digest
+      ids = {}
+      @nodes = nodes.dup.freeze
+      nodes.each do |node|
+        id = node.id || node.config.server_url
+        if ids[id]
+          raise ArgumentError, "duplicate node id: #{id.inspect}"
+        end
+
+        ids[id] = true
+
+        replicas.times do |i|
+          @ring[server_hash_for("#{id}:#{i}".freeze)] = node
+        end
+      end
+      @sorted_keys = @ring.keys
+      @sorted_keys.sort!
+    end
+
+    # get the node in the hash ring for this key
+    def node_for(key)
+      hash = hash_for(key)
+      idx = binary_search(@sorted_keys, hash)
+      @ring[@sorted_keys[idx]]
+    end
+
+    def nodes_for(*keys)
+      keys.flatten!
+      mapping = {}
+      keys.each do |key|
+        (mapping[node_for(key)] ||= []) << key
+      end
+      mapping
+    end
+
+    private
+
+    def hash_for(key)
+      Zlib.crc32(key)
+    end
+
+    def server_hash_for(key)
+      @digest.digest(key).unpack1("L>")
+    end
+
+    # Find the closest index in HashRing with value <= the given value
+    def binary_search(ary, value)
+      upper = ary.size
+      lower = 0
+
+      while lower < upper
+        mid = (lower + upper) / 2
+        if ary[mid] > value
+          upper = mid
+        else
+          lower = mid + 1
+        end
+      end
+
+      upper - 1
+    end
+  end
+end

data/lib/redis_client/ruby_connection.rb

@@ -156,7 +156,7 @@ class RedisClient
         write_timeout: @write_timeout,
       )
       true
-    rescue SystemCallError, OpenSSL::SSL::SSLError, SocketError => error
+    rescue SystemCallError, IOError, OpenSSL::SSL::SSLError, SocketError => error
       socket&.close
       raise CannotConnectError, error.message, error.backtrace
     end

data/lib/redis_client/sentinel_config.rb

@@ -22,12 +22,16 @@ class RedisClient
         raise ArgumentError, "Expected role to be either :master or :replica, got: #{role.inspect}"
       end
 
+      # Track whether SSL was explicitly provided by user
+      ssl_explicitly_set = client_config.key?(:ssl)
+
       if url
         url_config = URLConfig.new(url)
         client_config = {
           username: url_config.username,
           password: url_config.password,
           db: url_config.db,
+          ssl: url_config.ssl?,
         }.compact.merge(client_config)
         name ||= url_config.host
       end
@@ -66,6 +70,10 @@ class RedisClient
 
       client_config[:reconnect_attempts] ||= DEFAULT_RECONNECT_ATTEMPTS
       @client_config = client_config || {}
+      @sentinel_client_config = @client_config.dup
+      # Only remove SSL from sentinel config if it was derived from URL,
+      # not if explicitly set by user.
+      @sentinel_client_config.delete(:ssl) unless ssl_explicitly_set
       super(**client_config)
       @sentinel_configs = sentinels_to_configs(sentinels)
     end
@@ -133,9 +141,9 @@ class RedisClient
       sentinels.map do |sentinel|
         case sentinel
         when String
-          Config.new(**@client_config, **@extra_config, url: sentinel)
+          Config.new(**@sentinel_client_config, **@extra_config, url: sentinel)
         else
-          Config.new(**@client_config, **@extra_config, **sentinel)
+          Config.new(**@sentinel_client_config, **@extra_config, **sentinel)
         end
       end
     end
@@ -152,7 +160,7 @@ class RedisClient
 
     def resolve_master
       each_sentinel do |sentinel_client|
-        host, port = sentinel_client.call("SENTINEL", "get-master-addr-by-name", @name)
+        host, port = sentinel_client.call_v(["SENTINEL", "get-master-addr-by-name", @name])
         next unless host && port
 
         refresh_sentinels(sentinel_client)
@@ -171,7 +179,7 @@ class RedisClient
 
     def resolve_replica
       each_sentinel do |sentinel_client|
-        replicas = sentinel_client.call("SENTINEL", "replicas", @name, &@to_list_of_hash)
+        replicas = sentinel_client.call_v(["SENTINEL", "replicas", @name], &@to_list_of_hash)
         replicas.reject! do |r|
           flags = r["flags"].to_s.split(",")
           flags.include?("s_down") || flags.include?("o_down")
@@ -214,7 +222,7 @@ class RedisClient
     end
 
     def refresh_sentinels(sentinel_client)
-      sentinel_response = sentinel_client.call("SENTINEL", "sentinels", @name, &@to_list_of_hash)
+      sentinel_response = sentinel_client.call_v(["SENTINEL", "sentinels", @name], &@to_list_of_hash)
       sentinels = sentinel_response.map do |sentinel|
         { host: sentinel.fetch("ip"), port: Integer(sentinel.fetch("port")) }
       end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -61,7 +61,7 @@ class RedisClient
   end
 
   module Common
-    attr_reader :config, :id
+    attr_reader :config, :id, :nodes
     attr_accessor :connect_timeout, :read_timeout, :write_timeout
 
     def initialize(
@@ -78,11 +78,21 @@ class RedisClient
       @write_timeout = write_timeout
       @command_builder = config.command_builder
       @pid = PIDCache.pid
+      @nodes = [self].freeze
     end
 
     def timeout=(timeout)
       @connect_timeout = @read_timeout = @write_timeout = timeout
     end
+
+    def node_for(_key)
+      self
+    end
+
+    def nodes_for(*keys)
+      keys.flatten!
+      { self => keys }
+    end
   end
 
   module HasConfig
@@ -229,6 +239,12 @@ class RedisClient
       SentinelConfig.new(client_implementation: self, **kwargs)
     end
 
+    def ring(*clients, **options)
+      clients.flatten!
+      require "redis_client/hash_ring" unless defined?(HashRing)
+      HashRing.new(clients, **options)
+    end
+
     def new(arg = nil, **kwargs)
       if arg.is_a?(Config::Common)
         super
@@ -269,6 +285,10 @@ class RedisClient
     config.read_timeout
   end
 
+  def idle_timeout
+    config.idle_timeout
+  end
+
   def db
     config.db
   end
@@ -758,7 +778,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 +807,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 +823,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 +854,7 @@ class RedisClient
         )
       end
     end
+    @last_used_at = RedisClient.now
     @raw_connection.retry_attempt = @retry_attempt
 
     prelude = config.connection_prelude.dup
@@ -843,16 +878,22 @@ class RedisClient
       end
     end
   rescue FailoverError, CannotConnectError => error
+    @raw_connection&.close
     error._set_config(config)
     raise error
   rescue ConnectionError => error
+    @raw_connection&.close
     connect_error = CannotConnectError.with_config(error.message, config)
     connect_error.set_backtrace(error.backtrace)
     raise connect_error
   rescue CommandError => error
+    @raw_connection&.close
     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.2
+  version: 0.28.0
 platform: ruby
 authors:
 - Jean Boussier
@@ -39,6 +39,7 @@ files:
 - lib/redis_client/config.rb
 - lib/redis_client/connection_mixin.rb
 - lib/redis_client/decorator.rb
+- lib/redis_client/hash_ring.rb
 - lib/redis_client/middlewares.rb
 - lib/redis_client/pid_cache.rb
 - lib/redis_client/pooled.rb
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []