redis-client 0.12.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5e453ca140b38cff3f62e947e4168ca950117d1ff03562e5d6ed2bad0dbdd83
-  data.tar.gz: 8fe7edeb11051105d2505f95e6cda7360c2cf6a438b93e5bb0f775538456f28d
+  metadata.gz: ac50722e5156b95e037fb5fd933cb804a3d52d0d767faa2bbddaccc7cbd38d07
+  data.tar.gz: 0a1645c3788dd195bf3567e14c0ba508b892357991359297c002c84bd2796e2e
 SHA512:
-  metadata.gz: 27596015912265226cd39b7c6e27fff214e096166121aa0e8dba0a0f81a7ba45663c0d28239e3610d57c3955ace8cfc1f428c4af8f9373b80bb196eeb89c61a8
-  data.tar.gz: 91b24e94e5332f4e74ca2dbb2e9adc60f7e8f9c5b698b1af5dfd5483bf836c95f6a79f39689272b742c6693ff8b6a6dd0d275e820f4a29f6d86b4dab650be6b4
+  metadata.gz: 0c93ddbae9ffdd770589eb6003eee594dc902a8d2698c99c38878b923ac80a91aa6a43892d015d9a4ba52ef19300c95970a8947e25f1844c4c01d4b88ff9d9ae
+  data.tar.gz: a06dd7eaa65ccf8544b4f04f7beffe2580d139783770170fcf76348c5760f78c5baa0d77e734a31111c720df6458bb8112a64960316618b831fdb6059b625963

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Unreleased
 
+# 0.14.0
+
+- 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.
+
+# 0.13.0
+
+- Enable TCP keepalive on redis sockets. It sends a keep alive probe every 15 seconds for 2 minutes. #94.
+
 # 0.12.2
 
 - Cache calls to `Process.pid` on Ruby 3.1+. #91.

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    redis-client (0.12.2)
+    redis-client (0.14.0)
       connection_pool
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    benchmark-ips (2.10.0)
+    benchmark-ips (2.11.0)
     byebug (11.1.3)
     connection_pool (2.3.0)
     hiredis (0.6.3)

data/Rakefile

@@ -26,6 +26,7 @@ namespace :test do
     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|
@@ -33,13 +34,16 @@ namespace :test do
     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
 

data/lib/redis_client/config.rb

@@ -112,7 +112,9 @@ class RedisClient
       end
 
       def ssl_context
-        @ssl_context ||= @driver.ssl_context(@ssl_params || {})
+        if ssl
+          @ssl_context ||= @driver.ssl_context(@ssl_params || {})
+        end
       end
 
       def server_url

data/lib/redis_client/connection_mixin.rb

@@ -6,9 +6,22 @@ class RedisClient
       @pending_reads = 0
     end
 
+    def reconnect
+      close
+      connect
+    end
+
+    def close
+      @pending_reads = 0
+      nil
+    end
+
     def revalidate
-      if @pending_reads == 0 && connected?
-        self
+      if @pending_reads > 0
+        close
+        false
+      else
+        connected?
       end
     end
 

data/lib/redis_client/ruby_connection.rb

@@ -42,43 +42,11 @@ class RedisClient
 
     def initialize(config, connect_timeout:, read_timeout:, write_timeout:)
       super()
-      socket = if config.path
-        UNIXSocket.new(config.path)
-      else
-        sock = if SUPPORTS_RESOLV_TIMEOUT
-          Socket.tcp(config.host, config.port, connect_timeout: connect_timeout, resolv_timeout: connect_timeout)
-        else
-          Socket.tcp(config.host, config.port, connect_timeout: connect_timeout)
-        end
-        # disables Nagle's Algorithm, prevents multiple round trips with MULTI
-        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
-        sock
-      end
-
-      if config.ssl
-        socket = OpenSSL::SSL::SSLSocket.new(socket, config.ssl_context)
-        socket.hostname = config.host
-        loop do
-          case status = socket.connect_nonblock(exception: false)
-          when :wait_readable
-            socket.to_io.wait_readable(connect_timeout) or raise CannotConnectError
-          when :wait_writable
-            socket.to_io.wait_writable(connect_timeout) or raise CannotConnectError
-          when socket
-            break
-          else
-            raise "Unexpected `connect_nonblock` return: #{status.inspect}"
-          end
-        end
-      end
-
-      @io = BufferedIO.new(
-        socket,
-        read_timeout: read_timeout,
-        write_timeout: write_timeout,
-      )
-    rescue SystemCallError, OpenSSL::SSL::SSLError, SocketError => error
-      raise CannotConnectError, error.message, error.backtrace
+      @config = config
+      @connect_timeout = connect_timeout
+      @read_timeout = read_timeout
+      @write_timeout = write_timeout
+      connect
     end
 
     def connected?
