fix: sort valid waypoints #26705

allroundexperts · 2023-09-04T18:46:09Z

Details

This PR adds sorting logic to the validate waypoint function.

Fixed Issues

$ #26583
PROPOSAL: #26583 (comment)

Tests

Click on the + icon in the LHN.
Select "Request money" and then choose "Distance".

Case 1

Select the starting and finishing points
Click on "Add stop". Don't save an address for this new waypoint/stop.
Proceed by clicking the "Next" button.

Verify that the route is shown correctly.

Case 2

Select the starting and finishing points that are across continents.

Verify that an error occurs and the next button is disabled.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Click on the + icon in the LHN.
Select "Request money" and then choose "Distance".

Case 1

Select the starting and finishing points
Click on "Add stop". Don't save an address for this new waypoint/stop.
Proceed by clicking the "Next" button.

Verify that the route is shown correctly.

Case 2

Select the starting and finishing points that are across continents.

Verify that an error occurs and the next button is disabled.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-09-05.at.2.22.36.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-05.at.2.37.31.PM.mov

Mobile Web - Safari

Screen.Recording.2023-09-05.at.2.47.10.PM.mov

Desktop

Screen.Recording.2023-09-05.at.2.24.13.PM.mov

iOS

Screen.Recording.2023-09-05.at.2.42.37.PM.mov

Android

Screen.Recording.2023-09-05.at.2.41.45.PM.mov

melvin-bot · 2023-09-04T18:46:14Z

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

allroundexperts · 2023-09-04T18:54:49Z

Blocked on screenshots because of this

hayata-suenaga · 2023-09-05T03:30:34Z

@allroundexperts @situchan could you resume the work on this please?

situchan · 2023-09-05T03:31:19Z

Waiting for @allroundexperts to complete checklist

situchan · 2023-09-05T03:39:05Z

Please also add error case in QA step

allroundexperts · 2023-09-05T09:57:42Z

Checklist complete!

allroundexperts · 2023-09-05T09:59:07Z

@hayata-suenaga @situchan I've also disabled the next button when the user is offline. This is because some errors are not available until we get a response from the getRoute API. Let me know if we don't want to do that.

allroundexperts · 2023-09-05T09:59:52Z

Probably, another follow up polish item we can do is to disable the next button when the getRoute api call is loading.

situchan · 2023-09-05T12:40:12Z

disabled the next button when the user is offline

@hayata-suenaga please confirm if you also 👍

trjExpensify · 2023-09-05T12:50:27Z

@hayata-suenaga @situchan I've also disabled the next button when the user is offline. This is because some errors are not available until we get a response from the getRoute API. Let me know if we don't want to do that.

@allroundexperts on this are you following the offline pattern c, with the offline indicator beneath the disabled button?

allroundexperts · 2023-09-05T13:20:33Z

@hayata-suenaga @situchan I've also disabled the next button when the user is offline. This is because some errors are not available until we get a response from the getRoute API. Let me know if we don't want to do that.

@allroundexperts on this are you following the offline pattern c, with the offline indicator beneath the disabled button?

That already shows up!

trjExpensify · 2023-09-05T13:58:59Z

Cool, so if you can't submit the form because of an API call that's required then a disabled confirmation button with the offline indicator underneath it is correct in the realm of pattern C.

@neil-marcellini @hayata-suenaga I am curious though, I thought it was designed to be able to do the entire distance request flow offline using pattern B.

hayata-suenaga · 2023-09-05T15:34:51Z

@neil-marcellini @hayata-suenaga I am curious though, I thought it was designed to be able to do the entire distance request flow offline using pattern B.

We cannot correctly calculate the distance request amount without API call. So, I'd say we need to use Pattern C for this.

Let me quickly check with the Wave 5 team to confirm

Memo

What is being discussed: On the Distance Request page, whether to disable the "Continue" button when offline
Reason -> We fetch the route on the page when more than two waypoints are added. When offline, we cannot do that. This means that we cannot check if a route can be fetched or not (i.e. if waypoints are valid) while offline.

hayata-suenaga · 2023-09-05T16:23:24Z

@allroundexperts let's disable the button for now when offline (your current code)

src/libs/TransactionUtils.js

allroundexperts · 2023-09-05T17:55:19Z

Probably, another follow up polish item we can do is to disable the next button when the getRoute api call is loading.

@hayata-suenaga What about this? Shall we create a follow up ticket?

hayata-suenaga · 2023-09-05T18:33:42Z

@hayata-suenaga What about this? Shall we create a follow up ticket?

I gonna create a follow up GH ticket for this. This is out of scope for this PR

We eventually want to handle this case -> user create waypoints on the Distance Request page while offline -> Click "Continue" (your PR temporarily prevents the user doing this) -> While on the confirmation page, the device comes back online -> route is fetched -> turned out that waypoints are invalid -> display error message on the confirmation page

soooo... if the user clicks the "Continue" button while the route is being loaded and that route turned out to be invalid, we might be able to handle that case on the confirmation page (when the above flow is supported)

allroundexperts · 2023-09-05T20:00:18Z

So when there is an error, the user is prevented from submitting the distance request right?

Yes. An error on the waypoint selection screen will disable the next button.

hayata-suenaga · 2023-09-05T20:12:37Z

So when there is an error, the user is prevented from submitting the distance request right?

Yes. An error on the waypoint selection screen will disable the next button.

@allroundexperts

could you kindly check what happens if there is an error on the confirmation screen? Can you still submit the request?

allroundexperts · 2023-09-05T20:14:09Z

could you kindly check what happens if there is an error on the confirmation screen? Can you still submit the request?

Confirmation screen can only have an error once the API request from the backend fails as far as I know. I'll check what happens in this case.

