http: make timeout event work with agent timeout

lpinca · addaleax · commit 25c19eb1d887 · 2019-02-01T16:21:23.000+01:00
The `'timeout'` event is currently not emitted on the `ClientRequest` instance when the socket timeout expires if only the `timeout` option of the agent is set. This happens because, under these circumstances, `listenSocketTimeout()` is not called. This commit fixes the issue by calling it also when only the agent `timeout` option is set. PR-URL: #25488 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/lib/_http_client.js b/lib/_http_client.js
@@ -655,7 +655,10 @@ function tickOnSocket(req, socket) {
   socket.on('end', socketOnEnd);
   socket.on('close', socketCloseListener);
 
-  if (req.timeout !== undefined) {
+  if (
+    req.timeout !== undefined ||
+    (req.agent && req.agent.options && req.agent.options.timeout)
+  ) {
     listenSocketTimeout(req);
   }
   req.emit('socket', socket);
diff --git a/test/parallel/test-http-agent-timeout-option.js b/test/parallel/test-http-agent-timeout-option.js
@@ -0,0 +1,23 @@
+'use strict';
+
+const { expectsError, mustCall } = require('../common');
+const { Agent, get } = require('http');
+
+// Test that the `'timeout'` event is emitted on the `ClientRequest` instance
+// when the socket timeout set via the `timeout` option of the `Agent` expires.
+
+const request = get({
+  agent: new Agent({ timeout: 500 }),
+  // Non-routable IP address to prevent the connection from being established.
+  host: '192.0.2.1'
+});
+
+request.on('error', expectsError({
+  type: Error,
+  code: 'ECONNRESET',
+  message: 'socket hang up'
+}));
+
+request.on('timeout', mustCall(() => {
+  request.abort();
+}));
