redis-client 0.18.0 → 0.24.0

data/lib/redis_client/ruby_connection/resp3.rb

@@ -10,12 +10,12 @@ class RedisClient
 
     EOL = "\r\n".b.freeze
     EOL_SIZE = EOL.bytesize
-    DUMP_TYPES = { # rubocop:disable Style/MutableConstant
+    DUMP_TYPES = {
       String => :dump_string,
       Symbol => :dump_symbol,
       Integer => :dump_numeric,
       Float => :dump_numeric,
-    }
+    }.freeze
     PARSER_TYPES = {
       '#' => :parse_boolean,
       '$' => :parse_blob,
@@ -57,7 +57,7 @@ class RedisClient
     def dump_any(object, buffer)
       method = DUMP_TYPES.fetch(object.class) do |unexpected_class|
         if superclass = DUMP_TYPES.keys.find { |t| t > unexpected_class }
-          DUMP_TYPES[unexpected_class] = DUMP_TYPES[superclass]
+          DUMP_TYPES[superclass]
         else
           raise TypeError, "Unsupported command argument type: #{unexpected_class}"
         end
@@ -111,15 +111,39 @@ class RedisClient
 
     def parse(io)
       type = io.getbyte
-      method = PARSER_TYPES.fetch(type) do
+      if type == 35 # '#'.ord
+        parse_boolean(io)
+      elsif type == 36 # '$'.ord
+        parse_blob(io)
+      elsif type == 43 # '+'.ord
+        parse_string(io)
+      elsif type == 61 # '='.ord
+        parse_verbatim_string(io)
+      elsif type == 45 # '-'.ord
+        parse_error(io)
+      elsif type == 58 # ':'.ord
+        parse_integer(io)
+      elsif type == 40 # '('.ord
+        parse_integer(io)
+      elsif type == 44 # ','.ord
+        parse_double(io)
+      elsif type == 95 # '_'.ord
+        parse_null(io)
+      elsif type == 42 # '*'.ord
+        parse_array(io)
+      elsif type == 37 # '%'.ord
+        parse_map(io)
+      elsif type == 126 # '~'.ord
+        parse_set(io)
+      elsif type == 62 # '>'.ord
+        parse_array(io)
+      else
         raise UnknownType, "Unknown sigil type: #{type.chr.inspect}"
       end
-      send(method, io)
     end
 
     def parse_string(io)
       str = io.gets_chomp
-      str.force_encoding(Encoding.default_external)
       str.force_encoding(Encoding::BINARY) unless str.valid_encoding?
       str.freeze
     end
@@ -140,17 +164,17 @@ class RedisClient
     end
 
     def parse_array(io)
-      parse_sequence(io, parse_integer(io))
+      parse_sequence(io, io.gets_integer)
     end
 
     def parse_set(io)
-      parse_sequence(io, parse_integer(io))
+      parse_sequence(io, io.gets_integer)
     end
 
     def parse_map(io)
       hash = {}
-      parse_integer(io).times do
-        hash[parse(io)] = parse(io)
+      io.gets_integer.times do
+        hash[parse(io).freeze] = parse(io)
       end
       hash
     end
@@ -192,11 +216,10 @@ class RedisClient
     end
 
     def parse_blob(io)
-      bytesize = parse_integer(io)
+      bytesize = io.gets_integer
       return if bytesize < 0 # RESP2 nil type
 
       str = io.read_chomp(bytesize)
-      str.force_encoding(Encoding.default_external)
       str.force_encoding(Encoding::BINARY) unless str.valid_encoding?
       str
     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,15 +98,15 @@ 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
-      start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+      start = RedisClient.now_ms
       call(["PING"], @read_timeout)
-      Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - start
+      RedisClient.now_ms - start
     end
 
     private
@@ -114,7 +116,12 @@ class RedisClient
         UNIXSocket.new(@config.path)
       else
         sock = if SUPPORTS_RESOLV_TIMEOUT
-          Socket.tcp(@config.host, @config.port, connect_timeout: @connect_timeout, resolv_timeout: @connect_timeout)
+          begin
+            Socket.tcp(@config.host, @config.port, connect_timeout: @connect_timeout, resolv_timeout: @connect_timeout)
+          rescue Errno::ETIMEDOUT => timeout_error
+            timeout_error.message << ": #{@connect_timeout}s"
+            raise
+          end
         else
           Socket.tcp(@config.host, @config.port, connect_timeout: @connect_timeout)
         end
@@ -130,9 +137,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
@@ -148,6 +155,7 @@ class RedisClient
       )
       true
     rescue SystemCallError, OpenSSL::SSL::SSLError, SocketError => error