@@ -87,13 +55,16 @@ class RedisClient
 
     def close
       @io.close
+      super
     end
 
     def read_timeout=(timeout)
+      @read_timeout = timeout
       @io.read_timeout = timeout if @io
     end
 
     def write_timeout=(timeout)
+      @write_timeout = timeout
       @io.write_timeout = timeout if @io
     end
 
@@ -129,5 +100,78 @@ class RedisClient
     rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
       raise ConnectionError, error.message
     end
+
+    private
+
+    def connect
+      socket = if @config.path
+        UNIXSocket.new(@config.path)
+      else
+        sock = if SUPPORTS_RESOLV_TIMEOUT
+          Socket.tcp(@config.host, @config.port, connect_timeout: @connect_timeout, resolv_timeout: @connect_timeout)
+        else
+          Socket.tcp(@config.host, @config.port, connect_timeout: @connect_timeout)
+        end
+        # disables Nagle's Algorithm, prevents multiple round trips with MULTI
+        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        enable_socket_keep_alive(sock)
+        sock
+      end
+
+      if @config.ssl
+        socket = OpenSSL::SSL::SSLSocket.new(socket, @config.ssl_context)
+        socket.hostname = @config.host
+        loop do
+          case status = socket.connect_nonblock(exception: false)
+          when :wait_readable
+            socket.to_io.wait_readable(@connect_timeout) or raise CannotConnectError
+          when :wait_writable
+            socket.to_io.wait_writable(@connect_timeout) or raise CannotConnectError
+          when socket
+            break
+          else
+            raise "Unexpected `connect_nonblock` return: #{status.inspect}"
+          end
+        end
+      end
+
+      @io = BufferedIO.new(
+        socket,
+        read_timeout: @read_timeout,
+        write_timeout: @write_timeout,
+      )
+      true
+    rescue SystemCallError, OpenSSL::SSL::SSLError, SocketError => error
+      raise CannotConnectError, error.message, error.backtrace
+    end
+
+    KEEP_ALIVE_INTERVAL = 15 # Same as hiredis defaults
+    KEEP_ALIVE_TTL = 120 # Longer than hiredis defaults
+    KEEP_ALIVE_PROBES = (KEEP_ALIVE_TTL / KEEP_ALIVE_INTERVAL) - 1
+    private_constant :KEEP_ALIVE_INTERVAL
+    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
+      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)
+        socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, KEEP_ALIVE_INTERVAL)
+        socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPCNT, KEEP_ALIVE_PROBES)
+      end
+    elsif %i[IPPROTO_TCP TCP_KEEPINTVL TCP_KEEPCNT].all? { |c| Socket.const_defined? c } # macOS
+      def enable_socket_keep_alive(socket)
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+        socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPINTVL, KEEP_ALIVE_INTERVAL)
+        socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPCNT, KEEP_ALIVE_PROBES)
+      end
+    elsif %i[SOL_SOCKET SO_KEEPALIVE].all? { |c| Socket.const_defined? c } # unknown POSIX
+      def enable_socket_keep_alive(socket)
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+      end
+    else # unknown
+      def enable_socket_keep_alive(_socket)
+      end
+    end
   end
 end

data/lib/redis_client/sentinel_config.rb

@@ -13,9 +13,9 @@ class RedisClient
       end
 
       @to_list_of_hash = @to_hash = nil
-      extra_config = {}
+      @extra_config = {}
       if client_config[:protocol] == 2
-        extra_config[:protocol] = client_config[:protocol]
+        @extra_config[:protocol] = client_config[:protocol]
         @to_list_of_hash = lambda do |may_be_a_list|
           if may_be_a_list.is_a?(Array)
             may_be_a_list.map { |l| l.each_slice(2).to_h }
