actual/.github/workflows/e2e-test.yml

name: E2E Tests

on:
  pull_request:
    paths:
      - 'packages/**'
      - 'package.json'
      - 'yarn.lock'
      - '.github/workflows/e2e-test.yml'
      - '!packages/sync-server/**' # Sync server changes don't affect E2E tests
      - '!packages/api/**' # API changes don't affect E2E tests
      - '!packages/ci-actions/**' # CI actions changes don't affect E2E tests
      - '!packages/docs/**' # Docs changes don't affect E2E tests
      - '!packages/eslint-plugin-actual/**' # Eslint plugin changes don't affect E2E tests
  merge_group:

env:
  GITHUB_PR_NUMBER: ${{github.event.pull_request.number}}

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build-web:
    name: Build web bundle
    runs-on: depot-ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Set up environment
        uses: ./.github/actions/setup
        with:
          download-translations: 'false'
      - name: Build browser bundle
        # REACT_APP_NETLIFY=true flips isNonProductionEnvironment() on in the
        # bundle so the "Create test file" button (used by every e2e beforeEach
        # via ConfigurationPage.createTestFile()) is still rendered in a
        # production build. Without it, e2e tests would time out waiting for
        # a button that was tree-shaken out.
        # --skip-translations keeps VRT screenshots deterministic by rendering
        # source-code English instead of upstream Weblate en.json (which can
        # drift between snapshot capture and test runs).
        env:
          REACT_APP_NETLIFY: 'true'
        run: yarn build:browser --skip-translations
      - name: Upload build artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: desktop-client-build
          path: packages/desktop-client/build/
          retention-days: 1
          overwrite: true

  functional:
    name: Functional (shard ${{ matrix.shard }}/3)
    runs-on: depot-ubuntu-latest-4
    needs: build-web
    strategy:
      fail-fast: false
      matrix:
        shard: [1, 2, 3]
    container:
      image: mcr.microsoft.com/playwright:v1.59.1-jammy
    env:
      E2E_USE_BUILD: '1'
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Set up environment
        uses: ./.github/actions/setup
        with:
          download-translations: 'false'
      - name: Trust the repository directory
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
      - name: Download web build
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: desktop-client-build
          path: packages/desktop-client/build/
      - name: Run E2E Tests
        run: yarn e2e --shard=${{ matrix.shard }}/3
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: failure()
        with:
          name: desktop-client-test-results-shard-${{ matrix.shard }}
          path: packages/desktop-client/test-results/
          retention-days: 30
          overwrite: true
      - name: Upload E2E JUnit report
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: ${{ !cancelled() }}
        with:
          name: e2e-junit-${{ matrix.shard }}
          path: packages/desktop-client/test-results/junit.xml
          retention-days: 1
          overwrite: true

  report-e2e:
    name: Report E2E results to Depot
    needs: functional
    runs-on: depot-ubuntu-latest
    if: ${{ !cancelled() && github.event_name == 'merge_group' }}
    permissions:
      contents: read
      id-token: write # Authenticate to Depot via GitHub OIDC for test reporting
    steps:
      - name: Download E2E JUnit reports
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          path: e2e-junit
          pattern: e2e-junit-*
      - name: Report test results to Depot
        uses: depot/test-report-action@2ad5779840a9c63e884fa26f11d019768a27a941 # v1.0.1
        if: ${{ !cancelled() }}
        with:
          path: e2e-junit

  functional-desktop-app:
    name: Functional Desktop App
    runs-on: depot-ubuntu-latest-4
    permissions:
      contents: read
      id-token: write # Authenticate to Depot via GitHub OIDC for test reporting
    container:
      image: mcr.microsoft.com/playwright:v1.59.1-jammy
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Set up environment
        uses: ./.github/actions/setup
        with:
          download-translations: 'false'
      - name: Trust the repository directory
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"

      # Build tools are needed to rebuild native modules like better-sqlite3 used by the Desktop app, which is required to run E2E tests on the Desktop app.
      - name: Install build tools
        run: apt-get update && apt-get install -y build-essential python3

      - name: Run Desktop app E2E Tests
        run: |
          yarn rebuild-electron
          xvfb-run --auto-servernum --server-args="-screen 0 1920x1080x24" -- yarn e2e:desktop
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: always()
        with:
          name: desktop-app-test-results
          path: packages/desktop-electron/e2e/test-results/
          retention-days: 30
          overwrite: true
      - name: Report test results to Depot
        uses: depot/test-report-action@2ad5779840a9c63e884fa26f11d019768a27a941 # v1.0.1
        if: ${{ !cancelled() && github.event_name == 'merge_group' }}
        with:
          path: packages/desktop-electron/e2e/test-results/junit.xml

  vrt:
    name: Visual regression (shard ${{ matrix.shard }}/3)
    runs-on: depot-ubuntu-latest
    needs: build-web
    strategy:
      fail-fast: false
      matrix:
        shard: [1, 2, 3]
    container:
      image: mcr.microsoft.com/playwright:v1.59.1-jammy
    env:
      E2E_USE_BUILD: '1'
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Set up environment
        uses: ./.github/actions/setup
        with:
          download-translations: 'false'
      - name: Trust the repository directory
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
      - name: Download web build
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: desktop-client-build
          path: packages/desktop-client/build/
      - name: Run VRT Tests
        run: yarn vrt --shard=${{ matrix.shard }}/3
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: always()
        with:
          name: vrt-blob-report-${{ matrix.shard }}
          path: packages/desktop-client/blob-report/
          retention-days: 1
          overwrite: true
      - name: Upload VRT JUnit report
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        if: ${{ !cancelled() }}
        with:
          name: vrt-junit-${{ matrix.shard }}
          path: packages/desktop-client/test-results/junit.xml
          retention-days: 1
          overwrite: true

  merge-vrt:
    name: Merge VRT Reports
    needs: vrt
    runs-on: depot-ubuntu-latest
    if: ${{ !cancelled() }}
    permissions:
      contents: read
      id-token: write # Authenticate to Depot via GitHub OIDC for test reporting
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Download all blob reports
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          path: packages/desktop-client/all-blob-reports
          pattern: vrt-blob-report-*
          merge-multiple: true
      - name: Download VRT JUnit reports
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          path: vrt-junit
          pattern: vrt-junit-*
      - name: Report test results to Depot
        uses: depot/test-report-action@2ad5779840a9c63e884fa26f11d019768a27a941 # v1.0.1
        if: ${{ !cancelled() && github.event_name == 'merge_group' }}
        with:
          path: vrt-junit
      - name: Merge reports
        id: merge-reports
        run: yarn workspace @actual-app/web run playwright merge-reports --reporter html ./all-blob-reports
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        id: playwright-report-vrt
        with:
          name: html-report--attempt-${{ github.run_attempt }}
          path: packages/desktop-client/playwright-report
          retention-days: 30
          overwrite: true
      - name: Save VRT metadata for comment workflow
        if: github.event_name == 'pull_request'
        run: |
          mkdir -p vrt-metadata
          echo "${PR_NUMBER}" > vrt-metadata/pr-number.txt
          echo "${VRT_RESULT}" > vrt-metadata/vrt-result.txt
          echo "${STEPS_PLAYWRIGHT_REPORT_VRT_OUTPUTS_ARTIFACT_URL}" > vrt-metadata/artifact-url.txt
        env:
          PR_NUMBER: ${{ github.event.pull_request.number }}
          STEPS_PLAYWRIGHT_REPORT_VRT_OUTPUTS_ARTIFACT_URL: ${{ steps.playwright-report-vrt.outputs.artifact-url }}
          VRT_RESULT: ${{ needs.vrt.result }}
      - name: Upload VRT metadata
        if: github.event_name == 'pull_request'
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: vrt-comment-metadata
          path: vrt-metadata/
          retention-days: 1