Read GH Secrets to set env vars by hayata-suenaga · Pull Request #38442 · Expensify/App

hayata-suenaga · 2024-03-16T19:11:17Z

@roryabraham, as you're familiar with the GH workflow files, I'd appreciate if you could review this PR 🙇

Details

This PR modifies the GitHub Workflow for building the App to use the GitHub Secrets added in this internal ticket.

The GH Secrets contains the GCP Geolocation key that is used by the desktop app to fetch the current user location.

Reference to the Electron documentation on the need for the GCP key to fetch the user's current location

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/363543
PROPOSAL: Internal

Tests

This PR modifies the GH workflow for building apps. I will test this PR by running a build workflow

Offline tests

N/A

QA Steps

Open the Desktop New Expensify app. Make sure that you're online.
Global Create -> Request money -> Distance -> Start -> Current location
If you're prompted for the permission to use the current location, grant the permission
Confirm that your current location is chosen and shown on the map

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-03-18T23:04:54Z

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

mkhutornyi · 2024-03-20T14:26:31Z

@hayata-suenaga this doesn't require C+ review, right?

hayata-suenaga · 2024-03-20T15:22:55Z

@mkhutornyi no I don't think we need a C+ review.

roryabraham · 2024-03-20T23:30:35Z

 const useWebProxy = get(Config, 'USE_WEB_PROXY', 'true') === 'true';
 const expensifyComWithProxy = getPlatform() === 'web' && useWebProxy ? '/' : expensifyURL;
-const googleGeolocationAPIKey = get(Config, 'GOOGLE_GEOLOCATION_API_KEY', 'AIzaSyBqg6bMvQU7cPWDKhhzpYqJrTEnSorpiLI');
+const googleGeolocationAPIKey = get(Config, 'GCP_GEOLOCATION_API_KEY', '');


@hayata-suenaga did you mean to remove the default value here?

yes we want to avoid exposing any GCP keys that might result in Expensify being charged for the usage.

I'll add another commit to add a documentation on how to create the GCP key if engineers want to test the current location feature on the local environment

roryabraham · 2024-03-20T23:59:45Z

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 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 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 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.
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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-03-21T00:06:30Z

✋ 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 · 2024-03-22T16:21:12Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.56-0 🚀

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

kavimuru · 2024-03-22T17:21:52Z

@hayata-suenaga Could you help us with QA steps with more details?

kavimuru · 2024-03-25T12:06:59Z

@hayata-suenaga @roryabraham could help with the QA steps?

hayata-suenaga · 2024-03-25T17:29:27Z

oops sorry, I forgot to update the OP 🙇

Open the Desktop New Expensify app. Make sure that you're online.
Global Create -> Request money -> Distance -> Start -> Current location
If you're prompted for the permission to use the current location, grant the permission
Confirm that your current location is chosen and shown on the map

OSBotify · 2024-03-27T04:50:21Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

chore: read GH Secrets to set env vars

d22957d

hayata-suenaga marked this pull request as ready for review March 18, 2024 23:04

hayata-suenaga requested a review from a team as a code owner March 18, 2024 23:04

melvin-bot Bot requested review from mkhutornyi and removed request for a team March 18, 2024 23:04

hayata-suenaga self-assigned this Mar 18, 2024

chore: use the staging GCP key for ad hoc desktop builds

88503aa

hayata-suenaga changed the title ~~[HOLD] Read GH Secrets to set env vars~~ Read GH Secrets to set env vars Mar 18, 2024

roryabraham self-requested a review March 19, 2024 21:25

hayata-suenaga removed the request for review from mkhutornyi March 20, 2024 15:23

roryabraham reviewed Mar 20, 2024

View reviewed changes

roryabraham approved these changes Mar 20, 2024

View reviewed changes

roryabraham merged commit 1a8b66a into main Mar 21, 2024

roryabraham deleted the use-gh-secret-in-workflow branch March 21, 2024 00:00

github-actions Bot mentioned this pull request Mar 22, 2024

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

roryabraham mentioned this pull request Mar 25, 2024

Desktop - IOU - The Distance IOU is unable to determine the user's coordinates #38895

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read GH Secrets to set env vars#38442

Read GH Secrets to set env vars#38442
roryabraham merged 2 commits into
mainfrom
use-gh-secret-in-workflow

hayata-suenaga commented Mar 16, 2024 •

edited

Loading

Uh oh!

melvin-bot Bot commented Mar 18, 2024

Uh oh!

mkhutornyi commented Mar 20, 2024

Uh oh!

hayata-suenaga commented Mar 20, 2024

Uh oh!

roryabraham Mar 20, 2024

Uh oh!

hayata-suenaga Mar 20, 2024

Uh oh!

roryabraham commented Mar 20, 2024

Uh oh!

OSBotify commented Mar 21, 2024

Uh oh!

OSBotify commented Mar 22, 2024

Uh oh!

kavimuru commented Mar 22, 2024

Uh oh!

kavimuru commented Mar 25, 2024

Uh oh!

hayata-suenaga commented Mar 25, 2024 •

edited

Loading

Uh oh!

OSBotify commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

hayata-suenaga commented Mar 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 18, 2024

Uh oh!

mkhutornyi commented Mar 20, 2024

Uh oh!

hayata-suenaga commented Mar 20, 2024

Uh oh!

roryabraham Mar 20, 2024

Choose a reason for hiding this comment

Uh oh!

hayata-suenaga Mar 20, 2024

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Mar 20, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Mar 21, 2024

Uh oh!

OSBotify commented Mar 22, 2024

Uh oh!

kavimuru commented Mar 22, 2024

Uh oh!

kavimuru commented Mar 25, 2024

Uh oh!

hayata-suenaga commented Mar 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hayata-suenaga commented Mar 16, 2024 •

edited

Loading

hayata-suenaga commented Mar 25, 2024 •

edited

Loading