-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52629 from software-mansion-labs/feat/old-dot-sub…
…module [NoQA] [HybridApp] Add Mobile-Expensify submodule and build HybridApp on both platforms
- Loading branch information
Showing
26 changed files
with
298 additions
and
292 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -163,46 +163,25 @@ jobs: | |
| name: Build and deploy Android HybridApp | ||
| needs: prep | ||
| runs-on: ubuntu-latest-xl | ||
| defaults: | ||
| run: | ||
| working-directory: Mobile-Expensify/react-native | ||
| steps: | ||
| - name: Checkout App repo | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Checkout Mobile-Expensify repo | ||
| - name: Checkout App and Mobile-Expensify repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: 'Expensify/Mobile-Expensify' | ||
| submodules: true | ||
| path: 'Mobile-Expensify' | ||
| token: ${{ secrets.OS_BOTIFY_TOKEN }} | ||
| # fetch-depth: 0 is required in order to fetch the correct submodule branch | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Update submodule | ||
| - name: Update submodule to match main | ||
| run: | | ||
| git submodule update --init | ||
| # Update submodule to latest on staging | ||
| git fetch | ||
| git checkout staging | ||
| git submodule update --init --remote | ||
| - name: Configure MapBox SDK | ||
| run: ./scripts/setup-mapbox-sdk.sh ${{ secrets.MAPBOX_SDK_DOWNLOAD_TOKEN }} | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: 'Mobile-Expensify/react-native/.nvmrc' | ||
| cache: npm | ||
| cache-dependency-path: 'Mobile-Expensify/react-native' | ||
|
|
||
| - name: Install node modules | ||
| run: | | ||
| npm install | ||
| cd .. && npm install | ||
| # Fixes https://github.com/Expensify/App/issues/51682 | ||
| npm run grunt:build:shared | ||
| - name: Setup Node | ||
| id: setup-node | ||
| uses: ./.github/actions/composite/setupNode | ||
|
|
||
| - name: Setup Java | ||
| uses: actions/setup-java@v4 | ||
|
|
@@ -214,7 +193,6 @@ jobs: | |
| uses: ruby/[email protected] | ||
| with: | ||
| bundler-cache: true | ||
| working-directory: 'Mobile-Expensify/react-native' | ||
|
|
||
| - name: Install New Expensify Gems | ||
| run: bundle install | ||
|
|
@@ -229,7 +207,7 @@ jobs: | |
| op document get --output ./upload-key.keystore upload-key.keystore | ||
| op document get --output ./android-fastlane-json-key.json android-fastlane-json-key.json | ||
| # Copy the keystore to the Android directory for Fullstory | ||
| cp ./upload-key.keystore ../Android | ||
| cp ./upload-key.keystore Mobile-Expensify/Android | ||
| - name: Load Android upload keystore credentials from 1Password | ||
| id: load-credentials | ||
|
|
@@ -496,47 +474,31 @@ jobs: | |
| runs-on: macos-13-xlarge | ||
| env: | ||
| DEVELOPER_DIR: /Applications/Xcode_15.2.0.app/Contents/Developer | ||
| defaults: | ||
| run: | ||
| working-directory: Mobile-Expensify/react-native | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: 'Expensify/Mobile-Expensify' | ||
| submodules: true | ||
| path: 'Mobile-Expensify' | ||
| token: ${{ secrets.OS_BOTIFY_TOKEN }} | ||
| # fetch-depth: 0 is required in order to fetch the correct submodule branch | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Update submodule | ||
| run: | | ||
| git submodule update --init | ||
| # Update submodule to latest on staging | ||
| git fetch | ||
| git checkout staging | ||
| git submodule update --init --remote | ||
| - name: Configure MapBox SDK | ||
| run: | | ||
| ./scripts/setup-mapbox-sdk.sh ${{ secrets.MAPBOX_SDK_DOWNLOAD_TOKEN }} | ||
| - uses: actions/setup-node@v4 | ||
| - name: Setup Node | ||
| id: setup-node | ||
| with: | ||
| node-version-file: 'Mobile-Expensify/react-native/.nvmrc' | ||
| cache-dependency-path: 'Mobile-Expensify/react-native' | ||
|
|
||
| - name: Install node modules | ||
| run: | | ||
| npm install | ||
| cd .. && npm install | ||
| uses: ./.github/actions/composite/setupNode | ||
|
|
||
| - name: Setup Ruby | ||
| uses: ruby/[email protected] | ||
| with: | ||
| bundler-cache: true | ||
| working-directory: 'Mobile-Expensify/react-native' | ||
|
|
||
| - name: Install New Expensify Gems | ||
| run: bundle install | ||
|
|
@@ -545,20 +507,20 @@ jobs: | |
| uses: actions/cache@v4 | ||
| id: pods-cache | ||
| with: | ||
| path: ios/Pods | ||
| key: ${{ runner.os }}-pods-cache-${{ hashFiles('ios/Podfile.lock', 'firebase.json') }} | ||
| path: Mobile-Expensify/ios/Pods | ||
| key: ${{ runner.os }}-pods-cache-${{ hashFiles('Mobile-Expensify/ios/Podfile.lock', 'firebase.json') }} | ||
|
|
||
| - name: Compare Podfile.lock and Manifest.lock | ||
| id: compare-podfile-and-manifest | ||
| run: echo "IS_PODFILE_SAME_AS_MANIFEST=${{ hashFiles('ios/Podfile.lock') == hashFiles('ios/Pods/Manifest.lock') }}" >> "$GITHUB_OUTPUT" | ||
| run: echo "IS_PODFILE_SAME_AS_MANIFEST=${{ hashFiles('Mobile-Expensify/ios/Podfile.lock') == hashFiles('Mobile-Expensify/ios/Pods/Manifest.lock') }}" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Install cocoapods | ||
| uses: nick-fields/retry@3f757583fb1b1f940bc8ef4bf4734c8dc02a5847 | ||
| if: steps.pods-cache.outputs.cache-hit != 'true' || steps.compare-podfile-and-manifest.outputs.IS_PODFILE_SAME_AS_MANIFEST != 'true' || steps.setup-node.outputs.cache-hit != 'true' | ||
| with: | ||
| timeout_minutes: 10 | ||
| max_attempts: 5 | ||
| command: cd Mobile-Expensify/iOS && pod install | ||
| command: npm run pod-install | ||
|
|
||
| - name: Install 1Password CLI | ||
| uses: 1password/install-cli-action@v1 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "Mobile-Expensify"] | ||
| path = Mobile-Expensify | ||
| url = https://github.com/Expensify/Mobile-Expensify.git |
Submodule Mobile-Expensify
added at
7df7a0
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -437,6 +437,102 @@ export default withOnyx({ | |
| 1. The application uses [`react-navigation`](https://reactnavigation.org/) for navigating between parts of the app. | ||
| 1. [Higher Order Components](https://reactjs.org/docs/higher-order-components.html) are used to connect React components to persistent storage via [`react-native-onyx`](https://github.com/Expensify/react-native-onyx). | ||
| ---- | ||
| # HybridApp | ||
| Currently, the production Expensify app contains both "Expensify Classic" and "New Expensify". The file structure is as follows: | ||
| - 📂 [**App**](https://github.com/Expensify/App) | ||
| - 📂 [**android**](https://github.com/Expensify/App/tree/main/android): New Expensify Android specific code (not a part of HybridApp native code) | ||
| - 📂 [**ios**](https://github.com/Expensify/App/tree/main/ios): New Expensify iOS specific code (not a part of HybridApp native code) | ||
| - 📂 [**src**](https://github.com/Expensify/App/tree/main/src): New Expensify TypeScript logic | ||
| - 📂 [**Mobile-Expensify**](https://github.com/Expensify/Mobile-Expensify): `git` submodule that is pointed to [Mobile-Expensify](https://github.com/Expensify/Mobile-Expensify) | ||
| - 📂 [**Android**](https://github.com/Expensify/Mobile-Expensify/tree/main/Android): Expensify Classic Android specific code | ||
| - 📂 [**iOS**](https://github.com/Expensify/Mobile-Expensify/tree/main/iOS): Expensify Classic iOS specific code | ||
| - 📂 [**app**](https://github.com/Expensify/Mobile-Expensify/tree/main/app): Expensify Classic JavaScript logic (aka YAPL) | ||
| You can only build HybridApp if you have been granted access to [`Mobile-Expensify`](https://github.com/Expensify/Mobile-Expensify). For most contributors, you will be working on the standalone NewDot application. | ||
| ## Getting started with HybridApp | ||
| 1. If you haven't, please follow [these instructions](https://github.com/Expensify/App?tab=readme-ov-file#getting-started) to setup the NewDot local environment. | ||
| 2. Run `git submodule update --init` to download the `Mobile-Expensify` sourcecode. | ||
| - If you have access to `Mobile-Expensify` and the command fails with a https-related error add this to your `~/.gitconfig` file: | ||
|
|
||
| ``` | ||
| [url "ssh://[email protected]/"] | ||
| insteadOf = https://github.com/ | ||
| ``` | ||
|
|
||
| At this point, the default behavior of some `npm` scripts will change to target HybridApp: | ||
| - `npm run android` - build HybridApp for Android | ||
| - `npm run ios` - build HybridApp for iOS | ||
| - `npm run ipad` - build HybridApp for iPad | ||
| - `npm run ipad-sm` - build HybridApp for small iPad | ||
| - `npm run pod-install` - install pods for HybridApp | ||
| - `npm run clean` - clean native code of HybridApp | ||
|
|
||
| If for some reason, you need to target the standalone NewDot application, you can append `*-standalone` to each of these scripts (eg. `npm run ios-standalone` will build NewDot instead of HybridApp). | ||
|
|
||
| ## Working with HybridApp | ||
| Day-to-day work with HybridApp shouldn't differ much from the work on the standalone NewDot repo. | ||
| The main difference is that the native code which runs React Native is located in `./Mobile-Expensify/Android` and `./Mobile-Expensify/iOS` directories. It means, that changes in `./android` and `./ios` folders in the root **won't affect the HybridApp build**. | ||
|
|
||
| In that case, if you'd like to eg. remove `Pods`, you need to do it in `./Mobile-Expensify/iOS`. The same rule applies to Android builds - if you'd like to delete `.cxx`, `build` or `.gradle` directories, you need to go to `./Mobile-Expensify/android` first. | ||
|
|
||
| Additionally, If you'd like to open the HybridApp project in Android Studio or XCode, you **must choose a workspace located in the `Mobile-Expensify`** directory: | ||
| - Android: `./Mobile-Expensify/Android` | ||
| - iOS: `./Mobile-Expensify/iOS/Expensify.xcworkspace` | ||
| ### Updating the Mobile-Expensify submodule | ||
| `Mobile-Expensify` directory is a git submodule. It means, that it points to a specific commit on the `Mobile-Expensify` repository. If you'd like to download the most recent changes from `main`, please use the following command: | ||
|
|
||
| `git submodule update --remote` | ||
|
|
||
| ### Modifying Mobile-Expensify code | ||
|
|
||
| It's important to emphasise that a git submodule is just a **regular git repository** after all. It means that you can switch branches, pull the newest changes, and execute all regular git commands within the `Mobile-Expensify` directory. | ||
| > [!Note] | ||
| > #### For external contributors | ||
| > | ||
| > If you'd like to modify the `Mobile-Expensify` source code, it is best that you create your own fork. Then, you can swap origin of the remote repository by executing this command: | ||
| > | ||
| > `cd Mobile-Expensify && git remote set-url origin <YOUR_FORK_URL>` | ||
| > | ||
| > This way, you'll attach the submodule to your fork repository. | ||
| ### Adding HybridApp-related patches | ||
| Applying patches from the `patches` directory is performed automatically with the `npm install` command executed in `Expensify/App`. | ||
| If you'd like to add HybridApp-specific patches, use the `--patch-dir` flag: | ||
|
|
||
| `npx patch-package <PACKAGE_NAME> --patch-dir Mobile-Expensify/patches` | ||
|
|
||
| ### HybridApp troubleshooting | ||
|
|
||
| #### Cleaning the repo | ||
| - `npm run clean` - deep clean of all HybridApp artifacts (including NewDot's `node_modules`) | ||
| - `npm run clean -- --ios` - clean only iOS HybridApp artifacts (`Pods`, `build` folder, `DerivedData`) | ||
| - `npm run clean -- --android` - clean only Android HybridApp artifacts (`.cxx`, `build`, and `.gradle` folders, execute `./gradlew clean`) | ||
| If you'd like to do it manually, remember to `cd Mobile-Expensify` first! | ||
|
|
||
| #### Common errors | ||
| 1. **Please check your internet connection** - set `_isOnDev` in `api.js` to always return `false` | ||
| 2. **CDN: trunk URL couldn't be downloaded** - `cd Mobile-Expensify/iOS && pod repo remove trunk` | ||
| 3. **Task :validateSigningRelease FAILED** - open `Mobile-Expensify/Android/build.gradle` and do the following: | ||
| ``` | ||
| - signingConfig signingConfigs.release | ||
| + signingConfig signingConfigs.debug | ||
| ``` | ||
| 4. **Build service could not create build operation: unknown error while handling message: MsgHandlingError(message: "unable to initiate PIF transfer session (operation in progress?)")** - reopen XCode | ||
| ---- | ||
| # Philosophy | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
15 changes: 0 additions & 15 deletions
15
patches/@react-native-camera-roll+camera-roll+7.4.0+001+hybrid-app.patch
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.