http2: add compat trailers, adjust multi-headers #15193

apapirovski · 2017-09-05T02:35:09Z

Some changes to compatibility layer to bring it closer to the h1 implementation.

Adds Http2ServerRequest trailers & rawTrailers functionality. Previously didn't work at all and the request would also never end. Which actually makes me wonder, is this even correct or am I compensating for a deeper issue?
Fixes behaviour of multi-headers to conform with the spec (all values but set-cookie and cookie should be comma delimited, cookie should be semi-colon delimited and only set-cookie should be an array). I think it's important we conform to the spec and also be backwards compatible, even if arrays are easier to work with for multi-values. (H2 doesn't specify this directly but it links to https://tools.ietf.org/html/rfc7230#section-3.2.2)
Adds setter for statusMessage that warns (same as the getter), for backwards compatibility. See Initial support proposal for http2 expressjs/express#3390 (comment)

@jasnell, @mcollina I would also like to start a discussion re: rawHeaders if possible. The current behaviour doesn't result in true rawHeaders as we have no way of knowing in what format something like cookie was sent to us based on the headers object (could've already been joined or could've been separate). Should we just emit the raw headers object alongside headers & flags from onSessionHeaders (and then pass to onServerStream too)? If we were to add it as the last argument then it wouldn't really interfere with anything but I'm open to alternate suggestions. (We could also hide it on the headers object as non-enumerable property but that seems really dirty.)

Thanks in advance for any feedback!

Checklist

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

Affected core subsystem(s)

http2, test

Adds Http2ServerRequest trailers & rawTrailers functionality. Also fixes behaviour of multi-headers to conform with the spec (all values but set-cookie and cookie should be comma delimited, cookie should be semi-colon delimited and only set-cookie should be an array). Adds setter for statusMessage that warns, for backwards compatibility. Refs: expressjs/express#3390 (comment)

mcollina

Good work, thanks for taking this up! I have left some comments, let me know what you think

mcollina · 2017-09-05T10:21:24Z

lib/internal/http2/compat.js

+    if (trailers === undefined)
+      return [];
+    const tuples = Object.entries(trailers);
+    const flattened = Array.prototype.concat.apply([], tuples);


Can you use [].concat(tuples) instead? Why is this needed?

It's a [[name, value], [name, value]] type of structure. [].concat(tuples) won't flatten it.

That said, I would ideally like to land this without this code and instead with a real solution for rawHeaders and rawTrailers (one that actually provides the real raw data to the user). I'm going to create a new commit with that behaviour and would appreciate if you or @jasnell could review.

I think

[].concat(...Object.entries(obj))

would read better.

mcollina · 2017-09-05T10:22:38Z

lib/internal/http2/compat.js

@@ -164,7 +172,16 @@ class Http2ServerRequest extends Readable {
  }

  get trailers() {
-    return this[kTrailers];
+    return this[kTrailers] || [];


this is not the exact behavior. The returned this[kTrailers] will be editable, while [] will not.

Hmm, good point, thanks! Will update.

mcollina · 2017-09-05T10:25:45Z

lib/internal/http2/compat.js

+      );
+      statusMessageWarned = true;
+    }
+  }


this same block of code is shown in two other spots, can you refactor it to a single location? It needs a unit test as well.

Definitely. Will update.

apapirovski · 2017-09-05T12:28:34Z

@mcollina Incorporated your feedback and also added proper handling of raw headers & trailers, instead of the dummy version we had. Also have tests for everything now. Let me know if you want me to change anything about how the raw stuff works. Thanks!

mcollina

LGTM

mcollina · 2017-09-05T13:10:27Z

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

apapirovski · 2017-09-05T15:49:32Z

Ok, so as mentioned above, there really is an issue with streams not being ended properly. I'm going to add a commit shortly that fixes it and revises how trailers are handled slightly.

apapirovski · 2017-09-05T16:00:36Z

@mcollina new commit added to handle properly ending readable streams when there are trailers or the request has no body.

