Skip to content

Commit dec6c9a

Browse files
RaisinTenaduh95
authored andcommitted
http2: add diagnostics channel 'http2.server.stream.created'
Signed-off-by: Darshan Sen <[email protected]> PR-URL: #58390 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 5cc97df commit dec6c9a

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed

doc/api/diagnostics_channel.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1238,6 +1238,13 @@ Emitted when a stream is received on the client.
12381238
Emitted when a stream is closed on the client. The HTTP/2 error code used when
12391239
closing the stream can be retrieved using the `stream.rstCode` property.
12401240

1241+
`http2.server.stream.created`
1242+
1243+
* `stream` {ServerHttp2Stream}
1244+
* `headers` {HTTP/2 Headers Object}
1245+
1246+
Emitted when a stream is created on the server.
1247+
12411248
#### Modules
12421249

12431250
> Stability: 1 - Experimental

lib/internal/http2/core.js

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ const onClientStreamStartChannel = dc.channel('http2.client.stream.start');
195195
const onClientStreamErrorChannel = dc.channel('http2.client.stream.error');
196196
const onClientStreamFinishChannel = dc.channel('http2.client.stream.finish');
197197
const onClientStreamCloseChannel = dc.channel('http2.client.stream.close');
198+
const onServerStreamCreatedChannel = dc.channel('http2.server.stream.created');
198199

199200
let debug = require('internal/util/debuglog').debuglog('http2', (fn) => {
200201
debug = fn;
@@ -375,6 +376,12 @@ function onSessionHeaders(handle, id, cat, flags, headers, sensitiveHeaders) {
375376
if (type === NGHTTP2_SESSION_SERVER) {
376377
// eslint-disable-next-line no-use-before-define
377378
stream = new ServerHttp2Stream(session, handle, id, {}, obj);
379+
if (onServerStreamCreatedChannel.hasSubscribers) {
380+
onServerStreamCreatedChannel.publish({
381+
stream,
382+
headers: obj,
383+
});
384+
}
378385
if (endOfStream) {
379386
stream.push(null);
380387
}
@@ -2837,6 +2844,13 @@ class ServerHttp2Stream extends Http2Stream {
28372844
stream[kState].flags |= STREAM_FLAGS_HEAD_REQUEST;
28382845

28392846
process.nextTick(callback, null, stream, headers, 0);
2847+
2848+
if (onServerStreamCreatedChannel.hasSubscribers) {
2849+
onServerStreamCreatedChannel.publish({
2850+
stream,
2851+
headers,
2852+
});
2853+
}
28402854
}
28412855

28422856
// Initiate a response on this Http2Stream
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
'use strict';
2+
3+
const common = require('../common');
4+
if (!common.hasCrypto)
5+
common.skip('missing crypto');
6+
7+
// This test ensures that the built-in HTTP/2 diagnostics channels are reporting
8+
// the diagnostics messages for the 'http2.server.stream.created' channel when
9+
// ServerHttp2Streams are created by both:
10+
// - in response to an incoming 'stream' event from the client
11+
// - the server calling ServerHttp2Stream#pushStream()
12+
13+
const Countdown = require('../common/countdown');
14+
const assert = require('assert');
15+
const dc = require('diagnostics_channel');
16+
const http2 = require('http2');
17+
const { Duplex } = require('stream');
18+
19+
const serverHttp2StreamCreationCount = 2;
20+
21+
dc.subscribe('http2.server.stream.created', common.mustCall(({ stream, headers }) => {
22+
// Since ServerHttp2Stream is not exported from any module, this just checks
23+
// if the stream is an instance of Duplex and the constructor name is
24+
// 'ServerHttp2Stream'.
25+
assert.ok(stream instanceof Duplex);
26+
assert.strictEqual(stream.constructor.name, 'ServerHttp2Stream');
27+
assert.ok(headers && !Array.isArray(headers) && typeof headers === 'object');
28+
}, serverHttp2StreamCreationCount));
29+
30+
const server = http2.createServer();
31+
server.on('stream', common.mustCall((stream) => {
32+
stream.respond();
33+
stream.end();
34+
35+
stream.pushStream({}, common.mustSucceed((pushStream) => {
36+
pushStream.respond();
37+
pushStream.end();
38+
}));
39+
}));
40+
41+
server.listen(0, common.mustCall(() => {
42+
const port = server.address().port;
43+
const client = http2.connect(`http://localhost:${port}`);
44+
45+
const countdown = new Countdown(serverHttp2StreamCreationCount, () => {
46+
client.close();
47+
server.close();
48+
});
49+
50+
const stream = client.request({});
51+
stream.on('response', common.mustCall(() => {
52+
countdown.dec();
53+
}));
54+
55+
client.on('stream', common.mustCall((pushStream) => {
56+
pushStream.on('push', common.mustCall(() => {
57+
countdown.dec();
58+
}));
59+
}));
60+
}));

0 commit comments

Comments
 (0)