Migrate notification preference #47577

shubham1206agra · 2024-08-16T17:11:45Z

Details

Fixed Issues

$ #46835

Tests

Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/libs/OptionsListUtils.ts

ishpaul777

Preliminary review for changes in /src, i have had fixes for many failed IOUTests in https://github.com/ishpaul777/App/tree/fix/ioutest

src/libs/actions/Report.ts

src/libs/UnreadIndicatorUpdater/index.ts

tests/actions/IOUTest.ts

src/libs/ReportUtils.ts

Fix/ioutest

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

src/libs/actions/IOU.ts

tests/actions/IOUTest.ts

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

src/libs/actions/IOU.ts

ishpaul777 · 2024-08-22T15:14:42Z

is this ready for a review, if so could you mark it as open for review?

src/libs/ReportUtils.ts

ishpaul777 · 2024-08-25T18:33:29Z

There are Conflicts

melvin-bot · 2024-08-29T15:13:01Z

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

shubham1206agra · 2024-08-29T15:13:18Z

@ishpaul777 Can you start testing this?

ishpaul777 · 2024-08-29T18:41:52Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

ishpaul777 · 2024-08-30T18:17:19Z

I'll focus on this over weekend, this is only task i'll left with this week

ishpaul777

Looks good! only minor NAB comment

ishpaul777 · 2024-08-31T21:20:54Z

src/libs/actions/User.ts

@@ -556,11 +556,10 @@ const isChannelMuted = (reportId: string) =>
            key: `${ONYXKEYS.COLLECTION.REPORT}${reportId}`,
            callback: (report) => {
                Onyx.disconnect(connection);
+                const notificationPreference = report?.participants?.[currentUserAccountID]?.notificationPreference;


Can we use getReportNotificationPreference from Reportutils ?

Not really. Since this will create circular dependency.

ishpaul777 · 2024-08-31T21:25:25Z

Also there are conflicts..

shubham1206agra · 2024-09-01T01:15:05Z

Also there are conflicts..

Resolved

tests/actions/PolicyTest.ts

puneetlath · 2024-09-03T17:55:41Z

src/libs/ReportUtils.ts

+}
+
+/**
+ * Get the notification preference given a report


Suggested change

* Get the notification preference given a report

* Get the notification preference given a report for the current user

NAB but I think this is a bit more clear.

github-actions · 2024-09-03T18:41:31Z

🧪🧪 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/47577/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/47577/index.html

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

👀 View the workflow run that generated this build 👀

ishpaul777 · 2024-09-06T17:14:59Z

Any updates @puneetlath @shubham1206agra

puneetlath · 2024-09-07T14:19:08Z

QA was testing it. Looks like it's all good, so going to merge.

OSBotify · 2024-09-07T14:30:14Z

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

mvtglobally · 2024-09-09T16:54:33Z

@puneetlath Anything to QA here?

shubham1206agra · 2024-09-09T17:10:21Z

Yes, all tests in test rail related to notification preference.

dominictb · 2024-09-16T14:30:53Z

src/libs/actions/Report.ts

@@ -1016,7 +1020,7 @@ function navigateToAndOpenReport(
                undefined,
                undefined,
                undefined,
-                CONST.REPORT.NOTIFICATION_PREFERENCE.HIDDEN,
+                CONST.REPORT.NOTIFICATION_PREFERENCE.ALWAYS,


@shubham1206agra Sorry, I wonder why we need to update it "always"?

With these changes, when we initiate a conversation with a new user (FAB > Start chart > Type new email in search input > Choose that user), the notificationPreference in the optimistic data will be set to always, but the backend returns it as hidden.

Last I checked, BE was returning always too. Thats why I changed this.

Here, I see BE returns hidden:

Maybe it was a bug at that time, and I updated the preference.

What do you mean by "and I updated the preference."?

Migrating notification preference into participants

4c41990

ishpaul777 reviewed Aug 16, 2024

View reviewed changes

src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved

ishpaul777 added 2 commits August 18, 2024 23:57

fix/tests

8504a1d

FIXES MORE TESTS

4d34462

ishpaul777 reviewed Aug 18, 2024

View reviewed changes

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

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

src/libs/UnreadIndicatorUpdater/index.ts Outdated Show resolved Hide resolved

tests/actions/IOUTest.ts Outdated Show resolved Hide resolved

ishpaul777 reviewed Aug 18, 2024

View reviewed changes

src/libs/ReportUtils.ts Show resolved Hide resolved

shubham1206agra and others added 3 commits August 19, 2024 10:26

Merge pull request #4 from ishpaul777/fix/ioutest

49b79ca

Fix/ioutest

Apply suggestions from code review

24fe828

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

Fix lint

cc71ee5

ishpaul777 mentioned this pull request Aug 19, 2024

[HOLD for payment 2024-09-19][$1000] Replace report.notificationPreference with report.participants #46835

Open

5 tasks