Use installation token for OS Botify #23760

justinpersaud · 2023-07-27T20:47:52Z

Details

Switch our actions jobs to use an installation token instead of PAT

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/299601
PROPOSAL:

Tests

https://github.com/Expensify/App/actions/runs/5717994375/job/15492912210

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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 / Chrome
- iOS / native
- iOS / 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
- 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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…y_app

justinpersaud · 2023-07-27T20:49:46Z

.github/workflows/createNewVersion.yml

+      - name: Generate a token
+        id: generate_token
+        uses: tibdex/github-app-token@021a2405c7f990db57f5eae5397423dcc554159c
+        with:
+          app_id: ${{ secrets.OS_BOTIFY_APP_ID }}
+          private_key: ${{ secrets.OS_BOTIFY_PRIVATE_KEY }}
+          installation_id: ${{ secrets.OS_BOTIFY_INSTALLATION_ID }}


@roryabraham this is just a draft while I work through this but what are your thoughts about having the token generation be in this step as opposed to an independent job? I was having some trouble figuring out how to securely pass the output of the token into another job because github actions redacts/blanks it out due to it being a sensitive value. If it's in the same job, I can reference it via ${{ steps.generate_token.outputs.token }}

So recall that setupGitForOSBotify is an action not a worklow, so it's always going to be scoped to just a single job (and by extension a single runner). So we shouldn't need or want to pass tokens between runners.

Does that answer your question?

Sort of. Are you suggesting we move this step into setupGitForOSBotify then? And if we do that, how do we use that token in these next steps instead of the under the hood GITHUB_TOKEN the jobs use?

The part I think I'm missing is how we access an output from one action outside of it in another step?

Ok, I think I figured it out and got a little further. Long story short, order of operations matters here because we're flipping between the action token used in the job and the new token for OS Botify

https://github.com/Expensify/App/actions/runs/5686198797/job/15412567692

I think I'm getting this next error because I need to allow OS Botify App to override our branch protections and push to main.

melvin-bot · 2023-07-31T18:02:01Z

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

.github/actions/composite/setupGitForOSBotify/action.yml

Co-authored-by: Andrew Gable <andrew@expensify.com>

…y_app

justinpersaud · 2023-08-01T14:44:02Z

Pushed @AndrewGable's suggested change and retested here https://github.com/Expensify/App/actions/runs/5728276127/job/15522468403

roryabraham

I am still seeing a lot of uses of secrets.OS_BOTIFY_TOKEN in other workflows. Were you thinking we'd just start with these for the sake of testing, or should we update the other usages as well?

justinpersaud · 2023-08-01T23:19:05Z

Yeah I thought maybe start here and make sure it works then update others?

roryabraham · 2023-08-01T23:40:44Z

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

roryabraham

LGTM 👍🏼

roryabraham · 2023-08-01T23:41:56Z

Will let you self-merge when you're ready to live-test

OSBotify · 2023-08-02T15:56:21Z

✋ 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-03T17:42:04Z

🚀 Deployed to staging by https://github.com/justinpersaud in version: 1.3.50-0 🚀

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

OSBotify · 2023-08-07T18:30:24Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

OSBotify · 2023-08-07T18:57:37Z

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

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

OSBotify · 2023-08-09T08:46:45Z

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

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

justinpersaud added 14 commits July 25, 2023 15:23

Add action for OS BOTIFY github app

9bb8753

use latest commit

bc8625b

add installation id

6d19bfa

Use installation token instead of OS_BOTIFY_TOKEN

747b8bb

Merge branch 'main' of github.com:Expensify/App into jpersaud_osbotif…

d519aef

…y_app

fix brackets

d7453b0

update revision

aebdca4

comment out permission check temporarily

5876741

add token to other steps

a8aef1f

move token gen to new job, add output

6a31248

disable slack announce for now

37c53f3

add requirement for token job

6d61ee7

move token generation into same job

b716195

remove unused job

2c09f65

justinpersaud requested a review from roryabraham July 27, 2023 20:47

justinpersaud self-assigned this Jul 27, 2023

justinpersaud commented Jul 27, 2023

View reviewed changes

justinpersaud added 11 commits July 27, 2023 18:43

move token to setupGitForOSBotify

217eefd

change order of steps

4e58b80

use action token for repo checkout

3e9cf1d

use osbotify PAT for push

5e8cb85

run -> with

02f9de4

move the botify token to the checkout action

b9ef7de

rename tokens

5cdde7e

switch tokens

53979b7

fix linting errors

299318d

restore validateActor

5b155ee

re-enable slack notificaitons

82bb61c

justinpersaud marked this pull request as ready for review July 31, 2023 18:01

justinpersaud requested a review from a team as a code owner July 31, 2023 18:01

melvin-bot bot requested review from robertKozik and removed request for a team July 31, 2023 18:02

justinpersaud requested review from AndrewGable and removed request for robertKozik July 31, 2023 18:02

AndrewGable reviewed Aug 1, 2023

View reviewed changes

.github/actions/composite/setupGitForOSBotify/action.yml Outdated Show resolved Hide resolved

justinpersaud and others added 2 commits August 1, 2023 10:37

Update .github/actions/composite/setupGitForOSBotify/action.yml

66bb752

Co-authored-by: Andrew Gable <andrew@expensify.com>

Merge branch 'main' of github.com:Expensify/App into jpersaud_osbotif…

c20e7ac

…y_app

roryabraham reviewed Aug 1, 2023

View reviewed changes

roryabraham approved these changes Aug 1, 2023

View reviewed changes

justinpersaud merged commit 615c8a1 into main Aug 2, 2023
11 of 12 checks passed

justinpersaud deleted the jpersaud_osbotify_app branch August 2, 2023 15:51

justinpersaud mentioned this pull request Aug 2, 2023

Revert "Use installation token for OS Botify" #24060

Merged

58 tasks

OSBotify mentioned this pull request Aug 3, 2023

Deploy Checklist: New Expensify 2023-08-03 #24121

Closed

86 tasks

OSBotify mentioned this pull request Aug 7, 2023

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

Closed

98 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use installation token for OS Botify #23760

Use installation token for OS Botify #23760

justinpersaud commented Jul 27, 2023 •

edited

Loading

justinpersaud Jul 27, 2023

roryabraham Jul 27, 2023

justinpersaud Jul 27, 2023

justinpersaud Jul 27, 2023

melvin-bot bot commented Jul 31, 2023

justinpersaud commented Aug 1, 2023

roryabraham left a comment

justinpersaud commented Aug 1, 2023

roryabraham commented Aug 1, 2023 •

edited

Loading

roryabraham left a comment

roryabraham commented Aug 1, 2023

OSBotify commented Aug 2, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

Use installation token for OS Botify #23760

Use installation token for OS Botify #23760

Conversation

justinpersaud commented Jul 27, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

justinpersaud Jul 27, 2023

Choose a reason for hiding this comment

roryabraham Jul 27, 2023

Choose a reason for hiding this comment

justinpersaud Jul 27, 2023

Choose a reason for hiding this comment

justinpersaud Jul 27, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Jul 31, 2023

justinpersaud commented Aug 1, 2023

roryabraham left a comment

Choose a reason for hiding this comment

justinpersaud commented Aug 1, 2023

roryabraham commented Aug 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Aug 1, 2023

OSBotify commented Aug 2, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

justinpersaud commented Jul 27, 2023 •

edited

Loading

roryabraham commented Aug 1, 2023 •

edited

Loading