Skip to content

Commit a7914e5

Browse files
authored
Backport upgrade diagnostics lifecycle fixes to v7.x (#5783)
1 parent 48367af commit a7914e5

5 files changed

Lines changed: 340 additions & 10 deletions

File tree

‎docs/docs/api/DiagnosticsChannel.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ diagnosticsChannel.channel('undici:request:bodySent').subscribe(({ request }) =>
5353

5454
## `undici:request:headers`
5555

56-
This message is published after the response headers have been received.
56+
This message is published after the response headers have been received. This includes a successful CONNECT or
57+
protocol upgrade response.
5758

5859
```js
5960
import diagnosticsChannel from 'diagnostics_channel'
@@ -82,6 +83,7 @@ diagnosticsChannel.channel('undici:request:bodyChunkReceived').subscribe(({ requ
8283
## `undici:request:trailers`
8384

8485
This message is published after the response body and trailers have been received, i.e. the response has been completed.
86+
After an upgraded socket is passed to the request handler, this message is published with an empty `trailers` array.
8587

8688
```js
8789
import diagnosticsChannel from 'diagnostics_channel'

‎lib/core/request.js‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,11 +302,32 @@ class Request {
302302
}
303303
}
304304

305-
onUpgrade (statusCode, headers, socket) {
305+
/**
306+
* @param {number} statusCode
307+
* @param {Buffer[]|string[]} headers
308+
* @param {import('node:stream').Duplex} socket
309+
* @param {string} [statusText]
310+
*/
311+
onUpgrade (statusCode, headers, socket, statusText = '') {
312+
this.onFinally()
313+
306314
assert(!this.aborted)
307315
assert(!this.completed)
308316

309-
return this[kHandler].onUpgrade(statusCode, headers, socket)
317+
if (channels.headers.hasSubscribers) {
318+
channels.headers.publish({ request: this, response: { statusCode, headers, statusText } })
319+
}
320+
321+
const result = this[kHandler].onUpgrade(statusCode, headers, socket)
322+
323+
if (!this.aborted) {
324+
this.completed = true
325+
if (channels.trailers.hasSubscribers) {
326+
channels.trailers.publish({ request: this, trailers: [] })
327+
}
328+
}
329+
330+
return result
310331
}
311332

312333
onComplete (trailers) {

‎lib/dispatcher/client-h1.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ class Parser {
527527
* @param {Buffer} head
528528
*/
529529
onUpgrade (head) {
530-
const { upgrade, client, socket, headers, statusCode } = this
530+
const { upgrade, client, socket, headers, statusCode, statusText } = this
531531

532532
assert(upgrade)
533533
assert(client[kSocket] === socket)
@@ -562,8 +562,9 @@ class Parser {
562562
client.emit('disconnect', client[kUrl], [client], new InformationalError('upgrade'))
563563

564564
try {
565-
request.onUpgrade(statusCode, headers, socket)
565+
request.onUpgrade(statusCode, headers, socket, statusText)
566566
} catch (err) {
567+
util.errorRequest(client, request, err)
567568
util.destroy(socket, err)
568569
}
569570

‎lib/dispatcher/client-h2.js‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -575,13 +575,17 @@ function writeH2 (client, request) {
575575

576576
stream = session.request(headers, { endStream: false, signal })
577577
stream[kHTTP2Stream] = true
578+
++session[kOpenStreams]
578579

579580
stream.once('response', (headers, _flags) => {
580581
const { [HTTP2_HEADER_STATUS]: statusCode, ...realHeaders } = headers
581582

582-
request.onUpgrade(statusCode, parseH2Headers(realHeaders), stream)
583-
584-
++session[kOpenStreams]
583+
try {
584+
request.onUpgrade(statusCode, parseH2Headers(realHeaders), stream)
585+
} catch (err) {
586+
abort(err)
587+
return
588+
}
585589
completeRequest(client, request)
586590
})
587591

@@ -610,11 +614,16 @@ function writeH2 (client, request) {
610614
// We disabled endStream to allow the user to write to the stream
611615
stream = session.request(headers, { endStream: false, signal })
612616
stream[kHTTP2Stream] = true
617+
++session[kOpenStreams]
613618
stream.on('response', headers => {
614619
const { [HTTP2_HEADER_STATUS]: statusCode, ...realHeaders } = headers
615620

616-
request.onUpgrade(statusCode, parseH2Headers(realHeaders), stream)
617-
++session[kOpenStreams]
621+
try {
622+
request.onUpgrade(statusCode, parseH2Headers(realHeaders), stream)
623+
} catch (err) {
624+
abort(err)
625+
return
626+
}
618627
completeRequest(client, request)
619628
})
620629
stream.on('error', abort)

0 commit comments

Comments
 (0)