Missing Http2ServerResponse.setHeaders() fixed

Make it possible to invoke response.setHeaders() on response object from `node:http2` Fixes: #51573
nodejs · Jan 27, 2024 · 9d915fc · 9d915fc
1 parent af3e2b2
commit 9d915fc
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 0 deletions.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -3935,6 +3935,16 @@ const server = http2.createServer((req, res) => {
 });
 ```
 
+#### `response.setHeaders()`
+
+* `headers` {Headers|Map}
+
+Sets multiple header values for implicit headers.
+`headers` must be an instance of [`Headers`][] or `Map`,
+if a header already exists in the to-be-sent headers,
+its value will be replaced.
+
+
 #### `response.setTimeout(msecs[, callback])`
 
 <!-- YAML

diff --git a/lib/internal/http2/compat.js b/lib/internal/http2/compat.js
@@ -637,6 +637,24 @@ class Http2ServerResponse extends Stream {
     this[kSetHeader](name, value);
   }
 
+  setHeaders(headers) {
+    if (this[kStream].headersSent)
+      throw new ERR_HTTP2_HEADERS_SENT();
+
+    if (
+        !headers ||
+        ArrayIsArray(headers) ||
+        typeof headers.keys !== 'function' ||
+        typeof headers.get !== 'function'
+    ) {
+      throw new ERR_INVALID_ARG_TYPE('headers', ['Headers', 'Map'], headers);
+    }
+
+    for (const key of headers.keys()) {
+      this.setHeader(key, headers.get(key));
+    }
+  }
+
   [kSetHeader](name, value) {
     name = StringPrototypeToLowerCase(StringPrototypeTrim(name));
     assertValidHeader(name, value);

diff --git a/test/parallel/test-http2-server-set-headers.js b/test/parallel/test-http2-server-set-headers.js
@@ -0,0 +1,46 @@
+'use strict';
+
+const common = require('../common');
+if (!common.hasCrypto)
+    common.skip('missing crypto');
+const assert = require('assert');
+const http2 = require('http2');
+const body =
+    '<html><head></head><body><h1>this is some data</h2></body></html>';
+
+const server = http2.createServer((req, res) => {
+    res.setHeaders(new Map([
+        ['foobar', 'baz'],
+        ['X-POWERED-BY', 'node-test'],
+        ['connection', 'connection-test'],
+    ]));
+    res.end(body);
+});
+
+server.listen(0, common.mustCall(() => {
+    const client = http2.connect(`http://localhost:${server.address().port}`);
+    const headers = { ':path': '/' };
+    const req = client.request(headers);
+    req.setEncoding('utf8');
+    req.on('response', common.mustCall(function(headers) {
+        assert.strictEqual(headers.foobar, 'baz');
+        assert.strictEqual(headers['x-powered-by'], 'node-test');
+    }));
+
+    let data = '';
+    req.on('data', (d) => data += d);
+    req.on('end', () => {
+        assert.strictEqual(body, data);
+        server.close();
+        client.close();
+    });
+    req.end();
+}));
+
+const compatMsg = 'The provided connection header is not valid, ' +
+    'the value will be dropped from the header and ' +
+    'will never be in use.';
+
+common.expectWarning('UnsupportedWarning', compatMsg);
+
+server.on('error', common.mustNotCall());