redis-client 0.14.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9858303eff06d56f8e144eb7033995fc92839c41fe39d0bda6f1d9c2fed91e9
-  data.tar.gz: a4f4ca2073a32e28932c58e537963a2f0b2321e36ca472c6edc9edab1b29122b
+  metadata.gz: 35ff65a4af6127cb60acff6a3d3b2d2e5e65ddeffc0e8e808b7dec90792697a6
+  data.tar.gz: 854f82d7548c5462b53ae29a637dc208cdc70b3399b28d0c61f38e02f073e37e
 SHA512:
-  metadata.gz: 3c20b17e4587980ed89e0877b20cb9aee7d16365401127cfdc3b4f451f7706bf338988e97ac9d1e62d33c9af5b45ebfb3c35310205fbd309995ace46c3b85fce
-  data.tar.gz: 21ed1731b716f1bd6e525b638b7715683979860faa0d14f2fc6f210c4d185a95d2329650b56cf731734d22d7008cdadccc2055a8d5ff7a332b043836e0d39b75
+  metadata.gz: 2c9e8e564662e86f4e1a24ca9528a5d909a096218eaf62bd7b58838402db390e7bec65d79a43aa89a2b98d22f9645ca7e412ae2db4010dc4131cbf2133d2666f
+  data.tar.gz: c6400693a10e28e377bf52792ee54f41afb2b2c97ea49578a90eba767b6e3b6a7f37eaeaccf41a38a8222827f461f44aa0b1f75881084dc30a521e407508e277

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.16.0
+
+- Add `RedisClient#disable_reconnection`.
+- Reverted the special discard of connection. A regular `close(2)` should be enough.
+
+# 0.15.0
+
+- 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.
+
 # 0.14.1
 
 - Include the timeout value in TimeoutError messages.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.14.1)
+    redis-client (0.16.0)
       connection_pool
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     benchmark-ips (2.12.0)
     byebug (11.1.3)
-    connection_pool (2.4.0)
+    connection_pool (2.4.1)
     hiredis (0.6.3)
     hiredis (0.6.3-java)
     minitest (5.15.0)
@@ -19,7 +19,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rake-compiler (1.2.1)
+    rake-compiler (1.2.5)
       rake
     redis (4.6.0)
     regexp_parser (2.5.0)
@@ -38,7 +38,7 @@ GEM
     rubocop-minitest (0.19.1)
       rubocop (>= 0.90, < 2.0)
     ruby-progressbar (1.11.0)
-    stackprof (0.2.24)
+    stackprof (0.2.25)
     toxiproxy (2.0.2)
     unicode-display_width (2.2.0)
 

data/README.md

@@ -42,7 +42,7 @@ redis.with do |r|
 end
 ```
 
-If you are working in a single threaded environment, or wish to use your own connection pooling mechanism,
+If you are working in a single-threaded environment, or wish to use your own connection pooling mechanism,
 you can obtain a raw client with `#new_client`
 
 ```ruby
@@ -67,11 +67,11 @@ redis.call("GET", "mykey")
 - `host`: The server hostname or IP address. Defaults to `"localhost"`.
 - `port`: The server port. Defaults to `6379`.
 - `path`: The path to a UNIX socket, if set `url`, `host` and `port` are ignored.
-- `ssl`: Wether to connect using SSL or not.
+- `ssl`: Whether to connect using SSL or not.
 - `ssl_params`: A configuration Hash passed to [`OpenSSL::SSL::SSLContext#set_params`](https://www.rubydoc.info/stdlib/openssl/OpenSSL%2FSSL%2FSSLContext:set_params), notable options include:
   - `cert`: The path to the client certificate (e.g. `client.crt`).
   - `key`: The path to the client key (e.g. `client.key`).
-  - `ca_file`: The certificate authority to use, useful for self signed certificates (e.g. `ca.crt`),
+  - `ca_file`: The certificate authority to use, useful for self-signed certificates (e.g. `ca.crt`),
 - `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"`.
