supabase/.github/workflows/studio-e2e-test.yml

name: Selfhosted Studio E2E Tests
on:
  push:
    branches: [master]
  pull_request:

# Cancel old builds on new commit for same workflow + branch/PR
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions:
  contents: write
  pull-requests: write

jobs:
  test:
    name: 'E2E tests'
    timeout-minutes: 60
    runs-on: blacksmith-4vcpu-ubuntu-2404
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2]
        shardTotal: [2]
    outputs:
      tests_ran: ${{ steps.filter.outputs.studio == 'true' }}

    env:
      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

    steps:
      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
        id: filter
        with:
          filters: |
            studio:
              - 'packages/pg-meta/**'
              - 'apps/studio/**'
              - 'apps/ui-library/**'
              - 'apps/design-system/**'
              - 'e2e/studio/**'
              - 'pnpm-lock.yaml'
              - '.github/workflows/studio-e2e-test.yml'
      - uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
        if: steps.filter.outputs.studio == 'true'
        name: Install pnpm
        with:
          run_install: false
      - name: Use Node.js
        if: steps.filter.outputs.studio == 'true'
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version-file: '.nvmrc'
          cache: 'pnpm'

      - name: Install dependencies
        if: steps.filter.outputs.studio == 'true'
        run: pnpm install --frozen-lockfile

      - name: Install Playwright Browsers
        if: steps.filter.outputs.studio == 'true'
        run: pnpm -C e2e/studio exec playwright install chromium --with-deps --only-shell

      - name: Set up NextJS/Turbo cache
        if: steps.filter.outputs.studio == 'true'
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          # See here for caching with `yarn`, `bun` or other package managers https://github.com/actions/cache/blob/main/examples.md or you can leverage caching with actions/setup-node https://github.com/actions/setup-node
          path: |
            .turbo/cache
            apps/studio/.next/build
            apps/studio/.next/cache
          # Generate a new cache whenever packages or source files change.
          key: ${{ runner.os }}-nextjs-${{ hashFiles('pnpm-lock.yaml') }}-${{ hashFiles('apps/studio/**/*.js', 'apps/studio/**/*.jsx', 'apps/studio/**/*.ts', 'apps/studio/**/*.tsx') }}
          # If source files changed but packages didn't, rebuild from a prior cache.
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('pnpm-lock.yaml') }}-

      - name: 🚀 Run Playwright tests against Vercel Preview
        if: steps.filter.outputs.studio == 'true'
        id: playwright
        run: pnpm e2e --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}

      - name: Upload blob report to GitHub Actions Artifacts
        if: always() && steps.filter.outputs.studio == 'true'
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: blob-report-${{ matrix.shardIndex }}
          path: e2e/studio/blob-report
          retention-days: 7

      - name: Fail job if tests failed
        if: steps.filter.outputs.studio == 'true' && steps.playwright.outcome != 'success'
        run: |
          echo "E2E tests failed" >&2
          exit 1

  merge-reports:
    name: 'E2E reports'
    # Merge reports after playwright-tests, even if some shards have failed
    if: ${{ !cancelled() && needs.test.outputs.tests_ran == 'true' }}
    needs: [test]
    runs-on: blacksmith-4vcpu-ubuntu-2404
    steps:
      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0

      - name: Use Node.js
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version-file: '.nvmrc'

      - name: Download blob reports from GitHub Actions Artifacts
        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v 5.0.0
        with:
          path: e2e/studio/blob-report
          pattern: blob-report-*
          merge-multiple: true

      - name: Merge Playwright reports
        run: npx playwright merge-reports --config=e2e/studio/playwright.merge.config.ts -- e2e/studio/blob-report

      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
        with:
          name: playwright-artifacts
          path: |
            e2e/studio/playwright-report/
            e2e/studio/test-results/
          retention-days: 7

      - name: Comment Playwright test results on PR
        if: always() && github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork
        uses: daun/playwright-report-comment@be9e270edd5ad86038604d3caa84a819a6ff6fed # v3.10.0
        with:
          report-file: e2e/studio/test-results/test-results.json
          comment-title: '🎭 Playwright Test Results'

  merge-results:
    name: 'E2E results'
    runs-on: ubuntu-latest
    needs: [test]
    if: ${{ !cancelled() && needs.test.outputs.tests_ran == 'true' }}
    steps:
      - name: All tests ok
        if: ${{ !(contains(needs.*.result, 'failure')) }}
        run: exit 0
      - name: Some tests failed
        if: ${{ contains(needs.*.result, 'failure') }}
        run: exit 1