Display Route #25434

thienlnam · 2023-08-17T20:43:43Z

Details

Fixed Issues

$ #22708
PROPOSAL:

Tests

For engineers, if you're building and testing this PR in the development environment, you first need to run npm run configure-mapbox to setup the development environment.

Go to 'Request Money', 'Distance'
Add in a couple addresses
Verify that you see the route
Add stops
Verify that new routes are generated correctly
Remove one of the stops by editing the waypoint, and deleting all the text and pressing 'Enter'
Verify the new route is generated successfully

Offline tests

Offline is known to not work at this time. You can save waypoints while offline but when coming online there will be an error. This is known at the time.

QA Steps

Go to 'Request Money', 'Distance'
Add in a couple addresses
Verify that you see the route (You might have to scroll out to find the route unless you choose addresses in San Francisco. There is another PR that will handle the readjustment of the map)
Add stops
Verify that new routes are generated correctly

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-08-21.at.5.45.54.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-08-21.at.5.52.00.PM.mov

Mobile Web - Safari

Desktop

iOS

Android

hayata-suenaga · 2023-08-18T21:06:11Z

hey @thienlnam I sent you a message about this PR in slack

hayata-suenaga · 2023-08-21T05:45:26Z

just heads up. I'm changing react-native-x-maps a little bit in this PR to fix some issues, but this doesn't change the interface/API of MapView. So you don't have to wait for it to finish to merge your PR 👍

UPDATE:
The PR was merged and the version of react-native-x-maps was bumped to 1.0.8. You can change the version specified in package.json to that version. As I wrote above, this won't change how MapView works

allroundexperts · 2023-08-22T21:06:10Z

Oops. Lint failure @thienlnam!

src/components/DistanceRequest.js

allroundexperts · 2023-08-22T22:16:34Z

src/components/DistanceRequest.js

+    const hasRouteError = Boolean(lodashGet(transaction, 'errorFields.route'));
+    const previousWaypoints = usePrevious(waypoints);
+    const haveWaypointsChanged = !_.isEqual(previousWaypoints, waypoints);
+    const shouldFetchRoute = haveWaypointsChanged || !isOffline || !isLoadingRoute || TransactionUtils.validateWaypoints(waypoints);


This is wrong again @thienlnam. Lets keep this as it was and just change the variable name to shouldIgnoreFetching

I fixed it - we don't use the inverse as much so I just adjusted the check (more of a preference thing though)

melvin-bot · 2023-08-22T22:28:08Z

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

thienlnam · 2023-08-22T22:34:58Z

Removing additional auto-assigned reviewers since @hayata-suenaga is already on this

OSBotify · 2023-08-22T23:17:17Z

✋ 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-08-24T03:35:40Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.57-0 🚀

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

OSBotify · 2023-08-28T18:52:41Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.58-0 🚀

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

OSBotify · 2023-08-29T00:07:21Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

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

OSBotify · 2023-08-30T01:21:44Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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

parasharrajat · 2023-09-11T21:02:55Z

