Skip to content

Commit 0bbf614

Browse files
authored
fix(pool): keep caller async context for queued requests (#5982)
1 parent aa1eef1 commit 0bbf614

2 files changed

Lines changed: 94 additions & 3 deletions

File tree

‎lib/dispatcher/pool-base.js‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
'use strict'
22

3+
const { AsyncResource } = require('node:async_hooks')
34
const { PoolStats } = require('../util/stats.js')
45
const DispatcherBase = require('./dispatcher-base')
56
const FixedQueue = require('./fixed-queue')
@@ -26,6 +27,22 @@ const kRetiring = Symbol('retiring clients')
2627
// Closes every live client, including clients that have been
2728
// taken out of rotation but are still finishing their own
2829
// requests.
30+
// Requests that wait in the Pool queue are dispatched later from whichever
31+
// callback drains the queue (another request's connect, drain, ...). Capture
32+
// the caller's async context so Client#dispatch, and the diagnostics channel
33+
// events it publishes, still run in it.
34+
class QueuedRequest extends AsyncResource {
35+
constructor (opts, handler) {
36+
super('UNDICI_POOL_QUEUED_REQUEST')
37+
this.opts = opts
38+
this.handler = handler
39+
}
40+
41+
dispatch (dispatcher) {
42+
return this.runInAsyncScope(dispatcher.dispatch, dispatcher, this.opts, this.handler)
43+
}
44+
}
45+
2946
function closeClients (pool) {
3047
const closeAll = []
3148
for (let i = 0; i < pool[kClients].length; i++) {
@@ -69,7 +86,7 @@ class PoolBase extends DispatcherBase {
6986
break
7087
}
7188
this[kQueued]--
72-
needDrain = !client.dispatch(item.opts, item.handler)
89+
needDrain = !item.dispatch(client)
7390
}
7491

7592
client[kNeedDrain] = needDrain
@@ -114,7 +131,7 @@ class PoolBase extends DispatcherBase {
114131
const item = queue.shift()
115132
this[kQueued]--
116133

117-
if (!dispatcher.dispatch(item.opts, item.handler)) {
134+
if (!item.dispatch(dispatcher)) {
118135
dispatcher[kNeedDrain] = true
119136
this[kOnClientBusy](dispatcher)
120137
hasDispatcher = this[kHasDispatcher]()
@@ -228,7 +245,7 @@ class PoolBase extends DispatcherBase {
228245

229246
if (!dispatcher) {
230247
this[kNeedDrain] = true
231-
this[kQueue].push({ opts, handler })
248+
this[kQueue].push(new QueuedRequest(opts, handler))
232249
this[kQueued]++
233250
} else if (!dispatcher.dispatch(opts, handler)) {
234251
dispatcher[kNeedDrain] = true

‎test/issue-5981.js‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
'use strict'
2+
3+
const assert = require('node:assert')
4+
const { AsyncLocalStorage } = require('node:async_hooks')
5+
const diagnosticsChannel = require('node:diagnostics_channel')
6+
const { once } = require('node:events')
7+
const { readFileSync } = require('node:fs')
8+
const { createServer } = require('node:http')
9+
const { createSecureServer } = require('node:http2')
10+
const { createServer: createHttpsServer } = require('node:https')
11+
const { join } = require('node:path')
12+
const { test } = require('node:test')
13+
14+
const { Agent, Pool, fetch, request } = require('..')
15+
16+
const key = readFileSync(join(__dirname, 'fixtures', 'key.pem'), 'utf8')
17+
const cert = readFileSync(join(__dirname, 'fixtures', 'cert.pem'), 'utf8')
18+
19+
function collectContexts (t, storage) {
20+
const contexts = {}
21+
const onCreate = ({ request }) => {
22+
contexts[request.path] = storage.getStore()
23+
}
24+
diagnosticsChannel.subscribe('undici:request:create', onCreate)
25+
t.after(() => diagnosticsChannel.unsubscribe('undici:request:create', onCreate))
26+
return contexts
27+
}
28+
29+
async function listen (t, server) {
30+
server.listen(0)
31+
await once(server, 'listening')
32+
t.after(() => server.close())
33+
return server.address().port
34+
}
35+
36+
const expected = { '/a': 'a', '/b': 'b', '/c': 'c' }
37+
38+
// https://github.com/nodejs/undici/issues/5981
39+
for (const [name, createTlsServer] of [
40+
['h1', () => createHttpsServer({ key, cert }, (req, res) => res.end('ok'))],
41+
['h2', () => createSecureServer({ key, cert, allowHTTP1: true }, (req, res) => res.end('ok'))]
42+
]) {
43+
test(`requests queued during ALPN negotiation keep their async context (${name})`, async (t) => {
44+
const storage = new AsyncLocalStorage()
45+
const contexts = collectContexts(t, storage)
46+
const port = await listen(t, createTlsServer())
47+
48+
const dispatcher = new Agent({ connect: { rejectUnauthorized: false } })
49+
t.after(() => dispatcher.close())
50+
51+
await Promise.all(['a', 'b', 'c'].map((name) => storage.run(name, async () => {
52+
const res = await fetch(`https://localhost:${port}/${name}`, { dispatcher })
53+
await res.text()
54+
})))
55+
56+
assert.deepStrictEqual(contexts, expected)
57+
})
58+
}
59+
60+
test('requests queued in a Pool keep their async context', async (t) => {
61+
const storage = new AsyncLocalStorage()
62+
const contexts = collectContexts(t, storage)
63+
const port = await listen(t, createServer((req, res) => res.end('ok')))
64+
65+
const pool = new Pool(`http://localhost:${port}`, { connections: 1 })
66+
t.after(() => pool.close())
67+
68+
await Promise.all(['a', 'b', 'c'].map((name) => storage.run(name, async () => {
69+
const { body } = await request(`http://localhost:${port}/${name}`, { dispatcher: pool })
70+
await body.dump()
71+
})))
72+
73+
assert.deepStrictEqual(contexts, expected)
74+
})

0 commit comments

Comments
 (0)