Restore transaction when not saving distance in edit page

[dukenv0307]

Details

Restore transaction when not saving distance in edit page

Fixed Issues

$ #31816
PROPOSAL: #31816 (comment)

Tests

• New distance request flow

1. Go to FAB > Request money > Distance
2. Enter valid addresses and go to the next step
3. Choose any workspace and go to comfirm page
4. Click on Distance option to edit
5. Add a stop address that is very far from start and finish address
6. After the error appears, click on back button
7. Verify that the distance is revert to the previous distance

• Edit distance request flow

1. Create a distance
2. Go to transaction thread report
3. Click on distance to open the edit distance page
4. Edit or add an extra stop address
5. Save the distance
6. Verify that the distance is saved successfully
7. Report steps 3-4 one more time
8. Close the edit distance page without saving
9. Verify that the distance is restored

• Verify that no errors appear in the JS console

Offline tests

None

QA Steps

• New distance request flow

1. Go to FAB > Request money > Distance
2. Enter valid addresses and go to the next step
3. Choose any workspace and go to comfirm page
4. Click on Distance option to edit
5. Add a stop address that is very far from start and finish address
6. After the error appears, click on back button
7. Verify that the distance is revert to the previous distance

• Edit distance request flow

1. Create a distance
2. Go to transaction thread report
3. Click on distance to open the edit distance page
4. Edit or add an extra stop address
5. Save the distance
6. Verify that the distance is saved successfully
7. Report steps 3-4 one more time
8. Close the edit distance page without saving
9. Verify that the distance is restored

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

Screenshots/Videos

Android: Native

• New distance request flow

android-1.mov

• Edit distance request flow

android-1.mov

Android: mWeb Chrome

• New distance request flow

Screen.Recording.2023-12-01.at.15.27.35.mov

• Edit distance request flow

chrome-1.mov

iOS: Native

• New distance request flow

Screen.Recording.2023-12-01.at.15.34.41.mov

• Edit distance request flow

ios-1.mov

iOS: mWeb Safari

• New distance request flow

Screen.Recording.2023-12-01.at.15.29.11.mov

• Edit distance request flow

safari-1.mov

MacOS: Chrome / Safari

• New distance request flow

web-1.mov

• Edit distance request flow

web-1.mov

MacOS: Desktop

• New distance request flow

Screen.Recording.2023-12-01.at.15.37.09.mov

• Edit distance request flow

desktop-1.mov

[melvin-bot]

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

[dukenv0307]

@hoangzinh Updated.

[hoangzinh]

Revert transaction when not saving distance in edit page

@dukenv0307 the text "revert" in the title is scary. It usually means revert a PR or something. Can we change it to "Restore original transaction when..."

[dukenv0307]

Make sense.

[hoangzinh]

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

Android: Native

Screen.Recording.2023-12-04.at.20.54.48.android.mp4

Android: mWeb Chrome

Screen.Recording.2023-12-04.at.20.34.51.-.android.chrome.mov

iOS: Native

Screen.Recording.2023-12-04.at.20.30.36.-.ios.mp4

iOS: mWeb Safari

Screen.Recording.2023-12-04.at.20.32.43.-.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-04.at.20.22.41.-.web.mp4

MacOS: Desktop

Screen.Recording.2023-12-04.at.20.28.47.-.desktop.mp4

[hoangzinh]

LGTM 👍

[neil-marcellini]

Looks pretty good, but I have some questions. Could you pleas also test the distance edit flow after creation to make sure there are no regressions?

[neil-marcellini]

I don't understand this change, would you please explain it and include a comment in the code?

[dukenv0307]

@neil-marcellini We add isEditingNewRequest prop in NewDistanceRequestPage to centralize the onSubmit logic on this page so we replace all isEditing with isEditingNewRequest.

[neil-marcellini]

Ok yes I understand isEditingNewRequest is true when we click the distance field from the confirmation screen while creating a new request. This condition is deciding whether to return only content, or to wrap it with a screen wrapper and header. We don't need the header for the new distance request page, nor for the editing request page, but we are missing a header when editing a new distance request with the current change 😕

[neil-marcellini]

@dukenv0307 please fix this bug

[dukenv0307]

@neil-marcellini Not see any header is missing from my testing.

web21.mov

[dukenv0307]

@neil-marcellini I tested the edit flow locally before creating the PR. Should we add the test step for edit flow here?

[neil-marcellini]

@neil-marcellini I tested the edit flow locally before creating the PR. Should we add the test step for edit flow here?

Yes please. We should test flows that might break in relation to our changes, and editing an existing distance request could certainly be effected.

[neil-marcellini]

Thanks for the updates. Looks like we need a few more changes. I also found a bug. Please test all related flows with test steps and videos.

[dukenv0307]

@neil-marcellini Can you share the bug which you found?

[neil-marcellini]

@neil-marcellini Can you share the bug which you found?

#32334 (comment)

[dukenv0307]

@neil-marcellini Updated test steps and videos.

[neil-marcellini]

Ok I tested again and it's working great 🚀

new-edit-1080.mov

existing-edit-1080.mov

existing-edit-1080.mov

[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/neil-marcellini in version: 1.4.11-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.11-25 🚀

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