[No QA] Callable buildAndroid workflow #49434

roryabraham · 2024-09-19T01:51:40Z

Details

Making callable Android build workflow. This has several advantages:

DRYs up Android build code (which will be particularly useful for CP to Prod)
Makes workflow artifacts readily available for download on every build
allows for better retryability. i.e, if a build succeeds but an upload fails, we can retry just the upload without waiting for the build to happen again

Fixed Issues

$ n/a - related to CP To Prod

Tests

Live-testing this. We can test e2e builds and AdHoc builds before merging.

AdHoc test run: https://github.com/Expensify/App/actions/runs/11059940518
E2E Performance test run: https://github.com/Expensify/App/actions/runs/11060386432
Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

n/a

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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-09-19T01:51:45Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

melvin-bot · 2024-09-26T20:37:28Z

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

roryabraham · 2024-10-02T15:54:27Z

ok, AdHocs are working, just need to fix e2ePerformanceTests (and we'll have to see about deploy.yml live)

roryabraham · 2024-10-02T20:36:49Z

ok, so I think this is working as expected. The last e2e performance test failed, because it checked out a different ref for the baseline and one of the underlying environment variables exported from the Fastfile has been renamed. Let's put this in review

github-actions · 2024-10-03T00:34:23Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/49434/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49434/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49434/NewExpensify.dmg	https://49434.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

github-actions · 2024-10-03T01:52:09Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/49434/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49434/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49434/NewExpensify.dmg	https://49434.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

AndrewGable · 2024-10-03T18:02:17Z

.github/workflows/buildAndroid.yml

+          # Reload environment variables from GITHUB_ENV
+          # shellcheck disable=SC1090
+          source "$GITHUB_ENV"


What does this do and why is it required?

Explained in this comment, but let me add a permanent code comment

Tried to improve the code comment, let me know what you think

AndrewGable · 2024-10-03T18:03:18Z

.github/workflows/deploy.yml

-          MYAPP_UPLOAD_STORE_PASSWORD: ${{ secrets.MYAPP_UPLOAD_STORE_PASSWORD }}
-          MYAPP_UPLOAD_KEY_PASSWORD: ${{ secrets.MYAPP_UPLOAD_KEY_PASSWORD }}
+      - name: Log downloaded artifact paths
+        run: ls -R /tmp/artifacts


Do we still need this? Maybe let's make a follow up to remove.

I can remove it if you prefer, but I was also thinking why not just let it stay? It's not really doing any harm there, kind of makes the directory structure clear and shows you the name of files that are currently only represented as variables in the code 🙂

AndrewGable · 2024-10-03T18:03:51Z

.github/workflows/deploy.yml

+  submitAndroid:
+    name: Submit Android app for production review
+    needs: prep
+    if: ${{ github.ref == 'refs/heads/production' }}


Any reason we moved away from SHOULD_DEPLOY_PRODUCTION?

There are some contexts (such as this one) where the env context is not available. It's only available within steps, not at the job level or higher. Fortunately this was caught by actionslint

AndrewGable · 2024-10-03T19:58:43Z

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

N/A - No user code

Android: mWeb Chrome

N/A - No user code

iOS: Native

N/A - No user code

iOS: mWeb Safari

N/A - No user code

MacOS: Chrome / Safari

N/A - No user code

MacOS: Desktop

N/A - No user code

[No QA] Callable buildAndroid workflow (cherry picked from commit d1fcb16) (CP triggered by jasperhuangg)

OSBotify · 2024-10-03T20:13:45Z

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

github-actions · 2024-10-03T20:44:08Z

🚀 Cherry-picked to staging by https://github.com/jasperhuangg in version: 9.0.44-4 🚀

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

github-actions · 2024-10-04T20:57:58Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.44-12 🚀

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

roryabraham added 3 commits September 18, 2024 12:59

Remove unused VERSION environment variables

8ef859c

Save draft state

a449e56

Create and use callable buildAndroid workflow

e2d2dfb

roryabraham self-assigned this Sep 19, 2024

roryabraham added 16 commits September 18, 2024 18:53

Add quotes in case statement

281d558

Simplify environment variable names

bb94f92

Separate upload and submit step for Android deploys

b09fc11

Add continue-on-error for artifact upload steps

5aa4d48

Merge branch 'main' into Rory-CallableBuild

a5a8a4b

Merge branch 'main' into Rory-CallableBuild

c165fd4

Fix checkDeploymentSuccess job

019fcb2

Fix needs for other jobs

6235d41

Implement buildAndroid job in testBuild

00ffdda

Merge branch 'main' into Rory-CallableBuild

21e2ecb

Setup dotenv for e2e and e2eDelta builds

e4c568e

Add artifact-prefix input

87b7ca1

Refactor e2ePerformanceTests to use callable builds

5146322

Delete now-unused buildAndroidE2EAPK composite action

7e3c936

Use correct variable when checking if all platforms were a success

48336e3

Add better comment for creating branch

011e8d8

roryabraham changed the title ~~[WIP] Callable build workflows~~ Callable build workflows Sep 26, 2024

roryabraham changed the title ~~Callable build workflows~~ [No QA] Callable build workflows Sep 26, 2024

Fix actionslint

581c2c6

roryabraham requested a review from AndrewGable September 26, 2024 20:36

roryabraham marked this pull request as ready for review September 26, 2024 20:37

roryabraham requested a review from a team as a code owner September 26, 2024 20:37

melvin-bot bot removed the request for review from a team September 26, 2024 20:37

roryabraham changed the title ~~[No QA] Callable build workflows~~ [WIP][No QA] Callable build workflows Sep 26, 2024

This comment was marked as outdated.

Sign in to view

roryabraham added 3 commits October 2, 2024 08:54

Merge branch 'main' into Rory-CallableBuild

9cd621a

Fix artifact name in e2e download-artifact

c283f7c

Invert skip condition for building the baseline artifact

4097a12

roryabraham added 3 commits October 2, 2024 16:19

Remove unnecessary if statement

660020d

Consolidate S3 paths

342f861

exportS3Path singular

f2c9d7f

roryabraham mentioned this pull request Oct 3, 2024

[No QA] Callable buildIOS workflow #50123

Merged

50 tasks

roryabraham added 3 commits October 2, 2024 17:36

Provide pull_request_number to AdHoc builds

9f6280a

Make it type: string to make lint happy

74420b6

Don't access env where it's not available

5a4d56d

AndrewGable reviewed Oct 3, 2024

View reviewed changes

Improve comment

4e452c8

roryabraham requested a review from AndrewGable October 3, 2024 19:04

AndrewGable approved these changes Oct 3, 2024

View reviewed changes

AndrewGable merged commit d1fcb16 into main Oct 3, 2024
18 of 20 checks passed

AndrewGable deleted the Rory-CallableBuild branch October 3, 2024 20:03

OSBotify pushed a commit that referenced this pull request Oct 3, 2024

Merge pull request #49434 from Expensify/Rory-CallableBuild

6d9309a

[No QA] Callable buildAndroid workflow (cherry picked from commit d1fcb16) (CP triggered by jasperhuangg)

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Oct 3, 2024

github-actions bot mentioned this pull request Oct 3, 2024

Deploy Checklist: New Expensify 2024-10-03 #50125

Closed

63 tasks

justinpersaud mentioned this pull request Oct 4, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Build apk from delta ref / Build Android app #50242

Closed

s77rt mentioned this pull request Oct 8, 2024

Investigate workflow job failing on main: e2ePerformanceTests / Build apk from delta ref / Build Android app #50431

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Callable buildAndroid workflow #49434

[No QA] Callable buildAndroid workflow #49434

roryabraham commented Sep 19, 2024 •

edited

Loading

melvin-bot bot commented Sep 19, 2024

melvin-bot bot commented Sep 26, 2024

This comment was marked as outdated.

roryabraham commented Oct 2, 2024

roryabraham commented Oct 2, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

AndrewGable Oct 3, 2024

roryabraham Oct 3, 2024

roryabraham Oct 3, 2024

AndrewGable Oct 3, 2024

roryabraham Oct 3, 2024

AndrewGable Oct 3, 2024

roryabraham Oct 3, 2024

AndrewGable commented Oct 3, 2024

OSBotify commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 4, 2024

[No QA] Callable buildAndroid workflow #49434

[No QA] Callable buildAndroid workflow #49434

Conversation

roryabraham commented Sep 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 19, 2024

melvin-bot bot commented Sep 26, 2024

This comment was marked as outdated.

roryabraham commented Oct 2, 2024

roryabraham commented Oct 2, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

AndrewGable Oct 3, 2024

Choose a reason for hiding this comment

roryabraham Oct 3, 2024

Choose a reason for hiding this comment

roryabraham Oct 3, 2024

Choose a reason for hiding this comment

AndrewGable Oct 3, 2024

Choose a reason for hiding this comment

roryabraham Oct 3, 2024

Choose a reason for hiding this comment

AndrewGable Oct 3, 2024

Choose a reason for hiding this comment

roryabraham Oct 3, 2024

Choose a reason for hiding this comment

AndrewGable commented Oct 3, 2024

Reviewer Checklist

Screenshots/Videos

OSBotify commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 4, 2024

roryabraham commented Sep 19, 2024 •

edited

Loading