@@ -26,14 +26,7 @@ class RedisClient
       end
 
       @name = name
-      @sentinel_configs = sentinels.map do |s|
-        case s
-        when String
-          Config.new(**extra_config, url: s)
-        else
-          Config.new(**extra_config, **s)
-        end
-      end
+      @sentinel_configs = sentinels_to_configs(sentinels)
       @sentinels = {}.compare_by_identity
       @role = role
       @mutex = Mutex.new
@@ -93,6 +86,17 @@ class RedisClient
 
     private
 
+    def sentinels_to_configs(sentinels)
+      sentinels.map do |sentinel|
+        case sentinel
+        when String
+          Config.new(**@extra_config, url: sentinel)
+        else
+          Config.new(**@extra_config, **sentinel)
+        end
+      end
+    end
+
     def config
       @mutex.synchronize do
         @config ||= if @role == :master
@@ -106,9 +110,11 @@ class RedisClient
     def resolve_master
       each_sentinel do |sentinel_client|
         host, port = sentinel_client.call("SENTINEL", "get-master-addr-by-name", @name)
-        if host && port
-          return Config.new(host: host, port: Integer(port), **@client_config)
-        end
+        next unless host && port
+
+        refresh_sentinels(sentinel_client)
+
+        return Config.new(host: host, port: Integer(port), **@client_config)
       end
     rescue ConnectionError
       raise ConnectionError, "No sentinels available"
@@ -159,5 +165,19 @@ class RedisClient
 
       raise last_error if last_error
     end
+
+    def refresh_sentinels(sentinel_client)
+      sentinel_response = sentinel_client.call("SENTINEL", "sentinels", @name, &@to_list_of_hash)
+      sentinels = sentinel_response.map do |sentinel|
+        { host: sentinel.fetch("ip"), port: Integer(sentinel.fetch("port")) }
+      end
+      new_sentinels = sentinels.select do |sentinel|
+        @sentinel_configs.none? do |sentinel_config|
+          sentinel_config.host == sentinel.fetch(:host) && sentinel_config.port == sentinel.fetch(:port)
+        end
+      end
+
+      @sentinel_configs.concat sentinels_to_configs(new_sentinels)
+    end
   end
 end

data/lib/redis_client/version.rb

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

data/lib/redis_client.rb

@@ -346,7 +346,6 @@ class RedisClient
 
   def close
     @raw_connection&.close
-    @raw_connection = nil
     self
   end
 
@@ -430,7 +429,7 @@ class RedisClient
 
     def close
       @raw_connection&.close
-      @raw_connection = nil
+      @raw_connection = nil # PubSub can't just reconnect
       self
     end
 
@@ -654,20 +653,28 @@ class RedisClient
   end
 
   def raw_connection
-    @raw_connection = @raw_connection&.revalidate
-    @raw_connection ||= connect
+    if @raw_connection.nil? || !@raw_connection.revalidate
+      connect
+    end
+    @raw_connection
   end
 
   def connect
     @pid = PIDCache.pid
 
-    connection = @middlewares.connect(config) do
-      config.driver.new(
-        config,
-        connect_timeout: connect_timeout,
-        read_timeout: read_timeout,
-        write_timeout: write_timeout,
-      )
+    if @raw_connection
+      @middlewares.connect(config) do
+        @raw_connection.reconnect
+      end
+    else
+      @raw_connection = @middlewares.connect(config) do
+        config.driver.new(
+          config,
+          connect_timeout: connect_timeout,
+          read_timeout: read_timeout,
+          write_timeout: write_timeout,
+        )
+      end
     end
 
     prelude = config.connection_prelude.dup
@@ -680,18 +687,16 @@ class RedisClient
     if config.sentinel?
       prelude << ["ROLE"]
       role, = @middlewares.call_pipelined(prelude, config) do
-        connection.call_pipelined(prelude, nil).last
+        @raw_connection.call_pipelined(prelude, nil).last
       end
       config.check_role!(role)
     else
       unless prelude.empty?
         @middlewares.call_pipelined(prelude, config) do
-          connection.call_pipelined(prelude, nil)
+          @raw_connection.call_pipelined(prelude, nil)
         end
       end
     end
-
-    connection
   rescue FailoverError, CannotConnectError
     raise
   rescue ConnectionError => error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Simple low-level client for Redis 6+