situchan · 2023-09-05T20:15:51Z

Unexpected error requesting money, please try again later

Screen.Recording.2023-09-06.at.2.14.17.AM.mov

hayata-suenaga · 2023-09-05T20:18:10Z

@situchan thank you!

This is something we might want to cleanup but out of scope for this PR

but I wanted to check the current behavior. Thank you so much!

situchan · 2023-09-05T20:23:14Z

I am not sure what's happening but in android I cannot get error (invalid waypoint) at all and finally app crashes after confirm request. No issue on all other platforms.

android.mov

allroundexperts · 2023-09-05T20:24:47Z

I am not sure what's happening but in android I cannot get error (invalid waypoint) at all and finally app crashes after confirm request. No issue on all other platforms.

android.mov

Is your server set as staging?

situchan · 2023-09-05T20:26:30Z

I am not sure what's happening but in android I cannot get error (invalid waypoint) at all and finally app crashes after confirm request. No issue on all other platforms.
android.mov

Is your server set as staging?

I tested against both staging/production server

situchan · 2023-09-05T20:27:24Z

@allroundexperts can you test android with 3 locations I chose?

allroundexperts · 2023-09-05T20:47:21Z

My internet is really bad rn. It is taking years to upload. I'll try in slack.

situchan · 2023-09-05T21:05: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 / Chrome
- iOS / native
- iOS / 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

situchan

hayata-suenaga · 2023-09-05T22:20:34Z

I am not sure what's happening but in android I cannot get error (invalid waypoint) at all and finally app crashes after confirm request. No issue on all other platforms.

@situchan so this issue is not present?

hayata-suenaga · 2023-09-05T22:43:39Z

Decided to hold this PR until the conference where we announce the feature is over 🙇

Good work by the way 🎉

neil-marcellini · 2023-09-11T17:40:10Z

The conference and promotion is over so I'm taking this off hold and I'll give it another review now.

OSBotify · 2023-09-11T17:50:59Z

✋ 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 · 2023-09-12T00:16:28Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.68-0 🚀

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

OSBotify · 2023-09-13T08:42:55Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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

fix: sort valid waypoints

10a7e6c

allroundexperts requested a review from a team as a code owner September 4, 2023 18:46

melvin-bot bot requested review from situchan and removed request for a team September 4, 2023 18:46

allroundexperts mentioned this pull request Sep 4, 2023

fix: logic for waypoint validation #26591

Merged

57 tasks

allroundexperts added 2 commits September 4, 2023 23:55

lint errors

1fb4677

fix: disable button on error

26ca7fa

Merge branch 'main' into fix-followup-26583

30ddb27

fix: disable button when offline

ace6a40

neil-marcellini self-requested a review September 5, 2023 16:22

situchan reviewed Sep 5, 2023

View reviewed changes

src/libs/TransactionUtils.js Outdated Show resolved Hide resolved

fix: create a utility function for extracting waypoint index

9cedf17

allroundexperts requested review from hayata-suenaga and situchan September 5, 2023 17:54

situchan approved these changes Sep 5, 2023

View reviewed changes

hayata-suenaga approved these changes Sep 5, 2023

View reviewed changes

hayata-suenaga changed the title ~~fix: sort valid waypoints~~ [HOLD] fix: sort valid waypoints Sep 5, 2023

hayata-suenaga changed the title ~~[HOLD] fix: sort valid waypoints~~ [HOLD SBE] fix: sort valid waypoints Sep 5, 2023

neil-marcellini changed the title ~~[HOLD SBE] fix: sort valid waypoints~~ fix: sort valid waypoints Sep 11, 2023

neil-marcellini approved these changes Sep 11, 2023

View reviewed changes

neil-marcellini merged commit c95998d into Expensify:main Sep 11, 2023
18 of 20 checks passed

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

melvin-bot bot mentioned this pull request Sep 13, 2023

[HOLD for payment 2023-09-20] [HOLD for payment 2023-09-12] [$1000] Fix the logic to check Start and Finish waypoints #26583

Closed

6 tasks

bernhardoj mentioned this pull request Sep 21, 2023

[HOLD for payment 2023-10-02] [HOLD for payment 2023-09-29] IOU - Next button disabled when requesting a new distance IOU offline #27895

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: sort valid waypoints #26705

fix: sort valid waypoints #26705

allroundexperts commented Sep 4, 2023 •

edited

Loading

melvin-bot bot commented Sep 4, 2023

allroundexperts commented Sep 4, 2023

hayata-suenaga commented Sep 5, 2023

situchan commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

trjExpensify commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

trjExpensify commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023 •

edited

Loading

hayata-suenaga commented Sep 5, 2023 •

edited

Loading

allroundexperts commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

situchan left a comment

hayata-suenaga commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

neil-marcellini commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

fix: sort valid waypoints #26705

fix: sort valid waypoints #26705

Conversation

allroundexperts commented Sep 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 4, 2023

allroundexperts commented Sep 4, 2023

hayata-suenaga commented Sep 5, 2023

situchan commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

trjExpensify commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

trjExpensify commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023 • edited Loading

Memo

hayata-suenaga commented Sep 5, 2023 • edited Loading

allroundexperts commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

situchan commented Sep 5, 2023

allroundexperts commented Sep 5, 2023

situchan commented Sep 5, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Sep 5, 2023

hayata-suenaga commented Sep 5, 2023

neil-marcellini commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

allroundexperts commented Sep 4, 2023 •

edited

Loading

hayata-suenaga commented Sep 5, 2023 •

edited

Loading

hayata-suenaga commented Sep 5, 2023 •

edited

Loading