feat(fcm): Add HTTP2 support for sendEach() and sendEachForMulticast() (#2550)

* Refactor `api-requets` to prepare to handle both HTTP/1.1 and HTTP/2 requests

* Added HTTP2 support for `sendEach()` and sendEachForMulticast` with integration tests

* fix: lint

* Added unit tests

* Added tests for `Http2Client` and `AuthorizedHttp2Client`

* Address api review changes and typos.

* TW changes, backticks and typos

* fix deprecation note

* Reword deprecation note.

Author: jonathanedey

etc/firebase-admin.messaging.api.md

@@ -189,6 +189,8 @@ export type Message = TokenMessage | TopicMessage | ConditionMessage;
 // @public
 export class Messaging {
     get app(): App;
+    // @deprecated
+    enableLegacyHttpTransport(): void;
     send(message: Message, dryRun?: boolean): Promise<string>;
     // @deprecated
     sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

src/app-check/app-check-api-client-internal.ts

@@ -18,7 +18,7 @@
 import { App } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import {
-  HttpRequestConfig, HttpClient, HttpError, AuthorizedHttpClient, HttpResponse
+  HttpRequestConfig, HttpClient, RequestResponseError, AuthorizedHttpClient, RequestResponse
 } from '../utils/api-request';
 import { PrefixedFirebaseError } from '../utils/error';
 import * as utils from '../utils/index';
@@ -157,7 +157,7 @@ export class AppCheckApiClient {
       });
   }
 
-  private toFirebaseError(err: HttpError): PrefixedFirebaseError {
+  private toFirebaseError(err: RequestResponseError): PrefixedFirebaseError {
     if (err instanceof PrefixedFirebaseError) {
       return err;
     }
@@ -184,7 +184,7 @@ export class AppCheckApiClient {
    * @param resp - API response object.
    * @returns An AppCheckToken instance.
    */
-  private toAppCheckToken(resp: HttpResponse): AppCheckToken {
+  private toAppCheckToken(resp: RequestResponse): AppCheckToken {
     const token = resp.data.token;
     // `ttl` is a string with the suffix "s" preceded by the number of seconds,
     // with nanoseconds expressed as fractional seconds.

src/app-check/token-generator.ts

@@ -24,7 +24,7 @@ import {
   APP_CHECK_ERROR_CODE_MAPPING,
 } from './app-check-api-client-internal';
 import { AppCheckTokenOptions } from './app-check-api';
-import { HttpError } from '../utils/api-request';
+import { RequestResponseError } from '../utils/api-request';
 
 const ONE_MINUTE_IN_SECONDS = 60;
 const ONE_MINUTE_IN_MILLIS = ONE_MINUTE_IN_SECONDS * 1000;
@@ -147,7 +147,7 @@ export function appCheckErrorFromCryptoSignerError(err: Error): Error {
     return err;
   }
   if (err.code === CryptoSignerErrorCode.SERVER_ERROR && validator.isNonNullObject(err.cause)) {
-    const httpError = err.cause as HttpError
+    const httpError = err.cause as RequestResponseError
     const errorResponse = httpError.response.data;
     if (errorResponse?.error) {
       const status = errorResponse.error.status;

src/app/credential-internal.ts

@@ -22,7 +22,7 @@ import path = require('path');
 import { Agent } from 'http';
 import { Credential, GoogleOAuthAccessToken } from './credential';
 import { AppErrorCodes, FirebaseAppError } from '../utils/error';
-import { HttpClient, HttpRequestConfig, HttpError, HttpResponse } from '../utils/api-request';
+import { HttpClient, HttpRequestConfig, RequestResponseError, RequestResponse } from '../utils/api-request';
 import * as util from '../utils/validator';
 
 const GOOGLE_TOKEN_AUDIENCE = 'https://accounts.google.com/o/oauth2/token';
@@ -232,7 +232,8 @@ export class ComputeEngineCredential implements Credential {
         return this.projectId;
       })
       .catch((err) => {
-        const detail: string = (err instanceof HttpError) ? getDetailFromResponse(err.response) : err.message;
+        const detail: string =
+        (err instanceof RequestResponseError) ? getDetailFromResponse(err.response) : err.message;
         throw new FirebaseAppError(
           AppErrorCodes.INVALID_CREDENTIAL,
           `Failed to determine project ID: ${detail}`);
@@ -251,7 +252,8 @@ export class ComputeEngineCredential implements Credential {
         return this.accountId;
       })
       .catch((err) => {
-        const detail: string = (err instanceof HttpError) ? getDetailFromResponse(err.response) : err.message;
+        const detail: string =
+        (err instanceof RequestResponseError) ? getDetailFromResponse(err.response) : err.message;
         throw new FirebaseAppError(
           AppErrorCodes.INVALID_CREDENTIAL,
           `Failed to determine service account email: ${detail}`);
@@ -553,7 +555,7 @@ function requestIDToken(client: HttpClient, request: HttpRequestConfig): Promise
  * Constructs a human-readable error message from the given Error.
  */
 function getErrorMessage(err: Error): string {
-  const detail: string = (err instanceof HttpError) ? getDetailFromResponse(err.response) : err.message;
+  const detail: string = (err instanceof RequestResponseError) ? getDetailFromResponse(err.response) : err.message;
   return `Error fetching access token: ${detail}`;
 }
 
@@ -562,7 +564,7 @@ function getErrorMessage(err: Error): string {
  * the response is JSON-formatted, looks up the error and error_description fields sent by the
  * Google Auth servers. Otherwise returns the entire response payload as the error detail.
  */
-function getDetailFromResponse(response: HttpResponse): string {
+function getDetailFromResponse(response: RequestResponse): string {
   if (response.isJson() && response.data.error) {
     const json = response.data;
     let detail = json.error;

src/auth/auth-api-request.ts

@@ -22,7 +22,7 @@ import { FirebaseApp } from '../app/firebase-app';
 import { deepCopy, deepExtend } from '../utils/deep-copy';
 import { AuthClientErrorCode, FirebaseAuthError } from '../utils/error';
 import {
-  ApiSettings, AuthorizedHttpClient, HttpRequestConfig, HttpError,
+  ApiSettings, AuthorizedHttpClient, HttpRequestConfig, RequestResponseError,
 } from '../utils/api-request';
 import * as utils from '../utils/index';
 
@@ -1933,7 +1933,7 @@ export abstract class AbstractAuthRequestHandler {
         return response.data;
       })
       .catch((err) => {
-        if (err instanceof HttpError) {
+        if (err instanceof RequestResponseError) {
           const error = err.response.data;
           const errorCode = AbstractAuthRequestHandler.getErrorCode(error);
           if (!errorCode) {

src/auth/token-generator.ts

@@ -16,7 +16,7 @@
  */
 
 import { AuthClientErrorCode, ErrorInfo, FirebaseAuthError } from '../utils/error';
-import { HttpError } from '../utils/api-request';
+import { RequestResponseError } from '../utils/api-request';
 import { CryptoSigner, CryptoSignerError, CryptoSignerErrorCode } from '../utils/crypto-signer';
 
 import * as validator from '../utils/validator';
@@ -213,7 +213,7 @@ export function handleCryptoSignerError(err: Error): Error {
   }
   if (err.code === CryptoSignerErrorCode.SERVER_ERROR && validator.isNonNullObject(err.cause)) {
     const httpError = err.cause;
-    const errorResponse = (httpError as HttpError).response.data;
+    const errorResponse = (httpError as RequestResponseError).response.data;
     if (validator.isNonNullObject(errorResponse) && errorResponse.error) {
       const errorCode = errorResponse.error.status;
       const description = 'Please refer to https://firebase.google.com/docs/auth/admin/create-custom-tokens ' +

src/database/database.ts

@@ -24,7 +24,7 @@ import { Database as DatabaseImpl } from '@firebase/database-compat/standalone';
 import { App } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import * as validator from '../utils/validator';
-import { AuthorizedHttpClient, HttpRequestConfig, HttpError } from '../utils/api-request';
+import { AuthorizedHttpClient, HttpRequestConfig, RequestResponseError } from '../utils/api-request';
 import { getSdkVersion } from '../utils/index';
 
 /**
@@ -292,7 +292,7 @@ class DatabaseRulesClient {
   }
 
   private handleError(err: Error): Error {
-    if (err instanceof HttpError) {
+    if (err instanceof RequestResponseError) {
       return new FirebaseDatabaseError({
         code: AppErrorCodes.INTERNAL_ERROR,
         message: this.getErrorMessage(err),
@@ -301,7 +301,7 @@ class DatabaseRulesClient {
     return err;
   }
 
-  private getErrorMessage(err: HttpError): string {
+  private getErrorMessage(err: RequestResponseError): string {
     const intro = 'Error while accessing security rules';
     try {
       const body: { error?: string } = err.response.data;

src/eventarc/eventarc-client-internal.ts

@@ -20,7 +20,7 @@ import { FirebaseEventarcError, toCloudEventProtoFormat } from './eventarc-utils
 import { App } from '../app';
 import { Channel } from './eventarc';
 import {
-  HttpRequestConfig, HttpClient, HttpError, AuthorizedHttpClient
+  HttpRequestConfig, HttpClient, RequestResponseError, AuthorizedHttpClient
 } from '../utils/api-request';
 import { FirebaseApp } from '../app/firebase-app';
 import * as utils from '../utils';
@@ -117,7 +117,7 @@ export class EventarcApiClient {
       });
   }
 
-  private toFirebaseError(err: HttpError): PrefixedFirebaseError {
+  private toFirebaseError(err: RequestResponseError): PrefixedFirebaseError {
     if (err instanceof PrefixedFirebaseError) {
       return err;
     }

src/extensions/extensions-api-client-internal.ts

@@ -17,7 +17,7 @@
 
 import { App } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
-import { AuthorizedHttpClient, HttpClient, HttpError, HttpRequestConfig } from '../utils/api-request';
+import { AuthorizedHttpClient, HttpClient, RequestResponseError, HttpRequestConfig } from '../utils/api-request';
 import { FirebaseAppError, PrefixedFirebaseError } from '../utils/error';
 import * as validator from '../utils/validator';
 import * as utils from '../utils';
@@ -76,7 +76,7 @@ export class ExtensionsApiClient {
     }/${EXTENSIONS_API_VERSION}/projects/${projectId}/instances/${instanceId}/runtimeData`;
   }
 
