feat: add process notification action and update handle notification

Author: vinothvino42

lib/action/notification_action.dart

@@ -45,3 +45,47 @@ class GetDeviceTokenAction extends EnsembleAction {
     }
   }
 }
+
+class ProcessNotificationAction extends EnsembleAction {
+  ProcessNotificationAction(
+      {super.initiator, required this.onNotification, this.onNoNotification});
+
+  EnsembleAction? onNotification;
+  EnsembleAction? onNoNotification;
+
+  factory ProcessNotificationAction.fromMap({dynamic payload}) {
+    if (payload is Map) {
+      EnsembleAction? onNotification =
+          EnsembleAction.fromYaml(payload['onNotification']);
+      if (onNotification == null) {
+        throw LanguageError(
+            "onNotification() is required for Process Notification Action");
+      }
+      return ProcessNotificationAction(
+          onNotification: onNotification,
+          onNoNotification: EnsembleAction.fromYaml(payload['onError']));
+    }
+    throw LanguageError("Missing inputs for getDeviceToken.}");
+  }
+
+  @override
+  Future execute(BuildContext context, ScopeManager scopeManager) async {
+    final remoteNotification = await NotificationManager().getInitialMessage();
+    final data = {
+      'notification': {
+        'title': remoteNotification?.notification?.title,
+        'body': remoteNotification?.notification?.body,
+      },
+      'data': remoteNotification?.data,
+    };
+    if (remoteNotification != null && onNotification != null) {
+      return ScreenController().executeAction(context, onNotification!,
+          event: EnsembleEvent(initiator, data: data));
+    }
+    if (remoteNotification == null && onNoNotification != null) {
+      return ScreenController().executeAction(context, onNoNotification!,
+          event: EnsembleEvent(initiator,
+              error: 'Unable to get the remote notification message.'));
+    }
+  }
+}

lib/framework/action.dart

@@ -945,6 +945,7 @@ enum ActionType {
   saveKeychain,
   clearKeychain,
   getDeviceToken,
+  processNotification,
   receiveIntent,
   connectSocket,
   disconnectSocket,
@@ -1074,6 +1075,8 @@ abstract class EnsembleAction {
       return RateAppAction.from(payload: payload);
     } else if (actionType == ActionType.getDeviceToken) {
       return GetDeviceTokenAction.fromMap(payload: payload);
+    } else if (actionType == ActionType.processNotification) {
+      return ProcessNotificationAction.fromMap(payload: payload);
     } else if (actionType == ActionType.openPlaidLink) {
       return PlaidLinkAction.fromYaml(initiator: initiator, payload: payload);
     } else if (actionType == ActionType.openAppSettings) {

lib/framework/notification_manager.dart

@@ -37,6 +37,11 @@ class NotificationManager {
     }
   }
 
+  // Returns the remote notification only when the app is opened from terminated state otherwise it'll be null
+  Future<RemoteMessage?> getInitialMessage() {
+    return FirebaseMessaging.instance.getInitialMessage();
+  }
+
   /// get the device token. This guarantees the token (if available)
   /// is the latest correct token
   Future<String?> getDeviceToken() async {
@@ -101,8 +106,8 @@ class NotificationManager {
   }
 
   void initGetInitialMessage() {
-    // This is called when the user taps on the notification and the app is opened from the terminated state
-    FirebaseMessaging.instance.getInitialMessage().then((message) {
+    // Returns the remote notification only when the app is opened from the terminated state or else it'll be null
+    getInitialMessage().then((message) {
       if (message == null) return;
 
       Ensemble.externalDataContext.addAll({
@@ -120,17 +125,15 @@ class NotificationManager {
 
   Future<void> _handleNotification() async {
     Map<String, dynamic>? messageData = Ensemble.externalDataContext['data'];
-    if (messageData?['screenId'] != null ||
-        messageData?['screenName'] != null) {
-      ScreenController().navigateToScreen(
-        Utils.globalAppKey.currentContext!,
+    // If there is a screen, it navigates to that page
+    // or else it'll open the app with the root screen and clears all the previous screens
+    final screenNotFound =
+        messageData?['screenId'] == null && messageData?['screenName'] == null;
+    ScreenController().navigateToScreen(Utils.globalAppKey.currentContext!,
         screenId: messageData!['screenId'],
         screenName: messageData['screenName'],
         pageArgs: messageData,
-      );
-    } else {
-      log('No screenId nor screenName provided on the notification. Ignoring ...');
-    }
+        routeOption: screenNotFound ? RouteOption.clearAllScreens : null);
   }
 }