@@ -83,7 +83,7 @@ redis.call("GET", "mykey")
 - `reconnect_attempts`: Specify how many times the client should retry to send queries. Defaults to `0`. Makes sure to read the [reconnection section](#reconnection) before enabling it.
 - `circuit_breaker`: A Hash with circuit breaker configuration. Defaults to `nil`. See the [circuit breaker section](#circuit-breaker) for details.
 - `protocol:` The version of the RESP protocol to use. Default to `3`.
-- `custom`: A user owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user specific metadatas.
+- `custom`: A user-owned value ignored by `redis-client` but available as `Config#custom`. This can be used to hold middleware configurations and other user-specific metadata.
 
 ### Sentinel support
 
@@ -343,6 +343,10 @@ loop do
 end
 ```
 
+*Note*: pubsub connections are stateful, as such they won't ever reconnect automatically.
+The caller is responsible for reconnecting if the connection is lost and to resubscribe to
+all channels.
+
 ## Production
 
 ### Instrumentation and Middlewares
@@ -376,7 +380,7 @@ redis_config = RedisClient.config(middlewares: [AnotherRedisInstrumentation])
 redis_config.new_client
 ```
 
-If middlewares need a client specific configuration, `Config#custom` can be used
+If middlewares need a client-specific configuration, `Config#custom` can be used
 
 ```ruby
 module MyGlobalRedisInstrumentation
@@ -439,6 +443,8 @@ redis.call("GET", "counter") # Will be retried up to 3 times.
 redis.call_once("INCR", "counter") # Won't be retried.
 ```
 
+**Note**: automatic reconnection doesn't apply to pubsub clients as their connection is stateful.
+
 ### Exponential backoff
 
 Alternatively, `reconnect_attempts` accepts a list of sleep durations for implementing exponential backoff:
@@ -448,9 +454,9 @@ redis_config = RedisClient.config(reconnect_attempts: [0, 0.05, 0.1])
 ```
 
 This configuration is generally used when the Redis server is expected to failover or recover relatively quickly and
-that it's not really possibe to continue without issuing the command.
+that it's not really possible to continue without issuing the command.
 
-When the Redis server is used as an ephemeral cache, circuit breakers are generally prefered.
+When the Redis server is used as an ephemeral cache, circuit breakers are generally preferred.
 
 ### Circuit Breaker
 

data/lib/redis_client/config.rb

@@ -162,37 +162,21 @@ class RedisClient
       **kwargs
     )
       if url
-        uri = URI(url)
-        unless uri.scheme == "redis" || uri.scheme == "rediss"
-          raise ArgumentError, "Invalid URL: #{url.inspect}"
-        end
-
-        kwargs[:ssl] = uri.scheme == "rediss" unless kwargs.key?(:ssl)
-
-        kwargs[:username] ||= uri.user if uri.password && !uri.user.empty?
-
-        kwargs[:password] ||= if uri.user && !uri.password
-          URI.decode_www_form_component(uri.user)
-        elsif uri.user && uri.password
-          URI.decode_www_form_component(uri.password)
-        end
-
-        db_path = uri.path&.delete_prefix("/")
-        kwargs[:db] ||= Integer(db_path) if db_path && !db_path.empty?
+        url_config = URLConfig.new(url)
+        kwargs = {
+          ssl: url_config.ssl?,
+          username: url_config.username,
+          password: url_config.password,
+          db: url_config.db,
+        }.compact.merge(kwargs)
+        host ||= url_config.host
+        port ||= url_config.port
       end
 
       super(**kwargs)
 
-      @host = host
-      unless @host
-        uri_host = uri&.host
-        uri_host = nil if uri_host&.empty?
-        if uri_host
-          @host = uri_host&.sub(/\A\[(.*)\]\z/, '\1')
-        end
-      end
-      @host ||= DEFAULT_HOST
-      @port = Integer(port || uri&.port || DEFAULT_PORT)
+      @host = host || DEFAULT_HOST
+      @port = Integer(port || DEFAULT_PORT)
       @path = path
     end
   end

data/lib/redis_client/ruby_connection.rb

@@ -101,6 +101,12 @@ class RedisClient
       raise ConnectionError, error.message
     end
 
+    def measure_round_trip_delay
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+      call(["PING"], @read_timeout)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - start
+    end
+
     private
 
     def connect

data/lib/redis_client/sentinel_config.rb

@@ -7,11 +7,28 @@ class RedisClient
     SENTINEL_DELAY = 0.25
     DEFAULT_RECONNECT_ATTEMPTS = 2
 
-    def initialize(name:, sentinels:, role: :master, **client_config)
-      unless %i(master replica slave).include?(role)
+    attr_reader :name
+
+    def initialize(sentinels:, role: :master, name: nil, url: nil, **client_config)
+      unless %i(master replica slave).include?(role.to_sym)
         raise ArgumentError, "Expected role to be either :master or :replica, got: #{role.inspect}"
       end
 
+      if url
+        url_config = URLConfig.new(url)
+        client_config = {
+          username: url_config.username,
+          password: url_config.password,
+          db: url_config.db,
+        }.compact.merge(client_config)
+        name ||= url_config.host
+      end
+
+      @name = name
+      unless @name
+        raise ArgumentError, "RedisClient::SentinelConfig requires either a name or an url with a host"
+      end
+
       @to_list_of_hash = @to_hash = nil
       @extra_config = {}
       if client_config[:protocol] == 2
@@ -25,16 +42,15 @@ class RedisClient
         end
       end
 
-      @name = name
-      @sentinel_configs = sentinels_to_configs(sentinels)
       @sentinels = {}.compare_by_identity
-      @role = role
+      @role = role.to_sym
       @mutex = Mutex.new
       @config = nil
 
       client_config[:reconnect_attempts] ||= DEFAULT_RECONNECT_ATTEMPTS
       @client_config = client_config || {}
       super(**client_config)
+      @sentinel_configs = sentinels_to_configs(sentinels)
     end
 
     def sentinels
@@ -90,9 +106,9 @@ class RedisClient
       sentinels.map do |sentinel|
         case sentinel
         when String
-          Config.new(**@extra_config, url: sentinel)
+          Config.new(**@client_config, **@extra_config, url: sentinel, db: nil)
         else
-          Config.new(**@extra_config, **sentinel)
+          Config.new(**@client_config, **@extra_config, **sentinel, db: nil)
         end
       end
     end

data/lib/redis_client/url_config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+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}"
+      end
+    end
+
+    def ssl?
+      @uri.scheme == SSL_SCHEMA
+    end
+
+    def db
+      db_path = uri.path&.delete_prefix("/")
+      Integer(db_path) if db_path && !db_path.empty?
+    end
+
+    def username
+      uri.user if uri.password && !uri.user.empty?
+    end
+
+    def password
+      if uri.user && !uri.password
+        URI.decode_www_form_component(uri.user)
+      elsif uri.user && uri.password
+        URI.decode_www_form_component(uri.password)
+      end
+    end
+
+    def host
+      return if uri.host.nil? || uri.host.empty?
+
+      uri.host.sub(/\A\[(.*)\]\z/, '\1')
+    end
+
+    def port
+      return unless uri.port
+
+      Integer(uri.port)
+    end
+  end
+end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -2,6 +2,7 @@
 
 require "redis_client/version"
 require "redis_client/command_builder"
+require "redis_client/url_config"
 require "redis_client/config"
 require "redis_client/pid_cache"
 require "redis_client/sentinel_config"
@@ -204,6 +205,14 @@ class RedisClient
     sub
   end
 
+  def measure_round_trip_delay
+    ensure_connected do |connection|
+      @middlewares.call(["PING"], config) do
+        connection.measure_round_trip_delay
+      end
+    end
+  end
+
   def call(*command, **kwargs)
     command = @command_builder.generate(command, kwargs)
     result = ensure_connected do |connection|
@@ -349,6 +358,10 @@ class RedisClient
     self
   end
 
+  def disable_reconnection(&block)
+    ensure_connected(retryable: false, &block)
+  end
+
   def pipelined
     pipeline = Pipeline.new(@command_builder)
     yield pipeline

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -51,6 +51,7 @@ files:
 - lib/redis_client/ruby_connection/buffered_io.rb
 - lib/redis_client/ruby_connection/resp3.rb
 - 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
@@ -76,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+