fix(messaging): RemoteMessage.data may be JSON-serializable object as…

… well as string (#7316)
invertase · Sep 20, 2023 · 7945a24 · 7945a24 · vercel · Sep 20, 2023
1 parent eede992
commit 7945a24
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/packages/messaging/e2e/remoteMessage.e2e.js b/packages/messaging/e2e/remoteMessage.e2e.js
@@ -182,6 +182,7 @@ describe('remoteMessage modular', function () {
             await firebase.messaging().sendMessage({
               data: {
                 foo: 'bar',
+                fooObject: { image: 'testURL' },
               },
             });
           } else {
@@ -423,6 +424,7 @@ describe('remoteMessage modular', function () {
             await sendMessage(getMessaging(), {
               data: {
                 foo: 'bar',
+                fooObject: { image: 'testURL' },
               },
             });
           } else {

diff --git a/packages/messaging/lib/index.d.ts b/packages/messaging/lib/index.d.ts
@@ -108,7 +108,7 @@ export namespace FirebaseMessagingTypes {
     /**
      * Any additional data sent with the message.
      */
-    data?: { [key: string]: string };
+    data?: { [key: string]: string | object };
 
     /**
      * Additional NotificationPayload data sent with the message

diff --git a/packages/messaging/lib/remoteMessageOptions.js b/packages/messaging/lib/remoteMessageOptions.js
@@ -65,7 +65,21 @@ export default function remoteMessageOptions(messagingSenderId, remoteMessage) {
   } else if (!isObject(remoteMessage.data)) {
     throw new Error("'remoteMessage.data' expected an object value");
   } else {
-    out.data = remoteMessage.data;
+    // Serialize all objects to strings
+    out.data = {};
+    for (let key in remoteMessage.data) {
+      if (remoteMessage.data.hasOwnProperty(key)) {
+        if (
+          typeof remoteMessage.data[key] === 'object' &&
+          !Array.isArray(remoteMessage.data[key]) &&
+          remoteMessage.data[key] !== null
+        ) {
+          out.data[key] = JSON.stringify(remoteMessage.data[key]);
+        } else {
+          out.data[key] = remoteMessage.data[key];
+        }
+      }
+    }
   }
 
   if (remoteMessage.collapseKey) {