Gracefully handling array-like arguments in sendAll() and sendMulticast() (#569)

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Unreleased
 
--
+- [fixed] Gracefully handling array-like objects in `messaging.sendAll()` and
+  `messaging.sendMulticast()` APIs.
+- [fixed] Updated the metadata server URL (used by the application default credentials)
+  to the `v1` endpoint.
 
 # v8.1.0
 

src/messaging/messaging.ts

@@ -291,6 +291,13 @@ export class Messaging implements FirebaseServiceInterface {
    *     of the send operation.
    */
   public sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse> {
+    if (validator.isArray(messages) && messages.constructor !== Array) {
+      // In more recent JS specs, an array-like object might have a constructor that is not of
+      // Array type. Our deepCopy() method doesn't handle them properly. Convert such objects to
+      // a regular array here before calling deepCopy(). See issue #566 for details.
+      messages = Array.from(messages);
+    }
+
     const copy: Message[] = deepCopy(messages);
     if (!validator.isNonEmptyArray(copy)) {
       throw new FirebaseMessagingError(

test/unit/messaging/messaging.spec.ts

@@ -303,6 +303,8 @@ function disableRetries(messaging: Messaging) {
   (messaging as any).messagingRequestHandler.httpClient.retry = null;
 }
 
+class CustomArray extends Array { }
+
 describe('Messaging', () => {
   let mockApp: FirebaseApp;
   let messaging: Messaging;
@@ -608,6 +610,40 @@ describe('Messaging', () => {
         });
     });
 
+    it('should be fulfilled with a BatchResponse given array-like (issue #566)', () => {
+      const messageIds = [
+        'projects/projec_id/messages/1',
+        'projects/projec_id/messages/2',
+        'projects/projec_id/messages/3',
+      ];
+      mockedRequests.push(mockBatchRequest(messageIds));
+      const message = {
+        token: 'a',
+        android: {
+          ttl: 3600,
+        },
+      };
+      const arrayLike = new CustomArray();
+      arrayLike.push(message);
+      arrayLike.push(message);
+      arrayLike.push(message);
+      // Explicitly patch the constructor so that down compiling to ES5 doesn't affect the test.
+      // See https://github.com/firebase/firebase-admin-node/issues/566#issuecomment-501974238
+      // for more context.
+      arrayLike.constructor = CustomArray;
+
+      return messaging.sendAll(arrayLike)
+        .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;
+          });
+        });
+    });
+
     it('should be fulfilled with a BatchResponse given valid messages in dryRun mode', () => {
       const messageIds = [
         'projects/projec_id/messages/1',