Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add distance label on map route #55517

Merged
merged 19 commits into from
Feb 5, 2025
Merged

Conversation

truph01
Copy link
Contributor

@truph01 truph01 commented Jan 21, 2025

Explanation of Change

Fixed Issues

$ #53421
PROPOSAL: #53421 (comment)

Tests

  1. Open ND.
  2. FAB > Create expense > Distance.
  3. Add start and stop point so that the route is displayed.
  4. Verify there is a distance label is shown, which display how long the distance is.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  1. Open ND.
  2. FAB > Create expense > Distance.
  3. Add start and stop point so that the route is displayed.
  4. Verify there is a distance label is shown, which display how long the distance is.
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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)
    • 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.ts 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(theme.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 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:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-01-22.at.01.50.39.mov
Android: mWeb Chrome
Screen.Recording.2025-01-22.at.01.22.55.mov
iOS: Native
Screen.Recording.2025-01-22.at.01.10.21.mov
iOS: mWeb Safari
Screen.Recording.2025-01-22.at.01.21.08.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-22.at.01.16.09.mov
MacOS: Desktop
Screen.Recording.2025-01-22.at.01.22.07.mov

@truph01 truph01 marked this pull request as ready for review January 21, 2025 18:51
@truph01 truph01 requested review from a team as code owners January 21, 2025 18:51
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team January 21, 2025 18:51
Copy link

melvin-bot bot commented Jan 21, 2025

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

@dannymcclain
Copy link
Contributor

The screenshot/videos are looking pretty good to me. I'm going to try to spin up a test build so we can hopefully get a feel for it in real life.

Copy link
Contributor

🚧 @dannymcclain has triggered a test build. You can view the workflow run here.

Copy link
Contributor

@dannymcclain
Copy link
Contributor

Nice—looking good and working well to me!

@dubielzyk-expensify
Copy link
Contributor

Is it possible to make it so that the marker don't overlap the polyline/path?
CleanShot 2025-01-22 at 14 43 01@2x

Also on iOS and Android the blue dot is above the polyline/path which we don't want:
CleanShot 2025-01-22 at 14 47 26@2x

On web it's fine:
CleanShot 2025-01-22 at 14 46 58@2x

The clicking on the marker works well 😄 Yay!

Initially I didn't add the marker to the confirmation screen by design, but I'm wondering if it's weird not to show it there now? Thoughts @Expensify/design:
CleanShot 2025-01-22 at 14 43 54@2x

@shawnborton
Copy link
Contributor

I think the confirmation screen is basically showing like the "final receipt" - so I think we just need to determine if we think the final receipt should have it or not? Part of me thinks it doesn't need it since the total distance is written in text below as well as when you click into the receipt to view the whole image. No strong feelings though, I could also get down with showing it.

Great review of the other small design bugs though!

@shawnborton
Copy link
Contributor

shawnborton commented Jan 22, 2025

It looks like our brand font isn't being applied to the label, notice how the lowercase g isn't a double decker?
CleanShot 2025-01-22 at 07 46 13@2x

🦅 👁️

@dannymcclain
Copy link
Contributor

Is it possible to make it so that the marker don't overlap the polyline/path?

I almost said something about this, but since the path changes based on stops and zoom level, it seems like something that we're never going to be able to get perfect 100% of the time.

Great catches with the blue dot and typeface!! I think subconsciously something felt off about the typeface but I wasn't confident enough in the feeling to say anything 😂

As far as the confirmation screen goes, I could go either way. I basically feel exactly this:

Part of me thinks it doesn't need it since the total distance is written in text below as well as when you click into the receipt to view the whole image. No strong feelings though, I could also get down with showing it.

@truph01
Copy link
Contributor Author

truph01 commented Jan 28, 2025

Here's the marker with green-500. Let me know when you've gotten to these updates @truph01 👍

I updated PR. Here is the result:

Screenshot 2025-01-28 at 17 22 03

@dubielzyk-expensify
Copy link
Contributor

Visually looks good. Did we have more controls over where to place the label itself to avoid overlap on the path @truph01 ?

@truph01
Copy link
Contributor Author

truph01 commented Jan 29, 2025

Did we have more controls over where to place the label itself to avoid overlap on the path @truph01 ?

I did consider this option when implementing the PR, but there’s no way to guarantee the distance label won’t overlap the path. As someone mentioned earlier, "it feels like something we’re never going to get perfectly right 100% of the time."

@dubielzyk-expensify
Copy link
Contributor

Alright. Happy to merge then 👍

@shubham1206agra
Copy link
Contributor

@truph01 The unit of distance is not changing if I change the unit of distance from another device. Can you please fix this?

@truph01
Copy link
Contributor Author

truph01 commented Feb 3, 2025

The unit of distance is not changing if I change the unit of distance from another device. Can you please fix this?

I think we need to confirm the expected behavior here. Below are steps:

  1. [Device A]: Open any workspace chat.
  2. [Device A]: + > Create expense > Distance > Enter the stop and finish points.
  3. [Device A]: Observe that the distance label displayed with the unit is km.
  4. [Device B]: Change the unit of the distance of the workspace in step 1 to mi.
  5. [Device A]:
    Option 1: The distance label is still displayed with the unit km.
    Option 2: The distance label is displayed with the unit mi.

We should go with Option 1 because consistency is key. If Device A continues to display km until it refreshes or re-fetches data, it ensures a stable user experience without unexpected UI changes. Instantly switching to mi could be confusing, especially if the user isn't aware of the setting change from Device B. Keeping the current unit until an intentional refresh makes the behavior predictable and user-friendly. cc @dubielzyk-expensify

@shubham1206agra
Copy link
Contributor

@truph01 Can you fix the tests here?

@dubielzyk-expensify
Copy link
Contributor

I don't think this is a huge use case that we need to do much about. I do think the km/mi should always reflect the workspace settings but I don't think we need to fetch the data mid-flow. Basically I don't think we need to build anything specifically for this usecase. cc @Expensify/design for vis

@truph01
Copy link
Contributor Author

truph01 commented Feb 4, 2025

@shubham1206agra The reassure performance test error isn't related to our code changes.

@shubham1206agra
Copy link
Contributor

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 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 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)
    • 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.ts 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(theme.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 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:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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 Screenshot 2025-02-05 at 1 05 43 AM
Android: mWeb Chrome Screenshot 2025-02-05 at 12 40 01 AM
iOS: Native Screenshot 2025-02-05 at 12 52 11 AM
iOS: mWeb Safari Screenshot 2025-02-05 at 12 25 58 AM
MacOS: Chrome / Safari Screenshot 2025-02-05 at 12 18 42 AM
MacOS: Desktop Screenshot 2025-02-05 at 12 42 40 AM

@shubham1206agra
Copy link
Contributor

@truph01 Can you address this last comment?

@truph01
Copy link
Contributor Author

truph01 commented Feb 5, 2025

@shubham1206agra I updated PR to address comment.

@melvin-bot melvin-bot bot requested a review from Gonals February 5, 2025 04:31
Copy link
Contributor

@Gonals Gonals left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! Nice job!

@Gonals Gonals merged commit 07809b6 into Expensify:main Feb 5, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2025

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

github-actions bot commented Feb 6, 2025

🚀 Deployed to staging by https://github.com/Gonals in version: 9.0.95-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.95-6 🚀

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

Comment on lines +259 to +260
// Find the index of the middle element
const middleIndex = Math.floor(length / 2);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from #56531 checklist: We can enhance the logic by finding the closest point to the center of the waypoints instead of using the middle index, which may hide the distance label in some cases.

style={{marginRight: 100}}
>
<View style={styles.distanceLabelWrapper}>
<View style={styles.distanceLabelText}> {DistanceRequestUtils.getDistanceForDisplayLabel(distanceInMeters, distanceUnit)}</View>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was supposed to display a text value, wrapping it in a view caused #56603

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants