Background push notification processing

ios/Podfile.lock

@@ -1,15 +1,15 @@
 PODS:
-  - Airship (14.3.0):
-    - Airship/Automation (= 14.3.0)
-    - Airship/Core (= 14.3.0)
-    - Airship/ExtendedActions (= 14.3.0)
-    - Airship/MessageCenter (= 14.3.0)
-  - Airship/Automation (14.3.0):
+  - Airship (14.4.2):
+    - Airship/Automation (= 14.4.2)
+    - Airship/Core (= 14.4.2)
+    - Airship/ExtendedActions (= 14.4.2)
+    - Airship/MessageCenter (= 14.4.2)
+  - Airship/Automation (14.4.2):
     - Airship/Core
-  - Airship/Core (14.3.0)
-  - Airship/ExtendedActions (14.3.0):
+  - Airship/Core (14.4.2)
+  - Airship/ExtendedActions (14.4.2):
     - Airship/Core
-  - Airship/MessageCenter (14.3.0):
+  - Airship/MessageCenter (14.4.2):
     - Airship/Core
   - boost-for-react-native (1.63.0)
   - CocoaAsyncSocket (7.6.5)
@@ -492,8 +492,8 @@ PODS:
     - React-Core
   - RNSVG (12.1.0):
     - React
-  - urbanairship-react-native (11.0.1):
-    - Airship (= 14.3.0)
+  - urbanairship-react-native (11.0.2):
+    - Airship (= 14.4.2)
     - React-Core
   - Yoga (1.14.0)
   - YogaKit (1.18.1):
@@ -723,7 +723,7 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native/ReactCommon/yoga"
 
 SPEC CHECKSUMS:
-  Airship: 7609d263d3a207f112d6db066af5852b80af6819
+  Airship: 29d674abeac754f783fc46c7d383d6f046687341
   boost-for-react-native: 39c7adb57c4e60d6c5479dd8623128eb5b3f0f2c
   CocoaAsyncSocket: 065fd1e645c7abab64f7a6a2007a48038fdc6a99
   DoubleConversion: cf9b38bf0b2d048436d9a82ad2abe1404f11e7de
@@ -802,7 +802,7 @@ SPEC CHECKSUMS:
   RNReanimated: b8c8004b43446e3c2709fe64b2b41072f87428ad
   RNScreens: e8e8dd0588b5da0ab57dcca76ab9b2d8987757e0
   RNSVG: ce9d996113475209013317e48b05c21ee988d42e
-  urbanairship-react-native: d415a12e67ba93bf3ce914df9a310b66a88a5cc3
+  urbanairship-react-native: 60b4b4235838ff109a2639b639e2ef01d54ad455
   Yoga: a7de31c64fe738607e7a3803e3f591a4b1df7393
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a
 

package.json

@@ -97,7 +97,7 @@
     "rn-fetch-blob": "^0.12.0",
     "save": "^2.4.0",
     "underscore": "^1.10.2",
-    "urbanairship-react-native": "^11.0.1"
+    "urbanairship-react-native": "^11.0.2"
   },
   "devDependencies": {
     "@actions/core": "^1.2.6",

src/Expensify.js

@@ -2,15 +2,12 @@ import lodashGet from 'lodash/get';
 import PropTypes from 'prop-types';
 import React, {PureComponent} from 'react';
 import {View, AppState} from 'react-native';
-import Onyx, {withOnyx} from 'react-native-onyx';
+import {withOnyx} from 'react-native-onyx';
 
 import BootSplash from './libs/BootSplash';
-import listenToStorageEvents from './libs/listenToStorageEvents';
 import * as ActiveClientManager from './libs/ActiveClientManager';
 import ONYXKEYS from './ONYXKEYS';
-import CONST from './CONST';
 import NavigationRoot from './libs/Navigation/NavigationRoot';
-import Log from './libs/Log';
 import migrateOnyx from './libs/migrateOnyx';
 import styles from './styles/styles';
 import PushNotification from './libs/Notification/PushNotification';
@@ -21,32 +18,6 @@ import {growlRef} from './libs/Growl';
 import Navigation from './libs/Navigation/Navigation';
 import ROUTES from './ROUTES';
 
-// Initialize the store when the app loads for the first time
-Onyx.init({
-    keys: ONYXKEYS,
-    safeEvictionKeys: [ONYXKEYS.COLLECTION.REPORT_ACTIONS],
-    initialKeyStates: {
-
-        // Clear any loading and error messages so they do not appear on app startup
-        [ONYXKEYS.SESSION]: {loading: false, shouldShowComposeInput: true},
-        [ONYXKEYS.ACCOUNT]: CONST.DEFAULT_ACCOUNT_DATA,
-        [ONYXKEYS.NETWORK]: {isOffline: false},
-        [ONYXKEYS.IOU]: {
-            loading: false, error: false, creatingIOUTransaction: false, isRetrievingCurrency: false,
-        },
-    },
-    registerStorageEventListener: (onStorageEvent) => {
-        listenToStorageEvents(onStorageEvent);
-    },
-});
-Onyx.registerLogger(({level, message}) => {
-    if (level === 'alert') {
-        Log.alert(message, 0, {}, false);
-    } else {
-        Log.client(message);
-    }
-});
-
 const propTypes = {
     /* Onyx Props */
 

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

@@ -48,6 +48,30 @@ function pushNotificationEventCallback(eventType, notification) {
     action(payload);
 }
 
+/**
+ * Register push notification callbacks. This is separate from namedUser registration because it needs to be executed
+ * from a headless JS process, outside of any react lifecycle.
+ */
+function init() {
+    // Setup event listeners
+    UrbanAirship.addListener(EventType.PushReceived, (notification) => {
+        // If a push notification is received while the app is in foreground,
+        // we'll assume pusher is connected so we'll ignore it and not fetch the same data twice.
+        if (AppState.currentState === 'active') {
+            console.debug('[PUSH_NOTIFICATION] Push received while app is in foreground, not executing any callback.');
+            return;
+        }
+
+        pushNotificationEventCallback(EventType.PushReceived, notification);
+    });
+
+    // Note: the NotificationResponse event has a nested PushReceived event,
+    // so event.notification refers to the same thing as notification above ^
+    UrbanAirship.addListener(EventType.NotificationResponse, (event) => {
+        pushNotificationEventCallback(EventType.NotificationResponse, event.notification);
+    });
+}
+
 /**
  * Register this device for push notifications for the given accountID.
  *
@@ -71,24 +95,6 @@ function register(accountID) {
     // Regardless of the user's opt-in status, we still want to receive silent push notifications.
     console.debug(`[PUSH_NOTIFICATIONS] Subscribing to notifications for account ID ${accountID}`);
     UrbanAirship.setNamedUser(accountID.toString());
-
-    // Setup event listeners
-    UrbanAirship.addListener(EventType.PushReceived, (notification) => {
-        // If a push notification is received while the app is in foreground,
-        // we'll assume pusher is connected so we'll ignore it and not write the same data twice.
-        if (AppState.currentState === 'active') {
-            console.debug('[PUSH_NOTIFICATION] Push received while app is in foreground, not executing any callback.');
-            return;
-        }
-
-        pushNotificationEventCallback(EventType.PushReceived, notification);
-    });
-
-    // Note: the NotificationResponse event has a nested PushReceived event,
-    // so event.notification refers to the same thing as notification above ^
-    UrbanAirship.addListener(EventType.NotificationResponse, (event) => {
-        pushNotificationEventCallback(EventType.NotificationResponse, event.notification);
-    });
 }
 
 /**
@@ -142,6 +148,7 @@ function onSelected(notificationType, callback) {
 }
 
 export default {
+    init,
     register,
     deregister,
     onReceived,

src/libs/actions/Report.js

@@ -514,9 +514,13 @@ function updateReportActionMessage(reportID, sequenceNumber, message) {
  *
  * @param {Number} reportID
  * @param {Object} reportAction
- * @param {String} notificationPreference On what cadence the user would like to be notified
+ * @param {String} [notificationPreference] On what cadence the user would like to be notified
  */
-function updateReportWithNewAction(reportID, reportAction, notificationPreference) {
+function updateReportWithNewAction(
+    reportID,
+    reportAction,
+    notificationPreference = CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS,
+) {
     const newMaxSequenceNumber = reportAction.sequenceNumber;
     const isFromCurrentUser = reportAction.actorAccountID === currentUserAccountID;
     const initialLastReadSequenceNumber = lastReadSequenceNumbers[reportID] || 0;
@@ -715,7 +719,12 @@ function subscribeToUserEvents() {
                 {error, pusherChannelName, eventName: Pusher.TYPE.REPORT_TOGGLE_PINNED},
             );
         });
+}
 
+/**
+ * Setup reportComment push notification callbacks.
+ */
+function subscribeToReportCommentPushNotifications() {
     PushNotification.onReceived(PushNotification.TYPE.REPORT_COMMENT, ({reportID, reportAction}) => {
         Log.info('[Report] Handled event sent by Airship', true, {reportID});
         updateReportWithNewAction(reportID, reportAction);
@@ -1293,6 +1302,7 @@ export {
     setNewMarkerPosition,
     subscribeToReportTypingEvents,
     subscribeToUserEvents,
+    subscribeToReportCommentPushNotifications,
     unsubscribeFromReportChannel,
     saveReportComment,
     broadcastUserIsTyping,

src/pages/ReportDetailsPage.js

@@ -8,6 +8,7 @@ import lodashGet from 'lodash/get';
 import compose from '../libs/compose';
 import withLocalize, {withLocalizePropTypes} from '../components/withLocalize';
 import ONYXKEYS from '../ONYXKEYS';
+import CONST from '../CONST';
 import ScreenWrapper from '../components/ScreenWrapper';
 import Navigation from '../libs/Navigation/Navigation';
 import HeaderWithCloseButton from '../components/HeaderWithCloseButton';
@@ -72,16 +73,16 @@ class ReportDetailsPage extends Component {
 
         this.notificationPreferencesOptions = {
             default: {
-                value: 'always',
+                value: CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS,
                 label: props.translate('reportDetailsPage.always'),
 
             },
             daily: {
-                value: 'daily',
+                value: CONST.REPORT.NOTIFICATION_PREFERENCE.DAILY,
                 label: props.translate('reportDetailsPage.daily'),
             },
             mute: {
-                value: 'mute',
+                value: CONST.REPORT.NOTIFICATION_PREFERENCE.MUTE,
                 label: props.translate('reportDetailsPage.mute'),
             },
         };

src/setup/index.js

@@ -0,0 +1,38 @@
+import Onyx from 'react-native-onyx';
+import ONYXKEYS from '../ONYXKEYS';
+import CONST from '../CONST';
+import listenToStorageEvents from '../libs/listenToStorageEvents';
+import Log from '../libs/Log';
+import platformSetup from './platformSetup';
+
+export default function () {
+    // Initialize the Onyx store when the app loads for the first time
+    Onyx.init({
+        keys: ONYXKEYS,
+        safeEvictionKeys: [ONYXKEYS.COLLECTION.REPORT_ACTIONS],
+        initialKeyStates: {
+
+            // Clear any loading and error messages so they do not appear on app startup
+            [ONYXKEYS.SESSION]: {loading: false, shouldShowComposeInput: true},
+            [ONYXKEYS.ACCOUNT]: CONST.DEFAULT_ACCOUNT_DATA,
+            [ONYXKEYS.NETWORK]: {isOffline: false},
+            [ONYXKEYS.IOU]: {
+                loading: false, error: false, creatingIOUTransaction: false, isRetrievingCurrency: false,
+            },
+        },
+        registerStorageEventListener: (onStorageEvent) => {
+            listenToStorageEvents(onStorageEvent);
+        },
+    });
+
+    Onyx.registerLogger(({level, message}) => {
+        if (level === 'alert') {
+            Log.alert(message, 0, {}, false);
+        } else {
+            Log.client(message);
+        }
+    });
+
+    // Perform any other platform-specific setup
+    platformSetup();
+}

src/setup/index.desktop.js → src/setup/platformSetup/index.desktop.js

@@ -1,8 +1,8 @@
 import {AppRegistry} from 'react-native';
 import {ipcRenderer} from 'electron';
-import Config from '../CONFIG';
-import LocalNotification from '../libs/Notification/LocalNotification';
-import DateUtils from '../libs/DateUtils';
+import Config from '../../CONFIG';
+import LocalNotification from '../../libs/Notification/LocalNotification';
+import DateUtils from '../../libs/DateUtils';
 
 
 export default function () {

src/setup/platformSetup/index.native.js

@@ -0,0 +1,11 @@
+import PushNotification from '../../libs/Notification/PushNotification';
+import {subscribeToReportCommentPushNotifications} from '../../libs/actions/Report';
+
+/**
+ * Register callbacks for push notifications.
+ * This must happen outside of any React lifecycle in order for the headless JS process to work.
+ */
+export default function () {
+    PushNotification.init();
+    subscribeToReportCommentPushNotifications();
+}

src/setup/index.website.js → src/setup/platformSetup/index.website.js

@@ -1,10 +1,10 @@
 import {AppRegistry} from 'react-native';
-import checkForUpdates from '../libs/checkForUpdates';
-import Config from '../CONFIG';
-import HttpUtils from '../libs/HttpUtils';
-import DateUtils from '../libs/DateUtils';
-import {version as currentVersion} from '../../package.json';
-import Visibility from '../libs/Visibility';
+import checkForUpdates from '../../libs/checkForUpdates';
+import Config from '../../CONFIG';
+import HttpUtils from '../../libs/HttpUtils';
+import DateUtils from '../../libs/DateUtils';
+import {version as currentVersion} from '../../../package.json';
+import Visibility from '../../libs/Visibility';
 
 /**
  * Download the latest app version from the server, and if it is different than the current one,