http: provide keep-alive timeout response header

ronag · codebytere · commit 36fd3daae6fc · 2020-08-05T09:13:56.000-07:00
In http 1.1 persistent connection protocol there is a timing race where the client sends the request and then the server kills the connection (due to inactivity) before receiving the client's request. By providing a keep-alive header it is possible to provide the client a hint of when idle timeout would occur and avoid the race. Fixes: #34560 PR-URL: #34561 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
diff --git a/lib/_http_outgoing.js b/lib/_http_outgoing.js
@@ -28,6 +28,7 @@ const {
   ObjectKeys,
   ObjectPrototypeHasOwnProperty,
   ObjectSetPrototypeOf,
+  MathFloor,
   Symbol,
 } = primordials;
 
@@ -118,6 +119,8 @@ function OutgoingMessage() {
   this._header = null;
   this[kOutHeaders] = null;
 
+  this._keepAliveTimeout = 0;
+
   this._onPendingData = noopPendingOutput;
 }
 ObjectSetPrototypeOf(OutgoingMessage.prototype, Stream.prototype);
@@ -419,6 +422,10 @@ function _storeHeader(firstLine, headers) {
         (state.contLen || this.useChunkedEncodingByDefault || this.agent);
     if (shouldSendKeepAlive) {
       header += 'Connection: keep-alive\r\n';
+      if (this._keepAliveTimeout) {
+        const timeoutSeconds = MathFloor(this._keepAliveTimeout) / 1000;
+        header += `Keep-Alive: timeout=${timeoutSeconds}\r\n`;
+      }
     } else {
       this._last = true;
       header += 'Connection: close\r\n';
diff --git a/lib/_http_server.js b/lib/_http_server.js
@@ -743,6 +743,7 @@ function parserOnIncoming(server, socket, state, req, keepAlive) {
   }
 
   const res = new server[kServerResponse](req);
+  res._keepAliveTimeout = server.keepAliveTimeout;
   res._onPendingData = updateOutgoingData.bind(undefined, socket, state);
 
   res.shouldKeepAlive = keepAlive;
diff --git a/test/parallel/test-http-keep-alive-timeout.js b/test/parallel/test-http-keep-alive-timeout.js
@@ -0,0 +1,28 @@
+'use strict';
+
+const common = require('../common');
+const http = require('http');
+const assert = require('assert');
+
+const server = http.createServer(common.mustCall((req, res) => {
+  const body = 'hello world\n';
+
+  res.writeHead(200, { 'Content-Length': body.length });
+  res.write(body);
+  res.end();
+}));
+server.keepAliveTimeout = 12000;
+
+const agent = new http.Agent({ maxSockets: 1, keepAlive: true });
+
+server.listen(0, common.mustCall(function() {
+  http.get({
+    path: '/', port: this.address().port, agent: agent
+  }, common.mustCall((response) => {
+    response.resume();
+    assert.strictEqual(
+      response.headers['keep-alive'], 'timeout=12');
+    server.close();
+    agent.destroy();
+  }));
+}));

Original file line number	Diff line number	Diff line change
`@@ -743,6 +743,7 @@ function parserOnIncoming(server, socket, state, req, keepAlive) {`
`743`	`743`	`}`
`744`	`744`
`745`	`745`	`const res = new server[kServerResponse](req);`
	`746`	`+ res._keepAliveTimeout = server.keepAliveTimeout;`
`746`	`747`	`res._onPendingData = updateOutgoingData.bind(undefined, socket, state);`
`747`	`748`
`748`	`749`	`res.shouldKeepAlive = keepAlive;`