+      socket&.close
       raise CannotConnectError, error.message, error.backtrace
     end
 

data/lib/redis_client/sentinel_config.rb

@@ -38,9 +38,14 @@ class RedisClient
       end
 
       @to_list_of_hash = @to_hash = nil
+      password = if sentinel_password && !sentinel_password.respond_to?(:call)
+        ->(_) { sentinel_password }
+      else
+        sentinel_password
+      end
       @extra_config = {
         username: sentinel_username,
-        password: sentinel_password,
+        password: password,
         db: nil,
       }
       if client_config[:protocol] == 2
@@ -112,6 +117,12 @@ class RedisClient
       end
     end
 
+    def resolved?
+      @mutex.synchronize do
+        !!@config
+      end
+    end
+
     private
 
     def sentinels_to_configs(sentinels)
@@ -188,6 +199,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/url_config.rb

@@ -4,26 +4,41 @@ require "uri"
 
 class RedisClient
   class URLConfig
-    DEFAULT_SCHEMA = "redis"
-    SSL_SCHEMA = "rediss"
-
     attr_reader :url, :uri
 
     def initialize(url)
       @url = url
       @uri = URI(url)
-      unless uri.scheme == DEFAULT_SCHEMA || uri.scheme == SSL_SCHEMA
-        raise ArgumentError, "Invalid URL: #{url.inspect}"
+      @unix = false
+      @ssl = false
+      case uri.scheme
+      when "redis"
+        # expected
+      when "rediss"
+        @ssl = true
+      when "unix", nil
+        @unix = true
+      else
+        raise ArgumentError, "Unknown URL scheme: #{url.inspect}"
       end
     end
 
     def ssl?
-      @uri.scheme == SSL_SCHEMA
+      @ssl
     end
 
     def db
-      db_path = uri.path&.delete_prefix("/")
-      Integer(db_path) if db_path && !db_path.empty?
+      unless @unix
+        db_path = uri.path&.delete_prefix("/")
+        return Integer(db_path) if db_path && !db_path.empty?
+      end
+
+      unless uri.query.nil? || uri.query.empty?
+        _, db_query = URI.decode_www_form(uri.query).find do |key, _|
+          key == "db"
+        end
+        return Integer(db_query) if db_query && !db_query.empty?
+      end
     end
 
     def username
@@ -44,6 +59,12 @@ class RedisClient
       uri.host.sub(/\A\[(.*)\]\z/, '\1')
     end
 
+    def path
+      if @unix
+        File.join(*[uri.host, uri.path].compact)
+      end
+    end
+
     def port
       return unless uri.port
 

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -45,6 +45,14 @@ class RedisClient
     def default_driver=(name)
       @default_driver = driver(name)
     end
+
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def now_ms
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+    end
   end
 
   register_driver :ruby do
@@ -77,7 +85,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 +144,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
@@ -222,17 +252,18 @@ class RedisClient
 
   def timeout=(timeout)
     super
-    raw_connection.read_timeout = raw_connection.write_timeout = timeout if connected?
+    @raw_connection&.read_timeout = timeout
+    @raw_connection&.write_timeout = timeout
   end
 
   def read_timeout=(timeout)
     super
-    raw_connection.read_timeout = timeout if connected?
+    @raw_connection&.read_timeout = timeout
   end
 
   def write_timeout=(timeout)
     super
