[NO QA] Call Web-E API to get temporary token in Mapbox setup script #25545

hayata-suenaga · 2023-08-20T16:32:14Z

@neil-marcellini @tgolen
cc: @fabioh8010 @blazejkustra because this PR involves TypeScript code

Details

Most of the context behind this PR is covered in the issue description here.

This PR gets rid of existing bash scripts that I added in this PR. These bash scripts helped contributors

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/309451 (for calling a Web-E endpoint)
$ #25442 (for re-writing bash scripts in node/typescript)

Tests

For engineers:

Check out the branch hayata-change-mapbox-setup-script
Change this line as below:
```
const TOKEN_ENDPOINT = 'https://my-json-server.typicode.com/hayata-suenaga/mapbox-mock-response/token';
```
You can skip this step if this issue is closed and both this PR and this PR are merged. Otherwise, this step ensures that the script calls a mock API that I set up temporarily to simulate the response that will be returned once new API command in Web-E is deployed.
Run npm run configure-mapbox
Open ~/.netrc and confirm that the file includes the content below:
```
machine api.mapbox.com
login mapbox
password example-token
```
Open ~/.gradle/gradle.properties and confirm that the file includes the content below:
```
MAPBOX_DOWNLOADS_TOKEN=example-token
```
Repeat steps 3 ~ 5 and confirm that there isn't a duplicate entry in .netrc and gradle.properties

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-20T16:32:45Z

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

allroundexperts · 2023-08-20T18:28:03Z

.eslintignore

 **/node_modules/*
 **/dist/*
 .github/actions/**/index.js"
+/scripts/**


Do we need to ignore this script? Since its written in TS, it makes sense to lint it as well.

I think because these are node scripts and have different requirements/environment so existing ESLint rules might not make sense so I decided to exclude them from linting for now

I don't think we should ignore them. Node scripts are just like any other JS script and the same formatting and styles should apply to them. We've seen this in the GitHub actions as well. It makes sense that JS code everywhere is consistent, regardless of the platform it's running on.

allroundexperts · 2023-08-20T18:28:51Z

package.json

    "@vercel/ncc": "^0.27.0",
    "@welldone-software/why-did-you-render": "7.0.1",
    "ajv-cli": "^5.0.0",
+    "axios": "^1.4.0",


For a simple call like this plain fetch should be sufficient. No?

ah I didn't know fetch exits in node run time. trying to see if fetch works

You'll need a pollyfill. Ignore this if it requires too much work to add a polyfill!

hayatasuenaga@Hayatas-Work-MBP App % npm run configure-mapbox > new.expensify@1.3.55-7 configure-mapbox > ts-node scripts/setup-mapbox-sdk-local.ts Error: fetch is not defined

Fetch API was apparently introduced in Node 17. App repo somehow still uses node 16 (see the engines field in package.json) 😭 so fetch is not available.

ts-node uses the node that is active in the current terminal session, which is node 16 in the App repo

The other option is to use https module from node but the syntax is kind of verbose (even considering that we only need to make one API call). So, I'm thinking of sticking with axios. What do you think @allroundexperts

Since there is only one API call, I think using https is fine. Yes, it's more verbose, but adding this package just to make one API call is overkill.

scripts/setup-mapbox-sdk.ts

allroundexperts · 2023-08-20T18:32:03Z

scripts/setup-mapbox-sdk.ts

+
+async function main(): Promise<void> {
+    try {
+        const response = await axios.get(TOKEN_ENDPOINT);


Since we're doing this in TS, how about typing the response as well?

I'm actually not a huge fun of typing API responses. I like leaving response values as any or undefined to do type narrowing.

I made a change in this commit to add type checking for type narrowing: 5497523

allroundexperts

Great job @hayata-suenaga 🎖️ 🎖️ 🎖️

Requested some minor changes.

package.json

allroundexperts · 2023-08-20T18:34:50Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

This reverts commit c7b377e.

scripts/setup-mapbox-sdk-ci.ts

scripts/setup-mapbox-sdk-local.ts

scripts/setup-mapbox-sdk.ts

blazejkustra

Looking good in terms of Typescript! 💯

hayata-suenaga · 2023-08-21T14:42:53Z

For this build failure, I apparently selected a wrong branch. I'm re-running the test build with the correct branch here

hayata-suenaga · 2023-08-21T14:57:25Z

okay the test builds succeeded 🚀

fabioh8010

LGTM!

hayata-suenaga · 2023-08-22T00:46:31Z

Re-running test builds here: https://github.com/Expensify/App/actions/runs/5933032590

OSBotify · 2023-08-22T00:47:00Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the android build failed	The QR code can't be generated, because the iOS build failed
desktop 💻	web 🕸️
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the Desktop build failed	The QR code can't be generated, because the web build failed

hayata-suenaga · 2023-08-22T23:15:28Z

NOTE for myself

Fix this: https://expensify.slack.com/archives/C03TQ48KC/p1692745804074509

tgolen · 2023-08-23T15:29:34Z

.eslintignore

 **/node_modules/*
 **/dist/*
 .github/actions/**/index.js"
