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

fix add center button and blue dot #40759

Merged
merged 39 commits into from
Jun 3, 2024
Merged

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Apr 23, 2024

Details

Fixed Issues

$ #40209
PROPOSAL: #40209 (comment)

Tests

  1. Open app.
  2. Click on "Submit expense" -> "Distance".
  3. Verify that the map displays the blue dot as the current position.
  4. Move the map to any new location.
  5. Click on the "center-me" button.
  6. Verify that the map will animate to the location in which the current position is center.
  7. Select any waypoint.
  8. Select the 2nd waypoint.
  9. Move the map to any new location.
  10. Click on "center-me" button.
  11. Verify that the app will animate to the location which will contain the current route.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open app.
  2. Click on "Submit expense" -> "Distance".
  3. Verify that the map displays the blue dot as the current position.
  4. Move the map to any new location.
  5. Click on the "center-me" button.
  6. Verify that the map will animate to the location in which the current position is center.
  7. Select any waypoint.
  8. Select the 2nd waypoint.
  9. Move the map to any new location.
  10. Click on "center-me" button.
  11. Verify that the app will animate to the location which will contain the current route.
  • 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 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 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.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 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.
  • 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.2024-05-21.at.16.43.12.mov
Android: mWeb Chrome
Screen.Recording.2024-05-21.at.16.51.07.mov
iOS: Native
Screen.Recording.2024-05-21.at.16.43.53.mov
iOS: mWeb Safari
output.mp4
MacOS: Chrome / Safari
output.mp4
MacOS: Desktop
output.mp4

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Apr 23, 2024

Below is how it looks in web and native:

  • In web:
output.mp4
  • In native:
input-process.mp4

@nkdengineer nkdengineer marked this pull request as ready for review April 23, 2024 09:16
@nkdengineer nkdengineer requested a review from a team as a code owner April 23, 2024 09:16
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team April 23, 2024 09:16
Copy link

melvin-bot bot commented Apr 23, 2024

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

src/components/MapView/MapView.website.tsx Outdated Show resolved Hide resolved
src/components/MapView/MapView.website.tsx Outdated Show resolved Hide resolved
src/components/MapView/MapView.tsx Outdated Show resolved Hide resolved
src/components/MapView/MapView.tsx Outdated Show resolved Hide resolved
@parasharrajat
Copy link
Member

Please attach videos for all platforms.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

  1. Let's add the center button over the Map not as a separate button.
  2. Use similar animation time for all platforms.
  3. highlight the blue dot over the map. Currently is not visible clearly. May be show some shadow behind it.

@parasharrajat
Copy link
Member

@Expensify/design Can you please review the design for this change and share you feedback?

@dubielzyk-expensify
Copy link
Contributor

I'll take it internally and come back to you :)

@nkdengineer
Copy link
Contributor Author

@parasharrajat I just resolved a few comments. Others should be resolved after we have the design.

@parasharrajat
Copy link
Member

Let's for for design feedback.

@parasharrajat
Copy link
Member

@dubielzyk-expensify any updates?

@dubielzyk-expensify
Copy link
Contributor

We're back with updates! 😄 Here's the intended design:

CleanShot 2024-04-24 at 10 32 41@2x

Adding the button:

This should be using the icon button component size: medium. It should also be anchored in the bottom right overlaying the map with a 20px padding from the edge of the map:

image

Adding the icon

We're using a new icon called crosshair.svg that needs to be checked into our repo. Here's the button:
crosshair.svg.zip

Showing the button:

So ideally we actually want the button only to show once the map isn't centered. So imagine:

  1. The route is shown after the origin + destination has been entered
  2. User drags the map
  3. Then we show the button cause the map isn't centered
  4. User taps center button and it fades away. There should be a fade animation btw, not just appear/disappear.

If we can't do this, then showing the button at all times is fine. The other alternative here is to change the icon based on if it's centered or not:
CleanShot 2024-04-24 at 10 37 12@2x

Let us know what's doable here 😄

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Apr 24, 2024

  • @dubielzyk-expensify Can you give me the radius and the background color code of the center button? Currently, the Crosshair.svg you supplied above is just:

image

  • Also, as you can see in staging, there was a native icon "!" at the bottom right. If we add a "center-me" to the bottom right, that native icon will be overridden:

image

@dubielzyk-expensify
Copy link
Contributor

Shouldn't need to specify a button color as this is our regular IconButton component that's found elsewhere in the app:

CleanShot 2024-04-24 at 14 25 04@2x

It should use default values. That goes for the icon too.

Also, as you can see in staging, there was a native icon "!" at the bottom right. If we add a "center-me" to the bottom right, that native icon will be overridden:

Ahh good call. Maybe just put it in the top right for now. I assume we need that button for terms reasons with Mapbox.

@dubielzyk-expensify
Copy link
Contributor

@Expensify/design and @grgia , do you know what the icon button component is called?

@parasharrajat
Copy link
Member

@nkdengineer

  1. As mentioned there is an IconButton component in the app, please use that.
  2. There should be a mechanism to push the button on the map layer in a way that it does not overlap.
  3. Button should be pushed into a map layer not fixated over it with CSS.

