Merge pull request #1210 from casperisfine/redis-client-0.15

Fix compatibility with `redis-client 0.15.0` when using Redis Sentinel
redis · Aug 9, 2023 · f7dfa6b · f7dfa6b
2 parents f21cbca + ef8817e
commit f7dfa6b
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Unreleased
 
+- Fix compatibility with `redis-client 0.15.0` when using Redis Sentinel. Fix #1209.
+
 # 5.0.6
 
 - Wait for an extra `config.read_timeout` in blocking commands rather than an arbitrary 100ms. See #1175.

diff --git a/lib/redis.rb b/lib/redis.rb
@@ -166,6 +166,8 @@ def send_command(command, &block)
     @monitor.synchronize do
       @client.call_v(command, &block)
     end
+  rescue ::RedisClient::Error => error
+    Client.translate_error!(error)
   end
 
   def send_blocking_command(command, timeout, &block)

diff --git a/lib/redis/client.rb b/lib/redis/client.rb
@@ -24,7 +24,24 @@ def config(**kwargs)
       end
 
       def sentinel(**kwargs)
-        super(protocol: 2, **kwargs)
+        super(protocol: 2, **kwargs, client_implementation: ::RedisClient)
+      end
+
+      def translate_error!(error)
+        redis_error = translate_error_class(error.class)
+        raise redis_error, error.message, error.backtrace
+      end
+
+      private
+
+      def translate_error_class(error_class)
+        ERROR_MAPPING.fetch(error_class)
+      rescue IndexError
+        if (client_error = error_class.ancestors.find { |a| ERROR_MAPPING[a] })
+          ERROR_MAPPING[error_class] = ERROR_MAPPING[client_error]
+        else
+          raise
+        end
       end
     end
 
@@ -72,7 +89,7 @@ def password
     def call_v(command, &block)
       super(command, &block)
     rescue ::RedisClient::Error => error
-      translate_error!(error)
+      Client.translate_error!(error)
     end
 
     def blocking_call_v(timeout, command, &block)
@@ -85,19 +102,19 @@ def blocking_call_v(timeout, command, &block)
 
       super(timeout, command, &block)
     rescue ::RedisClient::Error => error
-      translate_error!(error)
+      Client.translate_error!(error)
     end
 
     def pipelined
       super
     rescue ::RedisClient::Error => error
-      translate_error!(error)
+      Client.translate_error!(error)
     end
 
     def multi
       super
     rescue ::RedisClient::Error => error
-      translate_error!(error)
+      Client.translate_error!(error)
     end
 
     def disable_reconnection(&block)
@@ -107,22 +124,5 @@ def disable_reconnection(&block)
     def inherit_socket!
       @inherit_socket = true
     end
-
-    private
-
-    def translate_error!(error)
-      redis_error = translate_error_class(error.class)
-      raise redis_error, error.message, error.backtrace
-    end
-
-    def translate_error_class(error_class)
-      ERROR_MAPPING.fetch(error_class)
-    rescue IndexError
-      if (client_error = error_class.ancestors.find { |a| ERROR_MAPPING[a] })
-        ERROR_MAPPING[error_class] = ERROR_MAPPING[client_error]
-      else
-        raise
-      end
-    end
   end
 end
diff --git a/test/redis/client_test.rb b/test/redis/client_test.rb
@@ -28,10 +28,10 @@ def test_call_raise
 
   def test_error_translate_subclasses
     error = Class.new(RedisClient::CommandError)
-    assert_equal Redis::CommandError, r._client.send(:translate_error_class, error)
+    assert_equal Redis::CommandError, Redis::Client.send(:translate_error_class, error)
 
     assert_raises KeyError do
-      r._client.send(:translate_error_class, StandardError)
+      Redis::Client.send(:translate_error_class, StandardError)
     end
   end
 

diff --git a/test/sentinel/sentinel_test.rb b/test/sentinel/sentinel_test.rb
@@ -197,7 +197,7 @@ def test_sentinel_with_non_sentinel_options
       end
     end
 
-    assert_equal [%w[get-master-addr-by-name master1], ["sentinels", "master1"]], commands[:s1]
+    assert_equal [%w[auth foo], %w[get-master-addr-by-name master1], ["sentinels", "master1"]], commands[:s1]
     assert_equal [%w[auth foo], %w[role]], commands[:m1]
   end
 
@@ -409,12 +409,15 @@ def test_sentinel_retries
 
     connections = []
 
+    fails = Hash.new(0)
+
     handler = lambda do |id, port|
       {
         sentinel: lambda do |command, *_args|
           connections << id
 
-          if connections.count(id) < 2
+          if fails[id] < 2
+            fails[id] += 1
             :close
           else
             case command
@@ -451,9 +454,10 @@ def test_sentinel_retries
       end
     end
 
-    assert_equal %i[s1 s2 s1 s1], connections
+    assert_equal %i[s1 s1 s2 s2 s1 s1], connections
 
     connections.clear
+    fails.clear
 
     ex = assert_raises(Redis::CannotConnectError) do
       RedisMock.start(master) do |master_port|