Wrap session errors in a new FirebaseMessagingSessionError

Author: jonathanedey

etc/firebase-admin.app.api.md

@@ -19,8 +19,6 @@ export class AppErrorCodes {
     // (undocumented)
     static DUPLICATE_APP: string;
     // (undocumented)
-    static HTTP2_SESSION_ERROR: string;
-    // (undocumented)
     static INTERNAL_ERROR: string;
     // (undocumented)
     static INVALID_APP_NAME: string;

src/messaging/messaging.ts

@@ -17,7 +17,9 @@
 
 import { App } from '../app';
 import { deepCopy } from '../utils/deep-copy';
-import { ErrorInfo, MessagingClientErrorCode, FirebaseMessagingError } from '../utils/error';
+import { 
+  ErrorInfo, MessagingClientErrorCode, FirebaseMessagingError, FirebaseMessagingSessionError
+} from '../utils/error';
 import * as utils from '../utils';
 import * as validator from '../utils/validator';
 import { validateMessage } from './messaging-internal';
@@ -211,13 +213,13 @@ export class Messaging {
     return this.getUrlPath()
       .then((urlPath) => {
         if (http2SessionHandler) {
-          let batchResponsePromise: Promise<PromiseSettledResult<SendResponse>[]>;
+          let sendResponsePromise: Promise<PromiseSettledResult<SendResponse>[]>;
           return new Promise((resolve: (result: PromiseSettledResult<SendResponse>[]) => void, reject) => {
             // Start session listeners
             http2SessionHandler.invoke().catch((error) => {
-              error.pendingBatchResponse =
-                batchResponsePromise ? batchResponsePromise.then(this.parseSendResponses) : undefined;
-              reject(error);
+              const pendingBatchResponse = 
+                sendResponsePromise ? sendResponsePromise.then(this.parseSendResponses) : undefined;
+              reject(new FirebaseMessagingSessionError(error, undefined, pendingBatchResponse));
             });
 
             // Start making requests
@@ -232,8 +234,8 @@ export class Messaging {
             });
 
             // Resolve once all requests have completed
-            batchResponsePromise = Promise.allSettled(requests);
-            batchResponsePromise.then(resolve);
+            sendResponsePromise = Promise.allSettled(requests);
+            sendResponsePromise.then(resolve);
           });
         } else {
           const requests: Promise<SendResponse>[] = copy.map(async (message) => {

src/utils/api-request.ts

@@ -1339,14 +1339,14 @@ export class Http2SessionHandler {
 
       http2Session.on('goaway', (errorCode, _, opaqueData) => {
         this.reject(new FirebaseAppError(
-          AppErrorCodes.HTTP2_SESSION_ERROR,
+          AppErrorCodes.NETWORK_ERROR,
           `Error while making requests: GOAWAY - ${opaqueData?.toString()}, Error code: ${errorCode}`
         ));
       })
 
       http2Session.on('error', (error) => {
         this.reject(new FirebaseAppError(
-          AppErrorCodes.HTTP2_SESSION_ERROR,
+          AppErrorCodes.NETWORK_ERROR,
           `Session error while making requests: ${error}`
         ));
       })

src/utils/error.ts

@@ -16,6 +16,7 @@
  */
 
 import { FirebaseError as FirebaseErrorInterface } from '../app';
+import { BatchResponse } from '../messaging/messaging-api';
 import { deepCopy } from '../utils/deep-copy';
 
 /**
@@ -344,6 +345,38 @@ export class FirebaseMessagingError extends PrefixedFirebaseError {
   }
 }
 
+export class FirebaseMessagingSessionError extends FirebaseMessagingError {
+  public pendingBatchResponse?: Promise<BatchResponse>;
+  /**
+     * 
+     * @param info - The error code info.
+     * @param message - The error message. This will override the default message if provided.
+     * @param pendingBatchResponse - BatchResponse for pending messages when session error occured.
+     * @constructor
+     * @internal
+     */
+  constructor(info: ErrorInfo, message?: string, pendingBatchResponse?: Promise<BatchResponse>) {
+    // Override default message if custom message provided.
+    super(info, message || info.message);
+    this.pendingBatchResponse = pendingBatchResponse;
+
+    /* tslint:disable:max-line-length */
+    // Set the prototype explicitly. See the following link for more details:
+    // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
+    /* tslint:enable:max-line-length */
+    (this as any).__proto__ = FirebaseMessagingSessionError.prototype;
+  }
+
+  /** @returns The object representation of the error. */
+  public toJSON(): object {
+    return {
+      code: this.code,
+      message: this.message,
+      pendingBatchResponse: this.pendingBatchResponse,
+    };
+  }
+}
+
 /**
  * Firebase project management error code structure. This extends PrefixedFirebaseError.
  */
@@ -377,7 +410,6 @@ export class AppErrorCodes {
   public static INVALID_APP_OPTIONS = 'invalid-app-options';
   public static INVALID_CREDENTIAL = 'invalid-credential';
   public static NETWORK_ERROR = 'network-error';
-  public static HTTP2_SESSION_ERROR = 'http2-session-error';
   public static NETWORK_TIMEOUT = 'network-timeout';
   public static NO_APP = 'no-app';
   public static UNABLE_TO_PARSE_RESPONSE = 'unable-to-parse-response';

test/unit/messaging/messaging.spec.ts

@@ -34,6 +34,7 @@ import {
 import { HttpClient } from '../../../src/utils/api-request';
 import { getMetricsHeader, getSdkVersion } from '../../../src/utils/index';
 import * as utils from '../utils';
+import { FirebaseMessagingSessionError } from '../../../src/utils/error';
 
 chai.should();
 chai.use(sinonChai);
@@ -923,9 +924,10 @@ describe('Messaging', () => {
 
       return messaging.sendEach(
         [validMessage, validMessage], true
-      ).catch(async (error) => {
-        expect(error.errorInfo.code).to.equal('app/http2-session-error')
-        await error.pendingBatchResponse.then((response: BatchResponse) => {
+      ).catch(async (error: FirebaseMessagingSessionError) => {
+        expect(error.code).to.equal('messaging/app/network-error');
+        expect(error.pendingBatchResponse).to.not.be.undefined;
+        await error.pendingBatchResponse?.then((response: BatchResponse) => {
           expect(http2Mocker.requests.length).to.equal(2);
           expect(response.failureCount).to.equal(1);
           const responses = response.responses;

test/unit/utils/api-request.spec.ts

@@ -2538,6 +2538,7 @@ describe('Http2Client', () => {
       });
 
     await http2SessionHandler.invoke().should.eventually.be.rejectedWith(sessionError)
+      .and.have.property('code', 'app/network-error')
   });
 });