diff --git a/lib/internal/http/outgoing.js b/lib/internal/http/outgoing.js index 92a325489f23..c328ed2b06c5 100644 --- a/lib/internal/http/outgoing.js +++ b/lib/internal/http/outgoing.js @@ -835,7 +835,12 @@ OutgoingMessage.prototype.setHeader = function setHeader(name, value) { if (headers === null) this[kOutHeaders] = headers = new OutgoingHeaders(); - headers[name.toLowerCase()] = [name, value]; + // Store a copy of an array value. appendHeader() pushes into the stored + // array, which must not be the caller's (it may also be frozen). + headers[name.toLowerCase()] = [ + name, + ArrayIsArray(value) ? value.slice() : value, + ]; return this; }; diff --git a/lib/internal/http2/compat.js b/lib/internal/http2/compat.js index 2eedfd39010a..592ae85037b8 100644 --- a/lib/internal/http2/compat.js +++ b/lib/internal/http2/compat.js @@ -687,7 +687,9 @@ class Http2ServerResponse extends Stream { else if (!checkIsHttpToken(name)) this.destroy(new ERR_INVALID_HTTP_TOKEN('Header name', name)); - this[kHeaders][name] = value; + // Store a copy of an array value. appendHeader() pushes into the stored + // array, which must not be the caller's (it may also be frozen). + this[kHeaders][name] = ArrayIsArray(value) ? value.slice() : value; } appendHeader(name, value) { diff --git a/test/parallel/test-http-outgoing-append-header-array.js b/test/parallel/test-http-outgoing-append-header-array.js new file mode 100644 index 000000000000..3fd3897e687c --- /dev/null +++ b/test/parallel/test-http-outgoing-append-header-array.js @@ -0,0 +1,79 @@ +'use strict'; + +require('../common'); +const assert = require('assert'); +const { ServerResponse } = require('http'); + +// setHeader() stores a copy of an array value, so appendHeader() never +// mutates an array the caller passed in. Frozen arrays must not make +// appendHeader() throw. + +function createResponse() { + return new ServerResponse({ + method: 'GET', + httpVersionMajor: 1, + httpVersionMinor: 1, + }); +} + +// setHeader() with an array, then appendHeader(). +{ + const res = createResponse(); + const cookies = ['a=1']; + res.setHeader('Set-Cookie', cookies); + res.appendHeader('set-cookie', 'b=2'); + res.appendHeader('set-cookie', ['c=3', 'd=4']); + assert.deepStrictEqual(cookies, ['a=1']); + assert.deepStrictEqual(res.getHeader('set-cookie'), + ['a=1', 'b=2', 'c=3', 'd=4']); +} + +// The response owns the stored array: changing the caller's array later has +// no effect, and getHeader() returns the stored array itself. +{ + const res = createResponse(); + const cookies = ['a=1']; + res.setHeader('Set-Cookie', cookies); + cookies.push('b=2'); + assert.deepStrictEqual(res.getHeader('set-cookie'), ['a=1']); + res.getHeader('set-cookie').push('c=3'); + assert.deepStrictEqual(res.getHeader('set-cookie'), ['a=1', 'c=3']); +} + +// setHeader() with a frozen array, then appendHeader(). +{ + const res = createResponse(); + const cookies = Object.freeze(['a=1']); + res.setHeader('Set-Cookie', cookies); + res.appendHeader('set-cookie', 'b=2'); + assert.deepStrictEqual(res.getHeader('set-cookie'), ['a=1', 'b=2']); +} + +// appendHeader() with an array on an unset field, then appendHeader(). +{ + const res = createResponse(); + const cookies = Object.freeze(['a=1']); + res.appendHeader('Set-Cookie', cookies); + res.appendHeader('set-cookie', 'b=2'); + assert.deepStrictEqual(res.getHeader('set-cookie'), ['a=1', 'b=2']); +} + +// setHeaders() with an array value, then appendHeader(). +{ + const res = createResponse(); + const values = Object.freeze(['a', 'b']); + res.setHeaders(new Map([['x-foo', values]])); + res.appendHeader('x-foo', 'c'); + assert.deepStrictEqual(values, ['a', 'b']); + assert.deepStrictEqual(res.getHeader('x-foo'), ['a', 'b', 'c']); +} + +// writeHead() with a raw header array after setHeader(): duplicate names +// go through appendHeader(). +{ + const res = createResponse(); + res.setHeader('X-Other', '1'); + const cookies = Object.freeze(['a=1']); + res.writeHead(200, ['Set-Cookie', cookies, 'Set-Cookie', 'b=2']); + assert.deepStrictEqual(res.getHeader('set-cookie'), ['a=1', 'b=2']); +} diff --git a/test/parallel/test-http2-compat-get-headers.js b/test/parallel/test-http2-compat-get-headers.js index f98ceca1db14..b93ba5f8290b 100644 --- a/test/parallel/test-http2-compat-get-headers.js +++ b/test/parallel/test-http2-compat-get-headers.js @@ -33,7 +33,7 @@ const server = http2.createServer(common.mustCall((request, response) => { const headers = response.getHeaders(); assert.deepStrictEqual(headers, expected); assert.deepStrictEqual(Object.keys(headers), Object.keys(expected)); - assert.strictEqual(headers['set-cookie'], cookies); + assert.strictEqual(headers['set-cookie'], response.getHeader('set-cookie')); assert.notStrictEqual(response.getHeaders(), headers); headers['x-first'] = 'changed'; @@ -42,8 +42,9 @@ const server = http2.createServer(common.mustCall((request, response) => { assert.deepStrictEqual(response.getHeaders(), expected); headers['set-cookie'].push('third=value'); - assert.strictEqual(response.getHeader('set-cookie'), cookies); + assert.strictEqual(response.getHeader('set-cookie'), headers['set-cookie']); assert.strictEqual(response.getHeader('set-cookie').length, 3); + expected['set-cookie'] = [...cookies, 'third=value']; response.removeHeader('X-First'); response.setHeader('X-First', 'replacement'); diff --git a/test/parallel/test-http2-compat-serverresponse-headers.js b/test/parallel/test-http2-compat-serverresponse-headers.js index 95423fd09d8e..43d5f46d470f 100644 --- a/test/parallel/test-http2-compat-serverresponse-headers.js +++ b/test/parallel/test-http2-compat-serverresponse-headers.js @@ -47,6 +47,14 @@ server.listen(0, common.mustCall(function() { ]); assert.strictEqual(response.hasHeader(real), true); + // appendHeader() must not mutate an array passed to setHeader(). + const values = Object.freeze(['a', 'b']); + response.setHeader('x-array', values); + response.appendHeader('x-array', 'c'); + assert.deepStrictEqual(values, ['a', 'b']); + assert.deepStrictEqual(response.getHeader('x-array'), ['a', 'b', 'c']); + response.removeHeader('x-array'); + response.removeHeader(denormalised); assert.strictEqual(response.hasHeader(denormalised), false); assert.strictEqual(response.hasHeader(real), false);