Hide notifications for the currently open report

__mocks__/@ua/react-native-airship.js

@@ -20,6 +20,10 @@ const Airship = {
         iOS: {
             setBadgeNumber: jest.fn(),
             setForegroundPresentationOptions: jest.fn(),
+            setForegroundPresentationOptionsCallback: jest.fn(),
+        },
+        android: {
+            setForegroundDisplayPredicate: jest.fn(),
         },
         enableUserNotifications: () => Promise.resolve(false),
         clearNotifications: jest.fn(),

android/app/build.gradle

@@ -334,6 +334,7 @@ dependencies {
     implementation project(':react-native-plaid-link-sdk')
 
     // Fixes a version conflict between airship and react-native-plaid-link-sdk
+    // This may be fixed by a newer version of the plaid SDK (not working as of 10.0.0)
     implementation "androidx.work:work-runtime-ktx:2.8.0"
 
     // This okhttp3 dependency prevents the app from crashing - See https://github.com/plaid/react-native-plaid-link-sdk/issues/74#issuecomment-648435002

src/libs/Notification/PushNotification/configureForegroundNotifications/index.android.js

@@ -0,0 +1,6 @@
+import Airship from '@ua/react-native-airship';
+import shouldShowPushNotification from '../shouldShowPushNotification';
+
+export default function configureForegroundNotifications() {
+    Airship.push.android.setForegroundDisplayPredicate(pushPayload => Promise.resolve(shouldShowPushNotification(pushPayload)));
+}

src/libs/Notification/PushNotification/configureForegroundNotifications/index.ios.js

@@ -0,0 +1,17 @@
+import Airship, {iOS} from '@ua/react-native-airship';
+import shouldShowPushNotification from '../shouldShowPushNotification';
+
+export default function configureForegroundNotifications() {
+    // Set our default iOS foreground presentation to be loud with a banner
+    // More info here https://developer.apple.com/documentation/usernotifications/unusernotificationcenterdelegate/1649518-usernotificationcenter
+    Airship.push.iOS.setForegroundPresentationOptions([
+        iOS.ForegroundPresentationOption.List,
+        iOS.ForegroundPresentationOption.Banner,
+        iOS.ForegroundPresentationOption.Sound,
+        iOS.ForegroundPresentationOption.Badge,
+    ]);
+
+    // Set a callback to override our foreground presentation per notification depending on the app's current state.
+    // Returning null keeps the default presentation. Returning [] uses no presentation (hides the notification).
+    Airship.push.iOS.setForegroundPresentationOptionsCallback(pushPayload => Promise.resolve(shouldShowPushNotification(pushPayload) ? null : []));
+}

src/libs/Notification/PushNotification/configureForegroundNotifications/index.js

@@ -0,0 +1,4 @@
+/**
+ * Configures notification handling while in the foreground on iOS and Android. This is a no-op on other platforms.
+ */
+export default function () {}

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

@@ -1,11 +1,12 @@
 import _ from 'underscore';
 import Onyx from 'react-native-onyx';
-import Airship, {EventType, iOS} from '@ua/react-native-airship';
+import Airship, {EventType} from '@ua/react-native-airship';
 import lodashGet from 'lodash/get';
 import Log from '../../Log';
 import NotificationType from './NotificationType';
 import * as PushNotification from '../../actions/PushNotification';
 import ONYXKEYS from '../../../ONYXKEYS';
+import configureForegroundNotifications from './configureForegroundNotifications';
 
 let isUserOptedInToPushNotifications = false;
 Onyx.connect({
@@ -30,21 +31,21 @@ function pushNotificationEventCallback(eventType, notification) {
         payload = JSON.parse(payload);
     }
 
-    Log.info(`[PUSH_NOTIFICATION] Callback triggered for ${eventType}`);
+    Log.info(`[PushNotification] Callback triggered for ${eventType}`);
 
     if (!payload) {
-        Log.warn('[PUSH_NOTIFICATION] Notification has null or undefined payload, not executing any callback.');
+        Log.warn('[PushNotification] Notification has null or undefined payload, not executing any callback.');
         return;
     }
 
     if (!payload.type) {
-        Log.warn('[PUSH_NOTIFICATION] No type value provided in payload, not executing any callback.');
+        Log.warn('[PushNotification] No type value provided in payload, not executing any callback.');
         return;
     }
 
     const action = actionMap[payload.type];
     if (!action) {
-        Log.warn('[PUSH_NOTIFICATION] No callback set up: ', {
+        Log.warn('[PushNotification] No callback set up: ', {
             event: eventType,
             notificationType: payload.type,
         });
@@ -64,13 +65,13 @@ function refreshNotificationOptInStatus() {
                 return;
             }
 
-            Log.info('[PUSH_NOTIFICATION] Push notification opt-in status changed.', false, {isOptedIn});
+            Log.info('[PushNotification] Push notification opt-in status changed.', false, {isOptedIn});
             PushNotification.setPushNotificationOptInStatus(isOptedIn);
         });
 }
 
 /**
- * Register push notification callbacks. This is separate from namedUser registration because it needs to be executed
+ * Configure push notifications and register callbacks. This is separate from namedUser registration because it needs to be executed
  * from a headless JS process, outside of any react lifecycle.
  *
  * WARNING: Moving or changing this code could break Push Notification processing in non-obvious ways.
@@ -96,16 +97,7 @@ function init() {
     // Keep track of which users have enabled push notifications via an NVP.
     Airship.addListener(EventType.NotificationOptInStatus, refreshNotificationOptInStatus);
 
-    // This statement has effect on iOS only.
-    // It enables the App to display push notifications when the App is in foreground.
-    // By default, the push notifications are silenced on iOS if the App is in foreground.
-    // More info here https://developer.apple.com/documentation/usernotifications/unusernotificationcenterdelegate/1649518-usernotificationcenter
-    Airship.push.iOS.setForegroundPresentationOptions([
-        iOS.ForegroundPresentationOption.List,
-        iOS.ForegroundPresentationOption.Banner,
-        iOS.ForegroundPresentationOption.Sound,
-        iOS.ForegroundPresentationOption.Badge,
-    ]);
+    configureForegroundNotifications();
 }
 
 /**
@@ -126,12 +118,12 @@ function register(accountID) {
                 return;
             }
 
-            Log.info('[PUSH_NOTIFICATIONS] User has disabled visible push notifications for this app.');
+            Log.info('[PushNotification] User has disabled visible push notifications for this app.');
         });
 
     // Register this device as a named user in AirshipAPI.
     // Regardless of the user's opt-in status, we still want to receive silent push notifications.
-    Log.info(`[PUSH_NOTIFICATIONS] Subscribing to notifications for account ID ${accountID}`);
+    Log.info(`[PushNotification] Subscribing to notifications for account ID ${accountID}`);
     Airship.contact.identify(accountID.toString());
 
     // Refresh notification opt-in status NVP for the new user.
@@ -142,7 +134,7 @@ function register(accountID) {
  * Deregister this device from push notifications.
  */
 function deregister() {
-    Log.info('[PUSH_NOTIFICATIONS] Unsubscribing from push notifications.');
+    Log.info('[PushNotification] Unsubscribing from push notifications.');
     Airship.contact.reset();
     Airship.removeAllListeners(EventType.PushReceived);
     Airship.removeAllListeners(EventType.NotificationResponse);

src/libs/Notification/PushNotification/shouldShowPushNotification.js

@@ -0,0 +1,30 @@
+import _ from 'underscore';
+import * as Report from '../../actions/Report';
+import Log from '../../Log';
+import * as ReportActionUtils from '../../ReportActionsUtils';
+
+/**
+ * Returns whether the given Airship notification should be shown depending on the current state of the app
+ * @param {PushPayload} pushPayload
+ * @returns {Boolean}
+ */
+export default function shouldShowPushNotification(pushPayload) {
+    Log.info('[PushNotification] push notification received', false, {pushPayload});
+
+    let pushData = pushPayload.extras.payload;
+
+    // The payload is string encoded on Android
+    if (_.isString(pushData)) {
+        pushData = JSON.parse(pushData);
+    }
+
+    if (!pushData.reportID) {
+        Log.info('[PushNotification] Not a report action notification. Showing notification');
+        return true;
+    }
+
+    const reportAction = ReportActionUtils.getLatestReportActionFromOnyxData(pushData.onyxData);
+    const shouldShow = Report.shouldShowReportActionNotification(String(pushData.reportID), reportAction, true);
+    Log.info(`[PushNotification] ${shouldShow ? 'Showing' : 'Not showing'} notification`);
+    return shouldShow;
+}

src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.js

@@ -0,0 +1,38 @@
+import {CONST} from 'expensify-common/lib/CONST';
+import {Linking} from 'react-native';
+import Onyx from 'react-native-onyx';
+import PushNotification from '.';
+import ROUTES from '../../../ROUTES';
+import Log from '../../Log';
+import Navigation from '../../Navigation/Navigation';
+
+/**
+ * Setup reportComment push notification callbacks.
+ */
+export default function subscribeToReportCommentPushNotifications() {
+    PushNotification.onReceived(PushNotification.TYPE.REPORT_COMMENT, ({reportID, onyxData}) => {
+        Log.info('[Report] Handled event sent by Airship', false, {reportID});
+        Onyx.update(onyxData);
+    });
+
+    // Open correct report when push notification is clicked
+    PushNotification.onSelected(PushNotification.TYPE.REPORT_COMMENT, ({reportID}) => {
+        if (Navigation.canNavigate('navigate')) {
+            // 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();
+            }
+            Navigation.isDrawerReady()
+                .then(() => {
+                    Navigation.navigate(ROUTES.getReportRoute(reportID));
+                });
+        } else {
+            // Navigation container is not yet ready, use deeplinking to open to correct report instead
+            Navigation.setDidTapNotification();
+            Navigation.isDrawerReady()
+                .then(() => {
+                    Linking.openURL(`${CONST.DEEPLINK_BASE_URL}${ROUTES.getReportRoute(reportID)}`);
+                });
+        }
+    });
+}

src/libs/ReportActionsUtils.js

@@ -228,6 +228,22 @@ function getLastClosedReportAction(reportActions) {
     return lodashFindLast(sortedReportActions, action => action.actionName === CONST.REPORT.ACTIONS.TYPE.CLOSED);
 }
 
+/**
+ * @param {Array} onyxData
+ * @returns {Object} The latest report action in the `onyxData` or `null` if one couldn't be found
+ */
+function getLatestReportActionFromOnyxData(onyxData) {
+    const reportActionUpdate = _.find(onyxData, onyxUpdate => onyxUpdate.key.startsWith(ONYXKEYS.COLLECTION.REPORT_ACTIONS));
+
+    if (!reportActionUpdate) {
+        return null;
+    }
+
+    const reportActions = _.values(reportActionUpdate.value);
+    const sortedReportActions = getSortedReportActions(reportActions);
+    return _.last(sortedReportActions);
+}
+
 export {
     getSortedReportActions,
     getLastVisibleAction,
@@ -237,4 +253,5 @@ export {
     isConsecutiveActionMadeByPreviousActor,
     getSortedReportActionsForDisplay,
     getLastClosedReportAction,
+    getLatestReportActionFromOnyxData,
 };