redis-client 0.20.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154db13231ff43137f013f9ef224846201eabf5fef93059a5ed48206e558f238
-  data.tar.gz: 882208c7ad423619cc19cdc3c0b9ae02bd75e425bd702e29b1f2104896a4e0cc
+  metadata.gz: 4742ae57d2d4b4510921d37359540257a2e70ee0f9038276f40f95506ae2ffa0
+  data.tar.gz: cb3f9702abcd04ae46cfb5d59350884fb9bcff6f6d4990f1e6a0ae66fb6a1f4a
 SHA512:
-  metadata.gz: 6e3d3fa8d9684387519cdcc90a7c43319678defa957087902fdb2297ada820cbe746c7821126bcfbdc1f35877bb642382c7b5abebd4a227b2b60a24b8944b4f8
-  data.tar.gz: 40ceb06e68a8fabd9dd067ab177f5e6ca83b9af04e04b8f166bdc36e33ddd642190c400446e029c91b8416eb44f17aeb5cea950b06b7afc2daf6fa5514bef3f3
+  metadata.gz: 14212b26415dd02f6b23f2f729b9690bcf9bd06c156b60ffb5cb4b9061172a3c08f670242d2e6d391770c4abb9cfdd3bd79dfd8d039ae54a9e1537ea39dfd05f
+  data.tar.gz: d5b1276dffe3c3fb6220fb06b9e22fd1440bd7d83e19e37031019f98b69ab3ae5c13cbef8bcd036e1929008f764d9b5117451c9fcb07964b28d11cad14ac449e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Unreleased
 
+# 0.21.1
+
+- Handle unresolved Sentinel master/replica error when displaying server URL in exceptions. See #182.
+
+# 0.21.0
+
+- Include redis server URL in most error messages. See #178.
+- Close Redis Sentinel connection after resolving role. See #176.
+
 # 0.20.0
 
 - Accept `unix://` schemes as well as simple paths in the `url:` config parameter. #170.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.20.0)
+    redis-client (0.21.1)
       connection_pool
 
 GEM
@@ -15,7 +15,7 @@ GEM
     hiredis (0.6.3-java)
     json (2.7.1)
     json (2.7.1-java)
-    minitest (5.22.0)
+    minitest (5.22.3)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)

data/lib/redis_client/config.rb

@@ -91,6 +91,10 @@ class RedisClient
         @username || DEFAULT_USERNAME
       end
 
+      def resolved?
+        true
+      end
+
       def sentinel?
         false
       end
@@ -124,10 +128,17 @@ class RedisClient
 
       def server_url
         if path
-          "#{path}/#{db}"
+          url = "unix://#{path}"
+          if db != 0
+            url = "#{url}?db=#{db}"
+          end
         else
-          "redis#{'s' if ssl?}://#{host}:#{port}/#{db}"
+          url = "redis#{'s' if ssl?}://#{host}:#{port}"
+          if db != 0
+            url = "#{url}/#{db}"
+          end
         end
+        url
       end
 
       private

data/lib/redis_client/connection_mixin.rb

@@ -32,6 +32,7 @@ class RedisClient
       @pending_reads -= 1
       if result.is_a?(Error)
         result._set_command(command)
+        result._set_config(config)
         raise result
       else
         result
@@ -50,10 +51,19 @@ class RedisClient
         timeout = timeouts && timeouts[index]
         result = read(timeout)
         @pending_reads -= 1
-        if result.is_a?(Error)
+
+        # A multi/exec command can return an array of results.
+        # An error from a multi/exec command is handled in Multi#_coerce!.
+        if result.is_a?(Array)
+          result.each do |res|
+            res._set_config(config) if res.is_a?(Error)
+          end
+        elsif result.is_a?(Error)
           result._set_command(commands[index])
+          result._set_config(config)
           exception ||= result
         end
+
         results[index] = result
       end
 

data/lib/redis_client/ruby_connection.rb

@@ -40,6 +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
@@ -72,8 +74,8 @@ class RedisClient
       buffer = RESP3.dump(command)
       begin
         @io.write(buffer)
-      rescue SystemCallError, IOError => error
-        raise ConnectionError, error.message
+      rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
+        raise ConnectionError.with_config(error.message, config)
       end
     end
 
@@ -84,8 +86,8 @@ class RedisClient
       end
       begin
         @io.write(buffer)
-      rescue SystemCallError, IOError => error
-        raise ConnectionError, error.message
+      rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
+        raise ConnectionError.with_config(error.message, config)
       end
     end
 
@@ -96,9 +98,9 @@ class RedisClient
         @io.with_timeout(timeout) { RESP3.load(@io) }
       end
     rescue RedisClient::RESP3::UnknownType => error
-      raise RedisClient::ProtocolError, error.message
+      raise RedisClient::ProtocolError.with_config(error.message, config)
     rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
-      raise ConnectionError, error.message
+      raise ConnectionError.with_config(error.message, config)
     end
 
     def measure_round_trip_delay
@@ -130,9 +132,9 @@ class RedisClient
         loop do
           case status = socket.connect_nonblock(exception: false)
           when :wait_readable
-            socket.to_io.wait_readable(@connect_timeout) or raise CannotConnectError
+            socket.to_io.wait_readable(@connect_timeout) or raise CannotConnectError.with_config("", config)
           when :wait_writable
-            socket.to_io.wait_writable(@connect_timeout) or raise CannotConnectError
+            socket.to_io.wait_writable(@connect_timeout) or raise CannotConnectError.with_config("", config)
           when socket
             break
           else

data/lib/redis_client/sentinel_config.rb

@@ -112,6 +112,12 @@ class RedisClient
       end
     end
 
+    def resolved?
+      @mutex.synchronize do
+        !!@config
+      end
+    end
+
     private
 
     def sentinels_to_configs(sentinels)
@@ -188,6 +194,10 @@ class RedisClient
           if success
             @sentinel_configs.unshift(@sentinel_configs.delete(sentinel_config))
           end
+          # Redis Sentinels may be configured to have a lower maxclients setting than
+          # the Redis nodes. Close the connection to the Sentinel node to avoid using
+          # a connection.
+          sentinel_client.close
         end
       end
 

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -77,7 +77,29 @@ class RedisClient
     end
   end
 
-  Error = Class.new(StandardError)
+  module HasConfig
+    attr_reader :config
+
+    def _set_config(config)
+      @config = config
+    end
+
+    def message
+      return super unless config&.resolved?
+
+      "#{super} (#{config.server_url})"
+    end
+  end
+
+  class Error < StandardError
+    include HasConfig
+
+    def self.with_config(message, config = nil)
+      new(message).tap do |error|
+        error._set_config(config)
+      end
+    end
+  end
 
   ProtocolError = Class.new(Error)
   UnsupportedServer = Class.new(Error)
@@ -114,7 +136,7 @@ class RedisClient
         end
         code ||= error_message.split(' ', 2).first
         klass = ERRORS.fetch(code, self)
-        klass.new(error_message)
+        klass.new(error_message.strip)
       end
     end
   end
@@ -750,10 +772,13 @@ class RedisClient
         end
       end
     end
-  rescue FailoverError, CannotConnectError
-    raise
+  rescue FailoverError, CannotConnectError => error
+    error._set_config(config)
+    raise error
   rescue ConnectionError => error
-    raise CannotConnectError, error.message, error.backtrace
+    connect_error = CannotConnectError.with_config(error.message, config)
+    connect_error.set_backtrace(error.backtrace)
+    raise connect_error
   rescue CommandError => error
     if error.message.match?(/ERR unknown command ['`]HELLO['`]/)
       raise UnsupportedServer,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool