👤 simplify user profile updates; refactor push notif registration

Before this change, we would make 2 calls to `profile/update` every time the UI is initialized: one for push notification registration and another to store device settings.
We also had a lot of unecessary complexity in all these places (event listeners everywhere!)

All we really need to do on UI init, iff onboarding is done:
1. call `profile/get` on the server to get the current user profile
2. perform push notif registration
3. get current device settings
4. based on the results of the above, determine what fields need to be updated and call `profile/update` on server if needed

1, 2, and 3 can be executed in any order/ in parallel (with Promise.all / Promise.allSettled). Added a file userProfile to handle this.

The added benefit of this is that we have access to the value of the current profile. We can keep it as state in AppContext allowing it to be used anywhere in the UI (this can simplify how custom labels are retrieved + used; and it may be useful for users to know their "last synced ts", for example)
When the profile is updated from the UI, we have to keep the the local state in sync so instead of directly calling commHelper updateUser directly, we expose `updateUserProfile` from AppContext

In removing the complexity, I moved remoteNotifyHandler into pushNotifySettings

Updated tests for all changes

Author: JGreenlee

www/__mocks__/cordovaMocks.ts

@@ -32,8 +32,14 @@ export const mockReminders = () => {
 
 export const mockDevice = () => {
   window['device'] ||= {};
+  window['device'].cordova ||= packageJson.dependencies['cordova-ios'];
+  window['device'].model ||= 'iPhone 12';
   window['device'].platform ||= 'ios';
+  window['device'].uuid ||= '123456';
   window['device'].version ||= '14.0.0';
+  window['device'].manufacturer ||= 'Apple';
+  window['device'].isVirtual ||= false;
+  window['device'].serial ||= 'ABC1234567890';
 };
 
 export const mockGetAppVersion = () => {
@@ -223,6 +229,7 @@ export const mockBEMDataCollection = () => {
     },
   };
   window['cordova'] ||= {};
+  window['cordova'].plugins ||= {};
   window['cordova'].plugins.BEMDataCollection = mockBEMDataCollection;
 };
 

www/__mocks__/pushNotificationMocks.ts

@@ -1,27 +1,38 @@
 let notifSettings;
