feat: support async callbacks for messages and notification taps (#252)

jkatins · web-flow · commit 86a27230749b · 2024-04-10T09:34:38.000-07:00
diff --git a/packages/firebase-messaging-core/index.ios.ts b/packages/firebase-messaging-core/index.ios.ts
@@ -43,15 +43,14 @@ function deserialize(data: any): any {
 
 export class MessagingCore implements IMessagingCore {
 	_APNSToken;
-	_onMessage(message: any) {
+	_onMessage(message: any, completionHandler: () => void) {
 		console.log('_onMessage', message);
 		if (onMessageCallbacks.size > 0) {
 			const msg = deserialize(message);
-			onMessageCallbacks.forEach((cb) => {
-				cb(msg);
-			});
+			Promise.all(Array.from(onMessageCallbacks).map((cb) => cb(msg))).finally(() => completionHandler());
 		} else {
 			MessagingCore._messageQueues._onMessage.push(message);
+			completionHandler();
 		}
 	}
 	_onToken(token: string) {
@@ -65,15 +64,14 @@ export class MessagingCore implements IMessagingCore {
 			MessagingCore._messageQueues._onToken.push(token);
 		}
 	}
-	_onNotificationTap(message: any) {
+	_onNotificationTap(message: any, completionHandler: () => void) {
 		console.log('_onNotificationTap', message);
 		if (onNotificationTapCallbacks.size > 0) {
 			const msg = deserialize(message);
-			onNotificationTapCallbacks.forEach((cb) => {
-				cb(msg);
-			});
+			Promise.all(Array.from(onNotificationTapCallbacks).map((cb) => cb(msg))).finally(() => completionHandler());
 		} else {
 			MessagingCore._messageQueues._onNotificationTap.push(message);
+			completionHandler();
 		}
 	}
 
@@ -336,7 +334,7 @@ export class MessagingCore implements IMessagingCore {
 		if (queue.length > 0) {
 			MessagingCore._messageQueues[type] = [];
 			queue.forEach((message) => {
-				this[type](message);
+				this[type](message, () => {});
 			});
 		}
 	}
diff --git a/packages/firebase-messaging-core/platforms/ios/src/NSCFirebaseMessagingCore.h b/packages/firebase-messaging-core/platforms/ios/src/NSCFirebaseMessagingCore.h
@@ -2,7 +2,7 @@
 #import <UIKit/UIKit.h>
 
 typedef void(^BoolCallback)(BOOL success, NSError* _Nullable error);
-typedef void(^DictionaryCallback)(NSDictionary* _Nullable value);
+typedef void(^CompletableDictionaryCallback)(NSDictionary* _Nullable value, void(^_Nonnull complete)(void));
 typedef void(^StringCallback)(NSString* _Nullable value);
 
 @interface NSCFirebaseMessagingCore: NSObject
@@ -11,9 +11,9 @@ typedef void(^StringCallback)(NSString* _Nullable value);
 
 @property (nonatomic, strong, class) BoolCallback _Nullable registerDeviceForRemoteMessagesCallback;
 
-@property (nonatomic, strong, class) DictionaryCallback _Nullable onNotificationTapCallback;
+@property (nonatomic, strong, class) CompletableDictionaryCallback _Nullable onNotificationTapCallback;
 
-@property (nonatomic, strong, class) DictionaryCallback _Nullable onMessageCallback;
+@property (nonatomic, strong, class) CompletableDictionaryCallback _Nullable onMessageCallback;
 
 @property (nonatomic, strong, class) StringCallback _Nullable onTokenCallback;
 
diff --git a/packages/firebase-messaging-core/platforms/ios/src/NSCFirebaseMessagingCore.m b/packages/firebase-messaging-core/platforms/ios/src/NSCFirebaseMessagingCore.m
@@ -3,8 +3,8 @@ @implementation NSCFirebaseMessagingCore
 
 BOOL ShowNotificationsWhenInForeground = NO;
 BoolCallback RegisterDeviceForRemoteMessagesCallback = nil;
-DictionaryCallback OnNotificationTapCallback = nil;
-DictionaryCallback OnMessageCallback = nil;
+CompletableDictionaryCallback OnNotificationTapCallback = nil;
+CompletableDictionaryCallback OnMessageCallback = nil;
 StringCallback OnTokenCallback = nil;
 
 + (void)setShowNotificationsWhenInForeground:(BOOL)showNotificationsWhenInForeground {
@@ -23,19 +23,19 @@ + (void)setRegisterDeviceForRemoteMessagesCallback:(BoolCallback)callback {
     RegisterDeviceForRemoteMessagesCallback = callback;
 }
 
-+ (DictionaryCallback)onNotificationTapCallback {
++ (CompletableDictionaryCallback)onNotificationTapCallback {
     return OnNotificationTapCallback;
 }
 
-+ (void)setOnNotificationTapCallback:(DictionaryCallback)callback {
++ (void)setOnNotificationTapCallback:(CompletableDictionaryCallback)callback {
     OnNotificationTapCallback = callback;
 }
 
-+ (DictionaryCallback)onMessageCallback {
++ (CompletableDictionaryCallback)onMessageCallback {
     return OnMessageCallback;
 }
 
-+ (void)setOnMessageCallback:(DictionaryCallback)callback {
++ (void)setOnMessageCallback:(CompletableDictionaryCallback)callback {
     OnMessageCallback = callback;
 }
 
diff --git a/packages/firebase-messaging-core/platforms/ios/src/NSCUIApplicationDelegate.swift b/packages/firebase-messaging-core/platforms/ios/src/NSCUIApplicationDelegate.swift
@@ -149,9 +149,9 @@ public class NSCUIApplicationDelegate: UIResponder , UIApplicationDelegate {
         message = parseRemoteMessage(userInfo)
         #endif
         message["foreground"] = application.applicationState == UIApplication.State.active
-        NSCFirebaseMessagingCore.onMessageCallback?(message)
-        completionHandler(.newData)
-        
+        NSCFirebaseMessagingCore.onMessageCallback?(message) {
+            completionHandler(.newData)
+        }
     }
     
 }
diff --git a/packages/firebase-messaging-core/platforms/ios/src/NSCUNUserNotificationCenterDelegate.swift b/packages/firebase-messaging-core/platforms/ios/src/NSCUNUserNotificationCenterDelegate.swift
@@ -53,12 +53,16 @@ public class NSCUNUserNotificationCenterDelegate: NSObject, UNUserNotificationCe
         if (remoteNotification["gcm.message_id"] != nil) {
             var message = parseNotification(response.notification)
             message["foreground"] = UIApplication.shared.applicationState == UIApplication.State.active
-            NSCFirebaseMessagingCore.onNotificationTapCallback?(message)
+            NSCFirebaseMessagingCore.onNotificationTapCallback?(message) {
+                completionHandler()
+            }
         }else {
             if((response.notification.request.trigger as? UNPushNotificationTrigger) != nil){
                 var message = remoteNotification
                 message["foreground"] = UIApplication.shared.applicationState == UIApplication.State.active
-                NSCFirebaseMessagingCore.onNotificationTapCallback?(message)
+                NSCFirebaseMessagingCore.onNotificationTapCallback?(message) {
+                    completionHandler()
+                }
             }
         }
         
@@ -82,18 +86,22 @@ public class NSCUNUserNotificationCenterDelegate: NSObject, UNUserNotificationCe
         if (notification.request.content.userInfo["gcm.message_id"] != nil) {
             var message = parseNotification(notification)
             if (message["contentAvailable"] == nil) {
-                NSCFirebaseMessagingCore.onMessageCallback?(message)
+                NSCFirebaseMessagingCore.onMessageCallback?(message) {
+                    completionHandler(options)
+                }
                 message["foreground"] = UIApplication.shared.applicationState == UIApplication.State.active
+            } else {
+                completionHandler(options)
             }
-            completionHandler(options)
             return
         }else {
             if((notification.request.trigger as? UNPushNotificationTrigger) != nil){
                 
                 var message = notification.request.content.userInfo
                 message["foreground"] = UIApplication.shared.applicationState == UIApplication.State.active
-                NSCFirebaseMessagingCore.onMessageCallback?(message)
-                completionHandler(options)
+                NSCFirebaseMessagingCore.onMessageCallback?(message) {
+                    completionHandler(options)
+                }
                 return
             }
         }
diff --git a/packages/firebase-messaging/typings/objc!NSCFirebaseMessagingCore.d.ts b/packages/firebase-messaging/typings/objc!NSCFirebaseMessagingCore.d.ts
@@ -5,9 +5,9 @@ declare class NSCFirebaseMessagingCore extends NSObject {
 
 	static new(): NSCFirebaseMessagingCore; // inherited from NSObject
 
-	static onMessageCallback: (p1: NSDictionary<any, any>) => void;
+	static onMessageCallback: (p1: NSDictionary<any, any>, p2: () => void) => void;
 
-	static onNotificationTapCallback: (p1: NSDictionary<any, any>) => void;
+	static onNotificationTapCallback: (p1: NSDictionary<any, any>, p2: () => void) => void;
 
 	static onTokenCallback: (p1: string) => void;
 

Original file line number	Diff line number	Diff line change
`@@ -43,15 +43,14 @@ function deserialize(data: any): any {`
`43`	`43`
`44`	`44`	`export class MessagingCore implements IMessagingCore {`
`45`	`45`	`_APNSToken;`
`46`		`- _onMessage(message: any) {`
	`46`	`+ _onMessage(message: any, completionHandler: () => void) {`
`47`	`47`	`console.log('_onMessage', message);`
`48`	`48`	`if (onMessageCallbacks.size > 0) {`
`49`	`49`	`const msg = deserialize(message);`
`50`		`- onMessageCallbacks.forEach((cb) => {`
`51`		`- cb(msg);`
`52`		`- });`
	`50`	`+ Promise.all(Array.from(onMessageCallbacks).map((cb) => cb(msg))).finally(() => completionHandler());`
`53`	`51`	`} else {`
`54`	`52`	`MessagingCore._messageQueues._onMessage.push(message);`
	`53`	`+ completionHandler();`
`55`	`54`	`}`
`56`	`55`	`}`
`57`	`56`	`_onToken(token: string) {`
`@@ -65,15 +64,14 @@ export class MessagingCore implements IMessagingCore {`
`65`	`64`	`MessagingCore._messageQueues._onToken.push(token);`
`66`	`65`	`}`
`67`	`66`	`}`
`68`		`- _onNotificationTap(message: any) {`
	`67`	`+ _onNotificationTap(message: any, completionHandler: () => void) {`
`69`	`68`	`console.log('_onNotificationTap', message);`
`70`	`69`	`if (onNotificationTapCallbacks.size > 0) {`
`71`	`70`	`const msg = deserialize(message);`
`72`		`- onNotificationTapCallbacks.forEach((cb) => {`
`73`		`- cb(msg);`
`74`		`- });`
	`71`	`+ Promise.all(Array.from(onNotificationTapCallbacks).map((cb) => cb(msg))).finally(() => completionHandler());`
`75`	`72`	`} else {`
`76`	`73`	`MessagingCore._messageQueues._onNotificationTap.push(message);`
	`74`	`+ completionHandler();`
`77`	`75`	`}`
`78`	`76`	`}`
`79`	`77`
`@@ -336,7 +334,7 @@ export class MessagingCore implements IMessagingCore {`
`336`	`334`	`if (queue.length > 0) {`
`337`	`335`	`MessagingCore._messageQueues[type] = [];`
`338`	`336`	`queue.forEach((message) => {`
`339`		`- this[type](message);`
	`337`	`+ this[type](message, () => {});`
`340`	`338`	`});`
`341`	`339`	`}`
`342`	`340`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@ @implementation NSCFirebaseMessagingCore`
`3`	`3`
`4`	`4`	`BOOL ShowNotificationsWhenInForeground = NO;`
`5`	`5`	`BoolCallback RegisterDeviceForRemoteMessagesCallback = nil;`
`6`		`-DictionaryCallback OnNotificationTapCallback = nil;`
`7`		`-DictionaryCallback OnMessageCallback = nil;`
	`6`	`+CompletableDictionaryCallback OnNotificationTapCallback = nil;`
	`7`	`+CompletableDictionaryCallback OnMessageCallback = nil;`
`8`	`8`	`StringCallback OnTokenCallback = nil;`
`9`	`9`
`10`	`10`	`+ (void)setShowNotificationsWhenInForeground:(BOOL)showNotificationsWhenInForeground {`
`@@ -23,19 +23,19 @@ + (void)setRegisterDeviceForRemoteMessagesCallback:(BoolCallback)callback {`
`23`	`23`	`RegisterDeviceForRemoteMessagesCallback = callback;`
`24`	`24`	`}`
`25`	`25`
`26`		`-+ (DictionaryCallback)onNotificationTapCallback {`
	`26`	`++ (CompletableDictionaryCallback)onNotificationTapCallback {`
`27`	`27`	`return OnNotificationTapCallback;`
`28`	`28`	`}`
`29`	`29`
`30`		`-+ (void)setOnNotificationTapCallback:(DictionaryCallback)callback {`
	`30`	`++ (void)setOnNotificationTapCallback:(CompletableDictionaryCallback)callback {`
`31`	`31`	`OnNotificationTapCallback = callback;`
`32`	`32`	`}`
`33`	`33`
`34`		`-+ (DictionaryCallback)onMessageCallback {`
	`34`	`++ (CompletableDictionaryCallback)onMessageCallback {`
`35`	`35`	`return OnMessageCallback;`
`36`	`36`	`}`
`37`	`37`
`38`		`-+ (void)setOnMessageCallback:(DictionaryCallback)callback {`
	`38`	`++ (void)setOnMessageCallback:(CompletableDictionaryCallback)callback {`
`39`	`39`	`OnMessageCallback = callback;`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -149,9 +149,9 @@ public class NSCUIApplicationDelegate: UIResponder , UIApplicationDelegate {`
`149`	`149`	`message = parseRemoteMessage(userInfo)`
`150`	`150`	`#endif`
`151`	`151`	`message["foreground"] = application.applicationState == UIApplication.State.active`
`152`		`- NSCFirebaseMessagingCore.onMessageCallback?(message)`
`153`		`- completionHandler(.newData)`
`154`		`-`
	`152`	`+ NSCFirebaseMessagingCore.onMessageCallback?(message) {`
	`153`	`+ completionHandler(.newData)`
	`154`	`+ }`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`}`