Notifications for editing money requests #27299

arosiclair · 2023-09-12T21:52:10Z

HELD on https://github.com/Expensify/Web-Expensify/pull/38830

Details

Adds support for displaying notifications for modified expense actions

Fixed Issues

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

Tests

Notifications not supported on mobile web

Create a workspace with an admin and member
Log in as the admin
Accept any prompt for notification permissions
On another device/browser login as the member and create a money request
As the admin, open the expense and reply to the thread to subscribe to it for notifications
Navigate away from the chat (eg: back to concierge)
As the member, edit the amount, description, date and merchant
On the admin device, verify for each edit a notification displays describing what changed

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

iOS

Android

…nce-edit-notifications

melvin-bot · 2023-09-18T10:08:07Z

@ntdiary 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]

arosiclair · 2023-09-18T10:09:13Z

Alright this tests well with the given Web-E PR. However, push notifications are not working on iOS in dev atm so I cannot test there.

arosiclair · 2023-09-19T05:01:31Z

Alright push notifications not working in dev is a known issue. Since this is controlled by the backend, verifying just Android should be safe since the logic is the same for both platforms.

arosiclair · 2023-09-22T01:48:32Z

Backend changes are on staging so this is ready for review! @ntdiary please review and do the checklist. You do not have to test iOS for this.

src/libs/actions/Report.js

ntdiary · 2023-09-22T13:48:56Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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.

Screenshots/Videos

Web

27299-web.mp4

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

27299-desktop.mp4

iOS

N/A

Android

27299-mobile-android.mp4

ntdiary · 2023-09-22T13:53:13Z

src/libs/Notification/LocalNotification/BrowserNotifications.js

@@ -128,6 +128,16 @@ export default {
        });
    },

+    pushModifiedExpenseNotification({reportAction, onClick}, usesIcon = false) {
+        push({
+            title: _.map(reportAction.person, (f) => f.text).join(),


Perhaps there is only one person for now, so it's okay. If multiple people are supported in the future, it's better to separate the names with a symbol. : )

join adds a comma by default but we should add a space too. I'll update this

ntdiary

It works well on web/desktop/android, clicking notifications can also open the corresponding messages correctly. Haven't tested the display of special characters yet, but those are more like edge cases. 🙂

melvin-bot · 2023-09-22T14:10:41Z

@grgia 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]

arosiclair · 2023-09-25T02:46:30Z

Ready for another review! @grgia @ntdiary

ntdiary · 2023-09-25T02:57:58Z

@arosiclair, it would be better if this comment about unit tests can be addressed. : )

marcaaron

Code LGTM - mostly non-blocking comments for some minor improvements.

marcaaron · 2023-09-25T05:58:20Z

src/libs/Notification/LocalNotification/BrowserNotifications.js

+            body: ReportUtils.getModifiedExpenseMessage(reportAction),
+            delay: 0,
+            onClick,
+            icon: usesIcon ? EXPENSIFY_ICON_URL : '',


NAB, just sort of noticing that this module is formatted a bit differently than others in that it's missing JSDocs and the methods come after the export keyword.

src/libs/Notification/LocalNotification/index.desktop.js

marcaaron · 2023-09-25T06:01:24Z

src/libs/ReportUtils.js

