Integrate Mapbox in App #24306

hayata-suenaga · 2023-08-09T05:14:11Z

Details

This PR does three things

Add scripts necessary to setup the environment to download Mapbox iOS and Android SDKs
You have to get credentials from Mapbox and add them to appropriate files to download Mapbox SDKs. Added scripts to streamline that process.
Configure the project for Mapbox SDKs
Mapbox SDKs requires configurations in build.gradle and Podfile.
Install react-native-x-maps which uses Mapbox mobile and web SDKs under the hood to display maps
Added a map in the Distance Request page (where users can report expenses for automobile transportations).

Fixed Issues

$ #22703
PROPOSAL: N/A

Tests / QA Steps

Map test

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.

Open NewDot on any platform
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.
Click "Distance" in the tab menu. Check that a map is displayed under "Add stop" button. Also check that the map is centered around San Francisco.

Verify that no errors appear in the JS console
Make the device offline and check that a placeholder component like below is displayed instead of the map

Bash script test (This doesn't have to be QAed by the QA team)

Run npm run configure-mapbox for the project root.
Check you see an output like below.
Don't enter anything for the secret token prompt and hit enter. Check you receive the following message
Run npm run configure-mapbox. Type something for the secret token prompt (it doesn't have to be the actual token). Note that you don't see what's you're typing. Check you see an output like below.

Open ~/.netrc. Check that you have an entry like the following

machine api.mapbox.com
login mapbox
password <your-password>

Open ~/.gradle/gradle.properties. Check you have an entry like the following.
```
MAPBOX_DOWNLOADS_TOKEN=<your-password>
```

Offline tests

If you open DistanceRequest page by following the test instruction for "Map test" while offline, you should not see the map.

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

neil-marcellini · 2023-08-10T15:45:25Z

I linked this PR to the issue for you. Please do that right away when you create your next draft PR since it makes the organization easier.

…-add-map

hayata-suenaga · 2023-08-10T17:44:32Z

Screen shots of the current UI

Web

neil-marcellini · 2023-08-10T18:26:45Z

I also changed the base branch to make it easier to review. When my PR is merged it will automatically update the base branch to main.

neil-marcellini

Looking good so far. Please also handle the set up of the secret tokens during deployment.

scripts/configure-netrc-for-mapbox-sdk-installation.sh

neil-marcellini · 2023-08-10T18:55:58Z

scripts/configure-netrc-for-mapbox-sdk-installation.sh

+    echo -e "1. \033[1m$NETRC_PATH\033[0m"
+    echo -e "2. \033[1m$GRADLE_PROPERTIES_PATH\033[0m"
+    echo -e "\nYou can grant permissions using the commands:"
+    echo -e "\033[1mchmod u+rw $NETRC_PATH\033[0m"
+    echo -e "\033[1mchmod u+rw $GRADLE_PROPERTIES_PATH\033[0m"


Can we check and update the permissions in the script?

I don't know if that's a good idea. I don't want to mess with contributor's file system with my script 😭 also I think I have to deal with other edge cases if I want to change the permissions in the script

so maybe it's better if a contributor change directory/file permissions by themselves

Fair enough, but what about when it's running in an GH action? We need to make sure the permissions are correct in that case. Idk if it's bad to change permissions from a script, but in the interactive version they would probably have to enter their login password to authorize it anyways.

package.json

android/build.gradle

melvin-bot · 2023-08-11T22:31:48Z

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

hayata-suenaga · 2023-08-17T20:08:43Z

if other things look good, could you complete the Reviewer Checklist 🙇 @parasharrajat

scripts/setup-mapbox-sdk.sh

mananjadhav · 2023-08-17T20:53:31Z

@hayata-suenaga As I can we all the bugs we've discussed would be picked up in the next issues, I am not blocking the checklist for the issue list, we can look at it once the PR is merged.

mananjadhav · 2023-08-17T21:04:42Z

@hayata-suenaga I can still reproduce that immediately opening the Mapview after sign-in doesn't load the Map. I think this is being addressed with Api.read change here?

web-first-load-map.mov

hayata-suenaga · 2023-08-17T21:07:21Z

@mananjadhav yes that's right it's being addressed in a separate PR 👍

mananjadhav · 2023-08-17T21:19:56Z

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

web-mapbox-offline.mov

web-first-load-map.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios-mapbox.mov

Android

android-mapbox.mov

iOS and Android builds are running.

mananjadhav · 2023-08-17T21:41:04Z

Still running the Android build.

mananjadhav · 2023-08-17T22:12:47Z

@hayata-suenaga Finally completed the checklist 😌

hayata-suenaga · 2023-08-17T22:22:50Z

Created the issue for rewriting bash scripts in node: #25442

tgolen

Looks good!

OSBotify · 2023-08-18T03:45:03Z

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

parasharrajat · 2023-08-18T07:15:45Z

Thanks @mananjadhav for covering up the checklist, I fell asleep. But I already tested so all good.

Julesssss · 2023-08-18T14:34:18Z

We should have tested the AdHoc builds here as the script was modified. The AdHoc build fails with these changes which are blocking us from testing lots of PRs and delaying the App deployment.

Can we revert?

Julesssss · 2023-08-18T15:53:18Z

Reverted here

hayata-suenaga · 2023-08-18T16:56:45Z

.github/workflows/testBuild.yml

          echo "PULL_REQUEST_NUMBER=$PULL_REQUEST_NUMBER" >> .env.adhoc

-      - uses: Expensify/App/.github/actions/composite/setupNode@main
+      - uses: ./.github/actions/composite/setupNode


OSBotify · 2023-08-21T22:24:52Z

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

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

OSBotify · 2023-08-24T03:07:53Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

aadil42 · 2025-10-16T05:27:18Z

@roryabraham

In the OP the path should be ~/.gradle/gradle.properties It might trip up new contributors. The file exists in home-dir but the current path is of root-dir.

roryabraham · 2025-10-16T19:44:24Z

Thanks! updated PR description

Hayata Suenaga added 5 commits August 8, 2023 22:12

chore: install mapbox client for react native

eea4eb9

feat: edit podfile and run pod install

af1365e

feat: add script to set credential for mapbox sdk

1e66728

chore: configure android for mapbox SDK

c2bae34

feat: make shell script configure android too

e2270a2

neil-marcellini self-requested a review August 10, 2023 15:45

Hayata Suenaga added 2 commits August 10, 2023 10:23

feat: add test library

c6deb54

Merge remote-tracking branch 'origin/neil-waypoints-list' into hayata…

2d60732

…-add-map

neil-marcellini changed the base branch from main to neil-waypoints-list August 10, 2023 18:26

style: rename script file name

fbed8b9

neil-marcellini requested changes Aug 10, 2023

View reviewed changes

Hayata Suenaga added 4 commits August 10, 2023 17:35

feat: divide script for CI and interactive ones

cee9748

chore: bump the version of temp library

f11c64b

feat: configure .env file as part of map setup

fa00c54

feat: use new MapView API

e11ca16

Base automatically changed from neil-waypoints-list to main August 11, 2023 18:07

hayata-suenaga mentioned this pull request Aug 11, 2023

Implement basic map view Expensify/react-native-x-maps#16

Merged

Hayata Suenaga added 2 commits August 11, 2023 13:54

chore: swap library

a398dd9

Merge branch 'main' into hayata-add-map

813440f

hayata-suenaga marked this pull request as ready for review August 11, 2023 22:31

hayata-suenaga requested a review from a team as a code owner August 11, 2023 22:31

melvin-bot bot requested review from parasharrajat and removed request for a team August 11, 2023 22:31

Hayata Suenaga added 3 commits August 11, 2023 16:58

chore: remove script for setting env

64d1014

chore: download pod

eed9bde

chore: download npm packages

c55e426

hayata-suenaga removed the Ready To Build label Aug 17, 2023

tgolen mentioned this pull request Aug 17, 2023

[No QA] Make sure only the active leader is managing the mapbox token #25431

Merged

59 tasks

allroundexperts reviewed Aug 17, 2023

View reviewed changes

scripts/setup-mapbox-sdk.sh Show resolved Hide resolved

tgolen approved these changes Aug 18, 2023

View reviewed changes

hayata-suenaga mentioned this pull request Aug 18, 2023

[HOLD Expensify 309451] Add instruction to manually setup Mapbox SDK credentials #25452

Closed

hayata-suenaga merged commit c435734 into main Aug 18, 2023

hayata-suenaga deleted the hayata-add-map branch August 18, 2023 03:36

hayata-suenaga mentioned this pull request Aug 18, 2023

Revert "Integrate Mapbox in App" #25492

Merged

Julesssss mentioned this pull request Aug 18, 2023

[HOLD #24444] Ensure CI builds are tested when modified in a PR #25493

Closed

hayata-suenaga restored the hayata-add-map branch August 18, 2023 14:53

hayata-suenaga commented Aug 18, 2023

View reviewed changes

This was referenced Aug 18, 2023

Second attempt for #24306 #25496

Closed

Revert "Revert "Integrate Mapbox in App"" (i.e. bring the original PR back) #25506

Merged

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

Integrate Mapbox in App #24306

Integrate Mapbox in App #24306

Uh oh!

Conversation

hayata-suenaga commented Aug 9, 2023 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests / QA Steps

Map test

Bash script test (This doesn't have to be QAed by the QA team)

Offline tests

PR Author Checklist

Screenshots/Videos

Uh oh!

neil-marcellini commented Aug 10, 2023

Uh oh!

hayata-suenaga commented Aug 10, 2023

Uh oh!

neil-marcellini commented Aug 10, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini Aug 10, 2023

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga Aug 14, 2023

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Aug 14, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented Aug 11, 2023

Uh oh!

hayata-suenaga commented Aug 17, 2023

Uh oh!

Uh oh!

mananjadhav commented Aug 17, 2023

Uh oh!

mananjadhav commented Aug 17, 2023

Uh oh!

hayata-suenaga commented Aug 17, 2023

Uh oh!

mananjadhav commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mananjadhav commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mananjadhav commented Aug 17, 2023

Uh oh!

hayata-suenaga commented Aug 17, 2023

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 18, 2023

Uh oh!

parasharrajat commented Aug 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Julesssss commented Aug 18, 2023

Uh oh!

Julesssss commented Aug 18, 2023

Uh oh!

hayata-suenaga Aug 18, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 21, 2023

Uh oh!

OSBotify commented Aug 24, 2023

hayata-suenaga commented Aug 9, 2023 •

edited by github-actions bot

Loading

mananjadhav commented Aug 17, 2023 •

edited

Loading

mananjadhav commented Aug 17, 2023 •

edited

Loading

parasharrajat commented Aug 18, 2023 •

edited

Loading