Merge pull request #31762 from Expensify/arosiclair-clear-read-notifi…

…cations

Clear notifications after opening a report

Gemfile.lock

@@ -81,7 +81,8 @@ GEM
     declarative (0.0.20)
     digest-crc (0.6.5)
       rake (>= 12.0.0, < 14.0.0)
-    domain_name (0.6.20231109)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
     emoji_regex (3.2.3)
     escape (0.0.4)
@@ -261,6 +262,9 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uber (0.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.9.1)
     unicode-display_width (2.5.0)
     webrick (1.8.1)
     word_wrap (1.0.0)
@@ -294,4 +298,4 @@ RUBY VERSION
    ruby 2.6.10p210
 
 BUNDLED WITH
-   2.1.4
+   2.4.7

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

@@ -28,6 +28,7 @@ const Airship = {
         enableUserNotifications: () => Promise.resolve(false),
         clearNotifications: jest.fn(),
         getNotificationStatus: () => Promise.resolve({airshipOptIn: false, systemEnabled: false}),
+        getActiveNotifications: () => Promise.resolve([]),
     },
     contact: {
         identify: jest.fn(),

ios/Podfile.lock

@@ -1,25 +1,25 @@
 PODS:
-  - Airship (16.11.3):
-    - Airship/Automation (= 16.11.3)
-    - Airship/Basement (= 16.11.3)
-    - Airship/Core (= 16.11.3)
-    - Airship/ExtendedActions (= 16.11.3)
-    - Airship/MessageCenter (= 16.11.3)
-  - Airship/Automation (16.11.3):
+  - Airship (16.12.1):
+    - Airship/Automation (= 16.12.1)
+    - Airship/Basement (= 16.12.1)
+    - Airship/Core (= 16.12.1)
+    - Airship/ExtendedActions (= 16.12.1)
+    - Airship/MessageCenter (= 16.12.1)
+  - Airship/Automation (16.12.1):
     - Airship/Core
-  - Airship/Basement (16.11.3)
-  - Airship/Core (16.11.3):
+  - Airship/Basement (16.12.1)
+  - Airship/Core (16.12.1):
     - Airship/Basement
-  - Airship/ExtendedActions (16.11.3):
+  - Airship/ExtendedActions (16.12.1):
     - Airship/Core
-  - Airship/MessageCenter (16.11.3):
+  - Airship/MessageCenter (16.12.1):
     - Airship/Core
-  - Airship/PreferenceCenter (16.11.3):
+  - Airship/PreferenceCenter (16.12.1):
     - Airship/Core
-  - AirshipFrameworkProxy (2.0.8):
-    - Airship (= 16.11.3)
-    - Airship/MessageCenter (= 16.11.3)
-    - Airship/PreferenceCenter (= 16.11.3)
+  - AirshipFrameworkProxy (2.1.1):
+    - Airship (= 16.12.1)
+    - Airship/MessageCenter (= 16.12.1)
+    - Airship/PreferenceCenter (= 16.12.1)
   - AppAuth (1.6.2):
     - AppAuth/Core (= 1.6.2)
     - AppAuth/ExternalUserAgent (= 1.6.2)
@@ -558,8 +558,8 @@ PODS:
   - React-jsinspector (0.72.4)
   - React-logger (0.72.4):
     - glog
-  - react-native-airship (15.2.6):
-    - AirshipFrameworkProxy (= 2.0.8)
+  - react-native-airship (15.3.1):
+    - AirshipFrameworkProxy (= 2.1.1)
     - React-Core
   - react-native-blob-util (0.17.3):
     - React-Core
@@ -1160,8 +1160,8 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native/ReactCommon/yoga"
 
 SPEC CHECKSUMS:
-  Airship: c70eed50e429f97f5adb285423c7291fb7a032ae
-  AirshipFrameworkProxy: 7bc4130c668c6c98e2d4c60fe4c9eb61a999be99
+  Airship: 2f4510b497a8200780752a5e0304a9072bfffb6d
+  AirshipFrameworkProxy: ea1b6c665c798637b93c465b5e505be3011f1d9d
   AppAuth: 3bb1d1cd9340bd09f5ed189fb00b1cc28e1e8570
   boost: 57d2868c099736d80fcd648bf211b4431e51a558
   BVLinearGradient: 421743791a59d259aec53f4c58793aad031da2ca
@@ -1224,7 +1224,7 @@ SPEC CHECKSUMS:
   React-jsiexecutor: c7f826e40fa9cab5d37cab6130b1af237332b594
   React-jsinspector: aaed4cf551c4a1c98092436518c2d267b13a673f
   React-logger: da1ebe05ae06eb6db4b162202faeafac4b435e77
-  react-native-airship: 5d19f4ba303481cf4101ff9dee9249ef6a8a6b64
+  react-native-airship: 6ded22e4ca54f2f80db80b7b911c2b9b696d9335
   react-native-blob-util: 99f4d79189252f597fe0d810c57a3733b1b1dea6
   react-native-cameraroll: 8ffb0af7a5e5de225fd667610e2979fc1f0c2151
   react-native-config: 7cd105e71d903104e8919261480858940a6b9c0e

package.json

@@ -89,7 +89,7 @@
     "@rnmapbox/maps": "^10.0.11",
     "@shopify/flash-list": "^1.6.1",
     "@types/node": "^18.14.0",
-    "@ua/react-native-airship": "^15.2.6",
+    "@ua/react-native-airship": "^15.3.1",
     "awesome-phonenumber": "^5.4.0",
     "babel-polyfill": "^6.26.0",
     "canvas-size": "^1.2.6",

src/hooks/useAppFocusEvent/index.native.ts

@@ -0,0 +1,20 @@
+import {useEffect} from 'react';
+import {AppState} from 'react-native';
+import {UseAppFocusEvent, UseAppFocusEventCallback} from './types';
+
+const useAppFocusEvent: UseAppFocusEvent = (callback: UseAppFocusEventCallback) => {
+    useEffect(() => {
+        const subscription = AppState.addEventListener('change', (appState) => {
+            if (appState !== 'active') {
+                return;
+            }
+            callback();
+        });
+
+        return () => {
+            subscription.remove();
+        };
+    }, [callback]);
+};
+
+export default useAppFocusEvent;

src/hooks/useAppFocusEvent/index.ts

@@ -0,0 +1,19 @@
+import {useEffect} from 'react';
+import {UseAppFocusEvent, UseAppFocusEventCallback} from './types';
+
+/**
+ * Runs the given callback when the app is focused (eg: after re-opening the app, switching tabs, or focusing the window)
+ *
+ * @param callback the function to run when the app is focused. This should be memoized with `useCallback`.
+ */
+const useAppFocusEvent: UseAppFocusEvent = (callback: UseAppFocusEventCallback) => {
+    useEffect(() => {
+        window.addEventListener('focus', callback);
+
+        return () => {
+            window.removeEventListener('focus', callback);
+        };
+    }, [callback]);
+};
+
+export default useAppFocusEvent;

src/hooks/useAppFocusEvent/types.ts

@@ -0,0 +1,5 @@
+type UseAppFocusEventCallback = () => void;
+
+type UseAppFocusEvent = (callback: UseAppFocusEventCallback) => void;
+
+export type {UseAppFocusEventCallback, UseAppFocusEvent};

src/libs/Notification/LocalNotification/BrowserNotifications.ts

@@ -1,11 +1,14 @@
 // Web and desktop implementation only. Do not import for direct use. Use LocalNotification.
+import Str from 'expensify-common/lib/str';
+import {ImageSourcePropType} from 'react-native';
 import EXPENSIFY_ICON_URL from '@assets/images/expensify-logo-round-clearspace.png';
 import * as ReportUtils from '@libs/ReportUtils';
 import * as AppUpdate from '@userActions/AppUpdate';
+import {Report, ReportAction} from '@src/types/onyx';
 import focusApp from './focusApp';
-import {PushParams, ReportCommentParams} from './types';
+import {LocalNotificationClickHandler, LocalNotificationData} from './types';
 
-const DEFAULT_DELAY = 4000;
+const notificationCache: Record<string, Notification> = {};
 
 /**
  * Checks if the user has granted permission to show browser notifications
@@ -34,42 +37,33 @@ function canUseBrowserNotifications(): Promise<boolean> {
 /**
  * Light abstraction around browser push notifications.
  * Checks for permission before determining whether to send.
- * @return resolves with Notification object or undefined
+ *
+ * @param icon Path to icon
+ * @param data extra data to attach to the notification
  */
-function push({title, body, delay = DEFAULT_DELAY, onClick = () => {}, tag = '', icon}: PushParams): Promise<void | Notification> {
-    return new Promise((resolve) => {
-        if (!title || !body) {
-            throw new Error('BrowserNotification must include title and body parameter.');
+function push(title: string, body = '', icon: string | ImageSourcePropType = '', data: LocalNotificationData = {}, onClick: LocalNotificationClickHandler = () => {}) {
+    canUseBrowserNotifications().then((canUseNotifications) => {
+        if (!canUseNotifications) {
+            return;
         }
 
-        canUseBrowserNotifications().then((canUseNotifications) => {
-            if (!canUseNotifications) {
-                resolve();
-                return;
-            }
-
-            const notification = new Notification(title, {
-                body,
-                tag,
-                icon: String(icon),
-            });
-
-            // If we pass in a delay param greater than 0 the notification
-            // will auto-close after the specified time.
-            if (delay > 0) {
-                setTimeout(notification.close.bind(notification), delay);
-            }
-
-            notification.onclick = () => {
-                onClick();
-                window.parent.focus();
-                window.focus();
-                focusApp();
-                notification.close();
-            };
-
-            resolve(notification);
+        // We cache these notifications so that we can clear them later
+        const notificationID = Str.guid();
+        notificationCache[notificationID] = new Notification(title, {
+            body,
+            icon: String(icon),
+            data,
         });
+        notificationCache[notificationID].onclick = () => {
+            onClick();
+            window.parent.focus();
+            window.focus();
+            focusApp();
+            notificationCache[notificationID].close();
+        };
+        notificationCache[notificationID].onclose = () => {
+            delete notificationCache[notificationID];
+        };
     });
 }
 
@@ -80,19 +74,21 @@ function push({title, body, delay = DEFAULT_DELAY, onClick = () => {}, tag = '',
 export default {
     /**
      * Create a report comment notification
+     *
      * @param usesIcon true if notification uses right circular icon
      */
-    pushReportCommentNotification({report, reportAction, onClick}: ReportCommentParams, usesIcon = false) {
-        let title: string | undefined;
-        let body: string | undefined;
+    pushReportCommentNotification(report: Report, reportAction: ReportAction, onClick: LocalNotificationClickHandler, usesIcon = false) {
+        let title;
+        let body;
+        const icon = usesIcon ? EXPENSIFY_ICON_URL : '';
 
         const isChatRoom = ReportUtils.isChatRoom(report);
 
         const {person, message} = reportAction;
-        const plainTextPerson = person?.map((f) => f.text).join();
+        const plainTextPerson = person?.map((f) => f.text).join() ?? '';
 
         // Specifically target the comment part of the message
-        const plainTextMessage = message?.find((f) => f.type === 'COMMENT')?.text;
+        const plainTextMessage = message?.find((f) => f.type === 'COMMENT')?.text ?? '';
 
         if (isChatRoom) {
             const roomName = ReportUtils.getReportName(report);
@@ -103,36 +99,40 @@ export default {
             body = plainTextMessage;
         }
 
-        push({
-            title: title ?? '',
-            body,
-            delay: 0,
-            onClick,
-            icon: usesIcon ? EXPENSIFY_ICON_URL : '',
-        });
+        const data = {
+            reportID: report.reportID,
+        };
+
+        push(title, body, icon, data, onClick);
     },
 
-    pushModifiedExpenseNotification({reportAction, onClick}: ReportCommentParams, usesIcon = false) {
-        push({
-            title: reportAction.person?.map((f) => f.text).join(', ') ?? '',
-            body: ReportUtils.getModifiedExpenseMessage(reportAction),
-            delay: 0,
-            onClick,
-            icon: usesIcon ? EXPENSIFY_ICON_URL : '',
-        });
+    pushModifiedExpenseNotification(report: Report, reportAction: ReportAction, onClick: LocalNotificationClickHandler, usesIcon = false) {
+        const title = reportAction.person?.map((f) => f.text).join(', ') ?? '';
+        const body = ReportUtils.getModifiedExpenseMessage(reportAction);
+        const icon = usesIcon ? EXPENSIFY_ICON_URL : '';
+        const data = {
+            reportID: report.reportID,
+        };
+        push(title, body, icon, data, onClick);
     },
 
     /**
      * Create a notification to indicate that an update is available.
      */
     pushUpdateAvailableNotification() {
-        push({
-            title: 'Update available',
-            body: 'A new version of this app is available!',
-            delay: 0,
-            onClick: () => {
-                AppUpdate.triggerUpdateAvailable();
-            },
+        push('Update available', 'A new version of this app is available!', '', {}, () => {
+            AppUpdate.triggerUpdateAvailable();
         });
     },
+
+    /**
+     * Clears all open notifications where shouldClearNotification returns true
+     *
+     * @param shouldClearNotification a function that receives notification.data and returns true/false if the notification should be cleared
+     */
+    clearNotifications(shouldClearNotification: (notificationData: LocalNotificationData) => boolean) {
+        Object.values(notificationCache)
+            .filter((notification) => shouldClearNotification(notification.data))
+            .forEach((notification) => notification.close());
+    },
 };