Register new installation-id-not-registered Error Code

Author: yvonnep165

src/messaging/messaging-errors-internal.ts

@@ -29,8 +29,22 @@ export function createFirebaseError(err: RequestResponseError): FirebaseMessagin
   if (err.response.isJson()) {
     // For JSON responses, map the server response to a client-side error.
     const json = err.response.data;
-    const errorCode = getErrorCode(json);
+    let errorCode = getErrorCode(json);
     const errorMessage = getErrorMessage(json);
+    if (errorCode === 'UNREGISTERED' || errorCode === 'NOT_FOUND') {
+      let requestData = err.response.config && err.response.config.data;
+      if (typeof requestData === 'string') {
+        try {
+          requestData = JSON.parse(requestData);
+        } catch (e) {
+          // Ignore parsing errors.
+        }
+      }
+      const messageObj = requestData && requestData.message;
+      if (messageObj && typeof messageObj.fid === 'string') {
+        errorCode = 'UNREGISTERED_FID';
+      }
+    }
     return FirebaseMessagingError.fromServerError(errorCode, errorMessage, json);
   }
 

src/utils/api-request.ts

@@ -75,6 +75,8 @@ export interface RequestResponse {
   readonly data?: any;
   /** For multipart responses, the payloads of individual parts. */
   readonly multipart?: Buffer[];
+  /** Optional request config used to send this request. */
+  readonly config?: any;
   /**
    * Indicates if the response content is JSON-formatted or not. If true, data field can be used
    * to retrieve the content as a parsed JSON object.
@@ -127,6 +129,7 @@ class DefaultRequestResponse implements RequestResponse {
   public readonly status: number;
   public readonly headers: any;
   public readonly text?: string;
+  public readonly config?: RequestConfig;
 
   private readonly parsedData: any;
   private readonly parseError: Error;
@@ -139,6 +142,7 @@ class DefaultRequestResponse implements RequestResponse {
     this.status = resp.status;
     this.headers = resp.headers;
     this.text = resp.data;
+    this.config = resp.config;
     try {
       if (!resp.data) {
         throw new FirebaseAppError(AppErrorCodes.INTERNAL_ERROR, 'HTTP response missing data.');
@@ -177,11 +181,13 @@ class MultipartRequestResponse implements RequestResponse {
   public readonly status: number;
   public readonly headers: any;
   public readonly multipart?: Buffer[];
+  public readonly config?: any;
 
   constructor(resp: LowLevelResponse) {
     this.status = resp.status;
     this.headers = resp.headers;
     this.multipart = resp.multipart;
+    this.config = resp.config;
   }
 
   get text(): string {

src/utils/error.ts

@@ -857,6 +857,12 @@ export class MessagingClientErrorCode {
       'token can be unregistered for a variety of reasons. See the error documentation for more ' +
       'details. Remove this registration token and stop using it to send messages.',
   };
+  public static INSTALLATION_ID_NOT_REGISTERED = {
+    code: 'installation-id-not-registered',
+    message: 'The provided installation ID is not registered. A previously valid installation ' +
+      'ID can be unregistered for a variety of reasons. See the error documentation for more ' +
+      'details. Remove this installation ID and stop using it to send messages.',
+  };
   public static MISMATCHED_CREDENTIAL = {
     code: 'mismatched-credential',
     message: 'The credential used to authenticate this SDK does not have permission to send ' +
@@ -1130,6 +1136,7 @@ const MESSAGING_SERVER_TO_CLIENT_CODE: ServerToClientCode = {
   THIRD_PARTY_AUTH_ERROR: 'THIRD_PARTY_AUTH_ERROR',
   UNAVAILABLE: 'SERVER_UNAVAILABLE',
   UNREGISTERED: 'REGISTRATION_TOKEN_NOT_REGISTERED',
+  UNREGISTERED_FID: 'INSTALLATION_ID_NOT_REGISTERED',
   UNSPECIFIED_ERROR: 'UNKNOWN_ERROR',
 };
 

test/integration/messaging.spec.ts

@@ -97,9 +97,9 @@ describe('admin.messaging', () => {
       });
   });
 
-  it('send(message with fid, dryRun) fails with registration-token-not-registered', () => {
+  it('send(message with fid, dryRun) fails with installation-id-not-registered', () => {
     return getMessaging().send(fidMessage, true)
-      .should.eventually.be.rejected.and.have.property('code', 'messaging/registration-token-not-registered');
+      .should.eventually.be.rejected.and.have.property('code', 'messaging/installation-id-not-registered');
   });
 
   it('sendEach()', () => {
@@ -166,7 +166,7 @@ describe('admin.messaging', () => {
         response.responses.forEach((resp) => {
           expect(resp.success).to.be.false;
           expect(resp.messageId).to.be.undefined;
-          expect(resp.error).to.have.property('code', 'messaging/registration-token-not-registered');
+          expect(resp.error).to.have.property('code', 'messaging/installation-id-not-registered');
         });
       });
   });
@@ -192,7 +192,7 @@ describe('admin.messaging', () => {
         expect(response.responses[1].messageId).to.be.undefined;
         expect(response.responses[1].error).to.have.property(
           'code',
-          'messaging/registration-token-not-registered',
+          'messaging/installation-id-not-registered',
         );
       });
   });

test/unit/messaging/messaging.spec.ts

@@ -425,6 +425,26 @@ describe('Messaging', () => {
         .and.have.property('code', 'messaging/registration-token-not-registered');
     });
 
+    it('should fail when the backend server returns a detailed error for a FID target', () => {
+      const resp = {
+        error: {
+          status: 'NOT_FOUND',
+          message: 'test error message',
+          details: [
+            {
+              '@type': 'type.googleapis.com/google.firebase.fcm.v1.FcmError',
+              'errorCode': 'UNREGISTERED',
+            },
+          ],
+        },
+      };
+      mockedRequests.push(mockSendError(404, 'json', resp));
+      return messaging.send(
+        { fid: 'mock-fid' },
+      ).should.eventually.be.rejectedWith('test error message')
+        .and.have.property('code', 'messaging/installation-id-not-registered');
+    });
+
     ['THIRD_PARTY_AUTH_ERROR', 'APNS_AUTH_ERROR'].forEach((errorCode) => {
       it(`should map ${errorCode} to third party auth error`, () => {
         const resp = {