redis-client 0.26.4 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154a0c259fc2b3ccd21836d769541db74daef95be9d2e235a36c15b8b6d68d3b
-  data.tar.gz: 5f27693c2903da092547ad8f4362a1573e8527d9ef38266074c389574523971b
+  metadata.gz: dc26284bc8ddd661e51d52ecf7afcf6d853b566128baa4176908eed4ed7e6ce2
+  data.tar.gz: 4051332c5b82220c88cb43efc0257e6dc61cba6b2c61ace4429d197591ecbd53
 SHA512:
-  metadata.gz: ca23aa033f2142cd608cf6197a35b0e32c89f1240344853be148b9eefbec330bbf1a8507277c822482455a8e7198abec888ce73c1f842382d5ebc826c417c5d2
-  data.tar.gz: e5f2086185d04e12462dc176a3c90084d7a7b04c520f906dcdb6024a1a42a6d7b418d5c94951628062a746ed0a0426add0970d877587f6b3d25843baf2c0a780
+  metadata.gz: 7f200a254286ae8c63dd708f4cc1d945b33a8ec96e5466de8b6fe966ddb2ebdca727cb532d817a05021eabdba9809eb2450a0ad31dfc24e39ae2e4473ca9a36a
+  data.tar.gz: 192f624ea10bf819f8d4f98d980861b945cbe5fad8a079dbb0ed247d031b70646eb16cf9a34eb9f0b7b80abb7eee191a3b006bc46a7b0ac8d7b9a9924ee00d1a

data/CHANGELOG.md

@@ -1,8 +1,22 @@
 # Unreleased
 
+# 0.29.0
+
+- Fix connecting to Redis 7.1 and older with `driver_info:`set.
+- Added `RedisClient::Error#next_error` for an easier way to check all errors produced by a pipeline.
+
+# 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:` 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 `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,7 @@ 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
+
 # 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 }]
@@ -166,6 +168,30 @@ Also the `name`, `password`, `username` and `db` for Redis instance can be passe
 redis_config = RedisClient.sentinel(url: "redis://appuser:mysecret@mymaster/10", sentinels: SENTINELS, role: :master)
 ```
 
+### 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.
+
 ### Type support
 
 Only a select few Ruby types are supported as arguments beside strings.
@@ -335,7 +361,11 @@ end
 
 #### Exception management
 
-The `exception` flag in the `#pipelined` method of `RedisClient` is a feature that modifies the pipeline execution
+By default, when a pipeline produce multiple command errors, only the first encountered error is raised.
+
+However, the raised exception have a `.next_error` method you can use like a linked list to check all encountered errors.
+
+Alternatively, the `exception` flag in the `#pipelined` method of `RedisClient` is a feature that modifies the pipeline execution
 behavior. When set to `false`, it doesn't raise an exception when a command error occurs. Instead, it allows the
 pipeline to execute all commands, and any failed command will be available in the returned array. (Defaults to `true`)
 

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

@@ -47,7 +47,7 @@ class RedisClient
     end
 
     def call_pipelined(commands, timeouts, exception: true)
-      first_exception = nil
+      first_error = last_error = nil
 
       size = commands.size
       results = Array.new(commands.size)
@@ -69,14 +69,16 @@ class RedisClient
           result._set_command(commands[index])
           result._set_config(config)
           result._set_retry_attempt(@retry_attempt)
-          first_exception ||= result
+
+          last_error&._set_next_error(result)
+          first_error ||= last_error = result
         end
 
         results[index] = result
       end
 
-      if first_exception && exception
-        raise first_exception
+      if first_error && exception
+        raise first_error
       else
         results
       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/sentinel_config.rb

@@ -116,6 +116,10 @@ class RedisClient
     end
 
     def check_role!(role)
+      unless role.is_a?(String)
+        raise TypeError, "Expected role to be a string, got: #{role.inspect}"
+      end
+
       if @role == :master
         unless role == "master"
           sleep SENTINEL_DELAY

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.26.4"
+  VERSION = "0.29.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
@@ -138,11 +148,17 @@ class RedisClient
     include HasConfig
     include Retriable
 
+    attr_reader :next_error
+
     def self.with_config(message, config = nil)
       error = new(message)
       error._set_config(config)
       error
     end
+
+    def _set_next_error(error) # :nodoc:
+      @next_error = error
+    end
   end
 
   ProtocolError = Class.new(Error)
@@ -229,6 +245,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 +291,10 @@ class RedisClient
     config.read_timeout
   end
 
+  def idle_timeout
+    config.idle_timeout
+  end
+
   def db
     config.db
   end
@@ -758,7 +784,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 +813,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 +829,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 +860,7 @@ class RedisClient
         )
       end
     end
+    @last_used_at = RedisClient.now
     @raw_connection.retry_attempt = @retry_attempt
 
     prelude = config.connection_prelude.dup
@@ -828,19 +869,26 @@ class RedisClient
       prelude << ["CLIENT", "SETNAME", id]
     end
 
-    # The connection prelude is deliberately not sent to Middlewares
     if config.sentinel?
       prelude << ["ROLE"]
-      role, = @middlewares.call_pipelined(prelude, config) do
-        @raw_connection.call_pipelined(prelude, nil).last
+    end
+
+    unless prelude.empty?
+      results = @middlewares.call_pipelined(prelude, config) do
+        @raw_connection.call_pipelined(prelude, nil, exception: false)
       end
-      config.check_role!(role)
-    else
-      unless prelude.empty?
-        @middlewares.call_pipelined(prelude, config) do
-          @raw_connection.call_pipelined(prelude, nil)
+
+      results.each do |result|
+        # CLIENT SETINFO is unsupported on Redis < 7.2. The pipeline drained all responses before raising,
+        # so if that's the only error, the socket is healthy: keep it.
+        if result.is_a?(CommandError) && !(result.command[0] == "CLIENT" && result.command[1] == "SETINFO")
+          raise result
         end
       end
+
+      if config.sentinel?
+        config.check_role!(results.last.first)
+      end
     end
   rescue FailoverError, CannotConnectError => error
     @raw_connection&.close
@@ -853,9 +901,10 @@ class RedisClient
     raise connect_error
   rescue CommandError => error
     @raw_connection&.close
-    if error.message.match?(/ERR unknown command ['`]HELLO['`]/)
+
+    if error.command&.first == "HELLO" && error.message.match?(/ERR unknown command/)
       raise UnsupportedServer,
-        "redis-client requires Redis 6+ with HELLO command available (#{config.server_url})"
+        "redis-client requires Redis 6+ with HELLO command available (#{config.server_url})", cause: error
     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.29.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: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []