fix: add more idle timeout options

Author: ronag

README.md

@@ -56,6 +56,15 @@ Options:
   This value may be overriden by keep-alive hints from the server.
   Default: `4e3` milliseconds (4s).
 
+- `maxIdleTimeout: Number`, the maximum allowed `idleTimeout` when overriden by
+  keep-alive hints from the server.
+  Default: `600e3` milliseconds (10min).
+
+- `idleThreshold: Number`, a number subtracted from server keep-alive hints
+  when overriding `idleTimeout` to account for timing inaccuries caused by e.g.
+  request/response latency.
+  Default: `1e3` milliseconds (1s).
+
 - `requestTimeout: Number`, the timeout after which a request will time out.
   Monitors time between request being enqueued and receiving
   a response. Use `0` to disable it entirely.

lib/client.js

@@ -49,7 +49,9 @@ const {
   kEnqueue,
   kKeepAliveTimeout,
   kMaxHeadersSize,
-  kHeadersTimeout
+  kHeadersTimeout,
+  kMaxIdleTimeout,
+  kIdleThreshold
 } = require('./symbols')
 const makeStream = require('./client-stream')
 const makeRequest = require('./client-request')
@@ -69,6 +71,8 @@ class Client extends EventEmitter {
     headersTimeout,
     socketTimeout,
     idleTimeout,
+    maxIdleTimeout,
+    idleThreshold,
     socketPath,
     requestTimeout,
     pipelining,
@@ -120,6 +124,18 @@ class Client extends EventEmitter {
       throw new InvalidArgumentError('invalid idleTimeout')
     }
 
+    if (idleTimeout != null && (!Number.isFinite(idleTimeout) || idleTimeout <= 0)) {
+      throw new InvalidArgumentError('invalid idleTimeout')
+    }
+
+    if (maxIdleTimeout != null && (!Number.isFinite(maxIdleTimeout) || maxIdleTimeout <= 0)) {
+      throw new InvalidArgumentError('invalid maxIdleTimeout')
+    }
+
+    if (idleThreshold != null && !Number.isFinite(idleThreshold)) {
+      throw new InvalidArgumentError('invalid idleThreshold')
+    }
+
     if (requestTimeout != null && !Number.isFinite(requestTimeout)) {
       throw new InvalidArgumentError('invalid requestTimeout')
     }
@@ -136,7 +152,9 @@ class Client extends EventEmitter {
     this[kUrl] = url
     this[kSocketPath] = socketPath
     this[kSocketTimeout] = socketTimeout == null ? 30e3 : socketTimeout
+    this[kMaxIdleTimeout] = maxIdleTimeout == null ? 600e3 : maxIdleTimeout
     this[kIdleTimeout] = idleTimeout == null ? 4e3 : idleTimeout
+    this[kIdleThreshold] = idleThreshold == null ? 1e3 : idleThreshold
     this[kKeepAliveTimeout] = this[kIdleTimeout]
     this[kRequestTimeout] = requestTimeout == null ? 30e3 : requestTimeout
     this[kClosed] = false
@@ -494,12 +512,14 @@ class Parser extends HTTPParser {
     if (headers['keep-alive']) {
       const m = headers['keep-alive'].match(/timeout=(\d+)/)
       if (m) {
-        const timeout = Number(m[1])
-        if (!timeout) {
+        const keepAliveTimeout = Math.min(
+          Number(m[1]) * 1000 - client[kIdleThreshold],
+          client[kMaxIdleTimeout]
+        )
+        if (!keepAliveTimeout || keepAliveTimeout < 1e3) {
           client[kReset] = true
         } else {
-          // Set timeout to 500ms less than hint to account for timing inaccuracies.
-          client[kKeepAliveTimeout] = timeout * 1000 - 500
+          client[kKeepAliveTimeout] = keepAliveTimeout
         }
       }
     } else {

lib/pool.js

@@ -12,27 +12,15 @@ const {
 class Pool {
   constructor (url, {
     connections,
-    maxAbortedPayload,
-    socketTimeout,
-    requestTimeout,
-    pipelining,
-    tls,
-    socketPath
+    ...options
   } = {}) {
     if (connections != null && (!Number.isFinite(connections) || connections <= 0)) {
       throw new InvalidArgumentError('invalid connections')
     }
 
     this[kClients] = Array.from({
       length: connections || 10
-    }, () => new Client(url, {
-      maxAbortedPayload,
-      socketTimeout,
-      requestTimeout,
-      pipelining,
-      tls,
-      socketPath
-    }))
+    }, () => new Client(url, options))
   }
 
   /* istanbul ignore next: use by benchmark */

lib/symbols.js

@@ -6,6 +6,8 @@ module.exports = {
   kConnect: Symbol('connect'),
   kSocketTimeout: Symbol('socket timeout'),
   kIdleTimeout: Symbol('idle timeout'),
+  kMaxIdleTimeout: Symbol('max idle timeout'),
+  kIdleThreshold: Symbol('keep alive threshold'),
   kRequestTimeout: Symbol('request timeout'),
   kKeepAliveTimeout: Symbol('keep alive timeout'),
   kServerName: Symbol('server name'),