http2: add raw header array support to h2Session.request()

This also notably changes error handling for request(). Previously some
invalid header values (but not all) would cause the session to be
unnecessarily destroyed automatically, e.g. passing an unparseable
header name to request(). This is no longer the case: header validation
failures will throw an error, but will not destroy the session or emit
'error' events.

PR-URL: #57917
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: James M Snell <[email protected]>

Author: pimterry

doc/api/http2.md

@@ -1078,7 +1078,7 @@ changes:
                  `weight` option is deprecated.
 -->
 
-* `headers` {HTTP/2 Headers Object}
+* `headers` {HTTP/2 Headers Object} | {Array}
 
 * `options` {Object}
   * `endStream` {boolean} `true` if the `Http2Stream` _writable_ side should

lib/internal/http2/core.js

@@ -9,7 +9,6 @@ const {
   ObjectDefineProperty,
   ObjectEntries,
   ObjectHasOwn,
-  ObjectKeys,
   Promise,
   Proxy,
   ReflectApply,
@@ -47,10 +46,7 @@ const { Duplex } = require('stream');
 const tls = require('tls');
 const { setImmediate, setTimeout, clearTimeout } = require('timers');
 
-const {
-  kIncomingMessage,
-  _checkIsHttpToken: checkIsHttpToken,
-} = require('_http_common');
+const { kIncomingMessage } = require('_http_common');
 const { kServerResponse, Server: HttpServer, httpServerPreClose, setupConnectionsTracking } = require('_http_server');
 const JSStreamSocket = require('internal/js_stream_socket');
 
@@ -69,9 +65,6 @@ const {
   codes: {
     ERR_HTTP2_ALTSVC_INVALID_ORIGIN,
     ERR_HTTP2_ALTSVC_LENGTH,
-    ERR_HTTP2_CONNECT_AUTHORITY,
-    ERR_HTTP2_CONNECT_PATH,
-    ERR_HTTP2_CONNECT_SCHEME,
     ERR_HTTP2_GOAWAY_SESSION,
     ERR_HTTP2_HEADERS_AFTER_RESPOND,
     ERR_HTTP2_HEADERS_SENT,
@@ -109,7 +102,6 @@ const {
     ERR_INVALID_ARG_TYPE,
     ERR_INVALID_ARG_VALUE,
     ERR_INVALID_CHAR,
-    ERR_INVALID_HTTP_TOKEN,
     ERR_OUT_OF_RANGE,
     ERR_SOCKET_CLOSED,
   },
@@ -138,23 +130,26 @@ const {
 const {
   assertIsObject,
   assertIsArray,
-  assertValidPseudoHeader,
   assertValidPseudoHeaderResponse,
   assertValidPseudoHeaderTrailer,
   assertWithinRange,
+  buildNgHeaderString,
   getAuthority,
   getDefaultSettings,
   getSessionState,
   getSettings,
   getStreamState,
   isPayloadMeaningless,
+  kAuthority,
   kSensitiveHeaders,
   kSocket,
   kRequest,
+  kProtocol,
   kProxySocket,
-  mapToHeaders,
   MAX_ADDITIONAL_SETTINGS,
   NghttpError,
+  prepareRequestHeadersArray,
+  prepareRequestHeadersObject,
   remoteCustomSettingsToBuffer,
   sessionName,
   toHeaderObject,
@@ -242,7 +237,6 @@ const NETServer = net.Server;
 const TLSServer = tls.Server;
 
 const kAlpnProtocol = Symbol('alpnProtocol');
-const kAuthority = Symbol('authority');
 const kEncrypted = Symbol('encrypted');
 const kID = Symbol('id');
 const kInit = Symbol('init');
@@ -254,7 +248,6 @@ const kOwner = owner_symbol;
 const kOrigin = Symbol('origin');
 const kPendingRequestCalls = Symbol('kPendingRequestCalls');
 const kProceed = Symbol('proceed');
-const kProtocol = Symbol('protocol');
 const kRemoteSettings = Symbol('remote-settings');
 const kRequestAsyncResource = Symbol('requestAsyncResource');
 const kSentHeaders = Symbol('sent-headers');
@@ -297,7 +290,6 @@ const {
   HTTP2_HEADER_DATE,
   HTTP2_HEADER_METHOD,
   HTTP2_HEADER_PATH,
-  HTTP2_HEADER_PROTOCOL,
   HTTP2_HEADER_SCHEME,
   HTTP2_HEADER_STATUS,
   HTTP2_HEADER_CONTENT_LENGTH,
@@ -312,7 +304,6 @@ const {
 
   HTTP2_METHOD_GET,
   HTTP2_METHOD_HEAD,
-  HTTP2_METHOD_CONNECT,
 
   HTTP_STATUS_CONTINUE,
   HTTP_STATUS_RESET_CONTENT,
@@ -1808,7 +1799,7 @@ class ClientHttp2Session extends Http2Session {
 
   // Submits a new HTTP2 request to the connected peer. Returns the
   // associated Http2Stream instance.
-  request(headers, options) {
+  request(headersParam, options) {
     debugSessionObj(this, 'initiating request');
 
     if (this.destroyed)
@@ -1819,62 +1810,61 @@ class ClientHttp2Session extends Http2Session {
 
     this[kUpdateTimer]();
 
-    if (headers !== null && headers !== undefined) {
-      const keys = ObjectKeys(headers);
-      for (let i = 0; i < keys.length; i++) {
-        const header = keys[i];
-        if (header[0] === ':') {
-          assertValidPseudoHeader(header);
-        } else if (header && !checkIsHttpToken(header))
-          this.destroy(new ERR_INVALID_HTTP_TOKEN('Header name', header));
-      }
+    let headersList;
+    let headersObject;
+    let scheme;
+    let authority;
+    let method;
+
+    if (ArrayIsArray(headersParam)) {
+      ({
+        headersList,
+        scheme,
+        authority,
+        method,
+      } = prepareRequestHeadersArray(headersParam, this));
+    } else if (!!headersParam && typeof headersParam === 'object') {
+      ({
+        headersObject,
+        headersList,
+        scheme,
+        authority,
+        method,
+      } = prepareRequestHeadersObject(headersParam, this));
+    } else if (headersParam === undefined) {
+      ({
+        headersObject,
+        headersList,
+        scheme,
+        authority,
+        method,
+      } = prepareRequestHeadersObject({}, this));
+    } else {
+      throw new ERR_INVALID_ARG_TYPE.HideStackFramesError(
+        'headers',
+        ['Object', 'Array'],
+        headersParam,
+      );
     }
 
-    assertIsObject(headers, 'headers');
     assertIsObject(options, 'options');
-
-    headers = ObjectAssign({ __proto__: null }, headers);
     options = { ...options };
 
-    if (headers[HTTP2_HEADER_METHOD] === undefined)
-      headers[HTTP2_HEADER_METHOD] = HTTP2_METHOD_GET;
-
-    const connect = headers[HTTP2_HEADER_METHOD] === HTTP2_METHOD_CONNECT;
-
-    if (!connect || headers[HTTP2_HEADER_PROTOCOL] !== undefined) {
-      if (getAuthority(headers) === undefined)
-        headers[HTTP2_HEADER_AUTHORITY] = this[kAuthority];
-      if (headers[HTTP2_HEADER_SCHEME] === undefined)
-        headers[HTTP2_HEADER_SCHEME] = this[kProtocol].slice(0, -1);
-      if (headers[HTTP2_HEADER_PATH] === undefined)
-        headers[HTTP2_HEADER_PATH] = '/';
-    } else {
-      if (headers[HTTP2_HEADER_AUTHORITY] === undefined)
-        throw new ERR_HTTP2_CONNECT_AUTHORITY();
-      if (headers[HTTP2_HEADER_SCHEME] !== undefined)
-        throw new ERR_HTTP2_CONNECT_SCHEME();
-      if (headers[HTTP2_HEADER_PATH] !== undefined)
-        throw new ERR_HTTP2_CONNECT_PATH();
-    }
-
     setAndValidatePriorityOptions(options);
 
     if (options.endStream === undefined) {
       // For some methods, we know that a payload is meaningless, so end the
       // stream by default if the user has not specifically indicated a
       // preference.
-      options.endStream = isPayloadMeaningless(headers[HTTP2_HEADER_METHOD]);
+      options.endStream = isPayloadMeaningless(method);
     } else {
       validateBoolean(options.endStream, 'options.endStream');
     }
 
-    const headersList = mapToHeaders(headers);
-
     // eslint-disable-next-line no-use-before-define
     const stream = new ClientHttp2Stream(this, undefined, undefined, {});
-    stream[kSentHeaders] = headers;
-    stream[kOrigin] = `${headers[HTTP2_HEADER_SCHEME]}://` +
-                      `${getAuthority(headers)}`;
+    stream[kSentHeaders] = headersObject; // N.b. Only set for object headers, not raw headers
+    stream[kOrigin] = `${scheme}://${authority}`;
     const reqAsync = new AsyncResource('PendingRequest');
     stream[kRequestAsyncResource] = reqAsync;
 
@@ -2350,7 +2340,7 @@ class Http2Stream extends Duplex {
 
     this[kUpdateTimer]();
 
-    const headersList = mapToHeaders(headers, assertValidPseudoHeaderTrailer);
+    const headersList = buildNgHeaderString(headers, assertValidPseudoHeaderTrailer);
     this[kSentTrailers] = headers;
 
     // Send the trailers in setImmediate so we don't do it on nghttp2 stack.
@@ -2598,7 +2588,7 @@ function processRespondWithFD(self, fd, headers, offset = 0, length = -1,
 
   let headersList;
   try {
-    headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
+    headersList = buildNgHeaderString(headers, assertValidPseudoHeaderResponse);
   } catch (err) {
     self.destroy(err);
     return;
@@ -2822,7 +2812,7 @@ class ServerHttp2Stream extends Http2Stream {
     if (headers[HTTP2_HEADER_METHOD] === HTTP2_METHOD_HEAD)
       headRequest = options.endStream = true;
 
-    const headersList = mapToHeaders(headers);
+    const headersList = buildNgHeaderString(headers);
 
     const streamOptions = options.endStream ? STREAM_OPTION_EMPTY_PAYLOAD : 0;
 
@@ -2902,7 +2892,7 @@ class ServerHttp2Stream extends Http2Stream {
     }
 
     headers = processHeaders(headers, options);
-    const headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
+    const headersList = buildNgHeaderString(headers, assertValidPseudoHeaderResponse);
     this[kSentHeaders] = headers;
 
     state.flags |= STREAM_FLAGS_HEADERS_SENT;
@@ -3079,7 +3069,7 @@ class ServerHttp2Stream extends Http2Stream {
 
     this[kUpdateTimer]();
 
-    const headersList = mapToHeaders(headers, assertValidPseudoHeaderResponse);
+    const headersList = buildNgHeaderString(headers, assertValidPseudoHeaderResponse);
     if (!this[kInfoHeaders])
       this[kInfoHeaders] = [headers];
     else