Fix: Distance - Unable to save distance when Start and Stop waypoints are valid address

[wildan-m]

Explanation of Change

This PR fixes route validation for offline modifications with waypoint errors.

Fixed Issues

$ #48401
PROPOSAL: #48401 (comment)

Tests

1. Open App
2. Go to workspace/1:1 chat.
3. Submit a distance expense.
4. Go to transaction thread.
5. Go offline.
6. Click Distance.
7. Change both Start and Stop waypoints to invalid address ( use random strings).
8. Save it.
9. Go online.
10. Click on the header subtitle to return to main chat.
11. Click on the expense preview.
12. Click Distance.
13. Note that the waypoints are valid addresses (from Step 3).
14. Click Save.
15. Verify that the distance will be saved because Start and Stop waypoints are valid.

• Verify that no errors appear in the JS console

Offline tests

Same as test

QA Steps

Same as test

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

Kapture.2024-11-19.at.09.54.25.mp4

Kapture.2024-11-19.at.09.56.24.mp4

Android: mWeb Chrome

Kapture.2024-11-19.at.10.32.22.mp4

Kapture.2024-11-19.at.10.34.22.mp4

iOS: Native

Kapture.2024-11-19.at.09.26.15.mp4

Kapture.2024-11-19.at.09.30.15.mp4

iOS: mWeb Safari

Kapture.2024-11-19.at.09.44.19.mp4

Kapture.2024-11-19.at.09.46.59.mp4

MacOS: Chrome / Safari

Kapture.2024-11-19.at.09.15.10.mp4

Kapture.2024-11-19.at.09.21.47.mp4

MacOS: Desktop

Kapture.2024-11-19.at.10.01.31.mp4

Kapture.2024-11-19.at.10.03.12.mp4

[melvin-bot]

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

[sobitneupane]

Screenshots/Videos

Android: Native

iOS: Native

Screen.Recording.2024-11-20.at.19.08.01.mov

Screen.Recording.2024-11-20.at.19.09.38.mov

iOS: mWeb Safari

Screen.Recording.2024-11-20.at.19.21.35.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-20.at.18.43.53.mov

Screen.Recording.2024-11-20.at.18.51.10.mov

MacOS: Desktop

Screen.Recording.2024-11-20.at.19.24.41.mov

[sobitneupane]

@wildan-m I can still reproduce the error in offline mode. Even though, valid waypoints are shown, waypoint error is shown.

Screen.Recording.2024-11-20.at.19.37.21.mov

[sobitneupane]

The other issue is even when error is shown, user is allowed to save the waypoints when offline.

Screen.Recording.2024-11-20.at.19.24.41.mov

[wildan-m]

@sobitneupane Thank you for the feedback. I couldn't address the offline issues with the current solution, but I believe I have a better solution now.

This new solution will clear the distanceErrors as soon as server restore the waypoints to their previous correct values

Please check this new Alternative 2 solution #48401 (comment)

Branch for that new solution

What do you think?

[sobitneupane]

Thanks for the update @wildan-m

I have not tested your solution yet, but my initial thought is that it would be more efficient to clear the error when we open the MoneyRequestView page, if required, rather than iterating on each update.

[wildan-m]

@sobitneupane any suggestion to improve current solution? I couldn't figured out one yet for the offline case, because there is no way we can server validate the transaction and transactionBackup while it's offline. IMO that x button in the moneyrequest view should be sufficient to handle that case

[wildan-m]

Or we might also need to provide x button in the distance editor?

[wildan-m]

@sobitneupane Hi, I've got an idea, while offline we can clear the error if all of the routes is a server validate route

useFetchRoute

    useEffect(() => {
        if(isOffline && hasRouteError && isDistanceRequest && isInitialMount){
            const waypointValues = Object.values(waypoints || {});
            const allWaypointsServerValidated = waypointValues.every(waypoint => waypoint.lat !== 0 && waypoint.lng !== 0 && waypoint.name);

            if (allWaypointsServerValidated) {
                TransactionAction.clearError(transaction.transactionID);
            }
            return;
        }

        if (isOffline || !shouldFetchRoute || !transaction?.transactionID) {
            return;
        }

        TransactionAction.getRoute(transaction.transactionID, validatedWaypoints, transactionState);
        setIsInitialMount(false);
    }, [shouldFetchRoute, transaction?.transactionID, validatedWaypoints, isOffline, action, transactionState]);

Note

This will also clear error related to route exceeded when offline, we can't validate the route when offline even when all of the waypoints are valid address.

Testing it..., please let me know if you have any concerns

[wildan-m]

@sobitneupane I think it's working. The PR has been updated

[wildan-m]

@sobitneupane additional update: we should also modify clearError to accept transactionState so the error message won't reappear when navigating back without saving in the distance editor.

function clearError(transactionID: string, transactionState: TransactionState = CONST.TRANSACTION.STATE.CURRENT) {
    let keyPrefix;
    switch (transactionState) {
        case CONST.TRANSACTION.STATE.DRAFT:
            keyPrefix = ONYXKEYS.COLLECTION.TRANSACTION_DRAFT;
            break;
        case CONST.TRANSACTION.STATE.BACKUP:
            keyPrefix = ONYXKEYS.COLLECTION.TRANSACTION_BACKUP;
            break;
        case CONST.TRANSACTION.STATE.CURRENT:
        default:
            keyPrefix = ONYXKEYS.COLLECTION.TRANSACTION;
            break;
    }

    Onyx.merge(`${keyPrefix}${transactionID}`, {errors: null, errorFields: {route: null}});
}

[sobitneupane]

Thanks for the update @wildan-m

I am not sure if we are heading in the right direction. I believe we can have a solution much simpler than this. I will let you know once I thoroughly go through it.

[sobitneupane]

additional update: we should also modify clearError to accept transactionState so the error message won't reappear when navigating back without saving in the distance editor.

@wildan-m Can you please explain this change? Why do we need it and what are we trying to achieve?

[sobitneupane]

Instead of making change in useFetchRoute, should we make the required change in IOURequestStepDistance?

useEffect(() => {
        if (!hasRouteError || !hasRoute) {
            return;
        }
    
        TransactionAction.clearError(transaction?.transactionID);
    }, []);

[wildan-m]

Instead of making change in useFetchRoute, should we make the required change in IOURequestStepDistance?

useEffect(() => {
        if (!hasRouteError || !hasRoute) {
            return;
        }
    
        TransactionAction.clearError(transaction?.transactionID);
    }, []);

@sobitneupane will this code remove error messages even when there is invalid waypoints?

Or did you mean to extract this change to IOURequestStepDistance?

[wildan-m]

@wildan-m Can you please explain #52736 (comment)? Why do we need it and what are we trying to achieve?

When we open waypoint editor, the transaction backup will be created. When a backup created it will also clone the errors.

If we tap back button without saving the editor, this transaction backup will be restored, including its error message.

If we apply this change without modifying clearError, we only clear the error from main transaction onyx data ONYXKEYS.COLLECTION.TRANSACTION without clearing the error message in the backup. That will make the error message re-shown if we tap back button without saving the waypoint editor, so we have to clear errors from both keys, main transaction ONYXKEYS.COLLECTION.TRANSACTION and its backup ONYXKEYS.COLLECTION.TRANSACTION_BACKUP