Allow configuration of keepAliveTimeout (#47)

- Support setting keepAliveTimeout on servers

Author: jpage-godaddy

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.3.0
+
+- Support `keepAliveTimeout`
+
 ## 3.2.1
 
 - [#50] Fix bug where cert file reading errors do not surface

README.md

@@ -12,15 +12,18 @@ a node-style callback. The config object must have at minimum an `http` or
 | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `handler`                | Request handler to be used for any server, unless overridden specifically with `http.handler` or `https.handler`.                                                                                                                                                                     |
 | `timeout`                | Socket timeout in milliseconds for any server, unless overridden with `http.timeout` or `https.timeout`. Defaults to the node default of 2 minutes.                                                                                                                                   |
+| `keepAliveTimeout`       | Milliseconds of activity before sockets are destroyed. Defaults to the node default value (currently 5 seconds). |
 | `http`                   | Optional. If present, an HTTP server is started. This can be an object or a number. If it's a number, it's used as the TCP port for an HTTP server. You may also use an Array to start multiple servers.                                                                              |
 | `http.port`              | TCP port for the HTTP server. Defaults to `80`.                                                                                                                                                                                                                                       |
 | `http.host`              | The address the HTTP server is bound to. Defaults to `::` or `0.0.0.0`.                                                                                                                                                                                                               |
 | `http.timeout`           | Socket timeout in milliseconds for the server. If unspecified, the top-level `timeout` configuration is used.                                                                                                                                                                         |
+| `http.keepAliveTimeout`  | Overrides the top-level keepAliveTimeout setting if specified. |
 | `http.handler`           | Handler for HTTP requests. If you want to share a handler with all servers, use a top-level `handler` config property instead.                                                                                                                                                        |
 | `https`                  | Optional object. If present, an HTTPS server is started. You may start multiple HTTPS servers by passing an array of objects                                                                                                                                                          |
 | `https.port`             | TCP port for the HTTPS server. Defaults to `443`.                                                                                                                                                                                                                                     |
 | `https.host`             | The address the HTTPS server is bound to. Defaults to `::` or `0.0.0.0`.                                                                                                                                                                                                              |
 | `https.timeout`          | Socket timeout in milliseconds for the server. If unspecified, the top-level `timeout` configuration is used.                                                                                                                                                                         |
+| `https.keepAliveTimeout`  | Overrides the top-level keepAliveTimeout setting if specified. |
 | `https.ciphers`          | Defaults to a [default cipher suite](#note-on-security). To customize, either supply a colon-separated string or array of strings for the ciphers you want the server to support.                                                                                                     |
 | `https.honorCipherOrder` | If true, prefer the server's specified cipher order instead of the client's. Defaults to `false`.                                                                                                                                                                                     |
 | `https.root`             | Root directory for certificate/key files. See [Certificate normalization](#certificate-normalization) for more details.                                                                                                                                                               |

index.js

@@ -116,7 +116,8 @@ function normalizeHttpOptions(httpConfig, baseConfig) {
     host: httpConfig.host || baseConfig.host,
     port: +port,
     handler: httpConfig.handler || baseConfig.handler,
-    timeout: httpConfig.timeout || baseConfig.timeout
+    timeout: httpConfig.timeout || baseConfig.timeout,
+    keepAliveTimeout: httpConfig.keepAliveTimeout || baseConfig.keepAliveTimeout
   };
 
   if (!http.handler) {
@@ -138,7 +139,8 @@ function normalizeHttpsOptions(httpsConfig, baseConfig) {
     host: httpsConfig.host || baseConfig.host,
     port: +('port' in httpsConfig ? httpsConfig.port : 443),
     handler: httpsConfig.handler || baseConfig.handler,
-    timeout: httpsConfig.timeout || baseConfig.timeout
+    timeout: httpsConfig.timeout || baseConfig.timeout,
+    keepAliveTimeout: httpsConfig.keepAliveTimeout || baseConfig.keepAliveTimeout
   };
 
   if (!https.handler) {
@@ -295,10 +297,9 @@ async function createHttp(httpConfig, log) {
 
   const
     server = require('http').createServer(httpConfig.handler),
-    timeout = httpConfig.timeout,
     port = httpConfig.port;
 
-  if (typeof timeout === 'number') server.setTimeout(timeout);
+  commonPostCreateSetup(httpConfig, server);
 
   const args = [server, port];
   if (httpConfig.host) {
@@ -363,8 +364,7 @@ async function createHttps(ssl, log, h2) {
     ? require('http2').createSecureServer(finalHttpsOptions, ssl.handler)
     : require('https').createServer(finalHttpsOptions, ssl.handler);
 
-  const timeout = ssl.timeout;
-  if (typeof timeout === 'number') server.setTimeout(timeout);
+  commonPostCreateSetup(ssl, server);
   const args = [server, port];
   if (ssl.host) {
     args.push(ssl.host);
@@ -395,3 +395,12 @@ async function createMultiple(createFn, configArray, log) {
     return servers;
   }
 }
+
+function commonPostCreateSetup({ timeout, keepAliveTimeout }, server) {
+  if (typeof timeout === 'number') {
+    server.setTimeout(timeout);
+  }
+  if (typeof keepAliveTimeout === 'number') {
+    server.keepAliveTimeout = keepAliveTimeout;
+  }
+}

test/create-servers-test.js

@@ -173,6 +173,20 @@ test('only http, timeout', function (t) {
   });
 });
 
+test('keepAliveTimeout', function (t) {
+  t.plan(1);
+  const time = 3000000;
+  createServers({
+    log: console.log,
+    keepAliveTimeout: time,
+    http: 0,
+    handler: fend
+  }, function (err, servers) {
+    t.equals(servers.http.keepAliveTimeout, time);
+    servers.http.close();
+  });
+});
+
 test('only https', function (t) {
   t.plan(5);
   createServers({