App icon indicating copy to clipboard operation
App copied to clipboard
verified publisher icon Expensify

Fix - Distance-Distance field is stuck on pending... and no error shown when updating of waypoints fails

Open FitseTLT opened this issue 1 year ago • 17 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/52248 PROPOSAL: https://github.com/Expensify/App/issues/52248#issuecomment-2492563418

Tests

Precondition: you need to test by making the update distance request to fail. You can enable Troubleshoot > Simulate failing networks

  1. Create a distance expense
  2. Open the request details page
  3. Press on distance and change the waypoints by either adding a waypoint or dragging and reshuffling the waypoints
  4. Verify that the waypoints are reverted to the original value and dismissable error is shown below the map
  • [x] Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

https://github.com/user-attachments/assets/fe7af4f6-1efd-4fb1-8dc8-fd97c2d02714

Android: mWeb Chrome

https://github.com/user-attachments/assets/5a359833-705c-4777-88e7-322ff3c5e52f

iOS: Native

https://github.com/user-attachments/assets/1fe662b1-46a7-4393-a161-005365aaffe8

iOS: mWeb Safari

https://github.com/user-attachments/assets/f59713c5-0db1-42f6-992d-2fec678c4e61

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/f62f0229-5da8-421e-9de6-749f8bef62f0

MacOS: Desktop

https://github.com/user-attachments/assets/0281318d-773a-44b9-886e-8c746cf97e7c

FitseTLT avatar Nov 29 '24 23:11 FitseTLT

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

melvin-bot[bot] avatar Nov 29 '24 23:11 melvin-bot[bot]

BTW @hoangzinh simulate failing networks is not reliable. It makes the request fail immediately and the values will be reverted and error displayed but after a while it sends the request and the change will be pushed from the BE. You can easily test by passing wrong params here https://github.com/Expensify/App/blob/10a75ac289e2926ee01da1fdbbb2f3dbe1cc376d/src/libs/actions/IOU.ts#L3229 but I am more concerned for QA because they can't alter the code so if you have a better QA testing steps please forward it 👍 And also what do you think about showing the pending map view when there is waypoints error? Now even on error we are showing the map if the coordinates are fetched and available from the BE.

FitseTLT avatar Nov 29 '24 23:11 FitseTLT

what do you think about showing the pending map view when there is waypoints error

Sorry for leaving for a while. @FitseTLT, I recall when there is waypoints error, we revert backs to previous waypoints. It makes sense to keep the previous map, doesn't it?

hoangzinh avatar Dec 03 '24 10:12 hoangzinh

what do you think about showing the pending map view when there is waypoints error

Sorry for leaving for a while. @FitseTLT, I recall when there is waypoints error, we revert backs to previous waypoints. It makes sense to keep the previous map, doesn't it?

We currently have two ways to show the map:

  1. Map image file returned from BE
  2. Via Mapbox map component using the route.coordinates and we show it when we have pending waypoints or there are errors https://github.com/Expensify/App/blob/b818d541098933d910be22a4853d380128b6e057/src/components/ReportActionItem/ReportActionItemImage.tsx#L88 so now in our case the error happened due to failing requests and when you go back online and there are no coordinates it will show the pending map view and when you open the distance page it automatically fetches the coordinates and populates the transaction so the map will appear in money request view. WDYT about this behaviour of the map appearing and disappearing like in the video

https://github.com/user-attachments/assets/0143a49a-6d7a-4036-9e37-69a1772cd107

FitseTLT avatar Dec 03 '24 16:12 FitseTLT

I see @FitseTLT. At first glance, I think we should avoid it. But let me take a look deeper

hoangzinh avatar Dec 04 '24 10:12 hoangzinh

It seems the current behavior in Prod. Hmm, I think we can leave it as it is because it can be an expected behavior.

https://github.com/user-attachments/assets/eac97c93-089b-4d08-a484-a01963d00f66

hoangzinh avatar Dec 04 '24 11:12 hoangzinh

Ok no problem 👍 @hoangzinh

