http2: remove `waitTrailers` listener after closing a stream #21764

RidgeA · 2018-07-11T15:01:15Z

When writeHear of Http2ServerResponse instance are called with 204,
205 and 304 status codes an underlying stream closes.
If call end method after sending any of these status codes it will
cause an error TypeError: Cannot read property 'Symbol(trailers)' of undefined because a reference to Http2ServerResponse instance
associated with Http2Stream already was deleted.
The closing of stream causes emitting watiTrailers event and, when
this event handles inside onStreamTrailerReady handler, there is
no reference to Http2ServerResponse instance.

Fises: #21740

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

After applying this changes trailing headers won't be sent if 204/205 and 204 status has been sent.
However, I don't think It is a problem, as according to standard for this HTTP status codes server shouldn't generate payload and have to close a connection after sending the blank line terminating the header section.

204 - https://tools.ietf.org/html/rfc7231#section-6.3.5
205 - https://tools.ietf.org/html/rfc7231#section-6.3.6
304 - https://tools.ietf.org/html/rfc7232#section-4.1

Additional info:
https://tools.ietf.org/html/rfc7230#section-3.3.3 (point 1)
https://tools.ietf.org/html/rfc7540#section-8.1.2.4

When `writeHear` of `Http2ServerResponse` instance are called with 204, 205 and 304 status codes an underlying stream closes. If call `end` method after sending any of these status codes it will cause an error `TypeError: Cannot read property 'Symbol(trailers)' of undefined` because a reference to `Http2ServerResponse` instance associated with Http2Stream already was deleted. The closing of stream causes emitting `watiTrailers` event and, when this event handles inside `onStreamTrailerReady` handler, there is no reference to Http2ServerResponse instance. Fises: #21740

Trott · 2018-07-11T17:21:28Z

@nodejs/http2

mcollina · 2018-07-12T13:16:50Z

CI: https://ci.nodejs.org/job/node-test-pull-request/15824/

RidgeA · 2018-07-12T14:30:22Z

Did I break something in FreeBSD?
If It it is my fault - let me know, please.

mcollina · 2018-07-12T17:08:32Z

Very likely it's a flaky test. I've resumed the build.

mcollina

LGTM

BridgeAR

LGTM. My nits do not have to be addressed but it would still be nice :)

BridgeAR · 2018-07-12T23:00:25Z

lib/internal/http2/compat.js

@@ -391,6 +391,8 @@ function onStreamCloseResponse() {
  state.closed = true;

  this[kProxySocket] = null;
+
+  this.off('wantTrailers', onStreamTrailersReady);


Nit: would you be so kind and use removeListener instead? That seems much clearer from the semantics and is therefore easier to grasp :-)

BridgeAR · 2018-07-12T23:03:42Z

test/parallel/test-http2-compat-serverresponse-end-after-statuses-withou-body.js

+  HTTP_STATUS_RESET_CONTENT,
+  HTTP_STATUS_NOT_MODIFIED,
+];
+const STATUS_CODES_COUNT = STATUS_WITHOUT_BODY.length;


Nit: would you mind changing the STATUS_WITHOUT_BODY name to statusWithoutBody? Since it is an array that is actually manipulated it is not really a constant. And constants in Node.js are normally written as: e.g. kStatusCodesCount.

Trott · 2018-07-12T23:23:01Z

CI that @mcollina started via Resume Build is all green: https://ci.nodejs.org/job/node-test-pull-request/15834/

…nd_after_writeHead

mcollina · 2018-07-13T08:26:32Z

CI: https://ci.nodejs.org/job/node-test-pull-request/15843/.

addaleax · 2018-07-15T23:50:36Z

Landed in 8babbc5 (only fixed up minor typos in the commit message and the test name while landing)

Thanks for the PR! 🎉

Edit: Oh, by the way – this was commit no 23000 in this repo! ✨

When `writeHeader` of `Http2ServerResponse` instance are called with 204, 205 and 304 status codes an underlying stream closes. If call `end` method after sending any of these status codes it will cause an error `TypeError: Cannot read property 'Symbol(trailers)' of undefined` because a reference to `Http2ServerResponse` instance associated with Http2Stream already was deleted. The closing of stream causes emitting `waitTrailers` event and, when this event handles inside `onStreamTrailerReady` handler, there is no reference to Http2ServerResponse instance. Fixes: #21740 PR-URL: #21764 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>

