redis-client 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0845ff9c4cbb2e63f1add455942b56eed1840abdd671e0d40aebb860bf6e8510'
-  data.tar.gz: 2ac5ed7d4ff7762d715f17fa462a6f139c65ba0c0055f25718af968e941ff805
+  metadata.gz: e12fdb44add8ecb747b797c75a5991c973cb78519bbbce1f15a68bb80d1e2bb9
+  data.tar.gz: 0def4c2cc5a2f55ec9e9eb48a4ce5bfeadbef889c9695642126c011aebcd83b2
 SHA512:
-  metadata.gz: 0e252e338aacc68a076fa2efe01d1bde4a74e25547c145670a979d0605ae022fc9a766e20ca765e7e2d4931298a7558fb154aed27d9d0c6ea5256238ac195d64
-  data.tar.gz: 4f3f9da3836a2c0e587322aece7d7932b0968f2b9d99fa665d557e2647c3a9e8ac41fc82feb2317d3169d6ddc9349eefef82c579f4415e4c0749d6a9b78dec38
+  metadata.gz: 5b242cf54b503ae90c4642acdd8d59d8022639cb97de09a664afcbaec8730269fab79e298b0e4e2f74fe54f14ecc36e54adbb65b508d9aead715d0758921a2bd
+  data.tar.gz: e8b33e77e568ad63150b40e5a17d5ef528346868d802be80b4953d68986a89b93eaa1d24dcd80368c7b73bcab4ee9428d6d0ad99f300eb18ef43502783649686

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 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.
+
 # 0.12.1
 
 - Improve compatibility with `uri 0.12.0` (default in Ruby 3.2.0).

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    redis-client (0.12.1)
+    redis-client (0.13.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/lib/redis_client/pid_cache.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class RedisClient
+  module PIDCache
+    if !Process.respond_to?(:fork) # JRuby or TruffleRuby
+      @pid = Process.pid
+      singleton_class.attr_reader(:pid)
+    elsif Process.respond_to?(:_fork) # Ruby 3.1+
+      class << self
+        attr_reader :pid
+
+        def update!
+          @pid = Process.pid
+        end
+      end
+      update!
+
+      module CoreExt
+        def _fork
+          child_pid = super
+          PIDCache.update! if child_pid == 0
+          child_pid
+        end
+      end
+      Process.singleton_class.prepend(CoreExt)
+    else # Ruby 3.0 or older
+      class << self
+        def pid
+          Process.pid
+        end
+      end
+    end
+  end
+end

data/lib/redis_client/ruby_connection.rb

@@ -52,6 +52,7 @@ class RedisClient
         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
 
@@ -129,5 +130,36 @@ class RedisClient
     rescue SystemCallError, IOError, OpenSSL::SSL::SSLError => error
       raise ConnectionError, error.message
     end
+
+    private
+
+    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/version.rb

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

data/lib/redis_client.rb

@@ -3,6 +3,7 @@
 require "redis_client/version"
 require "redis_client/command_builder"
 require "redis_client/config"
+require "redis_client/pid_cache"
 require "redis_client/sentinel_config"
 require "redis_client/middlewares"
 
@@ -67,7 +68,7 @@ class RedisClient
       @read_timeout = read_timeout
       @write_timeout = write_timeout
       @command_builder = config.command_builder
-      @pid = Process.pid
+      @pid = PIDCache.pid
     end
 
     def timeout=(timeout)
@@ -609,7 +610,7 @@ class RedisClient
   end
 
   def ensure_connected(retryable: true)
-    close if !config.inherit_socket && @pid != Process.pid
+    close if !config.inherit_socket && @pid != PIDCache.pid
 
     if @disable_reconnection
       if block_given?
@@ -658,7 +659,7 @@ class RedisClient
   end
 
   def connect
-    @pid = Process.pid
+    @pid = PIDCache.pid
 
     connection = @middlewares.connect(config) do
       config.driver.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -45,6 +45,7 @@ files:
 - lib/redis_client/connection_mixin.rb
 - lib/redis_client/decorator.rb
 - lib/redis_client/middlewares.rb
+- lib/redis_client/pid_cache.rb
 - lib/redis_client/pooled.rb
 - lib/redis_client/ruby_connection.rb
 - lib/redis_client/ruby_connection/buffered_io.rb
@@ -75,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+