redis-client 0.22.1 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac943e2497c5e52f402307d0acb4ba73cb25f6946efe66cb398a40a6b378b7e1
-  data.tar.gz: '034386c130f23d555834fa788a1ae8409d90dbf35bd0312045e35c715c26899d'
+  metadata.gz: 7c3cb528ecb15130b80ce97d00a5e0e45c31edfc6147068516e1a52295a94045
+  data.tar.gz: b4517fbd99d0f3997e510b6d0d56c345c1fceb1ad44fcac59cceb28faf4326b5
 SHA512:
-  metadata.gz: b83ef90c1f9f5994c7fbcf3fb304f41d977fbb04cdb0c02e08bc6294b064e939fad19b225fb7ac7b5fd95103712c46d690cdeaa724a2e07e6d343d35a483a14c
-  data.tar.gz: 0e3f65ac5ecceedc577d87dbf25604b331be6cfc4ac92c6f54633dc1acbc6ae4519ce32df3a4033a2594c5451194abbf0b80d9a6bcdb996169401af1805bb230
+  metadata.gz: dbc7fcacc084fcd9d765337ad48a2a8ee413eecfec48f1a166fbd58510299cf92b3e058ce08620055deadeca86464c2c25fe6cddcccab532ab3d2cd741f9cef0
+  data.tar.gz: '09164c4ea9f7021d58df97690f78e7940821a44eb7e12cc4c25324bd17e0e784f447443accedbe2299e6d8c0a0a6f15391491465c4c32baaa56286501b77b693'

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Unreleased
 
+# 0.24.0
+
+- Allow `sentinel_password` to be provided as a `Proc`.
+- Ensure `Config#inspect` and `Config#to_s` do not display stored passwords.
+
+# 0.23.2
+
+- Fix retry logic not to attempt to retry on an open circuit breaker. Fix #227.
+
+# 0.23.1
+
+- Fix a potential crash in `hiredis-client` when using subcriptions (`next_event`). See #221.
+
+# 0.23.0
+
+- Allow `password` to be a callable. Makes it easy to implement short lived password authentication strategies.
+- Fix a thread safety issue in `hiredis-client` when using the `pubsub` client concurrently.
+
+# 0.22.2
+
+- Fix the sentinel client to properly extend timeout for blocking commands.
+- Fix IPv6 support in `RedisClient::Config#server_url`.
+
 # 0.22.1
 
 - Fix `ProtocolError: Unknown sigil type` errors when using SSL connection. See #190.
@@ -57,6 +80,7 @@
 - Discard sockets rather than explictly close them when a fork is detected. #126.
 - Allow to configure sentinel client via url. #117.
 - Fix sentinel to preverse the auth/password when refreshing the sentinel list. #107.
+- Added `RedisClient#measure_round_trip_delay` method. #113.
 
 # 0.14.1
 

data/README.md

@@ -1,9 +1,10 @@
 # RedisClient
 
