Skip to content

Commit 5dba883

Browse files
AndreasMadsengibfahn
AndreasMadsen
authored and
gibfahn
committed
async_hooks,http: set HTTPParser trigger to socket
This allows more easy tracking of where HTTP requests come from. Before this change the HTTPParser would have the HTTPServer as the triggerAsyncId. The HTTPParser will still have the executionAsyncId set to the HTTP Server so that information is still directly available. Indirectly, the TCP socket itself also has its triggerAsyncId set to the TCP Server. PR-URL: nodejs#18003 Backport-PR-URL: nodejs#18179 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
1 parent a8b7e43 commit 5dba883

3 files changed

Lines changed: 86 additions & 10 deletions

File tree

‎lib/_http_server.js‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ const {
3737
} = require('_http_common');
3838
const { OutgoingMessage } = require('_http_outgoing');
3939
const { outHeadersKey, ondrain } = require('internal/http');
40+
const {
41+
defaultTriggerAsyncIdScope,
42+
getOrSetAsyncId
43+
} = require('internal/async_hooks');
4044

4145
const STATUS_CODES = {
4246
100: 'Continue',
@@ -289,20 +293,26 @@ Server.prototype.setTimeout = function setTimeout(msecs, callback) {
289293

290294

291295
function connectionListener(socket) {
296+
defaultTriggerAsyncIdScope(
297+
getOrSetAsyncId(socket), connectionListenerInternal, this, socket
298+
);
299+
}
300+
301+
function connectionListenerInternal(server, socket) {
292302
debug('SERVER new http connection');
293303

294304
httpSocketSetup(socket);
295305

296306
// Ensure that the server property of the socket is correctly set.
297307
// See https://github.com/nodejs/node/issues/13435
298308
if (socket.server === null)
299-
socket.server = this;
309+
socket.server = server;
300310

301311
// If the user has added a listener to the server,
302312
// request, or response, then it's their responsibility.
303313
// otherwise, destroy on timeout by default
304-
if (this.timeout && typeof socket.setTimeout === 'function')
305-
socket.setTimeout(this.timeout);
314+
if (server.timeout && typeof socket.setTimeout === 'function')
315+
socket.setTimeout(server.timeout);
306316
socket.on('timeout', socketOnTimeout);
307317

308318
var parser = parsers.alloc();
@@ -312,8 +322,8 @@ function connectionListener(socket) {
312322
parser.incoming = null;
313323

314324
// Propagate headers limit from server instance to parser
315-
if (typeof this.maxHeadersCount === 'number') {
316-
parser.maxHeaderPairs = this.maxHeadersCount << 1;
325+
if (typeof server.maxHeadersCount === 'number') {
326+
parser.maxHeaderPairs = server.maxHeadersCount << 1;
317327
} else {
318328
// Set default value because parser may be reused from FreeList
319329
parser.maxHeaderPairs = 2000;
@@ -333,16 +343,16 @@ function connectionListener(socket) {
333343
outgoingData: 0,
334344
keepAliveTimeoutSet: false
335345
};
336-
state.onData = socketOnData.bind(undefined, this, socket, parser, state);
337-
state.onEnd = socketOnEnd.bind(undefined, this, socket, parser, state);
346+
state.onData = socketOnData.bind(undefined, server, socket, parser, state);
347+
state.onEnd = socketOnEnd.bind(undefined, server, socket, parser, state);
338348
state.onClose = socketOnClose.bind(undefined, socket, state);
339349
state.onDrain = socketOnDrain.bind(undefined, socket, state);
340350
socket.on('data', state.onData);
341351
socket.on('error', socketOnError);
342352
socket.on('end', state.onEnd);
343353
socket.on('close', state.onClose);
344354
socket.on('drain', state.onDrain);
345-
parser.onIncoming = parserOnIncoming.bind(undefined, this, socket, state);
355+
parser.onIncoming = parserOnIncoming.bind(undefined, server, socket, state);
346356

347357
// We are consuming socket, so it won't get any actual data
348358
socket.on('resume', onSocketResume);
@@ -361,7 +371,7 @@ function connectionListener(socket) {
361371
}
362372
}
363373
parser[kOnExecute] =
364-
onParserExecute.bind(undefined, this, socket, parser, state);
374+
onParserExecute.bind(undefined, server, socket, parser, state);
365375

366376
socket._paused = false;
367377
}

‎lib/internal/async_hooks.js‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const async_wrap = process.binding('async_wrap');
2626
* It has a fixed size, so if that is exceeded, calls to the native
2727
* side are used instead in pushAsyncIds() and popAsyncIds().
2828
*/
29-
const { async_hook_fields, async_id_fields } = async_wrap;
29+
const { async_id_symbol, async_hook_fields, async_id_fields } = async_wrap;
3030
// Store the pair executionAsyncId and triggerAsyncId in a std::stack on
3131
// Environment::AsyncHooks::ids_stack_ tracks the resource responsible for the
3232
// current execution stack. This is unwound as each resource exits. In the case
@@ -251,6 +251,15 @@ function newUid() {
251251
return ++async_id_fields[kAsyncIdCounter];
252252
}
253253

254+
function getOrSetAsyncId(object) {
255+
if (object.hasOwnProperty(async_id_symbol)) {
256+
return object[async_id_symbol];
257+
}
258+
259+
return object[async_id_symbol] = newUid();
260+
}
261+
262+
254263
// Return the triggerAsyncId meant for the constructor calling it. It's up to
255264
// the user to safeguard this call and make sure it's zero'd out when the
256265
// constructor is complete.
@@ -381,6 +390,7 @@ module.exports = {
381390
disableHooks,
382391
// Sensitive Embedder API
383392
newUid,
393+
getOrSetAsyncId,
384394
getDefaultTriggerAsyncId,
385395
defaultTriggerAsyncIdScope,
386396
emitInit: emitInitScript,

‎test/async-hooks/test-graph.http.js‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
'use strict';
2+
3+
const common = require('../common');
4+
const initHooks = require('./init-hooks');
5+
const verifyGraph = require('./verify-graph');
6+
const http = require('http');
7+
8+
const hooks = initHooks();
9+
hooks.enable();
10+
11+
const server = http.createServer(common.mustCall(function(req, res) {
12+
res.end();
13+
this.close(common.mustCall());
14+
}));
15+
server.listen(0, common.mustCall(function() {
16+
http.get(`http://127.0.0.1:${server.address().port}`, common.mustCall());
17+
}));
18+
19+
process.on('exit', function() {
20+
hooks.disable();
21+
22+
verifyGraph(
23+
hooks,
24+
[ { type: 'TCPSERVERWRAP',
25+
id: 'tcpserver:1',
26+
triggerAsyncId: null },
27+
{ type: 'TCPWRAP', id: 'tcp:1', triggerAsyncId: 'tcpserver:1' },
28+
{ type: 'TCPCONNECTWRAP',
29+
id: 'tcpconnect:1',
30+
triggerAsyncId: 'tcp:1' },
31+
{ type: 'HTTPPARSER',
32+
id: 'httpparser:1',
33+
triggerAsyncId: 'tcpserver:1' },
34+
{ type: 'HTTPPARSER',
35+
id: 'httpparser:2',
36+
triggerAsyncId: 'tcpserver:1' },
37+
{ type: 'TCPWRAP', id: 'tcp:2', triggerAsyncId: 'tcpserver:1' },
38+
{ type: 'Timeout', id: 'timeout:1', triggerAsyncId: 'tcp:2' },
39+
{ type: 'TIMERWRAP', id: 'timer:1', triggerAsyncId: 'tcp:2' },
40+
{ type: 'HTTPPARSER',
41+
id: 'httpparser:3',
42+
triggerAsyncId: 'tcp:2' },
43+
{ type: 'HTTPPARSER',
44+
id: 'httpparser:4',
45+
triggerAsyncId: 'tcp:2' },
46+
{ type: 'Timeout',
47+
id: 'timeout:2',
48+
triggerAsyncId: 'httpparser:4' },
49+
{ type: 'TIMERWRAP',
50+
id: 'timer:2',
51+
triggerAsyncId: 'httpparser:4' },
52+
{ type: 'SHUTDOWNWRAP',
53+
id: 'shutdown:1',
54+
triggerAsyncId: 'tcp:2' } ]
55+
);
56+
});

0 commit comments

Comments
 (0)