redis-client 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac50722e5156b95e037fb5fd933cb804a3d52d0d767faa2bbddaccc7cbd38d07
-  data.tar.gz: 0a1645c3788dd195bf3567e14c0ba508b892357991359297c002c84bd2796e2e
+  metadata.gz: aa81349f7f830db128f2637bc4c782543b9c51a16075b54fdc4700810a95ae83
+  data.tar.gz: d34e19d6229292bb6b15e61aebeda57729780040e098f0fae1beb534f9717ff9
 SHA512:
-  metadata.gz: 0c93ddbae9ffdd770589eb6003eee594dc902a8d2698c99c38878b923ac80a91aa6a43892d015d9a4ba52ef19300c95970a8947e25f1844c4c01d4b88ff9d9ae
-  data.tar.gz: a06dd7eaa65ccf8544b4f04f7beffe2580d139783770170fcf76348c5760f78c5baa0d77e734a31111c720df6458bb8112a64960316618b831fdb6059b625963
+  metadata.gz: 01ed887cfc90ffc36ff82669a459d1c9b13b72c9d81f66ca770e7642c16cba90d30cfd31768029b81a1519778f6af2905b145ab606f070008ac471192ce812fa
+  data.tar.gz: 64320bfdcdaa3fd4402ae41350dc0451127f895e3f224d916140ea3fc5813dfe9344f04dc18c20d82e9c3a0878d19ade9b3716274278a21fbe3fd1c5da855797

data/CHANGELOG.md

@@ -1,7 +1,19 @@
 # Unreleased
 
+# 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.
+- Fix connection keep-alive on FreeBSD. #102.
+
 # 0.14.0
 
+- Implement Sentinels list automatic refresh.
 - hiredis binding now implement GC compaction and write barriers.
 - hiredis binding now properly release the GVL around `connect(2)`.
 - hiredis the client memory is now re-used on reconnection when possible to reduce allocation churn.

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    redis-client (0.14.0)
+    redis-client (0.15.0)
       connection_pool
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    benchmark-ips (2.11.0)
+    benchmark-ips (2.12.0)
     byebug (11.1.3)
-    connection_pool (2.3.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.3)
       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.23)
+    stackprof (0.2.25)
     toxiproxy (2.0.2)
     unicode-display_width (2.2.0)
 

data/README.md

@@ -343,6 +343,10 @@ loop do
 end
 ```
 
+*Note*: pubsub connections are stateful, as such they won't ever reconnect automatically.
+The caller is resonsible for reconnecting if the connection is lost and to resubscribe to
+all channels.
+
 ## Production
 
 ### Instrumentation and Middlewares
@@ -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:

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/buffered_io.rb

@@ -24,6 +24,10 @@ class RedisClient
         @io.to_io.close
       end
 
+      def reopen(*args)
+        @io.to_io.reopen(*args)
+      end
+
       def closed?
         @io.to_io.closed?
       end
@@ -70,9 +74,9 @@ class RedisClient
               return total
             end
           when :wait_readable
-            @io.to_io.wait_readable(@read_timeout) or raise ReadTimeoutError
+            @io.to_io.wait_readable(@read_timeout) or raise(ReadTimeoutError, "Waited #{@read_timeout} seconds")
           when :wait_writable
-            @io.to_io.wait_writable(@write_timeout) or raise WriteTimeoutError
+            @io.to_io.wait_writable(@write_timeout) or raise(WriteTimeoutError, "Waited #{@write_timeout} seconds")
           when nil
             raise Errno::ECONNRESET
           else
@@ -137,10 +141,10 @@ class RedisClient
             return if !strict || remaining <= 0
           when :wait_readable
             unless @io.to_io.wait_readable(@read_timeout)
-              raise ReadTimeoutError unless @blocking_reads
+              raise ReadTimeoutError, "Waited #{@read_timeout} seconds" unless @blocking_reads
             end
           when :wait_writable
-            @io.to_io.wait_writable(@write_timeout) or raise WriteTimeoutError
+            @io.to_io.wait_writable(@write_timeout) or raise(WriteTimeoutError, "Waited #{@write_timeout} seconds")
           when nil
             raise EOFError
           else

data/lib/redis_client/ruby_connection.rb

@@ -58,6 +58,13 @@ class RedisClient
       super
     end
 
+    def discard
+      unless @io.closed?
+        @io.reopen(File::NULL)
+      end
+      close
+    end
+
     def read_timeout=(timeout)
       @read_timeout = timeout
       @io.read_timeout = timeout if @io
@@ -101,6 +108,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
@@ -152,7 +165,7 @@ class RedisClient
     private_constant :KEEP_ALIVE_TTL
     private_constant :KEEP_ALIVE_PROBES
 
-    if %i[SOL_SOCKET TCP_KEEPIDLE TCP_KEEPINTVL TCP_KEEPCNT].all? { |c| Socket.const_defined? c } # Linux
+    if %i[SOL_TCP SOL_SOCKET TCP_KEEPIDLE TCP_KEEPINTVL TCP_KEEPCNT].all? { |c| Socket.const_defined? c } # Linux
       def enable_socket_keep_alive(socket)
         socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
         socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, KEEP_ALIVE_INTERVAL)

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)
+    attr_reader :name
+
+    def initialize(sentinels:, role: :master, name: nil, url: nil, **client_config)
       unless %i(master replica slave).include?(role)
         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,8 +42,6 @@ class RedisClient
         end
       end
 
-      @name = name
-      @sentinel_configs = sentinels_to_configs(sentinels)
       @sentinels = {}.compare_by_identity
       @role = role
       @mutex = Mutex.new
@@ -35,6 +50,7 @@ class RedisClient
       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.0"
+  VERSION = "0.15.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,11 @@ class RedisClient
     self
   end
 
+  def discard
+    @raw_connection&.discard
+    self
+  end
+
   def pipelined
     pipeline = Pipeline.new(@command_builder)
     yield pipeline
@@ -609,7 +623,7 @@ class RedisClient
   end
 
   def ensure_connected(retryable: true)
-    close if !config.inherit_socket && @pid != PIDCache.pid
+    discard if !config.inherit_socket && @pid != PIDCache.pid
 
     if @disable_reconnection
       if block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-08-01 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.3.7
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+