redis-client 0.25.3 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9d414e733ddfec002eb356535edebdca59f5dc95bb028ab9012ef7490708ef8
-  data.tar.gz: 829dd355a87f34c5dd94da685839be29cb23755c9eb420ee4fcf4faef557c741
+  metadata.gz: 532a6809e653318f469cf8aa5d3ed07498dd15b0557cea4449acde840f1c45ab
+  data.tar.gz: 8fef3135440099474344a957096db4ec1cc0d058e7e7ed80227282b37752ffd1
 SHA512:
-  metadata.gz: bbf68e7d8643165a1a7658a65774e0046e5c0e86338c91850f5c50292e3ba5bd2a8d9d4b124b95c722e5fb99844329bb8d1b42f4f5044c7f2e0db0a58f1f2add
-  data.tar.gz: 6416e379d6858466d93fae1861f446632cebe8bbdcda483add50c480f99856c1419d24a076fd12f76c921a9b5338850dc88b3bb30ab3edb683ba40935fd688bd
+  metadata.gz: b9a13cf5d2bed374fec9ad8d4cf92e2c3dda1b4aea9ea03180144b83ac7115daf4e5252c5c78b3dfbc4cf69eba7c0a79d5cc021a608d544d982c7165e2d77f18
+  data.tar.gz: 21c1b9828143c1edaba52f5359f15ac887ef8070fe3948ec893a63ad3800ba4612379985673beaa39dc6143fa0c39f18f7e1dab20beded463b748c752d8627aa

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Unreleased
 
+# 0.26.1
+
+- Fix a few corner cases where `RedisClient::Error#final?` was innacurate.
+- hiredis-client: Properly reconnect to the new leader after a sentinel failover.
+
+# 0.26.0
+
+- Add `RedisClient::Error#final?` and `#retriable?` to allow middleware to filter out non-final errors.
+- Fix precedence of `db: nil` initialization parameter.
+
+  ```ruby
+  Redis.new(url: "redis://localhost:6379/3", db: nil).db
+  ```
+
+  Before: `0`
+  After: `3`
+
 # 0.25.3
 
 - Fix `hiredis-client` compilation with `clang 21`.
@@ -205,7 +222,7 @@
 - Added `_v` versions of `call` methods to make it easier to pass commands as arrays without splating.
 - Fix calling `blocking_call` with a block in a pipeline.
 - `blocking_call` now raise `ReadTimeoutError` if the command didn't complete in time.
-- Fix `blocking_call` to not respect `retry_attempts` on timeout.
+- Fix `blocking_call` to not respect `reconnect_attempts` on timeout.
 - Stop parsing RESP3 sets as Ruby Set instances.
 - Fix `SystemStackError` when parsing very large hashes. Fix: #30
 - `hiredis` now more properly release the GVL when doing IOs.

data/README.md