So ideally we actually want the button only to show once the map isn't centered.

We should be able to do it.

@pecanoro pecanoro self-requested a review April 24, 2024 07:25
@nkdengineer
Copy link
Contributor Author

There should be a mechanism to push the button on the map layer in a way that it does not overlap

@parasharrajat I cannot find a way to do that because the "!" icon is also displayed on the top of the map
image

@grgia
Copy link
Contributor

grgia commented Apr 24, 2024

@dubielzyk-expensify we use <Button> or <Icon> in App right now

@parasharrajat
Copy link
Member

Maybe we can use https://visgl.github.io/react-map-gl/docs/api-reference/use-control to add a new control. If you pass bottom-right position it should automatically be placed above the other buttons.

@parasharrajat
Copy link
Member

@nkdengineer Any updates?

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Apr 25, 2024

I am trying to implement your suggestion here. It works well with the built-in control (MapboxDraw), but the custom react component

@nkdengineer
Copy link
Contributor Author

With the current code change, here is how it looks:

  • In native:
Screen.Recording.2024-04-25.at.09.54.12.mov
  • In web:
Screen.Recording.2024-04-25.at.09.54.47.mov

@parasharrajat
Copy link
Member

I can still reproduce this issue. It's web so there should be no build cache. Could you please try again? Looks like the button is there and it is functioning but it is not visible.

@parasharrajat
Copy link
Member

@pecanoro Could you please try to test this issue #40759 (comment)? Are you able to reproduce it?

@nkdengineer
Copy link
Contributor Author

I can still reproduce this issue.

@parasharrajat Thanks for confirmation. I am testing it again.

@pecanoro
Copy link
Contributor

Testing it!

@nkdengineer
Copy link
Contributor Author

@pecanoro Can you reproduce this bug?

@pecanoro
Copy link
Contributor

I can't seem to be able to reproduce the problem:

image

@parasharrajat
Copy link
Member

Then I guess something is wrong with my setup. I will complete the checklist now.

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

Screen.Recording.2024-05-28.at.10.18.58.PM.mov

🔲 iOS / Safari

Screen.Recording.2024-05-31.at.1.07.45.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2024-05-28.at.10.12.01.PM-short.mov

🔲 MacOS / Chrome

Screen.Recording.2024-05-28.at.5.31.25.PM-short.mov

🔲 Android / Chrome

Screen.Recording.2024-05-28.at.10.38.43.PM.mov

🔲 Android / native

Screen.Recording.2024-05-28.at.10.34.33.PM.mov

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from pecanoro May 31, 2024 07:39
src/components/MapView/MapView.website.tsx Outdated Show resolved Hide resolved
src/components/MapView/utils.ts Show resolved Hide resolved
src/components/MapView/utils.ts Outdated Show resolved Hide resolved
src/components/MapView/utils.ts Outdated Show resolved Hide resolved
@nkdengineer
Copy link
Contributor Author

@pecanoro I resolved your comments in commit

Copy link
Contributor

@pecanoro pecanoro left a comment

Choose a reason for hiding this comment

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

Small request and I will be ready to merge!

src/components/MapView/utils.ts Show resolved Hide resolved
@pecanoro pecanoro merged commit d3434cb into Expensify:main Jun 3, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 3, 2024

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

@dangrous
Copy link
Contributor

dangrous commented Jun 5, 2024

hi friends! can you take a quick look and see if this PR caused this bug: #43113 - thank you! I will look too but you'll have more context

@pecanoro
Copy link
Contributor

pecanoro commented Jun 5, 2024

@nkdengineer @parasharrajat It seems strongly related, right?

@parasharrajat
Copy link
Member

Let me test it.

@parasharrajat
Copy link
Member

I tested and #43113 is not related to this PR.

@OSBotify
Copy link
Contributor

OSBotify commented Jun 6, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.79-11 🚀

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

@@ -190,6 +237,22 @@ const MapView = forwardRef<MapViewHandle, ComponentProps>(

{directionCoordinates && <Direction coordinates={directionCoordinates} />}
</Mapbox.MapView>
<View style={[styles.pAbsolute, styles.p5, styles.t0, styles.r0, {zIndex: 1}]}>
<PressableWithoutFeedback
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 #43058. We missed adding hover and press effect on this button.

Copy link
Member

Choose a reason for hiding this comment

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

This is wrong. It was not part of the requirement. Design team approved this PR. So the mentioned issued is a new feature/change. @jjcoffee Could you please update the bug list to remove this PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

We might have missed this but the @Expensify/design explicitly stated several times that we wanted this button behavior to match all of our other default buttons. Don't our default buttons all have a hover and press style?

Copy link
Member

Choose a reason for hiding this comment

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

Ok. I see. We were pushed to merge this quickly so it might be missed.

@ahmedGaber93
Copy link
Contributor

The Mapbox library has a bug/different behavior in iOS, although we don't enable compassEnabled, after rotate the map the compass icon display on the same place "center" button displayed, and we handled it here #44752

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

Successfully merging this pull request may close these issues.