Display single waypoint

[hayata-suenaga]

cc: @neil-marcellini

Details

This PR makes it possible to display single or multiple waypoints on the map.

Fixed Issues

$ #22706
PROPOSAL: N/A

Tests / QA

First, we gonna test "flying" behavior (see the video below) when a single waypoint is provided.

1. Open NewDot on any platform

2. Go to any chat room where you can request money. Click the "+" icon next to the chat message text field. Click "Request money option from the popup menu.

3. Click "Distance" in the tab menu. Check a map of San Francisco is displayed (it might a lot time to render the map and you might see a placeholder component for a while. This is a known issue, and a fix is under work).

4. Click "Start" from the list of waypoints.
   

5. On the text field in the next screen, type 88 Kearny Street. Select the first option (the address should be San Francisco)
   

6. Confirm that map "flies" and zooms into a different part of San Francisco. Refer to the following video.

   video

   Screen.Recording.2023-08-16.at.9.56.38.PM.mov

7. Select "Finish" from the list of waypoints.

8. On the text field in the next screen, type "Golden Gate Bridge". Click the first option that appears.
   

9. Confirm that the map pans out to fit both the initial starting point and the finish point (Golden Gate Park). Refer to the following video.

   Video

   Uploading Screen Recording 2023-08-21 at 1.28.53 PM.mov…

10. Click the "Add stop" button. Confirm that the marker component changes. Refer to the following screenshots (the left one is "before" and the right one is "after."
    
    

11. Click "Finish" and type "Lands End Trail". Click the first option.
    

12. Verify that the map pans out more to fit all three points/markers.

    Video

    Uploading Screen Recording 2023-08-21 at 1.31.23 PM.mov…

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

web.single.mov

Mobile Web - Chrome

android.multiple.mov

Mobile Web - Safari

safari.single.mov

Desktop

desktop.single.mov

iOS

Screen.Recording.2023-08-21.at.9.08.37.AM.mov

Android

[melvin-bot]

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

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

Screen.Recording.2023-08-22.at.3.05.29.AM.mov

Mobile Web - Chrome

#25161 (comment)

Mobile Web - Safari

Screen.Recording.2023-08-22.at.4.23.49.AM.mov

Desktop

Screen.Recording.2023-08-22.at.3.11.58.AM.mov

iOS

Screen.Recording.2023-08-22.at.3.19.17.AM.mov

Android

Screen.Recording.2023-08-22.at.3.20.37.AM.mov

[hayata-suenaga]

@allroundexperts I haven't tested these on Android and iOS native apps. I'd really appreciate it if you could test this PR on these platforms 🙇

Also, you need to run npm run configure-mapbox if you haven't already 🙇

[allroundexperts]

Sure thing @hayata-suenaga.

[allroundexperts]

Hi @hayata-suenaga!
Can you please resolve the conflicts? 🙏

[hayata-suenaga]

Found a bug

when changing the window size while there is a single waypoint, the map is reset and the map focuses on a wrong location

Screen.Recording.2023-08-17.at.3.36.02.PM.mov

[hayata-suenaga]

This bug stems from how the Right Side Panel (I don't know if this is the right name) is resized when a breakpoint is reached (if you shrink the browser window, the size of Right Side Panel changes to cover the entire page).

I asked a question regarding this in the #epensify-open-source channel Slack channel.

According to this comment in the Slack thread, this is a known issue that stemmed from the Navigation Refactoring project. The bug is being worked on in this App issue.

Because this issue will be fixed in the future, I suggest we treat this bug as a temporary one and won't fix it in this PR. What do you think @neil-marcellini @allroundexperts ?

[allroundexperts]

Testing well!

[melvin-bot]

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

[hayata-suenaga]

The scrolling behavior of the waypoint list works fine on iOS
https://github.com/Expensify/App/assets/98560306/9770e573-8cc5-4a4f-9549-d5880c14d473

I gonna test on SE

[allroundexperts]

@hayata-suenaga On SE, don't add a new stop. Just check with the existing two options.

[hayata-suenaga]

@allroundexperts I feel like I'm missing something here 😕 the waypoint list is scrollable on SE, too

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

[allroundexperts]

That's weird. I'll check it again on.

[allroundexperts]

Okay. It turns out that if you try to scroll by pressing on the Stop text, it does not work. However, panning on anything above that does work.

Screen.Recording.2023-08-22.at.4.20.16.AM.mov

[hayata-suenaga]

Okay. It turns out that if you try to scroll by pressing on the Stop text, it does not work. However, panning on anything above that does work.

okay on the actual physical device, I think it would be much easier to scroll, but thank you for the investigation 🥇

[neil-marcellini]

Looks great, awesome work!

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

[thienlnam]

@allroundexperts Found that auto-panning doesn't seem to work if you add the following addresses on iOS

Start: 584 Castro St, San Francisco
End: 88 Kearney St, South San Francisco, CA 94080, USA

https://expensify.slack.com/archives/C02NK2DQWUX/p1692731847794059?thread_ts=1692665981.227269&cid=C02NK2DQWUX

[hayata-suenaga]

@thienlnam did you merge main to your PR?

[allroundexperts]

@hayata-suenaga I checked again and this seems to be still happening on iOS only.

Another issue that I'm noticing now is the following:

Screen.Recording.2023-08-23.at.1.21.03.AM.mov

Notice how the map zooms itself when I just click the Add stop button without actually adding the stop address.

[OSBotify]

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

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

[OSBotify]

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

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

[OSBotify]

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

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

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

[s77rt]

After adding waypoints, we should have changed the default location from SF to the first value in waypoints to keep animations consist (coming from #29471)

[hayata-suenaga]

ah that's a good point. Thank for letting us know!