FitseTLT avatar Dec 04 '24 13:12 FitseTLT

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • [x] 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.
  • [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/83b23645-5664-49a3-ba1d-db7870253e7d

Android: mWeb Chrome

https://github.com/user-attachments/assets/fe58659f-af9d-4ef3-9e8b-d7ab730fbf7b

iOS: Native

https://github.com/user-attachments/assets/c406eb1d-25a7-4935-8277-6b1545d17364

iOS: mWeb Safari

https://github.com/user-attachments/assets/6ab6f7a4-8dcb-416d-8874-e506c54b6dbe

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/3c86bedf-5b3a-479e-978c-1b8b88c21aab

MacOS: Desktop

https://github.com/user-attachments/assets/85dc32ff-2230-48df-8a60-66119a38b7e0

hoangzinh avatar Dec 04 '24 13:12 hoangzinh

@FitseTLT it seems the distance unit doesn't be reset if API is failed

https://github.com/user-attachments/assets/51ea370d-717a-438e-8b95-0ee1fdaeaa88

hoangzinh avatar Dec 05 '24 10:12 hoangzinh

@FitseTLT it seems the distance unit doesn't be reset if API is failed

Screen.Recording.2024-12-05.at.17.25.47.mov

Fixed @hoangzinh

FitseTLT avatar Dec 05 '24 16:12 FitseTLT

Looks good @FitseTLT. I will try to complete checklist today

hoangzinh avatar Dec 09 '24 15:12 hoangzinh

BTW @hoangzinh simulate failing networks is not reliable. It makes the request fail immediately and the values will be reverted and error displayed but after a while it sends the request and the change will be pushed from the BE.

@FitseTLT, turn on both "Force offline" and "Simulate failing network requests" work to me. Wdyt if the testing steps here is:

  1. Create a distance expense
  2. Open the request details page
  3. Open Testing preferences and turn on "Force offline" and "Simulate failing network requests"
  4. Press on distance menu and change the waypoints by either adding a waypoint or dragging and reshuffling the waypoints
  5. Click Save button
  6. Open Testing preferences and turn off "Force offline"
  7. Go to the request details page
  8. Verify that after a while, it shows "Unexpected error editing this expense" and the waypoints are reverted to the previous value
  9. Verify that there is a dismissable error shown below the map

hoangzinh avatar Dec 09 '24 16:12 hoangzinh

BTW @hoangzinh simulate failing networks is not reliable. It makes the request fail immediately and the values will be reverted and error displayed but after a while it sends the request and the change will be pushed from the BE.

@FitseTLT, turn on both "Force offline" and "Simulate failing network requests" work to me. Wdyt if the testing steps here is:

  1. Create a distance expense
  2. Open the request details page
  3. Open Testing preferences and turn on "Force offline" and "Simulate failing network requests"
  4. Press on distance menu and change the waypoints by either adding a waypoint or dragging and reshuffling the waypoints
  5. Click Save button
  6. Open Testing preferences and turn off "Force offline"
  7. Go to the request details page
  8. Verify that after a while, it shows "Unexpected error editing this expense" and the waypoints are reverted to the previous value
  9. Verify that there is a dismissable error shown below the map

@hoangzinh The problem is after the data is reverted, error shown and so on, a bit later you will see the changes applied (even after clearing cache to prove that the BE request was really executed) by the way I have seen that our simulate failing network has the same problem in other requests too. So I am only worried that the QA would interpret this as the PR is failing.

FitseTLT avatar Dec 09 '24 16:12 FitseTLT

a bit later you will see the changes applied (even after clearing cache to prove that the BE request was really executed)

Hi @FitseTLT do you have any recordings/screenshots to illustrate what you mean here? I tried to reproduce it but I couldn't.

hoangzinh avatar Dec 10 '24 09:12 hoangzinh

a bit later you will see the changes applied (even after clearing cache to prove that the BE request was really executed)

Hi @FitseTLT do you have any recordings/screenshots to illustrate what you mean here? I tried to reproduce it but I couldn't.

Here it is @hoangzinh the request gets sent after the error occurred and values reverted when I turn off the simulate option 2024-12-10 16-20-29.mp4.zip But because the request is sent after turning off the simulate failing ntwk option we can be good to go 👍

FitseTLT avatar Dec 10 '24 13:12 FitseTLT

we can be good to go 👍

@FitseTLT do you mean we can use those steps for QA steps?

hoangzinh avatar Dec 10 '24 22:12 hoangzinh

we can be good to go 👍

@FitseTLT do you mean we can use those steps for QA steps?

Yeah I think we shouldn't worry too much after all it not related with the current PR 👍

FitseTLT avatar Dec 10 '24 23:12 FitseTLT

Can you update it into QA steps? So they can test this PR on staging

hoangzinh avatar Dec 11 '24 06:12 hoangzinh

@hoangzinh Updated 👍

FitseTLT avatar Dec 11 '24 11:12 FitseTLT

@hoangzinh I think I have got better steps in https://github.com/Expensify/App/issues/54023 ? Wouldn't it be better for QA steps. WDYT

FitseTLT avatar Dec 12 '24 11:12 FitseTLT

Looks good to me.

https://github.com/user-attachments/assets/7be719c9-f9dd-4a69-95bb-e06d3aa76251

hoangzinh avatar Dec 12 '24 15:12 hoangzinh

Yep added it to the QA steps @pecanoro You can proceed with the review 👍

FitseTLT avatar Dec 12 '24 15:12 FitseTLT

:hand: 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 avatar Dec 12 '24 17:12 OSBotify

🚀 Deployed to staging by https://github.com/pecanoro in version: 9.0.76-0 🚀

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

github-actions[bot] avatar Dec 13 '24 16:12 github-actions[bot]

🚀 Deployed to production by https://github.com/grgia in version: 9.0.76-12 🚀

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

github-actions[bot] avatar Dec 18 '24 13:12 github-actions[bot]