src/components/DistanceRequest.js

    useEffect(updateGradientVisibility, [scrollContainerHeight, scrollContentHeight]);

    return (
-        <>
+        <ScreenWrapper shouldEnableMaxHeight>


Nested ScreenWrapper can cause extra padding. There should only be one ScreenWrapper component per page. This caused #26008.

parasharrajat · 2023-10-05T15:22:21Z

src/libs/actions/Transaction.js

@@ -96,8 +119,72 @@ function removeWaypoint(transactionID, currentIndex) {
            ...transaction.comment,
            waypoints: reIndexedWaypoints,
        },


We should also clear the error when we are removing the waypoint as we do in saveWaypoint action . This caused #27538

Add GetRoute API command

41a3590

thienlnam changed the base branch from main to hayata-add-map August 17, 2023 22:06

Add handling to fetch route

a0f270c

Base automatically changed from hayata-add-map to main August 18, 2023 03:36

thienlnam added 5 commits August 18, 2023 10:47

get display showing

e5c55cd

Add styling / update version

92e4489

Add errorFields

3a2f1a0

Prevent fetching while offline

c3abd93

Fix proptype

e03cd93

thienlnam added 2 commits August 18, 2023 18:27

Add error dot indicator and screen wrapper

4201756

Handle clearing errors when updating input

1b9056c

thienlnam added 4 commits August 21, 2023 13:59

Merge branch 'main' into jack-add-map-display-route

02529d3

Update react-native-x-maps to 1.0.8

2c5a9f0

Update DistanceRequest.js

a8fb1c7

prevent looping of getRoute

0105c37

hayata-suenaga mentioned this pull request Aug 21, 2023

Use styleURL passed as a prop Expensify/react-native-x-maps#26

Merged

add waypoint validation

d67bba4

hayata-suenaga mentioned this pull request Aug 22, 2023

Pass down directionStyle prop down Expensify/react-native-x-maps#28

Merged

thienlnam added 8 commits August 21, 2023 17:32

update styling

c928bfd

Prettier

1cc24c9

Update styles.js

b33c36d

Merge branch 'main' into jack-add-map-display-route

2f3be36

Merge branch 'main' into jack-add-map-display-route

d8cf419

Update DistanceRequest.js

679872e

clear out existing routes

55b5a38

Update Transaction.js

f4a8fce

thienlnam marked this pull request as ready for review August 22, 2023 00:58

thienlnam requested a review from a team as a code owner August 22, 2023 00:58

Update DistanceRequest.js

844ee72

hayata-suenaga reviewed Aug 22, 2023

View reviewed changes

src/components/DistanceRequest.js Outdated Show resolved Hide resolved

hayata-suenaga previously approved these changes Aug 22, 2023

View reviewed changes

update logic lol

2fe1326

thienlnam dismissed hayata-suenaga’s stale review via 2fe1326 August 22, 2023 22:12

allroundexperts reviewed Aug 22, 2023

View reviewed changes

adjust the check

4708446

allroundexperts approved these changes Aug 22, 2023

View reviewed changes

melvin-bot bot requested a review from arosiclair August 22, 2023 22:28

thienlnam removed request for stitesExpensify and arosiclair August 22, 2023 22:34

thienlnam requested a review from hayata-suenaga August 22, 2023 22:44

hayata-suenaga approved these changes Aug 22, 2023

View reviewed changes

hayata-suenaga merged commit a6e6b31 into main Aug 22, 2023
14 checks passed

hayata-suenaga deleted the jack-add-map-display-route branch August 22, 2023 23:09

OSBotify mentioned this pull request Aug 24, 2023

Deploy Checklist: New Expensify 2023-08-24 #25813

Closed

73 tasks

OSBotify mentioned this pull request Aug 28, 2023

Deploy Checklist: New Expensify 2023-08-28 #26113

Closed

melvin-bot bot mentioned this pull request Aug 28, 2023

[Awaiting C+ payment] [HOLD for payment 2023-09-04] Display a distance request route in App #22708

Closed

parasharrajat reviewed Sep 11, 2023

View reviewed changes

parasharrajat mentioned this pull request Sep 11, 2023

[HOLD for payment 2023-09-06] [$1000] Minimize the gap between waypoint input request money segmented control on mobile. #26008

Closed

parasharrajat reviewed Oct 5, 2023

View reviewed changes

parasharrajat mentioned this pull request Oct 5, 2023

[HOLD for payment 2023-10-02] [$500] [Distance] - Wrong error is shown for maximum distance limitation even after deleting way point #27538

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display Route #25434

Display Route #25434

thienlnam commented Aug 17, 2023 •

edited

Loading

hayata-suenaga commented Aug 18, 2023

hayata-suenaga commented Aug 21, 2023 •

edited

Loading

allroundexperts commented Aug 22, 2023

allroundexperts Aug 22, 2023

thienlnam Aug 22, 2023 •

edited

Loading

melvin-bot bot commented Aug 22, 2023

thienlnam commented Aug 22, 2023

OSBotify commented Aug 22, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

parasharrajat Sep 11, 2023

parasharrajat Oct 5, 2023

Display Route #25434

Display Route #25434

Conversation

thienlnam commented Aug 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hayata-suenaga commented Aug 18, 2023

hayata-suenaga commented Aug 21, 2023 • edited Loading

allroundexperts commented Aug 22, 2023

allroundexperts Aug 22, 2023

Choose a reason for hiding this comment

thienlnam Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Aug 22, 2023

thienlnam commented Aug 22, 2023

OSBotify commented Aug 22, 2023

OSBotify commented Aug 24, 2023

OSBotify commented Aug 28, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

parasharrajat Sep 11, 2023

Choose a reason for hiding this comment

parasharrajat Oct 5, 2023

Choose a reason for hiding this comment

thienlnam commented Aug 17, 2023 •

edited

Loading

hayata-suenaga commented Aug 21, 2023 •

edited

Loading

thienlnam Aug 22, 2023 •

edited

Loading