-  private toFirebaseError(err: HttpError): PrefixedFirebaseError {
+  private toFirebaseError(err: RequestResponseError): PrefixedFirebaseError {
     if (err instanceof PrefixedFirebaseError) {
       return err;
     }

src/functions/functions-api-client-internal.ts

@@ -18,7 +18,7 @@
 import { App } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import {
-  HttpRequestConfig, HttpClient, HttpError, AuthorizedHttpClient
+  HttpRequestConfig, HttpClient, RequestResponseError, AuthorizedHttpClient
 } from '../utils/api-request';
 import { PrefixedFirebaseError } from '../utils/error';
 import * as utils from '../utils/index';
@@ -99,7 +99,7 @@ export class FunctionsApiClient {
       };
       await this.httpClient.send(request);
     } catch (err: unknown) {
-      if (err instanceof HttpError) {
+      if (err instanceof RequestResponseError) {
         if (err.response.status === 404) {
           // if no task with the provided ID exists, then ignore the delete.
           return;
@@ -156,7 +156,7 @@ export class FunctionsApiClient {
       };
       await this.httpClient.send(request);
     } catch (err: unknown) {
-      if (err instanceof HttpError) {
+      if (err instanceof RequestResponseError) {
         if (err.response.status === 409) {
           throw new FirebaseFunctionsError('task-already-exists', `A task with ID ${opts?.id} already exists`);
         } else {
@@ -321,7 +321,7 @@ export class FunctionsApiClient {
     return task;
   }
 
-  private toFirebaseError(err: HttpError): PrefixedFirebaseError {
+  private toFirebaseError(err: RequestResponseError): PrefixedFirebaseError {
     if (err instanceof PrefixedFirebaseError) {
       return err;
     }