-let onList: any = {};
-let called = null;
+let listenerList: any = {};
+let finishedNotId = null;
 
 export const mockPushNotification = () => {
   window['PushNotification'] = {
     init: (settings: Object) => {
       notifSettings = settings;
-      return {
+      const push = {
         on: (event: string, callback: Function) => {
-          onList[event] = callback;
+          listenerList[event] = callback;
         },
         finish: (content: any, errorFcn: Function, notID: any) => {
-          called = notID;
+          finishedNotId = notID;
         },
       };
+      setTimeout(() => {
+        mockPushEvent('registration', {
+          registrationId: 'foo123',
+          registrationType: 'barABC',
+        });
+      }, 100);
+      return push;
     },
   };
 };
 
+export const getNotifSettings = () => notifSettings;
+export const getListenerList = () => listenerList;
+export const getFinishedNotId = () => finishedNotId;
+
+export const mockPushEvent = (event: string, data: any) => listenerList[event]?.(data);
+
 export function clearNotifMock() {
   notifSettings = {};
-  onList = {};
-  called = null;
+  listenerList = {};
+  finishedNotId = null;
 }
-export const getOnList = () => onList;
-export const getCalled = () => called;

www/__mocks__/setupJestEnv.js

@@ -18,6 +18,10 @@ import {
 import { mockFileSystem } from './fileSystemMocks';
 import { mockPushNotification } from './pushNotificationMocks';
 
+// init i18next so phone_lang is set correctly during tests
+import initializedI18next from '../js/i18nextInit';
+window['i18next'] = initializedI18next;
+
 mockLogger();
 mockCordova();
 mockDevice();

www/__tests__/notifScheduler.test.ts

@@ -265,7 +265,13 @@ describe('updateScheduledNotifs', () => {
         callback(arg);
       });
     // call the function
-    await updateScheduledNotifs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+    await updateScheduledNotifs(
+      reminderSchemes,
+      isScheduling,
+      setIsScheduling,
+      scheduledPromise,
+      updateUser,
+    );
     const scheduledNotifs = await getScheduledNotifs(isScheduling, scheduledPromise);
 
     expect(scheduledNotifs).toHaveLength(4);
@@ -295,7 +301,13 @@ describe('updateScheduledNotifs', () => {
       .spyOn(window['cordova'].plugins.notification.local, 'getScheduled')
       .mockImplementation((callback) => callback(mockNotifs));
     // call the function
-    await updateScheduledNotifs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+    await updateScheduledNotifs(
+      reminderSchemes,
+      isScheduling,
+      setIsScheduling,
+      scheduledPromise,
+      updateUser,
+    );
 
     expect(logDebug).toHaveBeenCalledWith('Already scheduled, not scheduling again');
   });
@@ -314,7 +326,13 @@ describe('updateScheduledNotifs', () => {
       .spyOn(window['cordova'].plugins.notification.local, 'getScheduled')
       .mockImplementation((callback) => callback(mockNotifs));
     // call the function
-    await updateScheduledNotifs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+    await updateScheduledNotifs(
+      reminderSchemes,
+      isScheduling,
+      setIsScheduling,
+      scheduledPromise,
+      updateUser,
+    );
 
     expect(logDebug).toHaveBeenCalledWith(
       'ERROR: Already scheduling notifications, not scheduling again',
@@ -329,7 +347,13 @@ describe('updateScheduledNotifs', () => {
     const setIsScheduling: Function = jest.fn((val: boolean) => (isScheduling = val));
     const scheduledPromise: Promise<any> = Promise.resolve();
     // call the function
-    await updateScheduledNotifs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+    await updateScheduledNotifs(
+      reminderSchemes,
+      isScheduling,
+      setIsScheduling,
+      scheduledPromise,
+      updateUser,
+    );
 
     expect(logDebug).toHaveBeenCalledWith('Error: Reminder scheme not found');
   });
@@ -377,7 +401,13 @@ describe('getReminderPrefs', () => {
 
     // call the function
     const { reminder_assignment, reminder_join_date, reminder_time_of_day } =
-      await getReminderPrefs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+      await getReminderPrefs(
+        reminderSchemes,
+        isScheduling,
+        setIsScheduling,
+        scheduledPromise,
+        updateUser,
+      );
 
     expect(logDebug).toHaveBeenCalledWith('User just joined, Initializing reminder prefs');
     expect(logDebug).toHaveBeenCalledWith('Added reminder prefs to client stats');
@@ -411,7 +441,13 @@ describe('getReminderPrefs', () => {
 
     // call the function
     const { reminder_assignment, reminder_join_date, reminder_time_of_day } =
-      await getReminderPrefs(reminderSchemes, isScheduling, setIsScheduling, scheduledPromise);
+      await getReminderPrefs(
+        reminderSchemes,
+        isScheduling,
+        setIsScheduling,
+        scheduledPromise,
+        updateUser,
+      );
 
     expect(reminder_assignment).toEqual(expectedResult.reminder_assignment);
     expect(reminder_join_date).toEqual(expectedResult.reminder_join_date);
@@ -459,6 +495,7 @@ describe('setReminderPrefs', () => {
       isScheduling,
       setIsScheduling,
       scheduledPromise,
+      updateUser,
     ).then(() => {
       // in the implementation in ProfileSettings.jsx,
       // refresNotificationSettings();

www/__tests__/pushNotifySettings.test.ts

@@ -1,106 +1,66 @@
-import { DateTime } from 'luxon';
-import { EVENTS, publish } from '../js/customEventHandler';
-import { INTRO_DONE_KEY, readIntroDone } from '../js/onboarding/onboardingHelper';
-import { storageSet } from '../js/plugin/storage';
-import { initPushNotify } from '../js/splash/pushNotifySettings';
-import { clearNotifMock, getOnList, getCalled } from '../__mocks__/pushNotificationMocks';
-
-global.fetch = (url: string) =>
-  new Promise((rs, rj) => {
-    setTimeout(() =>
-      rs({
-        json: () =>
-          new Promise((rs, rj) => {
-            let myJSON = {
-              emSensorDataCollectionProtocol: {
-                protocol_id: '2014-04-6267',
-                approval_date: '2016-07-14',
-              },
-            };
-            setTimeout(() => rs(myJSON), 100);
-          }),
-      }),
-    );
-  }) as any;
+import { initPushNotify, push } from '../js/splash/pushNotifySettings';
+import { clearNotifMock, getListenerList, mockPushEvent } from '../__mocks__/pushNotificationMocks';
+import { markConsented } from '../js/splash/startprefs';
+import { waitFor } from '@testing-library/react-native';
 
 afterEach(() => {
   clearNotifMock();
 });
 
-it('intro done does nothing if not registered', () => {
-  expect(getOnList()).toStrictEqual({});
-  publish(EVENTS.INTRO_DONE_EVENT, 'test data');
-  expect(getOnList()).toStrictEqual({});
-});
+describe('pushNotifySettings', () => {
+  describe('initPushNotify', () => {
+    it('does not set up listeners if consent not given', async () => {
+      expect(getListenerList()).toStrictEqual({});
+      await initPushNotify();
+      expect(getListenerList()).toStrictEqual({});
+    });
 
-it('intro done initializes the push notifications', () => {
-  expect(getOnList()).toStrictEqual({});
+    it('sets up listeners if consent given', async () => {
+      await markConsented();
+      await initPushNotify();
+      expect(getListenerList()).toStrictEqual(
+        expect.objectContaining({
+          notification: expect.any(Function),
+          error: expect.any(Function),
+          registration: expect.any(Function),
+        }),
+      );
+    });
 
-  initPushNotify();
-  publish(EVENTS.INTRO_DONE_EVENT, 'test data');
-  expect(getOnList()).toStrictEqual(
-    expect.objectContaining({
-      notification: expect.any(Function),
-      error: expect.any(Function),
-      registration: expect.any(Function),
-    }),
-  );
-});
+    it('handles visible notification', async () => {
+      const InAppBrowserOpenSpy = jest.spyOn(window['cordova'].InAppBrowser, 'open');
+      await initPushNotify();
+      mockPushEvent('notification', {
+        additionalData: {
+          payload: { alert_type: 'website', spec: { url: 'https://foo.bar' } },
+        },
+      });
+      expect(InAppBrowserOpenSpy).toHaveBeenCalledWith(
+        'https://foo.bar',
+        '_blank',
+        'location=yes,clearcache=no,toolbar=yes,hideurlbar=yes',
+      );
+    });
 
-it('cloud event does nothing if not registered', () => {
-  expect(window['cordova'].platformId).toEqual('ios');
-  publish(EVENTS.CLOUD_NOTIFICATION_EVENT, {
-    additionalData: { 'content-available': 1, payload: { notId: 3 } },
-  });
-  expect(getCalled()).toBeNull();
-});
+    it('handles silent notification', async () => {
+      const BEMDataCollectionHandleSilentPushSpy = jest.spyOn(
+        window['cordova'].plugins.BEMDataCollection,
+        'handleSilentPush',
+      );
+      await initPushNotify();
+      const pushFinishSpy = jest.spyOn(push, 'finish');
 
-it('cloud event handles notification if registered', async () => {
-  expect(window['cordova'].platformId).toEqual('ios');
-  initPushNotify();
-  publish(EVENTS.INTRO_DONE_EVENT, 'intro done');
-  publish(EVENTS.CLOUD_NOTIFICATION_EVENT, {
-    additionalData: { 'content-available': 1, payload: { notId: 3 } },
+      const NOTIF_ID = 98765;
+      mockPushEvent('notification', {
+        additionalData: {
+          'content-available': 1,
+          payload: { notId: NOTIF_ID },
+        },
+      });
+      await waitFor(() => {
+        expect(pushFinishSpy).toHaveBeenCalledWith(expect.anything(), expect.anything(), NOTIF_ID);
+        expect(BEMDataCollectionHandleSilentPushSpy).toHaveBeenCalled();
+      });
+    });
   });
-  await new Promise((r) => setTimeout(r, 1000));
-  expect(getCalled()).toEqual(3);
-});
-
-it('consent event does nothing if not registered', () => {
-  expect(getOnList()).toStrictEqual({});
-  publish(EVENTS.CONSENTED_EVENT, 'test data');
-  expect(getOnList()).toStrictEqual({});
-});
-
-it('consent event registers if intro done', async () => {
-  //make sure the mock is clear
-  expect(getOnList()).toStrictEqual({});
-
-  //initialize the pushNotify, to subscribe to events
-  initPushNotify();
-
-  //mark the intro as done
-  const currDateTime = DateTime.now().toISO();
-  let marked = await storageSet(INTRO_DONE_KEY, currDateTime);
-  let introDone = await readIntroDone();
-  expect(introDone).toBeTruthy();
-
-  //publish consent event and check results
-  publish(EVENTS.CONSENTED_EVENT, 'test data');
-  //have to wait a beat since event response is async
-  await new Promise((r) => setTimeout(r, 1000));
-  expect(getOnList()).toStrictEqual(
-    expect.objectContaining({
-      notification: expect.any(Function),
-      error: expect.any(Function),
-      registration: expect.any(Function),
-    }),
-  );
-});
-
-it('consent event does not register if intro not done', () => {
-  expect(getOnList()).toStrictEqual({});
-  initPushNotify();
-  publish(EVENTS.CONSENTED_EVENT, 'test data');
-  expect(getOnList()).toStrictEqual({}); //nothing, intro not done
 });