[No QA]Add new workflow to validate that HybridApp builds on every commit #55328

AndrewGable · 2025-01-15T22:53:47Z

Explanation of Change

This adds a test that verifies that the PR changes build on HybridApp using the Mobile-Expensify main branch. This test will only run when we think there are changes against files that have the possibility to break the HybridApp build (mainly native and/or dependency changes)

Fixed Issues

$ #54323

Tests

Merge this PR and verify that a PR against a native file or package.json runs this test.
Verify that the build and tests pass as expected
I verified this in my own tests here: https://github.com/Expensify/App/actions/runs/12940019870

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

AndrewGable · 2025-01-24T00:19:55Z

All green! Some last touches required to figure out caching and which files to run this on, then it will be ready for review.

AndrewGable · 2025-01-24T17:53:28Z

Also I don't see this action being run anywhere, is it automatic or just not triggered yet? -- I would like to understand.

It will only run when these conditions are met, so since there are no changes to these files it will not run. It ran earlier before I had this filter and I've attached the results in the tests section.

Julesssss · 2025-01-24T20:01:29Z

Ah thanks 👍

AndrewGable · 2025-01-24T20:31:31Z

Mind reviewing @shubham1206agra ? Thanks!

.github/workflows/verifyHybridApp.yml

shubham1206agra · 2025-01-27T17:23:21Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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.

melvin-bot · 2025-01-27T17:24:11Z

@roryabraham 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 · 2025-01-27T17:31:59Z

.github/workflows/verifyHybridApp.yml

+name: Verify HybridApp build
+
+on:
+  workflow_call:


Did you mean to include workflow_dispatch trigger? workflow_call is for reusable, callable workflows. But we don't have any such usage of this new workflow.

I will remove 👍

roryabraham · 2025-01-27T17:35:43Z

.github/workflows/verifyHybridApp.yml

+          submodules: true
+          ref: ${{ github.event.pull_request.head.sha }}
+          token: ${{ secrets.OS_BOTIFY_TOKEN }}
+          # fetch-depth: 0 is required in order to fetch the correct submodule branch


This is very slow, and most likely not necessary (though a manual git fetch may be necessary in a later step). To start, what happens if we just remove this?

Also, is "the correct submodule branch" just main in Mobile-Expensify?

Also, is "the correct submodule branch" just main in Mobile-Expensify?

It's a specific Mobile-Expensify commit that is locked to the latest commit as/when each App deploy is done.

Is that the case currently, or will it only be the case once #55403 is completed? Also, where do we store the current commit in Mobile-Expensify which E/App staging and production should point to?

My understanding is that currently all staging and production E/App builds use Mobile-Expensify main, but that there's consensus that this is a problem we need to fix. Am I mistaken?

My understanding is that currently all staging and production E/App builds use Mobile-Expensify main, but that there's consensus that this is a problem we need to fix. Am I mistaken?

Yeah, on each App staging build we bump the submodule to the latest commit (see every other commit here).

The problem is that this leads to Mobile-Expensify changes that can break an App release candidate late in a checklist that can break the build without us realising. To solve that we plan to lock the Mobile-Expensify commit for the full checklist -- but we'll give ourselves the option to override this if we need to.

roryabraham · 2025-01-27T17:40:02Z

.github/workflows/verifyHybridApp.yml

+      - name: Update submodule to match main
+        run: |
+          git submodule update --init --remote
+          git fetch


This is also yucky. I feel like what we want is more like this:

git submodule update --init --remote --depth 1

roryabraham · 2025-01-27T17:41:58Z

.github/workflows/verifyHybridApp.yml

+        run: |
+          git submodule update --init --remote
+          git fetch
+          git checkout main


Here, you're checking out the main branch of E/App, right? Is that what we want?

No, I don't think so.

@AndrewGable I think you forgot to do cd Mobile-Expensify first.

Will include in follow up

.github/workflows/verifyHybridApp.yml

roryabraham · 2025-01-27T17:48:45Z

.github/workflows/verifyHybridApp.yml

+          export RCT_NO_LAUNCH_PACKAGER=1
+
+          # Build iOS using xcodebuild
+          if ! xcodebuild \


NABish but maybe create a Fastlane lane for this build command?

roryabraham · 2025-01-27T17:50:14Z

oh, looks like I was too slow with my review. The slow checkouts are kind of blockerish for me (likely takes 2+ minutes and that time will only grow as time goes on). I'd be happy to address them in a follow-up.

OSBotify · 2025-01-27T17:52: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.

AndrewGable · 2025-01-27T17:53:30Z

No worries - I can send a follow up to you

roryabraham · 2025-01-27T17:54:33Z

Created #55805 if you want to take it over

github-actions · 2025-01-28T02:16:07Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.90-0 🚀

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

github-actions · 2025-01-29T06:23:56Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

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

AndrewGable added 22 commits January 15, 2025 15:52

Add new workflow to validate that HybridApp builds on every commit

d3bd9f5

Add flags

45b6c98

Merge branch 'main' into andrew-verify-hybrid

8a5620e

Use fastlane

b7ad7f0

Install ruby on Android runner

5a5acf5

Switch task

7f2f3ab

Use debug scheme

3622a01

Use configuration instead of scheme for iOS