mcollina · 2017-09-05T16:05:40Z

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

(still LGTM)

mcollina · 2017-09-07T16:52:06Z

Landed as 6416464.

Adds Http2ServerRequest trailers & rawTrailers functionality. Also fixes behaviour of multi-headers to conform with the spec (all values but set-cookie and cookie should be comma delimited, cookie should be semi-colon delimited and only set-cookie should be an array). Adds setter for statusMessage that warns, for backwards compatibility. End readable side of the stream on trailers or bodyless requests Refs: expressjs/express#3390 (comment) PR-URL: #15193 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

Adds Http2ServerRequest trailers & rawTrailers functionality. Also fixes behaviour of multi-headers to conform with the spec (all values but set-cookie and cookie should be comma delimited, cookie should be semi-colon delimited and only set-cookie should be an array). Adds setter for statusMessage that warns, for backwards compatibility. End readable side of the stream on trailers or bodyless requests Refs: expressjs/express#3390 (comment) PR-URL: nodejs#15193 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

nodejs-github-bot added the http2 Issues or PRs related to the http2 subsystem. label Sep 5, 2017

mcollina reviewed Sep 5, 2017

View reviewed changes

Add proper support for raw headers & trailers, incorporate feedback

52e79ea

apapirovski force-pushed the patch-http2-compat-additions branch from 07dc4c9 to 52e79ea Compare September 5, 2017 12:30

mcollina approved these changes Sep 5, 2017

View reviewed changes

dougwilson mentioned this pull request Sep 5, 2017

Initial support proposal for http2 expressjs/express#3390

Closed

End readable side of the stream on trailers or bodyless requests

85f9ab0

jasnell approved these changes Sep 5, 2017

View reviewed changes

mcollina closed this Sep 7, 2017

apapirovski deleted the patch-http2-compat-additions branch September 7, 2017 20:06

MylesBorins mentioned this pull request Sep 10, 2017

v8.5.0 proposal #15308

Merged

MylesBorins added the dont-land-on-v6.x label Sep 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http2: add compat trailers, adjust multi-headers #15193

http2: add compat trailers, adjust multi-headers #15193

apapirovski commented Sep 5, 2017 •

edited

Loading

mcollina left a comment

mcollina Sep 5, 2017

apapirovski Sep 5, 2017

mcollina Sep 5, 2017

mcollina Sep 5, 2017

apapirovski Sep 5, 2017

mcollina Sep 5, 2017

apapirovski Sep 5, 2017

apapirovski commented Sep 5, 2017 •

edited

Loading

mcollina left a comment

mcollina commented Sep 5, 2017

apapirovski commented Sep 5, 2017

apapirovski commented Sep 5, 2017

mcollina commented Sep 5, 2017

mcollina commented Sep 7, 2017

http2: add compat trailers, adjust multi-headers #15193

http2: add compat trailers, adjust multi-headers #15193

Conversation

apapirovski commented Sep 5, 2017 • edited Loading

Checklist

Affected core subsystem(s)

mcollina left a comment

Choose a reason for hiding this comment

mcollina Sep 5, 2017

Choose a reason for hiding this comment

apapirovski Sep 5, 2017

Choose a reason for hiding this comment

mcollina Sep 5, 2017

Choose a reason for hiding this comment

mcollina Sep 5, 2017

Choose a reason for hiding this comment

apapirovski Sep 5, 2017

Choose a reason for hiding this comment

mcollina Sep 5, 2017

Choose a reason for hiding this comment

apapirovski Sep 5, 2017

Choose a reason for hiding this comment

apapirovski commented Sep 5, 2017 • edited Loading

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented Sep 5, 2017

apapirovski commented Sep 5, 2017

apapirovski commented Sep 5, 2017

mcollina commented Sep 5, 2017

mcollina commented Sep 7, 2017

apapirovski commented Sep 5, 2017 •

edited

Loading

apapirovski commented Sep 5, 2017 •

edited

Loading