[CP Staging] Fix optimistic report status is not set correctly #53050

bernhardoj · 2024-11-25T05:05:48Z

Explanation of Change

#52204 (comment)

Fixed Issues

$ #53040
$ #53022
$ #52204
PROPOSAL:

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Thread:

Open any chat
Send a message
Open the thread of the sent message
Press the header thread parent link text
Verify the chat report is shown correctly

Save the world:

Open Settings and choose Save the world
Press I know a teacher
Fill the information and press the submit button
Verify the teachers unite room is loaded

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

web.2.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2024-11-25T05:05:54Z

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

hoangzinh · 2024-11-25T10:00:21Z

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

Screen.Recording.2024-11-25.at.19.48.14.android.mov

Android: mWeb Chrome

Screen.Recording.2024-11-25.at.19.53.41.android.chrome.mov

iOS: Native

Screen.Recording.2024-11-25.at.19.56.47.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-11-25.at.20.02.33.ios.safari2.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-25.at.19.35.23.web.mov

MacOS: Desktop

Screen.Recording.2024-11-25.at.19.39.22.desktop.mov

hoangzinh · 2024-11-25T10:01:23Z

@bernhardoj I think it helps if we can link this comment #52204 (comment) in the top of PR description or PROPOSAL link

hoangzinh · 2024-11-25T10:39:34Z

src/libs/actions/TeachersUnite.ts

@@ -48,6 +48,7 @@ function referTeachersUniteVolunteer(partnerUserID: string, firstName: string, l
            key: `${ONYXKEYS.COLLECTION.REPORT}${publicRoomReportID}`,
            value: {
                ...optimisticPublicRoom,
+                isOptimisticReport: false,


I am concerned about whether it works offline. Should we do the same for thread above? Set isOptimisticReport=false on successData

We can't do that. We need to trigger the openReport so we can get the existing messages on the room. Doing that means only the 2nd time we open the report will trigger the openReport.

@bernhardoj can you double-check if it works offline?

oh, the loading issue still happens in prod when offline so I think it's fine for DB fix PR

The chat list will show when you come back online, standard behavior.

hoangzinh · 2024-11-25T10:47:23Z

@bernhardoj could you also add recordings for other platforms?

bernhardoj · 2024-11-25T12:08:53Z

Done

shubham1206agra · 2024-11-25T12:22:43Z

src/libs/actions/IOU.ts

@@ -1550,6 +1550,7 @@ function buildOnyxDataForTrackExpense(
            value: {
                pendingFields: null,
                errorFields: null,
+                isOptimisticReport: false,


@puneetlath @TMisiukiewicz Just pinging here. I think this property should be inside reportMetadata key instead. What do you'll think?

This property isOptimisticReport exists in the other places so no need to hold merging on this

hmm yeah sounds like it could be possibly moved to reportMetadata. Tomorrow I'll do the migration and verify if everything works properly

That makes sense to me.

hoangzinh

LGTM

mountiny

Thanks!

mountiny · 2024-11-25T13:11:40Z

src/libs/actions/IOU.ts

@@ -1550,6 +1550,7 @@ function buildOnyxDataForTrackExpense(
            value: {
                pendingFields: null,
                errorFields: null,
+                isOptimisticReport: false,


This property isOptimisticReport exists in the other places so no need to hold merging on this

…t-set-correctly [CP Staging] Fix optimistic report status is not set correctly (cherry picked from commit 2b4ff21) (CP triggered by mountiny)

OSBotify · 2024-11-25T13:26:44Z

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

github-actions · 2024-11-25T14:01:04Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.66-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

github-actions · 2024-11-26T16:14:46Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.66-8 🚀

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

bernhardoj added 2 commits November 25, 2024 13:00

clear isOptimisticReport when success

3f4bf8a

don't set teachers room as optimistic report

a228530

bernhardoj requested a review from a team as a code owner November 25, 2024 05:05

melvin-bot bot requested a review from hoangzinh November 25, 2024 05:05

melvin-bot bot removed the request for review from a team November 25, 2024 05:05

clear isOptimisticReport when successfully created the report

fbfa19b

hoangzinh reviewed Nov 25, 2024

View reviewed changes

mountiny assigned bernhardoj Nov 25, 2024

mountiny changed the title ~~Fix optimistic report status is not set correctly~~ [CP Staging] Fix optimistic report status is not set correctly Nov 25, 2024

mountiny self-requested a review November 25, 2024 12:21

shubham1206agra reviewed Nov 25, 2024

View reviewed changes

hoangzinh approved these changes Nov 25, 2024

View reviewed changes

melvin-bot bot requested a review from aldo-expensify November 25, 2024 13:06

mountiny approved these changes Nov 25, 2024

View reviewed changes

mountiny merged commit 2b4ff21 into Expensify:main Nov 25, 2024
21 of 27 checks passed

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Nov 25, 2024

github-actions bot mentioned this pull request Nov 25, 2024

Deploy Checklist: New Expensify 2024-11-22 #52978

Closed

75 tasks

melvin-bot bot mentioned this pull request Nov 26, 2024

[HOLD for payment 2024-12-05] [HOLD for payment 2024-12-03] [$250] mweb/Chrome - Thread - Not here page when open multi level threads #52204

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix optimistic report status is not set correctly #53050

[CP Staging] Fix optimistic report status is not set correctly #53050

bernhardoj commented Nov 25, 2024 •

edited

Loading

melvin-bot bot commented Nov 25, 2024

hoangzinh commented Nov 25, 2024 •

edited

Loading

hoangzinh commented Nov 25, 2024

hoangzinh Nov 25, 2024

bernhardoj Nov 25, 2024

hoangzinh Nov 25, 2024

hoangzinh Nov 25, 2024

bernhardoj Nov 25, 2024

hoangzinh commented Nov 25, 2024 •

edited

Loading

bernhardoj commented Nov 25, 2024

shubham1206agra Nov 25, 2024

mountiny Nov 25, 2024

TMisiukiewicz Nov 25, 2024

puneetlath Nov 25, 2024

hoangzinh left a comment

mountiny left a comment

mountiny Nov 25, 2024

OSBotify commented Nov 25, 2024

github-actions bot commented Nov 25, 2024

github-actions bot commented Nov 26, 2024

[CP Staging] Fix optimistic report status is not set correctly #53050

[CP Staging] Fix optimistic report status is not set correctly #53050

Conversation

bernhardoj commented Nov 25, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 25, 2024

hoangzinh commented Nov 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh commented Nov 25, 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

Choose a reason for hiding this comment

hoangzinh commented Nov 25, 2024 • edited Loading

bernhardoj commented Nov 25, 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

hoangzinh left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 25, 2024

github-actions bot commented Nov 25, 2024

github-actions bot commented Nov 26, 2024

bernhardoj commented Nov 25, 2024 •

edited

Loading

hoangzinh commented Nov 25, 2024 •

edited

Loading

hoangzinh commented Nov 25, 2024 •

edited

Loading