-    raw_connection.write_timeout = timeout if connected?
+    @raw_connection&.write_timeout = timeout
   end
 
   def pubsub
@@ -386,7 +417,7 @@ class RedisClient
   end
 
   def connected?
-    @raw_connection&.connected?
+    @raw_connection&.revalidate
   end
 
   def close
@@ -398,7 +429,7 @@ class RedisClient
     ensure_connected(retryable: false, &block)
   end
 
-  def pipelined
+  def pipelined(exception: true)
     pipeline = Pipeline.new(@command_builder)
     yield pipeline
 
@@ -408,7 +439,7 @@ class RedisClient
       results = ensure_connected(retryable: pipeline._retryable?) do |connection|
         commands = pipeline._commands
         @middlewares.call_pipelined(commands, config) do
-          connection.call_pipelined(commands, pipeline._timeouts)
+          connection.call_pipelined(commands, pipeline._timeouts, exception: exception)
         end
       end
 
@@ -669,6 +700,7 @@ class RedisClient
     elsif retryable
       tries = 0
       connection = nil
+      preferred_error = nil
       begin
         connection = raw_connection
         if block_given?
@@ -677,13 +709,20 @@ class RedisClient
           connection
         end
       rescue ConnectionError, ProtocolError => error
+        preferred_error ||= error
         close
 
+        if error.is_a?(CircuitBreaker::OpenCircuitError)
+          raise preferred_error
+        else
+          preferred_error = error
+        end
+
         if !@disable_reconnection && config.retry_connecting?(tries, error)
           tries += 1
           retry
         else
-          raise
+          raise preferred_error
         end
       end
     else
@@ -746,10 +785,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,13 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Jean Boussier
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - jean.boussier@gmail.com
 executables: []
@@ -32,11 +30,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/redis-client.rb
 - lib/redis_client.rb
 - lib/redis_client/circuit_breaker.rb
@@ -53,7 +48,6 @@ files:
 - lib/redis_client/sentinel_config.rb
 - lib/redis_client/url_config.rb
 - lib/redis_client/version.rb
-- redis-client.gemspec
 homepage: https://github.com/redis-rb/redis-client
 licenses:
 - MIT
@@ -62,7 +56,6 @@ metadata:
   homepage_uri: https://github.com/redis-rb/redis-client
   source_code_uri: https://github.com/redis-rb/redis-client
   changelog_uri: https://github.com/redis-rb/redis-client/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Simple low-level client for Redis 6+
 test_files: []

data/Gemfile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in redis-client.gemspec
-gemspec name: "redis-client"
-
-gem "minitest"
-gem "rake", "~> 13.0"
-gem "rake-compiler"
-gem "rubocop"
-gem "rubocop-minitest"
-gem "toxiproxy"
-
-group :benchmark do
-  gem "benchmark-ips"
-  gem "hiredis"
-  gem "redis", "~> 4.6"
-  gem "stackprof", platform: :mri
-end
-
-gem "byebug", platform: :mri

data/Gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redis-client (0.18.0)
-      connection_pool
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    benchmark-ips (2.12.0)
-    byebug (11.1.3)
-    connection_pool (2.4.1)
-    hiredis (0.6.3)
-    hiredis (0.6.3-java)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rake-compiler (1.2.5)
-      rake
-    redis (4.6.0)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.28.2)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
-      rubocop (>= 0.90, < 2.0)
-    ruby-progressbar (1.11.0)
-    stackprof (0.2.25)
-    toxiproxy (2.0.2)
-    unicode-display_width (2.2.0)
-
-PLATFORMS
-  ruby
-  universal-java-18
-  x86_64-darwin-20
-  x86_64-linux
-
-DEPENDENCIES
-  benchmark-ips
-  byebug
-  hiredis
-  minitest
-  rake (~> 13.0)
-  rake-compiler
-  redis (~> 4.6)
-  redis-client!
-  rubocop
-  rubocop-minitest
-  stackprof
-  toxiproxy
-
-BUNDLED WITH
-   2.3.13