-`redis-client` is a simple, low-level, client for Redis 6+.
+`redis-client` is a simple, low-level, client for [Redis](https://redis.io/) 6+, [Valkey](https://valkey.io/) 7+, [KeyDB](https://docs.keydb.dev/),
+and several other databases that implement the same `RESP3` protocol.
 
 Contrary to the `redis` gem, `redis-client` doesn't try to map all Redis commands to Ruby constructs,
-it merely is a thin wrapper on top of the RESP3 protocol.
+it merely is a thin wrapper on top of the `RESP3` protocol.
 
 ## Installation
 
@@ -77,7 +78,7 @@ redis.call("GET", "mykey")
 - `db`: The database to select after connecting, defaults to `0`.
 - `id` ID for the client connection, assigns name to current connection by sending `CLIENT SETNAME`.
 - `username` Username to authenticate against server, defaults to `"default"`.
-- `password` Password to authenticate against server.
+- `password` Password to authenticate against server. Can either be a String or a callable that recieve `username` as argument and return a passowrd as a String.
 - `timeout`: The general timeout in seconds, default to `1.0`.
 - `connect_timeout`: The connection timeout, takes precedence over the general timeout when connecting to the server.
 - `read_timeout`: The read timeout, takes precedence over the general timeout when reading responses from the server.
@@ -89,7 +90,7 @@ redis.call("GET", "mykey")
 
 ### Sentinel support
 
-The client is able to perform automatic failover by using [Redis Sentinel](https://redis.io/docs/manual/sentinel/).
+The client is able to perform automatic failover by using [Redis Sentinel](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/).
 
 To connect using Sentinel, use:
 
@@ -149,7 +150,7 @@ SENTINELS = [{ host: '127.0.0.1', port: 26380 },
 redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret')
 ```
 
-So you have to provide Sentinel credential and Redis explictly even they are the same
+So you have to provide Sentinel credential and Redis explicitly even they are the same
 
 ```ruby
 # Use 'mysecret' to authenticate against the mymaster instance and sentinel
@@ -524,7 +525,7 @@ recover for a while.
 
 [Circuit breakers are a pattern that does exactly that](https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern).
 
-Configuation options:
+Configuration options:
 
   - `error_threshold`. The amount of errors to encounter within `error_threshold_timeout` amount of time before opening the circuit, that is to start rejecting requests instantly.
   - `error_threshold_timeout`. The amount of time in seconds that `error_threshold` errors must occur to open the circuit. Defaults to `error_timeout` seconds if not set.

data/lib/redis_client/circuit_breaker.rb

@@ -63,7 +63,7 @@ class RedisClient
     private
 
     def refresh_state
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      now = RedisClient.now
       @lock.synchronize do
         if @errors.last < (now - @error_timeout)
           if @success_threshold > 0
@@ -78,7 +78,7 @@ class RedisClient
     end
 
     def record_error
-      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      now = RedisClient.now
       expiry = now - @error_timeout
       @lock.synchronize do
         if @state == :closed

data/lib/redis_client/config.rb

@@ -12,8 +12,8 @@ class RedisClient
     DEFAULT_DB = 0
 
     module Common
-      attr_reader :db, :password, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
-        :connect_timeout, :read_timeout, :write_timeout, :driver, :connection_prelude, :protocol,
+      attr_reader :db, :id, :ssl, :ssl_params, :command_builder, :inherit_socket,
+        :connect_timeout, :read_timeout, :write_timeout, :driver, :protocol,
         :middlewares_stack, :custom, :circuit_breaker
 
       alias_method :ssl?, :ssl
@@ -40,7 +40,7 @@ class RedisClient
         circuit_breaker: nil
       )
         @username = username
-        @password = password
+        @password = password && !password.respond_to?(:call) ? ->(_) { password } : password
         @db = begin
           Integer(db || DEFAULT_DB)
         rescue ArgumentError
@@ -70,7 +70,6 @@ class RedisClient
 
         reconnect_attempts = Array.new(reconnect_attempts, 0).freeze if reconnect_attempts.is_a?(Integer)
         @reconnect_attempts = reconnect_attempts
-        @connection_prelude = build_connection_prelude
 
         circuit_breaker = CircuitBreaker.new(**circuit_breaker) if circuit_breaker.is_a?(Hash)
         if @circuit_breaker = circuit_breaker
@@ -87,6 +86,39 @@ class RedisClient
         @middlewares_stack = middlewares_stack
       end
 
+      def connection_prelude
+        prelude = []
+        pass = password
+        if protocol == 3
+          prelude << if pass
+            ["HELLO", "3", "AUTH", username, pass]
+          else
+            ["HELLO", "3"]
+          end
+        elsif pass
+          prelude << if @username && !@username.empty?
+            ["AUTH", @username, pass]
+          else
+            ["AUTH", pass]
+          end
+        end
+
+        if @db && @db != 0
+          prelude << ["SELECT", @db.to_s]
+        end
+
+        # Deep freeze all the strings and commands
+        prelude.map! do |commands|
+          commands = commands.map { |str| str.frozen? ? str : str.dup.freeze }
+          commands.freeze
+        end
+        prelude.freeze
+      end
+
+      def password
+        @password&.call(username)
+      end
+
       def username
         @username || DEFAULT_USERNAME
       end
@@ -133,43 +165,19 @@ class RedisClient
             url = "#{url}?db=#{db}"
           end
         else
-          url = "redis#{'s' if ssl?}://#{host}:#{port}"
+          # add brackets to IPv6 address
+          redis_host = if host.count(":") >= 2
+            "[#{host}]"
+          else
+            host
+          end
+          url = "redis#{'s' if ssl?}://#{redis_host}:#{port}"
           if db != 0
             url = "#{url}/#{db}"
           end
         end
         url
       end
-
-      private
-
-      def build_connection_prelude
-        prelude = []
-        if protocol == 3
-          prelude << if @password
-            ["HELLO", "3", "AUTH", @username || DEFAULT_USERNAME, @password]
-          else
-            ["HELLO", "3"]
-          end
-        elsif @password
-          prelude << if @username && !@username.empty?
-            ["AUTH", @username, @password]
-          else
-            ["AUTH", @password]
-          end
-        end
-
-        if @db && @db != 0
-          prelude << ["SELECT", @db.to_s]
-        end
-
-        # Deep freeze all the strings and commands
-        prelude.map! do |commands|
-          commands = commands.map { |str| str.frozen? ? str : str.dup.freeze }
-          commands.freeze
-        end
-        prelude.freeze
-      end
     end
 
     include Common

data/lib/redis_client/connection_mixin.rb

@@ -28,7 +28,7 @@ class RedisClient
     def call(command, timeout)
       @pending_reads += 1
       write(command)
-      result = read(timeout)
+      result = read(connection_timeout(timeout))
       @pending_reads -= 1
       if result.is_a?(Error)
         result._set_command(command)
@@ -49,7 +49,7 @@ class RedisClient
 
       size.times do |index|
         timeout = timeouts && timeouts[index]
-        result = read(timeout)
+        result = read(connection_timeout(timeout))
         @pending_reads -= 1
 
         # A multi/exec command can return an array of results.
@@ -73,5 +73,14 @@ class RedisClient
         results
       end
     end
+
+    def connection_timeout(timeout)
+      return timeout unless timeout && timeout > 0
+
+      # Can't use the command timeout argument as the connection timeout
+      # otherwise it would be very racy. So we add the regular read_timeout on top
+      # to account for the network delay.
+      timeout + config.read_timeout
+    end
   end
 end

data/lib/redis_client/ruby_connection.rb

@@ -104,9 +104,9 @@ class RedisClient
     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
@@ -116,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

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

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.22.1"
+  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
@@ -702,9 +710,14 @@ class RedisClient
         end
       rescue ConnectionError, ProtocolError => error
         preferred_error ||= error
-        preferred_error = error unless error.is_a?(CircuitBreaker::OpenCircuitError)
         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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.24.0
 platform: ruby
 authors:
 - Jean Boussier
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-16 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
@@ -77,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
-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.2"
-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,72 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redis-client (0.22.1)
-      connection_pool
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    benchmark-ips (2.13.0)
-    byebug (11.1.3)
-    connection_pool (2.4.1)
-    hiredis (0.6.3)
-    hiredis (0.6.3-java)
-    json (2.7.1)
-    json (2.7.1-java)
-    minitest (5.22.3)
-    parallel (1.24.0)
-    parser (3.3.0.5)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    racc (1.7.3-java)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rake-compiler (1.2.7)
-      rake
-    redis (4.6.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.50.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-minitest (0.30.0)
-      rubocop (>= 1.39, < 2.0)
-    ruby-progressbar (1.13.0)
-    stackprof (0.2.26)
-    toxiproxy (2.0.2)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  ruby
-  universal-java-18
-  x86_64-darwin-20
-  x86_64-linux
-
-DEPENDENCIES
-  benchmark-ips
-  byebug
-  hiredis
-  minitest
-  rake (~> 13.2)
-  rake-compiler
-  redis (~> 4.6)
-  redis-client!
-  rubocop
-  rubocop-minitest
-  stackprof
-  toxiproxy
-
-BUNDLED WITH
-   2.3.13

data/Rakefile

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-require "rake/extensiontask"
-require "rake/testtask"
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-require "rake/clean"
-CLOBBER.include "pkg"
-require "bundler/gem_helper"
-Bundler::GemHelper.install_tasks(name: "redis-client")
-Bundler::GemHelper.install_tasks(dir: "hiredis-client", name: "hiredis-client")
-
-gemspec = Gem::Specification.load("redis-client.gemspec")
-Rake::ExtensionTask.new do |ext|
-  ext.name = "hiredis_connection"
-  ext.ext_dir = "hiredis-client/ext/redis_client/hiredis"
-  ext.lib_dir = "hiredis-client/lib/redis_client"
-  ext.gem_spec = gemspec
-  CLEAN.add("#{ext.ext_dir}/vendor/*.{a,o}")
-end
-
-namespace :test do
-  Rake::TestTask.new(:ruby) do |t|
-    t.libs << "test"
-    t.libs << "lib"
-    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
-    t.options = '-v' if ENV['CI'] || ENV['VERBOSE']
-  end
-
-  Rake::TestTask.new(:sentinel) do |t|
-    t.libs << "test/sentinel"
-    t.libs << "test"
-    t.libs << "lib"
-    t.test_files = FileList["test/sentinel/*_test.rb"]
-    t.options = '-v' if ENV['CI'] || ENV['VERBOSE']
-  end
-
-  Rake::TestTask.new(:hiredis) do |t|
-    t.libs << "test/hiredis"
-    t.libs << "test"
-    t.libs << "hiredis-client/lib"
-    t.libs << "lib"
-    t.test_files = FileList["test/**/*_test.rb"].exclude("test/sentinel/*_test.rb")
-    t.options = '-v' if ENV['CI'] || ENV['VERBOSE']
-  end
-end
-
-hiredis_supported = RUBY_ENGINE == "ruby" && !RUBY_PLATFORM.match?(/mswin/)
-if hiredis_supported
-  task test: %i[test:ruby test:hiredis test:sentinel]
-else
-  task test: %i[test:ruby test:sentinel]
-end
-
-namespace :hiredis do
-  task :download do
-    version = "1.0.2"
-    archive_path = "tmp/hiredis-#{version}.tar.gz"
-    url = "https://github.com/redis/hiredis/archive/refs/tags/v#{version}.tar.gz"
-    system("curl", "-L", url, out: archive_path) or raise "Downloading of #{url} failed"
-    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/")
-    system("mkdir", "-p", "hiredis-client/ext/redis_client/hiredis/vendor/")
-    system(
-      "tar", "xvzf", archive_path,
-      "-C", "hiredis-client/ext/redis_client/hiredis/vendor",
-      "--strip-components", "1",
-    )
-    system("rm", "-rf", "hiredis-client/ext/redis_client/hiredis/vendor/examples")
-  end
-end
-
-benchmark_suites = %w(single pipelined drivers)
-benchmark_modes = %i[ruby yjit hiredis]
-namespace :benchmark do
-  benchmark_suites.each do |suite|
-    benchmark_modes.each do |mode|
-      next if suite == "drivers" && mode == :hiredis
-
-      name = "#{suite}_#{mode}"
-      desc name
-      task name do
-        output_path = "benchmark/#{name}.md"
-        sh "rm", "-f", output_path
-        File.open(output_path, "w+") do |output|
-          output.puts("ruby: `#{RUBY_DESCRIPTION}`\n\n")
-          output.puts("redis-server: `#{`redis-server -v`.strip}`\n\n")
-          output.puts
-          output.flush
-          env = {}
-          args = []
-          args << "--yjit" if mode == :yjit
-          env["DRIVER"] = mode == :hiredis ? "hiredis" : "ruby"
-          system(env, RbConfig.ruby, *args, "benchmark/#{suite}.rb", out: output)
-        end
-
-        skipping = false
-        output = File.readlines(output_path).reject do |line|
-          if skipping
-            if line == "Comparison:\n"
-              skipping = false
-              true
-            else
-              skipping
-            end
-          else
-            skipping = true if line.start_with?("Warming up ---")
-            skipping
-          end
-        end
-        File.write(output_path, output.join)
-      end
-    end
-  end
-
-  task all: benchmark_suites.flat_map { |s| benchmark_modes.flat_map { |m| "#{s}_#{m}" } }
-end
-
-if hiredis_supported
-  task default: %i[compile test rubocop]
-  task ci: %i[compile test:ruby test:hiredis]
-else
-  task default: %i[test rubocop]
-  task ci: %i[test:ruby]
-end

data/redis-client.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/redis_client/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "redis-client"
-  spec.version = RedisClient::VERSION
-  spec.authors = ["Jean Boussier"]
-  spec.email = ["jean.boussier@gmail.com"]
-
-  spec.summary = "Simple low-level client for Redis 6+"
-  spec.homepage = "https://github.com/redis-rb/redis-client"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/master/CHANGELOG.md")
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|hiredis-client|test|spec|features|benchmark)/|\.(?:git|rubocop))})
-    end
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "connection_pool"
-end