+/scripts/**


I don't think we should ignore them. Node scripts are just like any other JS script and the same formatting and styles should apply to them. We've seen this in the GitHub actions as well. It makes sense that JS code everywhere is consistent, regardless of the platform it's running on.

tgolen · 2023-08-23T15:31:00Z

package.json

    "@vercel/ncc": "^0.27.0",
    "@welldone-software/why-did-you-render": "7.0.1",
    "ajv-cli": "^5.0.0",
+    "axios": "^1.4.0",


Since there is only one API call, I think using https is fine. Yes, it's more verbose, but adding this package just to make one API call is overkill.

scripts/setup-mapbox-sdk.ts

hayata-suenaga · 2023-08-23T17:24:58Z

By the way, this is expected because the new Web-E API command hasn't been deployed yet.

tgolen · 2023-08-25T16:19:23Z

@hayata-suenaga Is this ready for review again? It looks like there are a couple of conflicts.

grgia · 2023-08-28T08:22:51Z

bump on merge conflicts

hayata-suenaga · 2023-08-28T15:25:58Z

thank you for reminding me @grgia we're currently treating this as lower priority so I gonna go back to this PR later this week 🙇

hayata-suenaga · 2023-09-11T03:24:10Z

Changing the priority to LOW because this is not a necessity right now.

This mostly improves the setup that new contributors need to do.

Because this PR will affect the build process, we want to be sure before merge

tgolen · 2023-10-27T14:53:15Z

@hayata-suenaga What is the plan for this? Should the PR just be closed?

hayata-suenaga · 2023-10-27T18:04:03Z

I was originally planning to resume working on and merge this after Money2020

I don't know how much we need this PR. I think it's still nice to have feature. What do you think @tgolen ?

tgolen · 2023-10-30T13:42:08Z

I think I would just close this. If anyone feels it is painful enough to solve, we can reopen at a later time.

hayata-suenaga · 2023-10-30T21:16:32Z

according to this comment, I'm closing this for now.

allroundexperts · 2023-10-31T06:59:47Z

@hayata-suenaga I might be eligible for partial compensation here as I did a review.

hayata-suenaga · 2023-10-31T17:35:40Z

sure I'm sorry that I didn't realize that. Asked for the payment to you here

Hayata Suenaga added 2 commits August 20, 2023 09:30

feat: call api in setup script to get token

fc8ea15

chore: calll real endpoint

02285ef

hayata-suenaga requested a review from a team as a code owner August 20, 2023 16:32

melvin-bot bot removed the request for review from a team August 20, 2023 16:32

melvin-bot bot requested a review from grgia August 20, 2023 16:32

Hayata Suenaga added 2 commits August 20, 2023 09:45

feat: update npm script to use node script

f516971

style: define const for URL

0c7eef3

hayata-suenaga changed the title ~~Call Web-E API to get temporary token in Mapbox setup script~~ [NO QA] Call Web-E API to get temporary token in Mapbox setup script Aug 20, 2023

hayata-suenaga mentioned this pull request Aug 20, 2023

[HOLD 309451] Rewrite setup-mapbox-sdk.sh in Node for better cross-platform support #25442

Closed

hayata-suenaga requested a review from allroundexperts August 20, 2023 18:01

hayata-suenaga self-assigned this Aug 20, 2023

allroundexperts reviewed Aug 20, 2023

View reviewed changes

scripts/setup-mapbox-sdk.ts Outdated Show resolved Hide resolved

allroundexperts reviewed Aug 20, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

Hayata Suenaga added 3 commits August 20, 2023 11:44

style: add setup script for local environment

cd3ed21

feat: add setup script for ci environment

1f35417

feat: use new node script on ci

2efeaf2

hayata-suenaga added the Ready To Build label Aug 20, 2023

Hayata Suenaga added 6 commits August 20, 2023 12:11

style: define const for gradle dir

6f5f7bb

chore: try fetch

c7b377e

Revert "chore: try fetch"

bc43f14

This reverts commit c7b377e.

style: add type check for response data

5497523

chore: change the test URL to actual URL

8e6060e

chore: remove unused scripts

b100f94

hayata-suenaga changed the title ~~[NO QA] Call Web-E API to get temporary token in Mapbox setup script~~ [NO QA] [HOLD Web-E #38559] Call Web-E API to get temporary token in Mapbox setup script Aug 21, 2023

fabioh8010 reviewed Aug 21, 2023

View reviewed changes

scripts/setup-mapbox-sdk-ci.ts Outdated Show resolved Hide resolved

scripts/setup-mapbox-sdk-local.ts Show resolved Hide resolved

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

style: simplify conditional check

f48525f

blazejkustra approved these changes Aug 21, 2023

View reviewed changes

fabioh8010 approved these changes Aug 21, 2023

View reviewed changes

Hayata Suenaga added 3 commits August 21, 2023 17:27

fix: remove setup scripts calls

c6e9cac

Merge branch 'main' into hayata-change-mapbox-setup-script

063712c

fix: update script to call to the new one

adc0d90

tgolen requested changes Aug 23, 2023

View reviewed changes

Hayata Suenaga added 4 commits August 23, 2023 09:27

chore(deps): remove axios

04260a0

fix: remove unnecessary await

3caf476

style: remove axois and async/await pattern

d22c47f

style: lint node scripts

21464b0

hayata-suenaga changed the title ~~[NO QA] [HOLD Web-E #38559] Call Web-E API to get temporary token in Mapbox setup script~~ [NO QA] Call Web-E API to get temporary token in Mapbox setup script Aug 24, 2023

hayata-suenaga closed this Oct 30, 2023

[NO QA] Call Web-E API to get temporary token in Mapbox setup script #25545

[NO QA] Call Web-E API to get temporary token in Mapbox setup script #25545

Uh oh!

Conversation

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

Uh oh!

Details

Fixed Issues

Tests

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Aug 20, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

allroundexperts commented Aug 20, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blazejkustra left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga commented Aug 21, 2023

Uh oh!

hayata-suenaga commented Aug 21, 2023

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga commented Aug 22, 2023

Uh oh!

OSBotify commented Aug 22, 2023

Uh oh!

hayata-suenaga commented Aug 22, 2023

NOTE for myself

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

tgolen commented Aug 25, 2023

Uh oh!

grgia commented Aug 28, 2023

Uh oh!

hayata-suenaga commented Aug 28, 2023

hayata-suenaga commented Aug 20, 2023 •

edited

Loading

blazejkustra left a comment •

edited

Loading

hayata-suenaga commented Aug 23, 2023 •

edited

Loading