Support money request push notifications #41861

arosiclair · 2024-05-08T19:07:16Z

Details

Adds support for new moneyRequest push notifications. Re-uses logic from subscribeToReportCommentPushNotifications to be common between them.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/381189

Tests

Note

Money request push notifications cannot be tested externally yet. Instead, Applause will QA when backend changes for them are deployed. For now, we will just regression test report comment push notifications.
Only test iOS and Android

Log into NewDot on web and mobile
Accept push notification permission
Send a chat message to mobile
Verify a push notification is received
Select the push notification
Verify the report is opened

Android background updates

Log in as a workspace member on two devices
Join a room on Android and set the notification preference to mute
Kill the app
Send messages in the room to create missed onyx updates
DM the Android user to trigger a push notification
Verify a push notification is received
Verify in logs that the app wakes and fetches missed onyx updates after a moment:

[info] [PushNotification] Applying onyx data in the background - {"reportID":2498013334625344,"reportActionID":"1691535872927344326"}
[info] [PushNotification] reliable onyx update received - {"lastUpdateID":6415,"previousUpdateID":6412,"onyxDataCount":2}

[info] Gap detected in update IDs from server so fetching incremental updates - {"lastUpdateIDFromServer":6415,"previousUpdateIDFromServer":6412,"lastUpdateIDFromClient":6407}
[info] Making API request - {"command":"GetMissingOnyxMessages"}

[OnyxUpdateManager] Done applying all updates

Offline tests

None

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

fixes push notifications not being shown when their payload was stripped

arosiclair · 2024-05-08T19:09:35Z

src/setup/platformSetup/index.native.ts

-     * 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();


This subscription was a duplicate and has been unnecessary for a while

I didn't understand. The comment says that it is necessary to be executed in Headless process. Are you saying that it is not needed anymore? We are already executing it somewhere else? If so, do you have more insights on where it is called?

App currently calls this twice. One in Setup and other one in Expensify.tsx file. But this file is also called in headLess env where Expensify.tsx is not loaded so it is necessary here.

We've been handling the subscription here so it's a dupe:

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

Lines 111 to 135 in 5642411

/**

* Manage push notification subscriptions on sign-in/sign-out.

*

* On Android, AuthScreens unmounts when the app is closed with the back button so we manage the

* push subscription when the session changes here.

*/

Onyx.connect({

key: ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID,

callback: (notificationID) => {

if (notificationID) {

PushNotification.register(notificationID);

PushNotification.init();

// 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();

}

},

});

The callbacks should work there, but I haven't been able to build Android to test it. Can you build Android to test?

Nvm I fixed the build here. Background updates are still working well on Android:

…-request-push-notif

arosiclair · 2024-05-10T02:18:31Z

Was not able to build Android, but iOS is looking good. This is ready for review.

melvin-bot · 2024-05-10T02:18:38Z

@parasharrajat Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

parasharrajat · 2024-05-10T04:21:51Z

Testing...

parasharrajat · 2024-05-10T04:24:41Z

@arosiclair Could you please trigger adHoc build for notification testing?

parasharrajat · 2024-05-10T04:42:13Z

src/setup/platformSetup/index.native.ts

-     * 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();


I didn't understand. The comment says that it is necessary to be executed in Headless process. Are you saying that it is not needed anymore? We are already executing it somewhere else? If so, do you have more insights on where it is called?

App currently calls this twice. One in Setup and other one in Expensify.tsx file. But this file is also called in headLess env where Expensify.tsx is not loaded so it is necessary here.

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

arosiclair · 2024-05-10T13:21:33Z

@arosiclair Could you please trigger adHoc build for notification testing?

Push notifications don't work in ad-hoc builds. You just need to test Android in dev. Make sure to follow these steps.

src/libs/Notification/PushNotification/NotificationType.ts

Julesssss · 2024-05-13T09:56:21Z

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

