-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
async_hooks: don't reuse resource in HttpAgent
As discussed in nodejs/diagnostics#248, #21313 and https://docs.google.com/document/d/1g8OrG5lMIUhRn1zbkutgY83MiTSMx-0NHDs8Bf-nXxM/preview reusing the resource object is a blocker for landing a resource based async hooks API and get rid of the promise destroy hook. This PR ensures that HttpAgent uses the a new resource object in case the socket handle gets reused. PR-URL: #27581 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Rich Trott <[email protected]>
- Loading branch information
Showing
5 changed files
with
141 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
'use strict'; | ||
// Flags: --expose-internals | ||
const common = require('../common'); | ||
const initHooks = require('./init-hooks'); | ||
const { checkInvocations } = require('./hook-checks'); | ||
const assert = require('assert'); | ||
const { async_id_symbol } = require('internal/async_hooks').symbols; | ||
const http = require('http'); | ||
|
||
// Checks that the async resource used in init in case of a resused handle | ||
// is not reused. Test is based on parallel\test-async-hooks-http-agent.js. | ||
|
||
const hooks = initHooks(); | ||
hooks.enable(); | ||
|
||
let asyncIdAtFirstReq; | ||
let asyncIdAtSecondReq; | ||
|
||
// Make sure a single socket is transparently reused for 2 requests. | ||
const agent = new http.Agent({ | ||
keepAlive: true, | ||
keepAliveMsecs: Infinity, | ||
maxSockets: 1 | ||
}); | ||
|
||
const server = http.createServer(common.mustCall((req, res) => { | ||
req.once('data', common.mustCallAtLeast(() => { | ||
res.writeHead(200, { 'Content-Type': 'text/plain' }); | ||
res.write('foo'); | ||
})); | ||
req.on('end', common.mustCall(() => { | ||
res.end('bar'); | ||
})); | ||
}, 2)).listen(0, common.mustCall(() => { | ||
const port = server.address().port; | ||
const payload = 'hello world'; | ||
|
||
// First request. This is useless except for adding a socket to the | ||
// agent’s pool for reuse. | ||
const r1 = http.request({ | ||
agent, port, method: 'POST' | ||
}, common.mustCall((res) => { | ||
// Remember which socket we used. | ||
const socket = res.socket; | ||
asyncIdAtFirstReq = socket[async_id_symbol]; | ||
assert.ok(asyncIdAtFirstReq > 0, `${asyncIdAtFirstReq} > 0`); | ||
// Check that request and response share their socket. | ||
assert.strictEqual(r1.socket, socket); | ||
|
||
res.on('data', common.mustCallAtLeast(() => {})); | ||
res.on('end', common.mustCall(() => { | ||
// setImmediate() to give the agent time to register the freed socket. | ||
setImmediate(common.mustCall(() => { | ||
// The socket is free for reuse now. | ||
assert.strictEqual(socket[async_id_symbol], -1); | ||
|
||
// Second request. To re-create the exact conditions from the | ||
// referenced issue, we use a POST request without chunked encoding | ||
// (hence the Content-Length header) and call .end() after the | ||
// response header has already been received. | ||
const r2 = http.request({ | ||
agent, port, method: 'POST', headers: { | ||
'Content-Length': payload.length | ||
} | ||
}, common.mustCall((res) => { | ||
asyncIdAtSecondReq = res.socket[async_id_symbol]; | ||
assert.ok(asyncIdAtSecondReq > 0, `${asyncIdAtSecondReq} > 0`); | ||
assert.strictEqual(r2.socket, socket); | ||
|
||
// Empty payload, to hit the “right” code path. | ||
r2.end(''); | ||
|
||
res.on('data', common.mustCallAtLeast(() => {})); | ||
res.on('end', common.mustCall(() => { | ||
// Clean up to let the event loop stop. | ||
server.close(); | ||
agent.destroy(); | ||
})); | ||
})); | ||
|
||
// Schedule a payload to be written immediately, but do not end the | ||
// request just yet. | ||
r2.write(payload); | ||
})); | ||
})); | ||
})); | ||
r1.end(payload); | ||
})); | ||
|
||
|
||
process.on('exit', onExit); | ||
|
||
function onExit() { | ||
hooks.disable(); | ||
hooks.sanityCheck(); | ||
const activities = hooks.activities; | ||
|
||
// Verify both invocations | ||
const first = activities.filter((x) => x.uid === asyncIdAtFirstReq)[0]; | ||
checkInvocations(first, { init: 1, destroy: 1 }, 'when process exits'); | ||
|
||
const second = activities.filter((x) => x.uid === asyncIdAtSecondReq)[0]; | ||
checkInvocations(second, { init: 1, destroy: 1 }, 'when process exits'); | ||
|
||
// Verify reuse handle has been wrapped | ||
assert.strictEqual(first.type, second.type); | ||
assert.ok(first.handle !== second.handle, 'Resource reused'); | ||
assert.ok(first.handle === second.handle.handle, | ||
'Resource not wrapped correctly'); | ||
} |