@@ -1542,6 +1542,9 @@ function getProperSchemaForModifiedExpenseMessage(newValue, oldValue, valueName,
 /**
 * Get the report action message when expense has been modified.
 *
+ * ModifiedExpense::getNewDotComment in Web-Expensify should match this.
+ * If we change this function be sure to update the backend as well.


NAB, this comment is well intentioned, but I wonder if we should take any additional steps besides this reminder.

Another thought, this kind of applies to basically any API call we have. Anytime the schema of the data passed to the frontend changes there is a risk of things breaking or being inconsistent.

I was thinking the best next step is to actually get rid of this function and only format the message in Web-E. I can make a follow-up issue to address it.

grgia · 2023-09-25T10:16:19Z

@arosiclair will let you decide if you want to address @marcaaron's comments or merge

grgia · 2023-09-25T11:40:05Z

@arosiclair unit test is failing?

ntdiary · 2023-09-25T13:48:12Z

@arosiclair unit test is failing?

Yeah, I pointed it out here. REPORT_ACTION needs a valid actionName value.

arosiclair · 2023-09-26T02:18:30Z

@arosiclair unit test is failing?

Yeah, I pointed it out here. REPORT_ACTION needs a valid actionName value.

Woops just fixed that. Ready for another review! @marcaaron

src/libs/actions/Report.js

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

OSBotify · 2023-09-26T05:27:50Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-09-28T19:19:54Z

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

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

OSBotify · 2023-10-02T17:23:50Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.75-12 🚀

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

OSBotify · 2023-10-02T17:52:28Z

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

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

s77rt · 2023-10-02T22:04:41Z

src/libs/actions/Report.js

-        onClick: () => {
-            // Navigate to this report onClick
-            Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(reportID));
-        },
-    });
-    notifyNewAction(reportID, action.actorAccountID, action.reportActionID);
+    const report = allReports[reportID];
+
+    const notificationParams = {
+        report,
+        reportAction,
+        onClick: () => Navigation.navigate(ROUTES.getReportRoute(reportID)),
+    };


This caused a regression #28328. We should have kept using ROUTES.REPORT_WITH_ID.getRoute because ROUTES.getReportRoute no longer exists.

(Seems like a merge conflict)

OSBotify · 2023-10-03T15:53:25Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

mountiny · 2023-10-04T22:32:35Z

src/libs/actions/Report.js

+    if (!ReportActionsUtils.isNotifiableReportAction(action)) {
+        Log.info(`${tag} No notification because this action type is not supported`, false, {actionName: action.actionName});


This is causing some crashes:

Fatal Exception: com.facebook.react.common.JavascriptException: TypeError: Cannot read property 'actionName' of null, js engine: hermes, stack: shouldShowReportActionNotification@1:3040125 shouldShowPushNotification@1:13695857 anonymous@1:13694964 anonymous@1:13688405 emit@1:162156 __callFunction@1:170848 anonymous@1:169200 __guard@1:170153 callFunctionReturnFlushedQueue@1:169158

If the action is not defined, we still proceed to the the block and we try to access the action.actionName which will cause crash

created a quick PR for this here #28880

arosiclair added 3 commits September 12, 2023 14:30

allow other types of notifications

d0b45ec

rename action to reportAction

93a5891

use formatting for modified expense notifications

cabe7a5

arosiclair self-assigned this Sep 12, 2023

arosiclair added 5 commits September 12, 2023 18:35

only allow some types of actions for notifications

ada2432

use report action user as title

d74bc4e

use icon on web

1cc8736

log reason for no notification

b6be992

use the alert in the payload as the notification message

6db3f48

arosiclair changed the title ~~Notifications for editing money requests~~ [HOLD] Notifications for editing money requests Sep 16, 2023

arosiclair added 5 commits September 16, 2023 00:03

add comment for matching the backend

0223dc5

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

127c0a0

…nce-edit-notifications

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

5f80689

…nce-edit-notifications

fix selecting the wrong report action to notify for

9ed14a9

suppress false positives

eceb13f

arosiclair marked this pull request as ready for review September 18, 2023 10:08

arosiclair requested a review from a team as a code owner September 18, 2023 10:08

melvin-bot bot requested review from ntdiary and removed request for a team September 18, 2023 10:08

neil-marcellini changed the title ~~[HOLD] Notifications for editing money requests~~ Notifications for editing money requests Sep 22, 2023

ntdiary reviewed Sep 22, 2023

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

ntdiary reviewed Sep 22, 2023

View reviewed changes

ntdiary approved these changes Sep 22, 2023

View reviewed changes

melvin-bot bot requested a review from grgia September 22, 2023 14:10

marcaaron previously approved these changes Sep 25, 2023

View reviewed changes

grgia previously approved these changes Sep 25, 2023

View reviewed changes

arosiclair added 2 commits September 26, 2023 09:33

add jsdocs

682be4a

add notifiable actionName

b173012

arosiclair dismissed stale reviews from grgia and marcaaron via b173012 September 26, 2023 01:48

marcaaron previously approved these changes Sep 26, 2023

View reviewed changes

src/libs/actions/Report.js Outdated Show resolved Hide resolved

arosiclair dismissed marcaaron’s stale review via b8791c3 September 26, 2023 04:31

DRY up notification params

b8791c3

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

marcaaron approved these changes Sep 26, 2023

View reviewed changes

arosiclair merged commit e3f32a0 into main Sep 26, 2023

arosiclair deleted the arosiclair-distance-edit-notifications branch September 26, 2023 05:22

OSBotify mentioned this pull request Sep 28, 2023

Deploy Checklist: New Expensify 2023-09-28 #28412

Closed

situchan mentioned this pull request Sep 29, 2023

[HOLD for payment 2023-10-10] [HOLD for payment 2023-10-09] [$500] Chat - Error appears on click of notification and does not redirect to page #28328

Closed

6 tasks

lanitochka17 mentioned this pull request Sep 29, 2023

Desktop- IOU - Notification is only received for the first edit of IOU request in workspace #28520

Closed

6 tasks

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

s77rt reviewed Oct 2, 2023

View reviewed changes

mountiny reviewed Oct 4, 2023

View reviewed changes

mountiny mentioned this pull request Oct 4, 2023

[NoQA] Access the report action safely in notification logic #28880

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Notifications for editing money requests #27299

Notifications for editing money requests #27299

arosiclair commented Sep 12, 2023 •

edited

Loading

melvin-bot bot commented Sep 18, 2023

arosiclair commented Sep 18, 2023

arosiclair commented Sep 19, 2023

arosiclair commented Sep 22, 2023

ntdiary commented Sep 22, 2023 •

edited

Loading

ntdiary Sep 22, 2023

arosiclair Sep 25, 2023

ntdiary left a comment

melvin-bot bot commented Sep 22, 2023

arosiclair commented Sep 25, 2023

ntdiary commented Sep 25, 2023

marcaaron left a comment

marcaaron Sep 25, 2023

marcaaron Sep 25, 2023

arosiclair Sep 26, 2023 •

edited

Loading

grgia commented Sep 25, 2023

grgia commented Sep 25, 2023

ntdiary commented Sep 25, 2023

arosiclair commented Sep 26, 2023

OSBotify commented Sep 26, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

s77rt Oct 2, 2023 •

edited

Loading

OSBotify commented Oct 3, 2023

mountiny Oct 4, 2023

mountiny Oct 4, 2023

		if (!ReportActionsUtils.isNotifiableReportAction(action)) {
		Log.info(`${tag} No notification because this action type is not supported`, false, {actionName: action.actionName});

Notifications for editing money requests #27299

Notifications for editing money requests #27299

Conversation

arosiclair commented Sep 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 18, 2023

arosiclair commented Sep 18, 2023

arosiclair commented Sep 19, 2023

arosiclair commented Sep 22, 2023

ntdiary commented Sep 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

ntdiary Sep 22, 2023

Choose a reason for hiding this comment

arosiclair Sep 25, 2023

Choose a reason for hiding this comment

ntdiary left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 22, 2023

arosiclair commented Sep 25, 2023

ntdiary commented Sep 25, 2023

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron Sep 25, 2023

Choose a reason for hiding this comment

marcaaron Sep 25, 2023

Choose a reason for hiding this comment

arosiclair Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

grgia commented Sep 25, 2023

grgia commented Sep 25, 2023

ntdiary commented Sep 25, 2023

arosiclair commented Sep 26, 2023

OSBotify commented Sep 26, 2023

OSBotify commented Sep 28, 2023

OSBotify commented Oct 2, 2023

OSBotify commented Oct 2, 2023

s77rt Oct 2, 2023 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Oct 3, 2023

mountiny Oct 4, 2023

Choose a reason for hiding this comment

mountiny Oct 4, 2023

Choose a reason for hiding this comment

arosiclair commented Sep 12, 2023 •

edited

Loading

ntdiary commented Sep 22, 2023 •

edited

Loading

arosiclair Sep 26, 2023 •

edited

Loading

s77rt Oct 2, 2023 •

edited

Loading