fix: loading indicator display when deleting vague distance Expense #51940

truph01 · 2024-11-04T07:36:29Z

Explanation of Change

Fixed Issues

$ #50022
PROPOSAL: #50022 (comment)

Tests

Click on Global Create > 'Submit Expense'.
Select the 'Distance' option.
Disable the internet connection.
Enter a vague start location using random characters.
Enter a vague end location using random characters.
Complete the expense submission flow.
Enable the internet connection.
Open the distance expense report.
Click on the close icon of the displayed error message.
Verify that the app navigates back to the workspace IOU report without displaying any intermediate screens such as a loading screen or a "Hmm it's not here".
Verify that the vague distance expense is deleted.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-04.at.14.26.42.mov

Android: mWeb Chrome

Screen.Recording.2024-11-04.at.14.32.46.mov

iOS: Native

Screen.Recording.2024-11-04.at.14.22.59.mov

iOS: mWeb Safari

Screen.Recording.2024-11-04.at.14.11.48.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-04.at.14.16.47.mov

MacOS: Desktop

Screen.Recording.2024-11-04.at.14.24.02.mov

melvin-bot · 2024-11-04T07:36:34Z

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

rayane-djouah

Tests are failing, but I think this is unrelated to this PR. Could you please merge the main branch?

rayane-djouah

Please clarify the tests as follows:


1. Click on Global Create > 'Submit Expense'.
2. Select the 'Distance' option.
3. Disable the internet connection.
4. Enter a vague start location using random characters.
5. Enter a vague end location using random characters.
6. Complete the expense submission flow.
7. Enable the internet connection.
8. Open the distance expense report.
9. Click on the close icon of the displayed error message.
10. Verify that the app navigates back to the workspace IOU report without displaying any intermediate screens such as a loading screen or a "Hmm it's not here".
11. Verify that the vague distance expense is deleted.

For the "QA Steps", please write "Same as tests" as required here:

App/.github/PULL_REQUEST_TEMPLATE.md

Lines 55 to 57 in 8fc023f

    
           It's acceptable to write "Same as tests" if the QA team is able to run the tests in the above "Tests" section. 
        
           ---> 
        
           // TODO: These must be filled out, or the issue title must include "[No QA]."

rayane-djouah · 2024-11-06T11:57:37Z

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-06.at.12.52.48.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-06.at.12.50.27.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-06.at.13.00.47.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-11-06.at.12.54.34.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-11-06.at.12.45.21.PM.mov

MacOS: Desktop

Screen.Recording.2024-11-06.at.12.46.20.PM.mov

truph01 · 2024-11-07T02:43:18Z

@rayane-djouah I updated the PR based on your suggestion

rayane-djouah

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.

truph01 · 2024-11-07T19:37:53Z

@rayane-djouah @flodnv After we click on "x" button, the report preview is displayed for a while before it is removed. Do we treat it as a regression:

Screen.Recording.2024-11-04.at.14.26.42.mov

rayane-djouah · 2024-11-09T19:53:13Z

src/components/ReportActionItem/MoneyRequestView.tsx

+                                    InteractionManager.runAfterInteractions(() => {
+                                        IOU.cleanUpMoneyRequest(transaction?.transactionID ?? linkedTransactionID, parentReportAction, true);
+                                    });


@rayane-djouah @flodnv After we click on "x" button, the report preview is displayed for a while before it is removed. Do we treat it as a regression

I believe it's not necessary to wait for all interactions to complete in this case. We can modify the behavior so that the report preview is removed immediately:

Screen.Recording.2024-11-09.at.8.48.54.PM.mov

Suggested change

InteractionManager.runAfterInteractions(() => {

IOU.cleanUpMoneyRequest(transaction?.transactionID ?? linkedTransactionID, parentReportAction, true);

});

IOU.cleanUpMoneyRequest(transaction?.transactionID ?? linkedTransactionID, parentReportAction, true);

@rayane-djouah I applied your fix, so the original bug is still appeared:

Screen.Recording.2024-11-11.at.11.51.05.mov

@rayane-djouah In my opinion, in the proposed solution here, we prioritize navigation over updating Onyx data. As a result, there's a case where the user navigates successfully, but the Onyx data hasn't yet updated. This makes the behavior noted here an acceptable outcome. cc @flodnv

