Create a token manager library for MapBox #23511

tgolen · 2023-07-24T20:36:36Z

Details

This library will manage the token for MapBox to ensure that an active token is always used with the MapBox library.

The token is stored in Onyx and passed to the MapBox component
The token is retrieved from an API endpoint
The token expires after 30 minutes
This library will fetch a new token:
- When the current token has expired (the expiration is checked with the app becomes active, as well as when the DistanceRequest component is mounted)
- Every 25 minutes

Fixed Issues

Tests

Note: this library isn't connected to anything now, but it can be tested by modifying a little bit of code. It will be fully tested in later PRs.

Modify src/App.js to import MapboxTokens from './libs/actions/MapboxToken'; and add MapboxTokens(); to the top of the App() function.
Modify src/lib/actions/MapboxTokens.js and change the refreshInterval to 1000 * 10 (so it will refresh every 10 seconds)
Load the app
Open up the JS console
Filter for debug messages with "Mapbox"
Verify that the token is correctly fetched every 10 seconds

Verify that no errors appear in the JS console

Offline tests

QA Steps

No QA. This functionality is not connected to anything yet and it will be QAed in a future PR

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

NOTE: I only tested on web since the only thing being tested are some JS console logs

Web

Mobile Web - Chrome

NA

Mobile Web - Safari

NA

Desktop

NA

iOS

NA

Android

NA

melvin-bot · 2023-07-28T14:51:11Z

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

melvin-bot · 2023-07-28T14:51:16Z

@0xmiroslav @ One of you needs to 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]

0xmiros · 2023-07-28T15:03:00Z

src/libs/actions/MapboxTokens.js

+
+const hasTokenExpired = () => {
+    const now = moment();
+    const expiration = moment(currentToken.expiration);


It will most likely not happen but there might be case when AppState change callback is called before Onyx connect callback, which will cause crash because of undefined currentToken.

Ah yes, you're right. I'll add a check for that.

Updated!

0xmiros · 2023-07-28T15:52:26Z

Is GetMapboxAccessToken api deployed to staging? Not working for me

tgolen · 2023-07-28T16:15:13Z

It's been merged to main, but I don't think it has been deployed yet. Good catch! It should be deployed sometime today so you could try again tomorrow.

situchan · 2023-08-04T23:44:05Z

After logout and login again, token isn't refreshed anymore until app reload

Screen.Recording.2023-08-05.at.5.40.34.AM.mov

thienlnam · 2023-08-05T00:03:20Z

Actually, I think that bug might be fine since we're calling MapboxTokens(); within App, and when you sign out it still exists on that page. I'm not sure where we will end up calling this - but it won't be like the way we are calling it now to test

situchan · 2023-08-05T00:17:03Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

situchan

melvin-bot · 2023-08-05T00:18:25Z

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

Co-authored-by: Carlos Martins <[email protected]>

src/libs/actions/MapboxToken.js

Co-authored-by: Situ Chandra Shil <[email protected]>

situchan · 2023-08-07T16:38:24Z

@tgolen lint failing

melvin-bot · 2023-08-07T17:27:22Z

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

OSBotify · 2023-08-07T17:36:31Z

✋ 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 · 2023-08-07T18:54:10Z

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

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

OSBotify · 2023-08-09T08:43:18Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:12:14Z

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

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

OSBotify · 2023-08-09T09:50:57Z

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

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

OSBotify · 2023-08-10T20:09:23Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

tgolen added 6 commits July 24, 2023 13:59

Add Onyx key and initial method

c9b8494

Handle expired tokens

b0fed71

Add token refresh

5449a64

Add app becomes active handler

c8bb64b

Fix expiration calculation, improve comments, document token shape

416b970

Move timeout logic into refresh method

53fd9f9

tgolen self-assigned this Jul 24, 2023

tgolen added 8 commits July 24, 2023 15:12

Add API calls

c53d822

Merge branch 'main' into tgolen-mapbox-tokenmanager

2ffe94a

Move file to actions and rename

1083804

Add imports and debug logs

f1dd506

Protect against multiple connections

09b09e5

Move refresh interval to a variable

cdcd828

Move API method inside of timeout

957f01c

Add early return and change variable to const

4df7fed

tgolen marked this pull request as ready for review July 28, 2023 14:51

tgolen requested a review from a team as a code owner July 28, 2023 14:51

melvin-bot bot requested review from thesahindia and removed request for a team July 28, 2023 14:51

tgolen requested review from luacmartins and a team and removed request for thesahindia July 28, 2023 14:51

melvin-bot bot requested review from 0xmiros and removed request for a team July 28, 2023 14:51

0xmiros reviewed Jul 28, 2023

View reviewed changes

Protect against undefined token

073fbe6

Comment update

e07ede3

situchan approved these changes Aug 5, 2023

View reviewed changes

melvin-bot bot requested a review from MariaHCD August 5, 2023 00:18

Update src/libs/actions/MapboxToken.js

98336ec

Co-authored-by: Carlos Martins <[email protected]>

tgolen requested a review from luacmartins August 7, 2023 15:23

situchan reviewed Aug 7, 2023

View reviewed changes

src/libs/actions/MapboxToken.js Outdated Show resolved Hide resolved

Update src/libs/actions/MapboxToken.js

de6f49a

Co-authored-by: Situ Chandra Shil <[email protected]>

tgolen requested a review from situchan August 7, 2023 16:30

Merge branch 'main' into tgolen-mapbox-tokenmanager

db9bc9f

Remove unnecessary whitespace

29c6f35

situchan approved these changes Aug 7, 2023

View reviewed changes

melvin-bot bot requested a review from arosiclair August 7, 2023 17:27

neil-marcellini approved these changes Aug 7, 2023

View reviewed changes

neil-marcellini merged commit aa5483d into main Aug 7, 2023

neil-marcellini deleted the tgolen-mapbox-tokenmanager branch August 7, 2023 17:31

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

melvin-bot bot mentioned this pull request Aug 9, 2023

[Awaiting C+ payment - $500] [HOLD for payment 2023-08-16] Implement the MapboxAccessTokenManager #22701

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a token manager library for MapBox #23511

Create a token manager library for MapBox #23511

tgolen commented Jul 24, 2023 •

edited by thienlnam

Loading

melvin-bot bot commented Jul 28, 2023

melvin-bot bot commented Jul 28, 2023

0xmiros Jul 28, 2023

tgolen Jul 28, 2023

0xmiros commented Jul 28, 2023

tgolen commented Jul 28, 2023

situchan commented Aug 4, 2023

thienlnam commented Aug 5, 2023 •

edited

Loading

situchan commented Aug 5, 2023

situchan left a comment

melvin-bot bot commented Aug 5, 2023

situchan commented Aug 7, 2023

melvin-bot bot commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

Create a token manager library for MapBox #23511

Create a token manager library for MapBox #23511

Conversation

tgolen commented Jul 24, 2023 • edited by thienlnam Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 28, 2023

melvin-bot bot commented Jul 28, 2023

0xmiros Jul 28, 2023

Choose a reason for hiding this comment

tgolen Jul 28, 2023

Choose a reason for hiding this comment

0xmiros commented Jul 28, 2023

tgolen commented Jul 28, 2023

situchan commented Aug 4, 2023

thienlnam commented Aug 5, 2023 • edited Loading

situchan commented Aug 5, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 5, 2023

situchan commented Aug 7, 2023

melvin-bot bot commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

tgolen commented Jul 24, 2023 •

edited by thienlnam

Loading

thienlnam commented Aug 5, 2023 •

edited

Loading