Add custom keep alive timeout seconds

Author: erimicel

README.md

@@ -47,7 +47,7 @@ Notes:
 
 - Connections are cached per `(thread, node)`. `Net::HTTP` is not thread-safe, so each thread maintains its own keep-alive socket to each Typesense node, and the existing node round-robin still works.
 - A cached connection is dropped automatically when a network error occurs, so retries open a fresh socket. We recommend setting `num_retries` to at least `1` so the gem can recover from a server- or load-balancer-side idle timeout transparently.
-- Idle sockets are closed after 30 seconds; tune your load balancer's idle timeout to match or exceed this.
+- Idle sockets are closed after 30 seconds by default. Override with `keep_alive_idle_timeout_seconds` to match or stay under your load balancer's idle timeout.
 - The option defaults to `false`, so upgrading the gem does not change behaviour until you opt in.
 
 ## Compatibility

lib/typesense/api_call.rb

@@ -6,7 +6,6 @@
 module Typesense
   class ApiCall
     API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY'
-    KEEP_ALIVE_IDLE_TIMEOUT_SECONDS = 30
 
     attr_reader :logger
 
@@ -21,6 +20,7 @@ def initialize(configuration)
       @num_retries_per_request = @configuration.num_retries
       @retry_interval_seconds = @configuration.retry_interval_seconds
       @keep_alive_connections = @configuration.keep_alive_connections
+      @keep_alive_idle_timeout_seconds = @configuration.keep_alive_idle_timeout_seconds
 
       @logger = @configuration.logger
 
@@ -176,7 +176,7 @@ def build_keep_alive_connection(node)
         f.options.timeout = @connection_timeout_seconds
         f.options.open_timeout = @connection_timeout_seconds
         f.adapter :net_http_persistent, pool_size: 1 do |http|
-          http.idle_timeout = KEEP_ALIVE_IDLE_TIMEOUT_SECONDS
+          http.idle_timeout = @keep_alive_idle_timeout_seconds
         end
       end
     end

lib/typesense/configuration.rb

@@ -4,7 +4,7 @@
 
 module Typesense
   class Configuration
-    attr_accessor :nodes, :nearest_node, :connection_timeout_seconds, :healthcheck_interval_seconds, :num_retries, :retry_interval_seconds, :api_key, :logger, :log_level, :keep_alive_connections
+    attr_accessor :nodes, :nearest_node, :connection_timeout_seconds, :healthcheck_interval_seconds, :num_retries, :retry_interval_seconds, :api_key, :logger, :log_level, :keep_alive_connections, :keep_alive_idle_timeout_seconds
 
     def initialize(options = {})
       @nodes = options[:nodes] || []
@@ -15,6 +15,7 @@ def initialize(options = {})
       @retry_interval_seconds = options[:retry_interval_seconds] || 0.1
       @api_key = options[:api_key]
       @keep_alive_connections = options.fetch(:keep_alive_connections, false)
+      @keep_alive_idle_timeout_seconds = options[:keep_alive_idle_timeout_seconds] || 30
 
       @logger = options[:logger] || Logger.new($stdout)
       @log_level = options[:log_level] || Logger::WARN

spec/typesense/api_call_spec.rb

@@ -338,6 +338,24 @@
       expect(conn.options.timeout).to eq(keep_alive_typesense.configuration.connection_timeout_seconds)
       expect(conn.options.open_timeout).to eq(keep_alive_typesense.configuration.connection_timeout_seconds)
     end
+
+    it 'defaults the idle timeout to 30 seconds' do
+      expect(keep_alive_typesense.configuration.keep_alive_idle_timeout_seconds).to eq(30)
+    end
+
+    it 'honours a custom keep_alive_idle_timeout_seconds' do
+      custom_client = Typesense::Client.new(
+        api_key: 'abcd',
+        nodes: typesense.configuration.nodes,
+        connection_timeout_seconds: 10,
+        log_level: Logger::ERROR,
+        keep_alive_connections: true,
+        keep_alive_idle_timeout_seconds: 5
+      )
+
+      expect(custom_client.configuration.keep_alive_idle_timeout_seconds).to eq(5)
+      expect(described_class.new(custom_client.configuration).instance_variable_get(:@keep_alive_idle_timeout_seconds)).to eq(5)
+    end
   end
 
   describe 'keep-alive disabled (default)' do