Make optimistic requests/IOUs/expense reports “hidden”

[rezkiy37]

Details

The PR makes Expense reports, IOU reports, and Individual requests to use the same hidden setting that we use for threads so that they will be hidden from the LHN by default.

Fixed Issues

$ #29593
PROPOSAL: N/A

Tests

Same as "Offline tests".

• Verify that no errors appear in the JS console

Offline tests

We are testing optimistic data, therefore we are offline.
Also, the backend is not ready yet, once you get online, you can see these "hidden" reports in LHN.

IOU report

1. Open a regular chat.
2. Create a money request.
3. Verify that LHN does not have a new chat like a thread.

Expense report

1. Open a workspace chat.
2. Create a money request.
3. Verify that LHN does not have a new chat like a thread.

Individual report

1. Open the IOU/Expense report details page.
2. Edit the money request.
3. Verify that LHN does not have a new chat like a thread.

QA Steps

Same as "Offline 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: 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 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

Android: Native

Android.Expense.mp4

Android.Individual.mp4

Android.IOU.mp4

Android: mWeb Chrome

Android.Chrome.Expense.mp4

Android.Chrome.Individual.mp4

Android.Chrome.IOU.mp4

iOS: Native

IOS.Expense.mp4

IOS.Individual.mp4

IOS.IOU.mp4

iOS: mWeb Safari

IOS.Safari.Expense.mp4

IOS.Safari.Individual.mp4

IOS.Safari.IOU.mp4

MacOS: Chrome / Safari

Chrome.Expense.mp4

Chrome.Individual.mp4

Chrome.IOU.mp4

MacOS: Desktop

Desktop.Expense.Individual.mp4

Desktop.IOU.mp4

[melvin-bot]

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

[situchan]

Is it expected not to show green dot in LHN when report is optimistic?
Asking this because report with green dot should be visible in LHN

After online:

[situchan]

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

iou.mov

expense.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[situchan]

Offline tests well, but not when online.
@puneetlath are we fine to merge this though backend is not deployed yet?

[puneetlath]

I think it's fine to go ahead and merge this ahead of the back-end. It won't cause any problems. Do you agree @mountiny?

[mountiny]

Online this works same as on main right? @situchan

[situchan]

Online this works same as on main right? @situchan

right

And can you also check #29681 (comment)?

[mountiny]

Is it expected not to show green dot in LHN when report is optimistic?
Asking this because report with green dot should be visible in LHN

Is this the admin's workspace chat right?

I guess that this should be handled in another PR which handle the GBR

[situchan]

Is it expected not to show green dot in LHN when report is optimistic?
Asking this because report with green dot should be visible in LHN

Is this the admin's workspace chat right?

I guess that this should be handled in another PR which handle the GBR

Correct. Admin is paying his own request on his workspace

[mountiny]

Great, thanks for quick testing, all yours @puneetlath

[mountiny]

Finished the backend changes and tested with this PR, I think there is one thing we can address here (also will discuss in slack):

1. When you visit the IOU/ expense report and you dont comment and leave its correctly still hidden. However, when you comment and leave its hidden and only stays around when you go back. Thats because we do not change this optimistically.
   • Could you please change this so when you Add comment in a thead and its set to notification preferences hidden it will change it to Always? Thats how the logic works in backend so we will get rid of this backend forth.
2. There is a backend bug that I am not getting the notification about the report preview in the DM chat, this is not bug for this PR seems like we might be missing some data because of the preferences and we dont push the report preview

Screen.Recording.2023-10-17.at.22.07.17.mp4

[rezkiy37]

@mountiny, @puneetlath, I know 2 ways how to apply the always notif. pref. once user has commented. For both we improve addActions.

1. If any report has currently notificationPreference equals hidden - the app updates it to always in the optimistic data.
2. Add a few conditions based on a report type:
   1. IOU report: if satisfies isIOUReport, we update the notificationPreference.
   2. Expense report: if satisfies isExpenseReport, we update the notificationPreference.
   3. Individual report: if satisfies isChatThread, we update the notificationPreference.

WDYT?

[rezkiy37]

Should we check that a report is already hidden?

[puneetlath]

WDYT?

I think we can go with approach one, but I asked for confirmation here.

Should we check that a report is already hidden?

Good question, yes, we should. We should only change the notification preference in the case where it is currently hidden. If the user has set it to something else (e.g. daily) we won't change it.

[mountiny]

Sounds good and yeah we should check if its hidden before changing it

[rezkiy37]

@mountiny, @puneetlath, @situchan, I've implement the 1st approach - 606a6a3.

Update.to.always.mp4

[mountiny]

Thanks, great job! One NAB question

@puneetlath we want to hold this, right?

[rezkiy37]

@puneetlath, @mountiny, can we move forward here?

[mountiny]

Soon

[rezkiy37]

I have to inform that starting tomorrow I have a short vocation until next Monday (6.11.2023). Feel free to left any comments, I will address them. See you soon 😉

Btw, I've synced with the latest main.

[rezkiy37]

@mountiny, can we move forward here?
Just a friendly reminder 🙂

[mountiny]

I think we can right @puneetlath?

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.96-6 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.98-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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