[No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls #37930

arosiclair · 2024-03-07T20:13:57Z

Details

Fixes issues with failed optimistic reports getting cleared immediately on reconnect. This prevents helpful error messages from being hidden.

Fixed Issues

$ #36928
PROPOSAL: #36928 (comment)

Tests

Non-existing report

Log in as user A
Go to https://staging.new.expensify.com/r/123456 (a report that doesn't exist)
- For dev: https://dev.new.expensify.com:8082/r/123456
Verify the "it's not here" page displays

No-access report

Log in as user B
Open the concierge chat and copy the link
Log in as user A
Go to the copied concierge link
Verify the "it's not here" page displays

Offline tests

Same as Tests

QA Steps

None

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 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

… reports

melvin-bot · 2024-03-07T20:39:10Z

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

arosiclair · 2024-03-07T20:41:53Z

This is ready for review however I did have trouble testing on mobile web and native since it's difficult to navigate back to the chat before the network call fails. I skipped those and just tested web and desktop but feel free to try.

mananjadhav · 2024-03-11T18:43:19Z

Been trying to test this, the offline report that I create goes blank, and hence when I come back I see

If I press back, I can see the chat momentarily but it hides abruptly.

…ne-request-fix

arosiclair · 2024-03-12T15:39:51Z

I'm seeing this now too. It seems that the report is empty so we're not preventing it from being fetched:

I'll take another look at this

arosiclair · 2024-03-12T17:05:05Z

It seems that there's a race condition between the API.write for the money request and dismissing the modal here. We navigate back to the report screen and queue OpenReport before the optimistic report gets merged into Onyx. This is why the report is empty and we can't tell that it's optimistic before calling OpenReport.

I'm not sure why this is suddenly an issue now and not before. Maybe the response from OpenReport for a non-existing report needs to stop being so destructive so that we can still show helpful error messages. I'll circle back on this later and maybe start a discussion about it.

arosiclair · 2024-03-15T18:31:34Z

Alright new approach is detailed here. I've updated this PR to handle errorFields.notFound. I'll also leave the shouldFetchReport improvements since those are good regardless.

@mananjadhav this is ready for review. However, this needs to be deployed before the backend changes are deployed so that we do not start setting errorFields.notFound before NewDot can handle it. That means you cannot test the offline money request flow at the moment. Instead Applause will QA when the backend changes are deployed.

mananjadhav · 2024-03-17T15:10:09Z

Okay thanks for the update. I'll get it reviewed.

…ne-request-fix

fedirjh · 2024-03-20T19:56:04Z

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

CleanShot.2024-03-20.at.21.05.27.mp4

Android: mWeb Chrome

CleanShot.2024-03-20.at.21.13.26.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.Xs.-.2024-03-20.at.20.50.23.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.Xs.-.2024-03-20.at.20.53.37.mp4

MacOS: Chrome / Safari

CleanShot.2024-03-20.at.20.31.24.mp4

MacOS: Desktop

CleanShot.2024-03-20.at.20.58.44.mp4

fedirjh

Looks good and tests well. Left little suggestion about the code.

src/pages/home/ReportScreen.tsx

src/libs/ReportUtils.ts

melvin-bot · 2024-03-20T20:17:21Z

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

amyevans · 2024-03-20T22:13:21Z

There's some conflicts to resolve @arosiclair

…ne-request-fix

arosiclair · 2024-03-21T14:47:24Z

@amyevans updated!

amyevans

Looks good!

OSBotify · 2024-03-21T15:58:16Z

✋ 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 · 2024-03-22T16:20:21Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.56-0 🚀

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

OSBotify · 2024-03-27T04:49:30Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

DylanDylann · 2025-02-25T06:44:18Z

src/libs/shouldFetchReport.ts

+export default function shouldFetchReport(report: Report) {
+    // If the report is optimistic, there's no need to fetch it. The original action should create it.
+    // If there is an error for creating the chat, there's no need to fetch it since it doesn't exist
+    return !report?.isOptimisticReport && !report?.errorFields?.createChat;


From #54512
we need to avoid the complications caused by passing and monitoring a complex object.

arosiclair added 3 commits March 7, 2024 14:49

clear isOptimisticReport on success

f5040bf

unify pre-fetch report checks and fix issues with fetching optimistic…

1245b79

… reports

add comment

b0d6dca

arosiclair self-assigned this Mar 7, 2024

arosiclair added 2 commits March 7, 2024 15:26

fix type import

03dba7f

update dependencies

6c74c15

arosiclair marked this pull request as ready for review March 7, 2024 20:39

arosiclair requested a review from a team as a code owner March 7, 2024 20:39

melvin-bot bot requested review from mananjadhav and removed request for a team March 7, 2024 20:39

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

4ac90dd

…ne-request-fix

arosiclair added 4 commits March 14, 2024 16:27

check for notFound errors

03bd7db

clear notFound on success

e41bdf6

prevent blocking the screen for non-404 errors

31bd599

prettier

4a4e1a2

arosiclair changed the title ~~Fix optimistic reports getting cleared by unnecessary OpenReport calls~~ [No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls Mar 15, 2024

arosiclair mentioned this pull request Mar 15, 2024

[HOLD for payment 2024-04-03] [LOW] [Splits] [$500] Chat - Error "a previously existing chat between these users." is missing when go online #36928

Closed

6 tasks

arosiclair requested review from fedirjh and removed request for mananjadhav March 20, 2024 18:35

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

a436bec

…ne-request-fix

fedirjh approved these changes Mar 20, 2024

View reviewed changes

src/pages/home/ReportScreen.tsx Show resolved Hide resolved

src/libs/ReportUtils.ts Show resolved Hide resolved

melvin-bot bot requested a review from amyevans March 20, 2024 20:17

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

9e0304e

…ne-request-fix

amyevans approved these changes Mar 21, 2024

View reviewed changes

amyevans merged commit 956d14f into main Mar 21, 2024
15 checks passed

amyevans deleted the arosiclair-offline-request-fix branch March 21, 2024 15:49

github-actions bot mentioned this pull request Mar 22, 2024

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

pecanoro mentioned this pull request Mar 22, 2024

Web - Creating new chat is lagging #38818

Closed

6 tasks

DylanDylann reviewed Feb 25, 2025

View reviewed changes

DylanDylann mentioned this pull request Feb 25, 2025

[Due for payment 2025-02-18] [$250] Expense-App shows not here page instead of auto refresh report when exchanging expense offline #54512

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls #37930

[No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls #37930

arosiclair commented Mar 7, 2024 •

edited

Loading

melvin-bot bot commented Mar 7, 2024

arosiclair commented Mar 7, 2024

mananjadhav commented Mar 11, 2024

arosiclair commented Mar 12, 2024

arosiclair commented Mar 12, 2024

arosiclair commented Mar 15, 2024

mananjadhav commented Mar 17, 2024

fedirjh commented Mar 20, 2024 •

edited

Loading

fedirjh left a comment

melvin-bot bot commented Mar 20, 2024

amyevans commented Mar 20, 2024

arosiclair commented Mar 21, 2024

amyevans left a comment

OSBotify commented Mar 21, 2024

OSBotify commented Mar 22, 2024

OSBotify commented Mar 27, 2024

DylanDylann Feb 25, 2025

[No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls #37930

[No QA] Fix optimistic reports getting cleared by unnecessary OpenReport calls #37930

Conversation

arosiclair commented Mar 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 7, 2024

arosiclair commented Mar 7, 2024

mananjadhav commented Mar 11, 2024

arosiclair commented Mar 12, 2024

arosiclair commented Mar 12, 2024

arosiclair commented Mar 15, 2024

mananjadhav commented Mar 17, 2024

fedirjh commented Mar 20, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 20, 2024

amyevans commented Mar 20, 2024

arosiclair commented Mar 21, 2024

amyevans left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 21, 2024

OSBotify commented Mar 22, 2024

OSBotify commented Mar 27, 2024

DylanDylann Feb 25, 2025

Choose a reason for hiding this comment

arosiclair commented Mar 7, 2024 •

edited

Loading

fedirjh commented Mar 20, 2024 •

edited

Loading