Support money request push notifications

src/libs/Notification/PushNotification/NotificationType.ts

@@ -1,30 +1,38 @@
+import {ValueOf} from 'type-fest';
 import type {OnyxServerUpdate} from '@src/types/onyx/OnyxUpdatesFromServer';
 
 const NotificationType = {
     REPORT_COMMENT: 'reportComment',
+    MONEY_REQUEST: 'moneyRequest',
 } as const;
 
 type NotificationDataMap = {
-    [NotificationType.REPORT_COMMENT]: ReportCommentNotificationData;
+    [NotificationType.REPORT_COMMENT]: ReportCommentPushNotificationData;
+    [NotificationType.MONEY_REQUEST]: ReportActionPushNotificationData;
 };
 
-type NotificationData = ReportCommentNotificationData;
+type PushNotificationData = ReportCommentPushNotificationData | ReportActionPushNotificationData;
 
-type ReportCommentNotificationData = {
+type BasePushNotificationData = {
     title: string;
-    type: typeof NotificationType.REPORT_COMMENT;
-    reportID: number;
-    reportActionID: string;
-    shouldScrollToLastUnread?: boolean;
-    roomName?: string;
+    type: ValueOf<typeof NotificationType>;
     onyxData?: OnyxServerUpdate[];
     lastUpdateID?: number;
     previousUpdateID?: number;
 };
 
+type ReportActionPushNotificationData = BasePushNotificationData & {
+    reportID: number;
+    reportActionID: string;
+};
+
+type ReportCommentPushNotificationData = ReportActionPushNotificationData & {
+    roomName?: string;
+};
+
 /**
  * See https://github.com/Expensify/Web-Expensify/blob/main/lib/MobilePushNotifications.php for the various
  * types of push notifications sent by our API.
  */
 export default NotificationType;
-export type {NotificationDataMap, NotificationData, ReportCommentNotificationData};
+export type {NotificationDataMap, PushNotificationData, ReportActionPushNotificationData, ReportCommentPushNotificationData};

src/libs/Notification/PushNotification/index.native.ts

@@ -5,12 +5,12 @@ import Log from '@libs/Log';
 import * as PushNotificationActions from '@userActions/PushNotification';
 import ONYXKEYS from '@src/ONYXKEYS';
 import ForegroundNotifications from './ForegroundNotifications';
-import type {NotificationData} from './NotificationType';
+import type {PushNotificationData} from './NotificationType';
 import NotificationType from './NotificationType';
 import type {ClearNotifications, Deregister, Init, OnReceived, OnSelected, Register} from './types';
 import type PushNotificationType from './types';
 
-type NotificationEventActionCallback = (data: NotificationData) => Promise<void>;
+type NotificationEventActionCallback = (data: PushNotificationData) => Promise<void>;
 
 type NotificationEventActionMap = Partial<Record<EventType, Record<string, NotificationEventActionCallback>>>;
 
@@ -34,7 +34,7 @@ function pushNotificationEventCallback(eventType: EventType, notification: PushP
         payload = JSON.parse(payload);
     }
 
-    const data = payload as NotificationData;
+    const data = payload as PushNotificationData;
 
     Log.info(`[PushNotification] Callback triggered for ${eventType}`);
 

src/libs/Notification/PushNotification/shouldShowPushNotification.ts

@@ -2,7 +2,7 @@ import type {PushPayload} from '@ua/react-native-airship';
 import Log from '@libs/Log';
 import * as ReportActionUtils from '@libs/ReportActionsUtils';
 import * as Report from '@userActions/Report';
-import type {NotificationData} from './NotificationType';
+import type {PushNotificationData} from './NotificationType';
 
 /**
  * Returns whether the given Airship notification should be shown depending on the current state of the app
@@ -17,7 +17,7 @@ export default function shouldShowPushNotification(pushPayload: PushPayload): bo
         payload = JSON.parse(payload);
     }
 
-    const data = payload as NotificationData;
+    const data = payload as PushNotificationData;
 
     if (!data.reportID) {
         Log.info('[PushNotification] Not a report action notification. Showing notification');

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

@@ -1,7 +1,20 @@
 import Onyx from 'react-native-onyx';
-import subscribeToReportCommentPushNotifications from '@libs/Notification/PushNotification/subscribeToReportCommentPushNotifications';
+import applyOnyxUpdatesReliably from '@libs/actions/applyOnyxUpdatesReliably';
+import * as ActiveClientManager from '@libs/ActiveClientManager';
+import Log from '@libs/Log';
+import Navigation from '@libs/Navigation/Navigation';
+import getPolicyEmployeeAccountIDs from '@libs/PolicyEmployeeListUtils';
+import {extractPolicyIDFromPath} from '@libs/PolicyUtils';
+import {doesReportBelongToWorkspace, getReport} from '@libs/ReportUtils';
+import Visibility from '@libs/Visibility';
+import * as Modal from '@userActions/Modal';
+import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
+import ROUTES from '@src/ROUTES';
+import type {OnyxUpdatesFromServer} from '@src/types/onyx';
+import {isEmptyObject} from '@src/types/utils/EmptyObject';
 import PushNotification from '..';
+import {ReportActionPushNotificationData} from '../NotificationType';
 
 /**
  * Manage push notification subscriptions on sign-in/sign-out.
@@ -14,13 +27,109 @@
     callback: (notificationID) => {
         if (notificationID) {
             PushNotification.register(notificationID);
-
-            // Prevent issue where report linking fails after users switch accounts without closing the app
             PushNotification.init();
-            subscribeToReportCommentPushNotifications();
+
+            // Subscribe handlers for different push notification types
+            PushNotification.onReceived(PushNotification.TYPE.REPORT_COMMENT, applyOnyxData);
+            PushNotification.onSelected(PushNotification.TYPE.REPORT_COMMENT, navigateToReport);
+
+            PushNotification.onReceived(PushNotification.TYPE.MONEY_REQUEST, applyOnyxData);
+            PushNotification.onSelected(PushNotification.TYPE.MONEY_REQUEST, navigateToReport);
         } else {
             PushNotification.deregister();
             PushNotification.clearNotifications();
         }
     },
 });
+
+let lastVisitedPath: string | undefined;
+Onyx.connect({
+    key: ONYXKEYS.LAST_VISITED_PATH,
+    callback: (value) => {
+        if (!value) {
+            return;
+        }
+        lastVisitedPath = value;
+    },
+});
+
+function applyOnyxData({reportID, reportActionID, onyxData, lastUpdateID, previousUpdateID}: ReportActionPushNotificationData): Promise<void> {
+    Log.info(`[PushNotification] Applying onyx data in the ${Visibility.isVisible() ? 'foreground' : 'background'}`, false, {reportID, reportActionID});
+
+    if (!ActiveClientManager.isClientTheLeader()) {
+        Log.info('[PushNotification] received report comment notification, but ignoring it since this is not the active client');
+        return Promise.resolve();
+    }
+
+    if (!onyxData || !lastUpdateID || !previousUpdateID) {
+        Log.hmmm("[PushNotification] didn't apply onyx updates because some data is missing", {lastUpdateID, previousUpdateID, onyxDataCount: onyxData?.length ?? 0});
+        return Promise.resolve();
+    }
+
+    Log.info('[PushNotification] reliable onyx update received', false, {lastUpdateID, previousUpdateID, onyxDataCount: onyxData?.length ?? 0});
+    const updates: OnyxUpdatesFromServer = {
+        type: CONST.ONYX_UPDATE_TYPES.AIRSHIP,
+        lastUpdateID,
+        previousUpdateID,
+        updates: [
+            {
+                eventType: 'eventType',
+                data: onyxData,
+            },
+        ],
+    };
+
+    /**
+     * When this callback runs in the background on Android (via Headless JS), no other Onyx.connect callbacks will run. This means that
+     * lastUpdateIDAppliedToClient will NOT be populated in other libs. To workaround this, we manually read the value here
+     * and pass it as a param
+     */
+    return getLastUpdateIDAppliedToClient().then((lastUpdateIDAppliedToClient) => applyOnyxUpdatesReliably(updates, true, lastUpdateIDAppliedToClient));
+}
+
+function navigateToReport({reportID, reportActionID}: ReportActionPushNotificationData): Promise<void> {
+    Log.info('[PushNotification] Navigating to report', false, {reportID, reportActionID});
+
+    const policyID = lastVisitedPath && extractPolicyIDFromPath(lastVisitedPath);
+    const report = getReport(reportID.toString());
+    const policyEmployeeAccountIDs = policyID ? getPolicyEmployeeAccountIDs(policyID) : [];
+    const reportBelongsToWorkspace = policyID && !isEmptyObject(report) && doesReportBelongToWorkspace(report, policyEmployeeAccountIDs, policyID);
+
+    Navigation.isNavigationReady()
+        .then(Navigation.waitForProtectedRoutes)
+        .then(() => {
+            // The attachment modal remains open when navigating to the report so we need to close it
+            Modal.close(() => {
+                try {
+                    // If a chat is visible other than the one we are trying to navigate to, then we need to navigate back
+                    if (Navigation.getActiveRoute().slice(1, 2) === ROUTES.REPORT && !Navigation.isActiveRoute(`r/${reportID}`)) {
+                        Navigation.goBack();
+                    }
+
+                    Log.info('[PushNotification] onSelected() - Navigation is ready. Navigating...', false, {reportID, reportActionID});
+                    if (!reportBelongsToWorkspace) {
+                        Navigation.navigateWithSwitchPolicyID({route: ROUTES.HOME});
+                    }
+                    Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(String(reportID)));
+                } catch (error) {
+                    let errorMessage = String(error);
+                    if (error instanceof Error) {
+                        errorMessage = error.message;
+                    }
+
+                    Log.alert('[PushNotification] onSelected() - failed', {reportID, reportActionID, error: errorMessage});
+                }
+            });
+        });
+
+    return Promise.resolve();
+}
+
+function getLastUpdateIDAppliedToClient(): Promise<number> {
+    return new Promise((resolve) => {
+        Onyx.connect({
+            key: ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT,
+            callback: (value) => resolve(value ?? 0),
+        });
+    });
+}

