Skip to content

Commit

Permalink
http2: pass incoming set-cookie header as array
Browse files Browse the repository at this point in the history
Incoming set-cookie headers should be passed to user as array like in
http module.

Besides improving compatibility between http and http2 it avoids the
need to check if the type is an array or not in user code.

PR-URL: nodejs#21360
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
  • Loading branch information
Flarna authored and kjin committed Sep 25, 2018
1 parent 05a5a8f commit dc62e90
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 10 deletions.
3 changes: 1 addition & 2 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2132,8 +2132,7 @@ For incoming headers:
`proxy-authorization`, `range`, `referer`,`retry-after`, `tk`,
`upgrade-insecure-requests`, `user-agent` or `x-content-type-options` are
discarded.
* `set-cookie` is a string if present once or an array in case duplicates
are present.
* `set-cookie` is always an array. Duplicates are added to the array.
* `cookie`: the values are joined together with '; '.
* For all other headers, the values are joined together with ', '.

Expand Down
7 changes: 2 additions & 5 deletions lib/internal/http2/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ function toHeaderObject(headers) {
value |= 0;
var existing = obj[name];
if (existing === undefined) {
obj[name] = value;
obj[name] = name === HTTP2_HEADER_SET_COOKIE ? [value] : value;
} else if (!kSingleValueHeaders.has(name)) {
switch (name) {
case HTTP2_HEADER_COOKIE:
Expand All @@ -523,10 +523,7 @@ function toHeaderObject(headers) {
// fields with the same name. Since it cannot be combined into a
// single field-value, recipients ought to handle "Set-Cookie" as a
// special case while processing header fields."
if (Array.isArray(existing))
existing.push(value);
else
obj[name] = [existing, value];
existing.push(value);
break;
default:
// https://tools.ietf.org/html/rfc7230#section-3.2.2
Expand Down
44 changes: 41 additions & 3 deletions test/parallel/test-http2-util-headers-list.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
// Flags: --expose-internals
'use strict';

// Tests the internal utility function that is used to prepare headers
// to pass to the internal binding layer.
// Tests the internal utility functions that are used to prepare headers
// to pass to the internal binding layer and to build a header object.

const common = require('../common');
if (!common.hasCrypto)
common.skip('missing crypto');
const assert = require('assert');
const { mapToHeaders } = require('internal/http2/util');
const { mapToHeaders, toHeaderObject } = require('internal/http2/util');

const {
HTTP2_HEADER_STATUS,
Expand Down Expand Up @@ -302,3 +302,41 @@ common.expectsError({

assert(!(mapToHeaders({ te: 'trailers' }) instanceof Error));
assert(!(mapToHeaders({ te: ['trailers'] }) instanceof Error));


{
const rawHeaders = [
':status', '200',
'cookie', 'foo',
'set-cookie', 'sc1',
'age', '10',
'x-multi', 'first'
];
const headers = toHeaderObject(rawHeaders);
assert.strictEqual(headers[':status'], 200);
assert.strictEqual(headers.cookie, 'foo');
assert.deepStrictEqual(headers['set-cookie'], ['sc1']);
assert.strictEqual(headers.age, '10');
assert.strictEqual(headers['x-multi'], 'first');
}

{
const rawHeaders = [
':status', '200',
':status', '400',
'cookie', 'foo',
'cookie', 'bar',
'set-cookie', 'sc1',
'set-cookie', 'sc2',
'age', '10',
'age', '20',
'x-multi', 'first',
'x-multi', 'second'
];
const headers = toHeaderObject(rawHeaders);
assert.strictEqual(headers[':status'], 200);
assert.strictEqual(headers.cookie, 'foo; bar');
assert.deepStrictEqual(headers['set-cookie'], ['sc1', 'sc2']);
assert.strictEqual(headers.age, '10');
assert.strictEqual(headers['x-multi'], 'first, second');
}

0 comments on commit dc62e90

Please sign in to comment.