I'm a bit confused -- it seems like we should optimistically set the onyx data, which ensures that it's in an expected state before we navigate, no?

it seems like we should optimistically set the onyx data, which ensures that it's in an expected state before we navigate, no?

@flodnv This decision depends on our priorities, as each approach has its trade-offs:

Optimistically setting Onyx data before navigating: While this ensures the data is in the expected state before navigating, it reintroduces the bug we're currently addressing.

Navigating without waiting for Onyx data to update (current PR's approach): This approach resolves the bug but introduces a potential behavioral issue.

I tried a few solutions but there is no way to both:

optimistically set the onyx data

don't display the loading indicator.

Each approach has its own trade-offs, as outlined here. In other parts of the NewDot app, we sometimes use the first approach and other times the second.

So if we want to follow the 1st approach, we just need to close this PR. What do you think @rayane-djouah
@flodnv?

@truph01 I think a potential solution would involve:

Cleaning up the transaction preview report action.

Navigating back to the IOU report.

Cleaning up the remaining money request data afterward.

This approach assumes that the root cause of the loading indicator bug is the transaction thread data being cleared before navigation.

Could you try implementing this approach?

Thanks @rayane-djouah. I am trying your approach

@truph01 Could you please share an update?

truph01 · 2024-12-03T03:50:04Z

@rayane-djouah I updated PR to fix issue:

Web:

Screen.Recording.2024-12-03.at.10.44.33.mov

Native:

Screen.Recording.2024-12-03.at.10.45.56.mov

rayane-djouah · 2024-12-04T22:50:26Z

src/components/ReportActionItem/MoneyRequestView.tsx

+                                    if (isWeb) {
+                                        Navigation.goBack(urlToNavigateBack);
+                                    }
+                                    InteractionManager.runAfterInteractions(() => {
+                                        if (!isWeb) {
+                                            Navigation.goBack(urlToNavigateBack);
+                                        }


@truph01 Is there any specific reason for handling web differently?

During testing, I noticed differences in processing speed in Onyx and navigation between web versus native platforms. Therefore, I need to account for the specific platform in this case.

rayane-djouah · 2024-12-04T23:01:03Z

src/libs/actions/IOU.ts

 * @return the url to navigate back once the money request is deleted
 */
-function cleanUpMoneyRequest(transactionID: string, reportAction: OnyxTypes.ReportAction, isSingleTransactionView = false) {
+function cleanUpMoneyRequest(transactionID: string, reportAction: OnyxTypes.ReportAction, isSingleTransactionView = false, onlyCleanupActions = false) {


Instead of calling cleanUpMoneyRequest twice with onlyCleanupActions toggled between true and false, it would be more efficient to manage the Onyx updates within a single invocation of cleanUpMoneyRequest. The method should first prepare and apply updates relevant to report actions using Onyx.update(onyxReportActionsUpdates). After navigating back with Navigation.goBack(urlToNavigateBack);, it should then prepare and apply the remaining updates with Onyx.update(onyxRemainingUpdates). This change eliminates the need for cleanUpMoneyRequest to return urlToNavigateBack, as navigation can be handled directly after the initial Onyx update, simplifying the flow and enhancing readability. A comment should be added within the code to clarify the sequence of operations.

truph01 · 2024-12-06T02:59:02Z

@rayane-djouah I applied your suggestion. Here is result:

Screen.Recording.2024-12-06.at.09.56.07.mov

Screen.Recording.2024-12-06.at.09.49.43.mov

src/libs/actions/IOU.ts

truph01 · 2024-12-10T02:09:50Z

@rayane-djouah I updated PR

rayane-djouah · 2024-12-10T11:20:31Z

Screenshots/Videos

Android: Native

Screen.Recording.2024-12-10.at.12.20.06.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-12-10.at.12.15.20.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-10.at.12.16.59.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-12-10.at.12.11.55.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-12-10.at.12.06.18.PM.mov

MacOS: Desktop

Screen.Recording.2024-12-10.at.12.08.00.PM.mov

rayane-djouah · 2024-12-10T11:27:26Z

@flodnv all yours!

fix: loading indicator display when deleting vague distance Expense

1fff908

truph01 requested a review from a team as a code owner November 4, 2024 07:36

melvin-bot bot requested review from rayane-djouah and removed request for a team November 4, 2024 07:36

truph01 mentioned this pull request Nov 4, 2024

[$250] mWeb - Submit expense- "Hmm it's not here" message gets visible when deleting vague distance Expense #50022

Open

6 tasks

rayane-djouah suggested changes Nov 5, 2024

View reviewed changes

merge main

41f25da

rayane-djouah approved these changes Nov 7, 2024

View reviewed changes

melvin-bot bot requested a review from flodnv November 7, 2024 11:34

rayane-djouah suggested changes Nov 9, 2024

View reviewed changes

truph01 added 9 commits November 11, 2024 11:42

merge main

0fab945

remove InteractionManager.runAfterInteractions

fcf7f3f

fix: remove unused lib

65b343b

fix: revert remove InteractionManager.runAfterInteractions

10fb70b

merge main

3ac6241

merge main

38b088c

fix: clear action first then navigate back then clear rest

d332cb7

fix: add isWeb logic

12a0a68

fix: revert unused change

70fb37d

truph01 added 2 commits December 3, 2024 10:51

fix: lint

173a51e

fix: lint

8353a82

rayane-djouah reviewed Dec 4, 2024

View reviewed changes

rayane-djouah suggested changes Dec 4, 2024

View reviewed changes

merge main

3ecf918

truph01 added 3 commits December 6, 2024 09:34

fix: move all update logic to cleanUpMoneyRequest

a90580a

fix: lint

d71f1eb

fix: use promise

4149884

truph01 added 2 commits December 6, 2024 09:59

fix: lint

5117bec

fix: remove param

9d570a1

rayane-djouah suggested changes Dec 6, 2024

View reviewed changes

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

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

truph01 added 2 commits December 9, 2024 16:09

merge main

cc1ef7f

fix: remove variable and remove unused export

f104ffd

rayane-djouah approved these changes Dec 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: loading indicator display when deleting vague distance Expense #51940

fix: loading indicator display when deleting vague distance Expense #51940

truph01 commented Nov 4, 2024 •

edited

Loading

melvin-bot bot commented Nov 4, 2024

rayane-djouah left a comment

rayane-djouah left a comment •

edited

Loading

rayane-djouah commented Nov 6, 2024 •

edited

Loading

truph01 commented Nov 7, 2024

rayane-djouah left a comment

truph01 commented Nov 7, 2024

rayane-djouah Nov 9, 2024

truph01 Nov 11, 2024

truph01 Nov 11, 2024

flodnv Nov 11, 2024

truph01 Nov 12, 2024

truph01 Nov 25, 2024

truph01 Nov 25, 2024

rayane-djouah Nov 29, 2024 •

edited

Loading

truph01 Dec 1, 2024

rayane-djouah Dec 2, 2024

truph01 commented Dec 3, 2024

rayane-djouah Dec 4, 2024

truph01 Dec 6, 2024

rayane-djouah Dec 4, 2024

truph01 commented Dec 6, 2024

truph01 commented Dec 10, 2024

rayane-djouah commented Dec 10, 2024

rayane-djouah commented Dec 10, 2024

	It's acceptable to write "Same as tests" if the QA team is able to run the tests in the above "Tests" section.
	--->
	// TODO: These must be filled out, or the issue title must include "[No QA]."

fix: loading indicator display when deleting vague distance Expense #51940

Are you sure you want to change the base?

fix: loading indicator display when deleting vague distance Expense #51940

Conversation

truph01 commented Nov 4, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 4, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

rayane-djouah left a comment • edited Loading

Choose a reason for hiding this comment

rayane-djouah commented Nov 6, 2024 • edited Loading

Screenshots/Videos

truph01 commented Nov 7, 2024

rayane-djouah left a comment

Choose a reason for hiding this comment

Reviewer Checklist

truph01 commented Nov 7, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rayane-djouah Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

truph01 commented Dec 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

truph01 commented Dec 6, 2024

truph01 commented Dec 10, 2024

rayane-djouah commented Dec 10, 2024

Screenshots/Videos

rayane-djouah commented Dec 10, 2024

truph01 commented Nov 4, 2024 •

edited

Loading

rayane-djouah left a comment •

edited

Loading

rayane-djouah commented Nov 6, 2024 •

edited

Loading

rayane-djouah Nov 29, 2024 •

edited

Loading