8c5b4ad

Use xcodebuild and gradle manually

05e4a29

Tweak commands

9fc9001

Add RCT_NO_LAUNCH_PACKAGER

621b112

Try setting differently

84fbe76

Merge branch 'main' into andrew-verify-hybrid

63b5dd0

Update submodule

51e1482

Checkout commit manually

1822133

Use main

7ff0979

Install shared js

c64c1f5

Build ios code

c126731

Merge branch 'main' into andrew-verify-hybrid

b636925

Remove bad iOS build code

dcff2a2

Fix shell lint

ed20005

Fix Android shell check lint issues

90e4525

AndrewGable mentioned this pull request Jan 24, 2025

[No QA] Fix workflow warning about changed native files #55518

Closed

50 tasks

AndrewGable added 3 commits January 24, 2025 09:05

Add paths for HybridApp build to limit number of builds

a30b7ed

Merge branch 'main' into andrew-verify-hybrid

bb58023

Revert unused changes

a0b05da

AndrewGable self-assigned this Jan 24, 2025

AndrewGable changed the title ~~Add new workflow to validate that HybridApp builds on every commit~~ [No QA]Add new workflow to validate that HybridApp builds on every commit Jan 24, 2025

AndrewGable requested a review from Julesssss January 24, 2025 16:26

Clean up code

17427b3

Julesssss previously approved these changes Jan 24, 2025

View reviewed changes

shubham1206agra reviewed Jan 24, 2025

View reviewed changes

.github/workflows/verifyHybridApp.yml Show resolved Hide resolved

Update paths

0319348

AndrewGable dismissed Julesssss’s stale review via 0319348 January 24, 2025 21:37

AndrewGable requested a review from shubham1206agra January 24, 2025 21:40

shubham1206agra reviewed Jan 25, 2025

View reviewed changes

.github/workflows/verifyHybridApp.yml Show resolved Hide resolved

shubham1206agra approved these changes Jan 27, 2025

View reviewed changes

melvin-bot bot requested a review from roryabraham January 27, 2025 17:24

Julesssss approved these changes Jan 27, 2025

View reviewed changes

Julesssss merged commit c9cff0d into main Jan 27, 2025
10 of 14 checks passed

Julesssss deleted the andrew-verify-hybrid branch January 27, 2025 17:43

roryabraham requested changes Jan 27, 2025

View reviewed changes

roryabraham mentioned this pull request Jan 27, 2025

[Due for payment 2025-02-13] Improve checkout times in verifyHybridAppBuild workflow #55805

Closed

github-actions bot mentioned this pull request Jan 28, 2025

Deploy Checklist: New Expensify 2025-01-28 #55824

Closed

82 tasks

melvin-bot bot mentioned this pull request Jan 29, 2025

[$250] [HOLD for payment 2025-02-05] [HybridApp][Fire Clean Up] Create HybridApp CI Test #54323

Open

jnowakow mentioned this pull request Jan 29, 2025

[No QA] Remove redundant workflow #55928

Merged

50 tasks

VickyStash mentioned this pull request Jan 29, 2025

Fix wrong default number id usages #55535

Merged

50 tasks

AndrewGable mentioned this pull request Feb 3, 2025

[No QA]Followups for HybridApp building on main test #55807

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA]Add new workflow to validate that HybridApp builds on every commit #55328

[No QA]Add new workflow to validate that HybridApp builds on every commit #55328

AndrewGable commented Jan 15, 2025 •

edited

Loading

AndrewGable commented Jan 24, 2025

AndrewGable commented Jan 24, 2025

Julesssss commented Jan 24, 2025

AndrewGable commented Jan 24, 2025

shubham1206agra commented Jan 27, 2025

melvin-bot bot commented Jan 27, 2025

roryabraham Jan 27, 2025

AndrewGable Jan 27, 2025

roryabraham Jan 27, 2025

Julesssss Jan 27, 2025

roryabraham Jan 27, 2025 •

edited

Loading

Julesssss Jan 27, 2025

roryabraham Jan 27, 2025

roryabraham Jan 27, 2025

shubham1206agra Jan 27, 2025

AndrewGable Jan 27, 2025

roryabraham Jan 27, 2025

roryabraham commented Jan 27, 2025

OSBotify commented Jan 27, 2025

AndrewGable commented Jan 27, 2025

roryabraham commented Jan 27, 2025

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

[No QA]Add new workflow to validate that HybridApp builds on every commit #55328

[No QA]Add new workflow to validate that HybridApp builds on every commit #55328

Conversation

AndrewGable commented Jan 15, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

PR Author Checklist

Screenshots/Videos

AndrewGable commented Jan 24, 2025

AndrewGable commented Jan 24, 2025

Julesssss commented Jan 24, 2025

AndrewGable commented Jan 24, 2025

shubham1206agra commented Jan 27, 2025

Reviewer Checklist

melvin-bot bot commented Jan 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roryabraham Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roryabraham commented Jan 27, 2025

OSBotify commented Jan 27, 2025

AndrewGable commented Jan 27, 2025

roryabraham commented Jan 27, 2025

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

AndrewGable commented Jan 15, 2025 •

edited

Loading

roryabraham Jan 27, 2025 •

edited

Loading