Skip to content

Commit eee40c7

Browse files
jasnellevanlucas
authored andcommitted
http2: remember sent headers
Add sentHeaders, sentTrailers, and sentInfoHeaders properties on `Http2Stream`. PR-URL: #18045 Fixes: #16619 Reviewed-By: Matteo Collina <[email protected]>
1 parent 645be73 commit eee40c7

File tree

3 files changed

+99
-0
lines changed

3 files changed

+99
-0
lines changed

doc/api/http2.md

+28
Original file line numberDiff line numberDiff line change
@@ -989,6 +989,34 @@ destroyed after either receiving an `RST_STREAM` frame from the connected peer,
989989
calling `http2stream.close()`, or `http2stream.destroy()`. Will be
990990
`undefined` if the `Http2Stream` has not been closed.
991991

992+
#### http2stream.sentHeaders
993+
<!-- YAML
994+
added: REPLACEME
995+
-->
996+
997+
* Value: {[Headers Object][]}
998+
999+
An object containing the outbound headers sent for this `Http2Stream`.
1000+
1001+
#### http2stream.sentInfoHeaders
1002+
<!-- YAML
1003+
added: REPLACEME
1004+
-->
1005+
1006+
* Value: {[Headers Object][]\[\]}
1007+
1008+
An array of objects containing the outbound informational (additional) headers
1009+
sent for this `Http2Stream`.
1010+
1011+
#### http2stream.sentTrailers
1012+
<!-- YAML
1013+
added: REPLACEME
1014+
-->
1015+
1016+
* Value: {[Headers Object][]}
1017+
1018+
An object containing the outbound trailers sent for this this `HttpStream`.
1019+
9921020
#### http2stream.session
9931021
<!-- YAML
9941022
added: v8.4.0

lib/internal/http2/core.js

+24
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ const kEncrypted = Symbol('encrypted');
7474
const kHandle = Symbol('handle');
7575
const kID = Symbol('id');
7676
const kInit = Symbol('init');
77+
const kInfoHeaders = Symbol('sent-info-headers');
7778
const kMaybeDestroy = Symbol('maybe-destroy');
7879
const kLocalSettings = Symbol('local-settings');
7980
const kOptions = Symbol('options');
@@ -82,6 +83,8 @@ const kProceed = Symbol('proceed');
8283
const kProtocol = Symbol('protocol');
8384
const kProxySocket = Symbol('proxy-socket');
8485
const kRemoteSettings = Symbol('remote-settings');
86+
const kSentHeaders = Symbol('sent-headers');
87+
const kSentTrailers = Symbol('sent-trailers');
8588
const kServer = Symbol('server');
8689
const kSession = Symbol('session');
8790
const kState = Symbol('state');
@@ -256,6 +259,7 @@ function onStreamTrailers() {
256259
stream.destroy(headersList);
257260
return [];
258261
}
262+
stream[kSentTrailers] = trailers;
259263
return headersList;
260264
}
261265

@@ -1344,6 +1348,7 @@ class ClientHttp2Session extends Http2Session {
13441348
throw headersList;
13451349

13461350
const stream = new ClientHttp2Stream(this, undefined, undefined, {});
1351+
stream[kSentHeaders] = headers;
13471352

13481353
// Close the writable side of the stream if options.endStream is set.
13491354
if (options.endStream)
@@ -1507,6 +1512,18 @@ class Http2Stream extends Duplex {
15071512
return `Http2Stream ${util.format(obj)}`;
15081513
}
15091514

1515+
get sentHeaders() {
1516+
return this[kSentHeaders];
1517+
}
1518+
1519+
get sentTrailers() {
1520+
return this[kSentTrailers];
1521+
}
1522+
1523+
get sentInfoHeaders() {
1524+
return this[kInfoHeaders];
1525+
}
1526+
15101527
get pending() {
15111528
return this[kID] === undefined;
15121529
}
@@ -1846,6 +1863,7 @@ function processRespondWithFD(self, fd, headers, offset = 0, length = -1,
18461863
state.flags |= STREAM_FLAGS_HEADERS_SENT;
18471864

18481865
const headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
1866+
self[kSentHeaders] = headers;
18491867
if (!Array.isArray(headersList)) {
18501868
self.destroy(headersList);
18511869
return;
@@ -2076,6 +2094,7 @@ class ServerHttp2Stream extends Http2Stream {
20762094

20772095
const id = ret.id();
20782096
const stream = new ServerHttp2Stream(session, ret, id, options, headers);
2097+
stream[kSentHeaders] = headers;
20792098

20802099
if (options.endStream)
20812100
stream.end();
@@ -2135,6 +2154,7 @@ class ServerHttp2Stream extends Http2Stream {
21352154
const headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
21362155
if (!Array.isArray(headersList))
21372156
throw headersList;
2157+
this[kSentHeaders] = headers;
21382158

21392159
state.flags |= STREAM_FLAGS_HEADERS_SENT;
21402160

@@ -2320,6 +2340,10 @@ class ServerHttp2Stream extends Http2Stream {
23202340
const headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
23212341
if (!Array.isArray(headersList))
23222342
throw headersList;
2343+
if (!this[kInfoHeaders])
2344+
this[kInfoHeaders] = [headers];
2345+
else
2346+
this[kInfoHeaders].push(headers);
23232347

23242348
const ret = this[kHandle].info(headersList);
23252349
if (ret < 0)
+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
'use strict';
2+
3+
const common = require('../common');
4+
if (!common.hasCrypto)
5+
common.skip('missing crypto');
6+
const assert = require('assert');
7+
const h2 = require('http2');
8+
9+
const server = h2.createServer();
10+
11+
server.on('stream', common.mustCall((stream) => {
12+
stream.additionalHeaders({ ':status': 102 });
13+
assert.strictEqual(stream.sentInfoHeaders[0][':status'], 102);
14+
15+
stream.respond({ abc: 'xyz' }, {
16+
getTrailers(headers) {
17+
headers.xyz = 'abc';
18+
}
19+
});
20+
assert.strictEqual(stream.sentHeaders.abc, 'xyz');
21+
assert.strictEqual(stream.sentHeaders[':status'], 200);
22+
assert.notStrictEqual(stream.sentHeaders.date, undefined);
23+
stream.end();
24+
stream.on('close', () => {
25+
assert.strictEqual(stream.sentTrailers.xyz, 'abc');
26+
});
27+
}));
28+
29+
server.listen(0, common.mustCall(() => {
30+
const client = h2.connect(`http://localhost:${server.address().port}`);
31+
const req = client.request();
32+
33+
req.on('headers', common.mustCall((headers) => {
34+
assert.strictEqual(headers[':status'], 102);
35+
}));
36+
37+
assert.strictEqual(req.sentHeaders[':method'], 'GET');
38+
assert.strictEqual(req.sentHeaders[':authority'],
39+
`localhost:${server.address().port}`);
40+
assert.strictEqual(req.sentHeaders[':scheme'], 'http');
41+
assert.strictEqual(req.sentHeaders[':path'], '/');
42+
req.resume();
43+
req.on('close', () => {
44+
server.close();
45+
client.close();
46+
});
47+
}));

0 commit comments

Comments
 (0)