@@ -459,6 +459,29 @@ RedisClient.register(MyGlobalRedisInstrumentation)
 
 redis_config = RedisClient.config(custom: { tags: { "environment": Rails.env }})
 ```
+
+### Instrumenting Errors
+
+It is important to note that when `reconnect_attempts` is enabled, all network errors are reported to the middlewares,
+even the ones that will be retried.
+
+In many cases you may want to ignore retriable errors, or report them differently:
+
+```ruby
+module MyGlobalRedisInstrumentation
+  def call(command, redis_config)
+    super
+  rescue RedisClient::Error => error
+    if error.final?
+      # Error won't be retried.
+    else
+      # Error will be retried.
+    end
+    raise
+  end
+end
+```
+
 ### Timeouts
 
 The client allows you to configure connect, read, and write timeouts.

data/lib/redis_client/config.rb

@@ -140,6 +140,10 @@ class RedisClient
         @client_implementation.new(self, **kwargs)
       end
 
+      def retriable?(attempt)
+        @reconnect_attempts && @reconnect_attempts[attempt]
+      end
+
       def retry_connecting?(attempt, _error)
         if @reconnect_attempts
           if (pause = @reconnect_attempts[attempt])
@@ -182,7 +186,7 @@ class RedisClient
 
     include Common
 
-    attr_reader :host, :port, :path
+    attr_reader :host, :port, :path, :server_key
 
     def initialize(
       url: nil,
@@ -191,14 +195,15 @@ class RedisClient
       path: nil,
       username: nil,
       password: nil,
+      db: nil,
       **kwargs
     )
       if url
         url_config = URLConfig.new(url)
         kwargs = {
           ssl: url_config.ssl?,
-          db: url_config.db,
         }.compact.merge(kwargs)
+        db ||= url_config.db
         host ||= url_config.host
         port ||= url_config.port
         path ||= url_config.path
@@ -206,7 +211,7 @@ class RedisClient
         password ||= url_config.password
       end
 
-      super(username: username, password: password, **kwargs)
+      super(username: username, password: password, db: db, **kwargs)
 
       if @path = path
         @host = nil
@@ -215,6 +220,8 @@ class RedisClient
         @host = host || DEFAULT_HOST
         @port = Integer(port || DEFAULT_PORT)
       end
+
+      @server_key = [@path, @host, @port].freeze
     end
   end
 end

data/lib/redis_client/connection_mixin.rb

@@ -2,8 +2,14 @@
 
 class RedisClient
   module ConnectionMixin
-    def initialize
+    attr_accessor :retry_attempt
+    attr_reader :config
+
+    def initialize(config)
       @pending_reads = 0
+      @retry_attempt = nil
+      @config = config
+      @server_key = nil
     end
 
     def reconnect
@@ -17,7 +23,7 @@ class RedisClient
     end
 
     def revalidate
-      if @pending_reads > 0
+      if @pending_reads > 0 || @server_key != @config.server_key
         close
         false
       else
@@ -33,6 +39,7 @@ class RedisClient
       if result.is_a?(Error)
         result._set_command(command)
         result._set_config(config)
+        result._set_retry_attempt(@retry_attempt)
         raise result
       else
         result
@@ -61,6 +68,7 @@ class RedisClient
         elsif result.is_a?(Error)
           result._set_command(commands[index])
           result._set_config(config)
+          result._set_retry_attempt(@retry_attempt)
           first_exception ||= result
         end
 
@@ -82,5 +90,17 @@ class RedisClient
       # to account for the network delay.
       timeout + config.read_timeout
     end
+
+    def protocol_error(message)
+      error = ProtocolError.with_config(message, config)
+      error._set_retry_attempt(@retry_attempt)
+      error
+    end
+
+    def connection_error(message)
+      error = ConnectionError.with_config(message, config)
+      error._set_retry_attempt(@retry_attempt)
+      error
+    end
   end
 end

data/lib/redis_client/ruby_connection.rb

@@ -40,11 +40,8 @@ class RedisClient
 
     SUPPORTS_RESOLV_TIMEOUT = Socket.method(:tcp).parameters.any? { |p| p.last == :resolv_timeout }
 
-    attr_reader :config
-
     def initialize(config, connect_timeout:, read_timeout:, write_timeout:)
-      super()
-      @config = config
+      super(config)
       @connect_timeout = connect_timeout
       @read_timeout = read_timeout
       @write_timeout = write_timeout
@@ -75,7 +72,11 @@ class RedisClient
       begin
         @io.write(buffer)
       rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
-        raise ConnectionError.with_config(error.message, config)
+        raise connection_error(error.message)
+      rescue Error => error
+        error._set_config(config)
+        error._set_retry_attempt(@retry_attempt)
+        raise error
       end
     end
 
@@ -87,7 +88,7 @@ class RedisClient
       begin
         @io.write(buffer)
       rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
-        raise ConnectionError.with_config(error.message, config)
+        raise connection_error(error.message)
       end
     end
 
@@ -97,10 +98,10 @@ class RedisClient
       else
         @io.with_timeout(timeout) { RESP3.load(@io) }
       end
-    rescue RedisClient::RESP3::UnknownType => error
-      raise RedisClient::ProtocolError.with_config(error.message, config)
+    rescue RedisClient::RESP3::Error => error
+      raise protocol_error(error.message)
     rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
-      raise ConnectionError.with_config(error.message, config)
+      raise connection_error(error.message)
     end
 
     def measure_round_trip_delay
@@ -112,6 +113,7 @@ class RedisClient
     private
 
     def connect
+      @server_key = @config.server_key
       socket = if @config.path
         UNIXSocket.new(@config.path)
       else

data/lib/redis_client/sentinel_config.rb

@@ -82,6 +82,10 @@ class RedisClient
       end
     end
 
+    def server_key
+      config.server_key
+    end
+
     def host
       config.host
     end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -99,13 +99,49 @@ class RedisClient
     end
   end
 
+  module Retriable
+    def _set_retry_attempt(retry_attempt)
+      @retry_attempt = retry_attempt
+    end
+
+    def retry_attempt
+      @retry_attempt || 0
+    end
+
+    def retriable?
+      !!@retry_attempt
+    end
+
+    def final?
+      !@retry_attempt
+    end
+  end
+
+  module Final
+    def _set_retry_attempt(_retry_attempt)
+    end
+
+    def retry_attempt
+      0
+    end
+
+    def retriable?
+      false
+    end
+
+    def final?
+      true
+    end
+  end
+
   class Error < StandardError
     include HasConfig
+    include Retriable
 
     def self.with_config(message, config = nil)
-      new(message).tap do |error|
-        error._set_config(config)
-      end
+      error = new(message)
+      error._set_config(config)
+      error
     end
   end
 
@@ -142,6 +178,7 @@ class RedisClient
   class CommandError < Error
     include HasCommand
     include HasCode
+    include Final
 
     class << self
       def parse(error_message)
@@ -212,6 +249,7 @@ class RedisClient
     @middlewares = config.middlewares_stack.new(self)
     @raw_connection = nil
     @disable_reconnection = false
+    @retry_attempt = nil
   end
 
   def inspect
@@ -706,6 +744,7 @@ class RedisClient
     close if !config.inherit_socket && @pid != PIDCache.pid
 
     if @disable_reconnection
+      @raw_connection.retry_attempt = nil
       if block_given?
         yield @raw_connection
       else
@@ -716,6 +755,7 @@ class RedisClient
       connection = nil
       preferred_error = nil
       begin
+        @retry_attempt = config.retriable?(tries) ? tries : nil
         connection = raw_connection
         if block_given?
           yield connection
@@ -744,6 +784,7 @@ class RedisClient
       connection = ensure_connected
       begin
         @disable_reconnection = true
+        @raw_connection.retry_attempt = nil
         yield connection
       rescue ConnectionError, ProtocolError
         close
@@ -758,13 +799,14 @@ class RedisClient
     if @raw_connection.nil? || !@raw_connection.revalidate
       connect
     end
+    @raw_connection.retry_attempt = @retry_attempt
     @raw_connection
   end
 
   def connect
     @pid = PIDCache.pid
 
-    if @raw_connection
+    if @raw_connection&.revalidate
       @middlewares.connect(config) do
         @raw_connection.reconnect
       end
@@ -778,6 +820,7 @@ class RedisClient
         )
       end
     end
+    @raw_connection.retry_attempt = @retry_attempt
 
     prelude = config.connection_prelude.dup
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.25.3
+  version: 0.26.1
 platform: ruby
 authors:
 - Jean Boussier
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []