action.yml

name: Apple road test (selected RN app & AppleApp)
description: Package the given RN app as XCFramework, build the corresponding AppleApp variant, and optionally run Detox E2E

inputs:
  variant:
    description: 'AppleApp yarn command variant to run (vanilla or expo<version>)'
    required: true

  rn-project-path:
    description: 'Path to the RN project to build'
    required: true

  run-e2e:
    description: 'Run Detox E2E after packaging (uses Debug build instead of Release road-test build)'
    required: false
    default: 'false'

  e2e-artifact-name:
    description: 'Name prefix for Detox artifacts uploaded on failure'
    required: false
    default: 'detox-appleapp'

  restore-turbo-cache:
    description: 'Whether to restore the Turbo cache during setup'
    required: false
    default: 'true'

  skip-setup:
    description: 'Skip yarn install/build when the caller already prepared the monorepo (e.g. Expo preview workflow)'
    required: false
    default: 'false'

runs:
  using: composite
  steps:
    - name: '::group:: Setup & prepare iOS'
      run: echo "::group::Setup & prepare iOS"
      shell: bash

    - name: Setup
      if: inputs.skip-setup != 'true'
      uses: ./.github/actions/setup
      with:
        restore-turbo-cache: ${{ inputs.restore-turbo-cache }}

    - name: Prepare iOS environment
      uses: ./.github/actions/prepare-ios

    - name: '::endgroup:: Setup & prepare iOS'
      run: echo "::endgroup::"
      shell: bash

    - name: '::group:: ccache & iOS build caches'
      run: echo "::group::ccache & iOS build caches"
      shell: bash

    - name: Configure ccache environment
      run: |
        echo "USE_CCACHE=1" >> "$GITHUB_ENV"
        echo "CCACHE_DIR=${{ github.workspace }}/.ios_ccache" >> "$GITHUB_ENV"
        echo "CCACHE_BASEDIR=${{ github.workspace }}" >> "$GITHUB_ENV"
        echo "CCACHE_COMPRESS=1" >> "$GITHUB_ENV"
      shell: bash

    - name: Install ccache
      run: brew install ccache
      shell: bash

    - name: Install applesimutils
      if: inputs.run-e2e == 'true'
      run: |
        brew tap wix/brew
        brew trust --formula wix/brew/applesimutils
        brew install applesimutils
      shell: bash

    - name: Enable ccache
      run: echo "$(brew --prefix)/opt/ccache/libexec" >> $GITHUB_PATH
      shell: bash

    - name: Restore AppleApp ccache
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: |
          .ios_ccache
        key: ${{ runner.os }}-rnapp-appleapp-${{ inputs.variant }}-ios-ccache-${{ hashFiles(format('{0}/ios/Podfile.lock', inputs.rn-project-path), format('{0}/ios/*.xcodeproj/project.pbxproj', inputs.rn-project-path), 'apps/AppleApp/Brownfield Apple App.xcodeproj/project.pbxproj') }}
        restore-keys: |
          ${{ runner.os }}-rnapp-appleapp-${{ inputs.variant }}-ios-ccache-

    - name: '::endgroup:: ccache & iOS build caches'
      run: echo "::endgroup::"
      shell: bash

    - name: '::group:: RN app — pods & package iOS XCFramework'
      run: |
        echo "::group::RN app — pods & package iOS XCFramework"
        echo "variant=${{ inputs.variant }} rn-project=${{ inputs.rn-project-path }}"
      shell: bash

    - name: Restore Pods cache (RN ${{ inputs.variant }} app)
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: |
          ${{ inputs.rn-project-path }}/ios/Pods
        key: ${{ runner.os }}-rnapp-${{ inputs.variant }}-ios-pods-${{ hashFiles(format('{0}/ios/Podfile.lock', inputs.rn-project-path)) }}
        restore-keys: |
          ${{ runner.os }}-rnapp-${{ inputs.variant }}-ios-pods-

    - name: Brownfield codegen (RN ${{ inputs.variant }} app)
      if: inputs.variant == 'vanilla' && inputs.run-e2e == 'true'
      run: yarn codegen
      working-directory: ${{ inputs.rn-project-path }}
      shell: bash

    # RN 0.84+ defaults to prebuilt RNCore during pod install. For the Detox packaging
    # step we build RN from source so native deps (e.g. react-native-screens) link against
    # the same headers as the Debug simulator XCFramework. Road-test builds without E2E
    # keep the default prebuilt path for faster CI.
    - name: Install pods (RN ${{ inputs.variant }} app, E2E)
      if: inputs.variant == 'vanilla' && inputs.run-e2e == 'true'
      env:
        RCT_USE_PREBUILT_RNCORE: '0'
      run: |
        cd ${{ inputs.rn-project-path }}/ios
        pod install
      shell: bash

    - name: Apply Brownfield Debug pod settings (E2E)
      if: inputs.variant == 'vanilla' && inputs.run-e2e == 'true'
      run: |
        source scripts/ci-local-ios-e2e-common.sh
        ci_local_e2e_apply_brownfield_debug_pod_settings "${{ github.workspace }}/${{ inputs.rn-project-path }}/ios"
      shell: bash

    - name: Install pods (RN ${{ inputs.variant }} app)
      if: inputs.variant == 'vanilla' && inputs.run-e2e != 'true'
      run: |
        cd ${{ inputs.rn-project-path }}/ios
        pod install
      shell: bash

    - name: Restore DerivedData cache (RN ${{ inputs.variant }} app)
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: ${{ inputs.rn-project-path }}/ios/build
        key: ${{ runner.os }}-ios-rnapp-${{ inputs.variant }}-derived-data-${{ hashFiles(format('{0}/ios/Podfile.lock', inputs.rn-project-path), format('{0}/ios/*.xcodeproj/project.pbxproj', inputs.rn-project-path)) }}
        restore-keys: |
          ${{ runner.os }}-ios-rnapp-${{ inputs.variant }}-derived-data-

    - name: Package iOS framework with the Brownfield CLI
      run: |
        cd ${{ inputs.rn-project-path }}
        yarn run brownfield:package:ios
      shell: bash

    - name: '::endgroup:: RN app — pods & package iOS XCFramework'
      run: echo "::endgroup::"
      shell: bash

    - name: '::group:: AppleApp — Release road test build'
      if: inputs.run-e2e != 'true'
      run: echo "::group::AppleApp — Release road test build"
      shell: bash

    - name: Build Brownfield iOS native app (${{ inputs.variant }})
      if: inputs.run-e2e != 'true'
      run: |
        yarn run build:example:ios-consumer:${{ inputs.variant }}
      shell: bash

    - name: '::endgroup:: AppleApp — Release road test build'
      if: inputs.run-e2e != 'true'
      run: echo "::endgroup::"
      shell: bash

    - name: '::group:: AppleApp — Detox E2E'
      if: inputs.run-e2e == 'true'
      run: echo "::group::AppleApp — Detox E2E"
      shell: bash

    - name: Resolve AppleApp E2E settings
      if: inputs.run-e2e == 'true'
      run: |
        node <<'NODE'
        const { getAppleAppDetoxVariant } = require('./apps/brownfield-example-shared-tests/detox-appleapp-variants.cjs');
        const variant = getAppleAppDetoxVariant(process.env.APPLEAPP_VARIANT);
        const append = (key, value) => {
          const fs = require('node:fs');
          fs.appendFileSync(process.env.GITHUB_ENV, `${key}=${value}\n`);
        };
        append('APPLEAPP_XCFRAMEWORK_APP', variant.xcframeworkApp);
        append('APPLEAPP_E2E_CONFIGURATION', variant.configuration);
        append('APPLEAPP_E2E_BUILD_SCRIPT', variant.e2eBuildScript);
        append('APPLEAPP_E2E_TEST_SCRIPT', variant.e2eTestScript);
        NODE
      env:
        APPLEAPP_VARIANT: ${{ inputs.variant }}
      shell: bash

    - name: Copy XCFrameworks into AppleApp
      if: inputs.run-e2e == 'true'
      run: node prepareXCFrameworks.js --appName "$APPLEAPP_XCFRAMEWORK_APP"
      working-directory: apps/AppleApp
      shell: bash

    - name: Restore Detox build cache (AppleApp)
      if: inputs.run-e2e == 'true'
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: apps/AppleApp/build
        key: ${{ runner.os }}-e2e-appleapp-${{ inputs.variant }}-build-${{ hashFiles(format('{0}/ios/Podfile.lock', inputs.rn-project-path), 'apps/AppleApp/Brownfield Apple App.xcodeproj/project.pbxproj', 'apps/brownfield-example-shared-tests/e2e/**') }}
        restore-keys: |
          ${{ runner.os }}-e2e-appleapp-${{ inputs.variant }}-build-

    - name: Install Detox iOS artifacts
      if: inputs.run-e2e == 'true'
      run: node node_modules/detox/scripts/postinstall.js
      working-directory: apps/AppleApp
      shell: bash

    - name: Detox build (AppleApp ${{ inputs.variant }})
      if: inputs.run-e2e == 'true'
      run: yarn "$APPLEAPP_E2E_BUILD_SCRIPT"
      working-directory: apps/AppleApp
      shell: bash

    - name: Verify embedded JS bundle in BrownfieldLib (E2E)
      if: inputs.run-e2e == 'true'
      run: |
        echo "::group::Verify embedded JS bundle"
        set -euo pipefail
        PRODUCTS_DIR="apps/AppleApp/build/Build/Products/${APPLEAPP_E2E_CONFIGURATION}-iphonesimulator"
        APP_PATH="$(find "$PRODUCTS_DIR" -maxdepth 1 -name '*.app' -print -quit)"
        if [[ -z "$APP_PATH" ]]; then
          echo "error: no .app under $PRODUCTS_DIR" >&2
          exit 1
        fi
        EXECUTABLE_PATH="$APP_PATH/$(basename "$APP_PATH" .app)"
        if [[ ! -f "$EXECUTABLE_PATH" ]]; then
          echo "error: $EXECUTABLE_PATH missing — host app target produced an invalid .app (no bundle executable)." >&2
          echo "Check AppleApp target membership for BrownfieldAppleApp.swift and related sources." >&2
          exit 1
        fi
        BUNDLE_PATH="$APP_PATH/Frameworks/BrownfieldLib.framework/main.jsbundle"
        if [[ ! -f "$BUNDLE_PATH" ]]; then
          echo "error: $BUNDLE_PATH missing — E2E needs the packaged ${APPLEAPP_XCFRAMEWORK_APP} bundle, not Metro." >&2
          echo "Re-run: yarn brownfield:package:ios (${APPLEAPP_XCFRAMEWORK_APP}) && node prepareXCFrameworks.js --appName ${APPLEAPP_XCFRAMEWORK_APP}" >&2
          exit 1
        fi
        echo "App executable OK: $EXECUTABLE_PATH ($(wc -c < "$EXECUTABLE_PATH") bytes)"
        echo "Embedded bundle OK: $BUNDLE_PATH ($(wc -c < "$BUNDLE_PATH") bytes)"
        echo "::endgroup::"
      shell: bash

    - name: Detox test (AppleApp ${{ inputs.variant }})
      if: inputs.run-e2e == 'true'
      run: |
        echo "::group::Detox test"
        rm -rf e2e-artifacts
        yarn "$APPLEAPP_E2E_TEST_SCRIPT"
        echo "::endgroup::"
      working-directory: apps/AppleApp
      shell: bash

    - name: Upload Detox recordings on failure
      if: failure() && inputs.run-e2e == 'true'
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: ${{ inputs.e2e-artifact-name }}-${{ inputs.variant }}-ios-recordings
        path: apps/AppleApp/e2e-artifacts
        if-no-files-found: warn
        retention-days: 5

    - name: '::endgroup:: AppleApp — Detox E2E'
      if: always() && inputs.run-e2e == 'true'
      run: echo "::endgroup::"
      shell: bash

    - name: '::group:: Summary'
      run: echo "::group::Summary"
      shell: bash

    - name: Log ccache stats
      uses: ./.github/actions/ccache-summary
      with:
        name: RN ${{ inputs.variant }} app & AppleApp

    - name: '::endgroup:: Summary'
      run: echo "::endgroup::"
      shell: bash