Automatically pan initial map based on current location

[MaciejSWM]

Details

Thread: https://expensify.slack.com/archives/C01GTK53T8Q/p1698404342523299

Fixed Issues

$ #22704
PROPOSAL:

Tests

Web

There are three possibilities when testing the Web, depending on user's location permissions:

When page Wants to know your location:

1. Logout. Reset page's permissions so that browser can ask you for Location permission. Login and go to Request Money -> Distance. Browser should ask if you want to grant location access. Map should stay in pending state until you choose something. Grant the permission. Map should navigate straight to your current location within 1-2 seconds.
2. Do step 1. again. This time don't grant the permission. Map should take you to the default San Francisco location.

When location access allowed:

1. Logout. Then login and go to Request Money -> Distance. You should see the map in pending state. Once map is fully loaded, it should take you straight to your location. There should be no animation, just land straight in the current location.
2. In DistanceRequestFooter.js add the following:

    useEffect(() => {
        Onyx.set(ONYXKEYS.USER_LOCATION, { longitude: 12, latitude: 12 })
    }, [])

Then open Request Money -> Distance. You should see the map initially load the [12, 12] coords, and after a second or so it should take you to your current location, once your location is obtained.
3. Do the same as in step 2., but before your current location is obtained, drag the map with the mouse. This should keep you at [12, 12] coords and should stop the map from auto-panning to your current location.

When location access is disabled:

• Logout. Then login and go to Request Money -> Distance. You should land in the default location, which is San Francisco.
• Refresh the page. You should land straight in the San Francisco location.
• Enable the location and refresh the page to cache the current location in ONYX. Then disable the location and refresh the page. You should land in this cached location instead of the default San Francisco location.

Desktop

You have to control the location permissions from the system settings:

Test all the scenarios (enabled/ask/disabled) similarly to web.

Mobile

Control the location permissions through your phone settings:

Test all the scenarios (enabled/ask/disabled) similarly to web.

Offline tests

Map won't load in offline mode. Browser won't ask about granting location permissions.

QA Steps

• Same as Tests

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 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
    • 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

Android: Native

(Ignore console warnings - I added them for easier debugging)

Screen.Recording.2023-10-31.at.17.45.24.mov

Android: mWeb Chrome

104006-480x1120.mp4

iOS: Native

Screen.Recording.2023-10-31.at.17.36.11.mov

Screen.Recording.2023-10-31.at.17.37.40.mov

iOS: mWeb Safari

Screen.Recording.2023-10-31.at.17.42.37.mov

Screen.Recording.2023-11-02.at.19.03.58.mov

Screen.Recording.2023-11-02.at.19.10.27.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-30.at.15.33.54.mov

MacOS: Desktop

Screen.Recording.2023-10-30.at.15.56.28.mov

Screen.Recording.2023-10-30.at.15.59.56.mov

[MaciejSWM]

Confirmed by @blazejkustra that this is the way we can handle it for now until useLocalize is migrated to TS.

Without this type definition, usage of useLocalize in MapView.tsx would throw TS errors

[melvin-bot]

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

[MaciejSWM]

@mananjadhav the perf test failure is probably a false alarm, as others also experience the same: https://github.com/Expensify/App/actions/runs/6768457070/job/18392931251?pr=30901

[mananjadhav]

@MaciejSWM Started reviewing, can you please merge the latest main and resolve conflicts?

[dylanexpensify]

@mananjadhav can we get this reviewed again today?? TY!

[mananjadhav]

Thanks for the bump, I'll have this finished today.

[mananjadhav]

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(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

Android: Native

android-current-location-2.mov

android-current-location-1.mov

Android: mWeb Chrome

mweb-chrome-current-location.mov

iOS: Native

ios-current-location.mov

iOS: mWeb Safari

mweb-safari-current-location.mov

MacOS: Chrome / Safari

web-current-location-2.mov

web-current-location-1.mov

MacOS: Desktop

desktop-current-location_a0vhxiJw.mp4

[mananjadhav]

@MaciejSWM I had one issue testing with mobile web chrome. The location shows momentarily and then goes black. Even when switching from default location to the user's location. Did you experience this? I have had this issue with my emulator earlier too, and I don't have a physical android device to test. But thought of clarifying with you before we merge.

Also one comment about removing accessToken.isRequired is pending to be resolved.

[thienlnam]

Holding until we get those last couple of comments addressed

[MaciejSWM]

Hey @mananjadhav. I restored isRequired - looks like a mistake on my end. When it comes to testing I tested on Android emulator and on physical Android device with Chrome and never experienced black map. I'm checking one more time right now.

[MaciejSWM]

I'm having problems now to open it on any Android device - Emulator freezes once again because it runs out of memory. Physical device doesn't want to login to expensify because it's getting 429 Too many requests (tested ports 8082 and 8080)

[MaciejSWM]

@mananjadhav I confirm that it's still all good on my side:

android.mp4

[mananjadhav]

Thanks for confirming @MaciejSWM. It must be my emulator.

@thienlnam All good here. I've also check off the checklist for the pending propTypes change.

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

[OSBotify]

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.4-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.4-3 🚀

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

[shubham1206agra]

Comment for reference

[eVoloshchak]

Just a heads up, this has caused an issue in #32261

The zoom level was changed from 15 to 10 for web, but it's still 15 for other platforms.
This caused an issue when the default zoom and zoom when you select a location is the same, so if the default location and the location you've selected are the same - the map isn't zoomed in
This was changed back to 15 in #33234