+    });
+}
+
+function applyOnyxData({reportID, reportActionID, onyxData, lastUpdateID, previousUpdateID}: ReportActionPushNotificationData): Promise<void> {


Additional function comments would be useful here

I thought about it, but I'm not sure there's anything to comment on. "Apply the onyx data" seems like a useless comment and we didn't have any comments for it before either

Julesssss · 2024-05-13T09:58:05Z

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

+            PushNotification.onReceived(PushNotification.TYPE.MONEY_REQUEST, applyOnyxData);
+            PushNotification.onSelected(PushNotification.TYPE.MONEY_REQUEST, navigateToReport);


Do you forsee other types? I assume the individual splits will be fine, but what about the parent split action for example

Yeah there will be other types in the future, but for now there is only reportComment and moneyRequest.

Julesssss

I don't know how easy this would be, but more App testing would make me more confident that the Web > App flow will remain stable

parasharrajat · 2024-05-13T10:36:22Z

Failed Test: Android: Message does not show up while offline in the chat.

arosiclair · 2024-05-13T15:32:25Z

Failed Test: Android: Message does not show up while offline in the chat.

This is actually a known issue that will be fixed here: #40227

parasharrajat · 2024-05-13T18:40:16Z

Screenshots

🔲 iOS / native

Screen.Recording.2024-05-14.at.1.19.57.AM.mov

🔲 iOS / Safari

Screen.Recording.2024-05-14.at.1.19.13.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-05-14.at.1.26.57.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2024-05-14.at.1.10.50.AM.mov

🔲 Android / Chrome

Screen.Recording.2024-05-14.at.1.15.13.AM.mov

🔲 Android / native

Screen.Recording.2024-05-14.at.1.17.16.AM.mov

parasharrajat

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

melvin-bot · 2024-05-13T19:59:48Z

@jasperhuangg Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

melvin-bot · 2024-05-13T19:59:52Z

🎯 @parasharrajat, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #42107.

jasperhuangg · 2024-05-13T20:20:18Z

Don't have much context here but looked at the code and everything makes sense to me. Gonna run an AdHoc build to test on my Android/iOS devices.

https://github.com/Expensify/App/actions/runs/9069271736

parasharrajat · 2024-05-13T20:35:09Z

I didn't test iOS Notifications because I can't. I don't have necessary keys.

arosiclair · 2024-05-13T20:49:48Z

@jasperhuangg ad-hoc builds don't work with push notifications!! Just mentioned that up here.

You just need to test iOS in dev on a physical device.

jasperhuangg · 2024-05-13T20:53:03Z

@arosiclair Ah shoot, my mistake! thanks for pointing that out–in that case I don't want to block this on me, feel free to merge if you think everything checks out.

github-actions · 2024-05-13T20:54:23Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/41861/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/41861/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/41861/NewExpensify.dmg	https://41861.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

OSBotify · 2024-05-15T10:14:53Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.4.74-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

kavimuru · 2024-05-16T14:14:05Z

@arosiclair can we skip onyx updates logs verification? We can't test at our end.

Android background updates
Verify in logs that the app wakes and fetches missed onyx updates after a moment:

arosiclair · 2024-05-16T14:17:43Z

@arosiclair can we skip onyx updates logs verification? We can't test at our end.

Yes you can skip that section

OSBotify · 2024-05-22T23:59:54Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

arosiclair added 5 commits May 8, 2024 10:53

remove duplicate push notif subscription

e0dc8df

update PushNotificationData types

3516441

add moneyRequest push notification type

4c8b147

subscribe to both reportComment and moneyRequest notifications

8669849

skip action type check when the report action is null

f6823bd

fixes push notifications not being shown when their payload was stripped

arosiclair self-assigned this May 8, 2024

arosiclair commented May 8, 2024

View reviewed changes

arosiclair added 3 commits May 9, 2024 12:53

Merge branch 'main' of github.com:Expensify/App into arosiclair-money…

b6e9949

…-request-push-notif

import type

feae90f

eslint

5642411

arosiclair marked this pull request as ready for review May 10, 2024 02:18

arosiclair requested a review from a team as a code owner May 10, 2024 02:18

melvin-bot bot requested review from parasharrajat and removed request for a team May 10, 2024 02:18

parasharrajat suggested changes May 10, 2024

View reviewed changes

src/libs/Notification/PushNotification/subscribePushNotification/index.ts Show resolved Hide resolved

src/libs/Notification/PushNotification/subscribePushNotification/index.ts Show resolved Hide resolved

Julesssss reviewed May 13, 2024

View reviewed changes

src/libs/Notification/PushNotification/NotificationType.ts Outdated Show resolved Hide resolved

Julesssss reviewed May 13, 2024

View reviewed changes

arosiclair requested review from parasharrajat and Julesssss May 13, 2024 15:33

move roomName to ReportActionPushNotificationData

1dbd34c

parasharrajat approved these changes May 13, 2024

View reviewed changes

melvin-bot bot requested a review from jasperhuangg May 13, 2024 19:59

melvin-bot bot mentioned this pull request May 13, 2024

[May 29] Payment issue for E/App PR#41861 #42107

Closed

jasperhuangg approved these changes May 13, 2024

View reviewed changes

jasperhuangg added the Ready To Build label May 13, 2024

arosiclair merged commit 159d4cb into main May 13, 2024
16 checks passed

arosiclair deleted the arosiclair-money-request-push-notif branch May 13, 2024 21:48

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support money request push notifications #41861

Support money request push notifications #41861

arosiclair commented May 8, 2024 •

edited

Loading

arosiclair May 8, 2024

parasharrajat May 10, 2024

arosiclair May 10, 2024

arosiclair May 10, 2024

arosiclair commented May 10, 2024

melvin-bot bot commented May 10, 2024

parasharrajat commented May 10, 2024

parasharrajat commented May 10, 2024

parasharrajat May 10, 2024

arosiclair commented May 10, 2024

Julesssss May 13, 2024

arosiclair May 13, 2024

Julesssss May 13, 2024

arosiclair May 13, 2024

Julesssss left a comment •

edited

Loading

parasharrajat commented May 13, 2024 •

edited

Loading

arosiclair commented May 13, 2024

parasharrajat commented May 13, 2024 •

edited

Loading

parasharrajat left a comment

melvin-bot bot commented May 13, 2024

melvin-bot bot commented May 13, 2024

jasperhuangg commented May 13, 2024 •

edited

Loading

parasharrajat commented May 13, 2024

arosiclair commented May 13, 2024

jasperhuangg commented May 13, 2024

github-actions bot commented May 13, 2024

OSBotify commented May 15, 2024

kavimuru commented May 16, 2024 •

edited

Loading

arosiclair commented May 16, 2024

OSBotify commented May 22, 2024

	/**
	* Manage push notification subscriptions on sign-in/sign-out.
	*
	* On Android, AuthScreens unmounts when the app is closed with the back button so we manage the
	* push subscription when the session changes here.
	*/
	Onyx.connect({
	key: ONYXKEYS.NVP_PRIVATE_PUSH_NOTIFICATION_ID,
	callback: (notificationID) => {
	if (notificationID) {
	PushNotification.register(notificationID);
	PushNotification.init();

	// 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();
	}
	},
	});

Support money request push notifications #41861

Support money request push notifications #41861

Conversation

arosiclair commented May 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arosiclair commented May 10, 2024

melvin-bot bot commented May 10, 2024

parasharrajat commented May 10, 2024

parasharrajat commented May 10, 2024

Choose a reason for hiding this comment

arosiclair commented May 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Julesssss left a comment • edited Loading

Choose a reason for hiding this comment

parasharrajat commented May 13, 2024 • edited Loading

arosiclair commented May 13, 2024

parasharrajat commented May 13, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

melvin-bot bot commented May 13, 2024

melvin-bot bot commented May 13, 2024

jasperhuangg commented May 13, 2024 • edited Loading

parasharrajat commented May 13, 2024

arosiclair commented May 13, 2024

jasperhuangg commented May 13, 2024

github-actions bot commented May 13, 2024

OSBotify commented May 15, 2024

kavimuru commented May 16, 2024 • edited Loading

arosiclair commented May 16, 2024

OSBotify commented May 22, 2024

arosiclair commented May 8, 2024 •

edited

Loading

Julesssss left a comment •

edited

Loading

parasharrajat commented May 13, 2024 •

edited

Loading

parasharrajat commented May 13, 2024 •

edited

Loading

jasperhuangg commented May 13, 2024 •

edited

Loading

kavimuru commented May 16, 2024 •

edited

Loading