redis-client 0.26.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f265ac0d87bb764ab0e577f3ef0440b155de0ba2d88d44469167a634eebd03bb
-  data.tar.gz: 6edcf258e079c1123587e2f670793bd64dd38ada6116c31ddf992a328f015ecd
+  metadata.gz: 532a6809e653318f469cf8aa5d3ed07498dd15b0557cea4449acde840f1c45ab
+  data.tar.gz: 8fef3135440099474344a957096db4ec1cc0d058e7e7ed80227282b37752ffd1
 SHA512:
-  metadata.gz: dfd46c41eca304f6b438da604089e51719239c0e72a3658a464c1f769fa14b005415e105cc2765a98f3e708b41fa39073ed5d982539fa58a465f391c7f3d40fd
-  data.tar.gz: 2b2180f10bf25af818729ccce4724d378a03cb009361fb76c5b704c0171ca19c66766878e375f5f4e483f1b604c3e5ff8ca29ffe7495aa15ca0b2c3f5a4c0b7e
+  metadata.gz: b9a13cf5d2bed374fec9ad8d4cf92e2c3dda1b4aea9ea03180144b83ac7115daf4e5252c5c78b3dfbc4cf69eba7c0a79d5cc021a608d544d982c7165e2d77f18
+  data.tar.gz: 21c1b9828143c1edaba52f5359f15ac887ef8070fe3948ec893a63ad3800ba4612379985673beaa39dc6143fa0c39f18f7e1dab20beded463b748c752d8627aa

data/CHANGELOG.md

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

data/lib/redis_client/config.rb

@@ -186,7 +186,7 @@ class RedisClient
 
     include Common
 
-    attr_reader :host, :port, :path
+    attr_reader :host, :port, :path, :server_key
 
     def initialize(
       url: nil,
@@ -220,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

@@ -3,10 +3,13 @@
 class RedisClient
   module ConnectionMixin
     attr_accessor :retry_attempt
+    attr_reader :config
 
-    def initialize
+    def initialize(config)
       @pending_reads = 0
       @retry_attempt = nil
+      @config = config
+      @server_key = nil
     end
 
     def reconnect
@@ -20,7 +23,7 @@ class RedisClient
     end
 
     def revalidate
-      if @pending_reads > 0
+      if @pending_reads > 0 || @server_key != @config.server_key
         close
         false
       else
@@ -89,7 +92,9 @@ class RedisClient
     end
 
     def protocol_error(message)
-      ProtocolError.with_config(message, config)
+      error = ProtocolError.with_config(message, config)
+      error._set_retry_attempt(@retry_attempt)
+      error
     end
 
     def connection_error(message)

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
@@ -76,6 +73,10 @@ class RedisClient
         @io.write(buffer)
       rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
         raise connection_error(error.message)
+      rescue Error => error
+        error._set_config(config)
+        error._set_retry_attempt(@retry_attempt)
+        raise error
       end
     end
 
@@ -97,8 +98,8 @@ 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 connection_error(error.message)
     end
@@ -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.26.0"
+  VERSION = "0.26.1"
 end

data/lib/redis_client.rb

@@ -117,6 +117,23 @@ class RedisClient
     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
@@ -161,6 +178,7 @@ class RedisClient
   class CommandError < Error
     include HasCommand
     include HasCode
+    include Final
 
     class << self
       def parse(error_message)
@@ -231,6 +249,7 @@ class RedisClient
     @middlewares = config.middlewares_stack.new(self)
     @raw_connection = nil
     @disable_reconnection = false
+    @retry_attempt = nil
   end
 
   def inspect
@@ -736,8 +755,8 @@ class RedisClient
       connection = nil
       preferred_error = nil
       begin
+        @retry_attempt = config.retriable?(tries) ? tries : nil
         connection = raw_connection
-        connection.retry_attempt = config.retriable?(tries) ? tries : nil
         if block_given?
           yield connection
         else
@@ -780,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
@@ -800,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.26.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Jean Boussier