When `writeHeader` of `Http2ServerResponse` instance are called with 204, 205 and 304 status codes an underlying stream closes. If call `end` method after sending any of these status codes it will cause an error `TypeError: Cannot read property 'Symbol(trailers)' of undefined` because a reference to `Http2ServerResponse` instance associated with Http2Stream already was deleted. The closing of stream causes emitting `waitTrailers` event and, when this event handles inside `onStreamTrailerReady` handler, there is no reference to Http2ServerResponse instance. Fixes: nodejs#21740 PR-URL: nodejs#21764 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>

When `writeHeader` of `Http2ServerResponse` instance are called with 204, 205 and 304 status codes an underlying stream closes. If call `end` method after sending any of these status codes it will cause an error `TypeError: Cannot read property 'Symbol(trailers)' of undefined` because a reference to `Http2ServerResponse` instance associated with Http2Stream already was deleted. The closing of stream causes emitting `waitTrailers` event and, when this event handles inside `onStreamTrailerReady` handler, there is no reference to Http2ServerResponse instance. Fixes: #21740 Backport-PR-URL: #22850 PR-URL: #21764 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]>

nodejs-github-bot added dont-land-on-v4.x http2 Issues or PRs related to the http2 subsystem. labels Jul 11, 2018

RidgeA mentioned this pull request Jul 11, 2018

HTTP2: Calling res.end after res.writeHead(204) cause an error #21740

Closed

jasnell approved these changes Jul 11, 2018

View reviewed changes

mcollina approved these changes Jul 12, 2018

View reviewed changes

BridgeAR approved these changes Jul 12, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 12, 2018

RidgeA added 2 commits July 13, 2018 09:23

Merge remote-tracking branch 'upstream/master' into fix/21740_http2_e…

0e914d5

…nd_after_writeHead

Change to off -> removeListener and variable to lowercase

74389f2

apapirovski approved these changes Jul 15, 2018

View reviewed changes

addaleax closed this Jul 15, 2018

targos mentioned this pull request Jul 17, 2018

v10.7.0 proposal #21851

Merged

BethGriggs mentioned this pull request Oct 30, 2018

v8.13.0 proposal #23974

Merged

beevelop mentioned this pull request Nov 20, 2018

2018-11-20 Version 8.13.0 'Carbon' (LTS) @MylesBorins prepared by @BethGriggs beevelop/docker-android-nodejs#250

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http2: remove `waitTrailers` listener after closing a stream #21764

http2: remove `waitTrailers` listener after closing a stream #21764

RidgeA commented Jul 11, 2018

Trott commented Jul 11, 2018

mcollina commented Jul 12, 2018

RidgeA commented Jul 12, 2018

mcollina commented Jul 12, 2018

mcollina left a comment

BridgeAR left a comment

BridgeAR Jul 12, 2018

RidgeA Jul 13, 2018

BridgeAR Jul 12, 2018

RidgeA Jul 13, 2018

Trott commented Jul 12, 2018

mcollina commented Jul 13, 2018

addaleax commented Jul 15, 2018 •

edited

Loading

http2: remove waitTrailers listener after closing a stream #21764

http2: remove waitTrailers listener after closing a stream #21764

Conversation

RidgeA commented Jul 11, 2018

Checklist

Trott commented Jul 11, 2018

mcollina commented Jul 12, 2018

RidgeA commented Jul 12, 2018

mcollina commented Jul 12, 2018

mcollina left a comment

Choose a reason for hiding this comment

BridgeAR left a comment

Choose a reason for hiding this comment

BridgeAR Jul 12, 2018

Choose a reason for hiding this comment

RidgeA Jul 13, 2018

Choose a reason for hiding this comment

BridgeAR Jul 12, 2018

Choose a reason for hiding this comment

RidgeA Jul 13, 2018

Choose a reason for hiding this comment

Trott commented Jul 12, 2018

mcollina commented Jul 13, 2018

addaleax commented Jul 15, 2018 • edited Loading

http2: remove `waitTrailers` listener after closing a stream #21764

http2: remove `waitTrailers` listener after closing a stream #21764

addaleax commented Jul 15, 2018 •

edited

Loading