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

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

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

jobs:
  netlify:
    name: Wait for Netlify build to finish
    runs-on: ubuntu-latest
    outputs:
      netlify_url: ${{ steps.netlify.outputs.url }}
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Wait for Netlify build to finish
        id: netlify
        env:
          COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: ./.github/actions/netlify-wait-for-build

  functional:
    name: Functional (shard ${{ matrix.shard }}/5)
    needs: netlify
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shard: [1, 2, 3, 4, 5]
    container:
      image: mcr.microsoft.com/playwright:v1.56.0-jammy
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Trust the repository directory
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
      - name: Run E2E Tests on Netlify URL
        run: yarn e2e --shard=${{ matrix.shard }}/5
        env:
          E2E_START_URL: ${{ needs.netlify.outputs.netlify_url }}
      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        if: always()
        with:
          name: desktop-client-test-results-shard-${{ matrix.shard }}
          path: packages/desktop-client/test-results/
          retention-days: 30
          overwrite: true

  functional-desktop-app:
    name: Functional Desktop App
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/playwright:v1.56.0-jammy
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Trust the repository directory
        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
      - name: Run Desktop app E2E Tests
        run: |
          xvfb-run --auto-servernum --server-args="-screen 0 1920x1080x24" -- yarn e2e:desktop
      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        if: always()
        with:
          name: desktop-app-test-results
          path: packages/desktop-electron/e2e/test-results/
          retention-days: 30
          overwrite: true

  vrt:
    name: Visual regression (shard ${{ matrix.shard }}/5)
    needs: netlify
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shard: [1, 2, 3, 4, 5]
    container:
      image: mcr.microsoft.com/playwright:v1.56.0-jammy
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Run VRT Tests on Netlify URL
        run: yarn vrt --shard=${{ matrix.shard }}/5
        env:
          E2E_START_URL: ${{ needs.netlify.outputs.netlify_url }}
      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        if: always()
        with:
          name: vrt-blob-report-${{ matrix.shard }}
          path: packages/desktop-client/blob-report/
          retention-days: 1
          overwrite: true

  merge-vrt:
    name: Merge VRT Reports
    needs: vrt
    runs-on: ubuntu-latest
    if: ${{ !cancelled() }}
    container:
      image: mcr.microsoft.com/playwright:v1.56.0-jammy
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Set up environment
        uses: ./.github/actions/setup
      - name: Download all blob reports
        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
        with:
          path: packages/desktop-client/all-blob-reports
          pattern: vrt-blob-report-*
          merge-multiple: true
      - 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@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
        id: playwright-report-vrt
        with:
          name: html-report--attempt-${{ github.run_attempt }}
          path: packages/desktop-client/playwright-report
          retention-days: 30
          overwrite: true
      - name: Comment on PR with VRT report link
        if: github.event_name == 'pull_request' && needs.vrt.result == 'failure'
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
        with:
          script: |
            await github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `VRT tests ❌ failed. [View the test report](${{ steps.playwright-report-vrt.outputs.artifact-url }}).\n\nTo update the VRT screenshots, comment \`/update-vrt\` on this PR.`
            });