From 01d8177650676a142474229538f0b469fc363a65 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Borntr=C3=A4ger?= <marc.borntraeger@gmail.com>
Date: Thu, 4 Feb 2021 20:04:19 +0100
Subject: [PATCH] feat: Exporting all types of Messages so they can be used by
 consumers (#1147)

* feat: Exporting all types of Messages so they can be used by consumers

Fixes https://github.com/firebase/firebase-admin-node/issues/1146

* feat(exportMessageTypes): Testing TokenMessage

* feat(exportMessageTypes): Added tests for all Message types

* feat(exportMessageTypes): Fixed build

* feat(exportMessageTypes): Better unit tests

* feat(exportMessageTypes): Deleted unneeded separate TS test

* feat(exportMessageTypes): Fixed build

* feat(exportMessageTypes): Fixed linting
---
 src/messaging/index.ts                |  6 ++---
 test/unit/messaging/messaging.spec.ts | 33 +++++++++++++++++++++++++--
 2 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/src/messaging/index.ts b/src/messaging/index.ts
index 020ee7c875..6c074cea7c 100644
--- a/src/messaging/index.ts
+++ b/src/messaging/index.ts
@@ -58,15 +58,15 @@ export namespace messaging {
     fcmOptions?: FcmOptions;
   }
 
-  interface TokenMessage extends BaseMessage {
+  export interface TokenMessage extends BaseMessage {
     token: string;
   }
 
-  interface TopicMessage extends BaseMessage {
+  export interface TopicMessage extends BaseMessage {
     topic: string;
   }
 
-  interface ConditionMessage extends BaseMessage {
+  export interface ConditionMessage extends BaseMessage {
     condition: string;
   }
 
diff --git a/test/unit/messaging/messaging.spec.ts b/test/unit/messaging/messaging.spec.ts
index 82f0973f67..236c18213a 100644
--- a/test/unit/messaging/messaging.spec.ts
+++ b/test/unit/messaging/messaging.spec.ts
@@ -41,6 +41,9 @@ chai.use(chaiAsPromised);
 const expect = chai.expect;
 
 import Message = messaging.Message;
+import TokenMessage = messaging.TokenMessage;
+import TopicMessage = messaging.TopicMessage;
+import ConditionMessage = messaging.ConditionMessage;
 import MessagingOptions = messaging.MessagingOptions;
 import MessagingPayload = messaging.MessagingPayload;
 import MessagingDevicesResponse = messaging.MessagingDevicesResponse;
@@ -823,6 +826,32 @@ describe('Messaging', () => {
         [validMessage],
       ).should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
     });
+
+    // This test was added to also verify https://github.com/firebase/firebase-admin-node/issues/1146
+    it('should be fulfilled when called with different message types', () => {
+      const messageIds = [
+        'projects/projec_id/messages/1',
+        'projects/projec_id/messages/2',
+        'projects/projec_id/messages/3',
+      ];
+      const tokenMessage: TokenMessage = { token: 'test' };
+      const topicMessage: TopicMessage = { topic: 'test' };
+      const conditionMessage: ConditionMessage = { condition: 'test' };
+      const messages: Message[] = [tokenMessage, topicMessage, conditionMessage];
+      
+      mockedRequests.push(mockBatchRequest(messageIds));
+      
+      return messaging.sendAll(messages)
+        .then((response: BatchResponse) => {
+          expect(response.successCount).to.equal(3);
+          expect(response.failureCount).to.equal(0);
+          response.responses.forEach((resp, idx) => {
+            expect(resp.success).to.be.true;
+            expect(resp.messageId).to.equal(messageIds[idx]);
+            expect(resp.error).to.be.undefined;
+          });
+        });
+    });    
   });
 
   describe('sendMulticast()', () => {
@@ -887,7 +916,7 @@ describe('Messaging', () => {
           expect(messages.length).to.equal(3);
           expect(stub!.args[0][1]).to.be.undefined;
           messages.forEach((message, idx) => {
-            expect((message as any).token).to.equal(tokens[idx]);
+            expect((message as TokenMessage).token).to.equal(tokens[idx]);
             expect(message.android).to.be.undefined;
             expect(message.apns).to.be.undefined;
             expect(message.data).to.be.undefined;
@@ -917,7 +946,7 @@ describe('Messaging', () => {
           expect(messages.length).to.equal(3);
           expect(stub!.args[0][1]).to.be.undefined;
           messages.forEach((message, idx) => {
-            expect((message as any).token).to.equal(tokens[idx]);
+            expect((message as TokenMessage).token).to.equal(tokens[idx]);
             expect(message.android).to.deep.equal(multicast.android);
             expect(message.apns).to.be.deep.equal(multicast.apns);
             expect(message.data).to.be.deep.equal(multicast.data);