src/libs/Notification/clearReportNotifications/index.native.ts

@@ -1,7 +1,7 @@
 import type {PushPayload} from '@ua/react-native-airship';
 import Airship from '@ua/react-native-airship';
 import Log from '@libs/Log';
-import type {NotificationData} from '@libs/Notification/PushNotification/NotificationType';
+import type {PushNotificationData} from '@libs/Notification/PushNotification/NotificationType';
 import CONST from '@src/CONST';
 import type ClearReportNotifications from './types';
 
@@ -10,7 +10,7 @@ const parseNotificationAndReportIDs = (pushPayload: PushPayload) => {
     if (typeof payload === 'string') {
         payload = JSON.parse(payload);
     }
-    const data = payload as NotificationData;
+    const data = payload as PushNotificationData;
     return {
         notificationID: pushPayload.notificationId,
         reportID: String(data.reportID),

src/libs/actions/Report.ts

@@ -2263,7 +2263,7 @@ function shouldShowReportActionNotification(reportID: string, action: ReportActi
     }
 
     // Only show notifications for supported types of report actions
-    if (!ReportActionsUtils.isNotifiableReportAction(action)) {
+    if (action && !ReportActionsUtils.isNotifiableReportAction(action)) {
         Log.info(`${tag} No notification because this action type is not supported`, false, {actionName: action?.actionName});
         return false;
     }

src/setup/platformSetup/index.native.ts

@@ -1,6 +1,4 @@
 import crashlytics from '@react-native-firebase/crashlytics';
-import PushNotification from '@libs/Notification/PushNotification';
-import subscribeToReportCommentPushNotifications from '@libs/Notification/PushNotification/subscribeToReportCommentPushNotifications';
 import Performance from '@libs/Performance';
 import CONFIG from '@src/CONFIG';
 
@@ -12,14 +10,5 @@ export default function () {
         crashlytics().setCrashlyticsCollectionEnabled(false);
     }
 
-    /*
-     * Register callbacks for push notifications.
-     * When the app is completely closed, this code will be executed by a headless JS process thanks to magic in the UrbanAirship RN library.
-     * However, the main App component will not be mounted in this headless context, so we must register these callbacks outside of any React lifecycle.
-     * Otherwise, they will not be executed when the app is completely closed, and the push notification won't update the app data.
-     */
-    PushNotification.init();
-    subscribeToReportCommentPushNotifications();
-
     Performance.setupPerformanceObserver();
 }