ci.yml

name: Tests
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
env:
  # Playwright headless browsers running in CI get low confidence scores, causing flaky e2e tests. Lower the confidence score threshold for CI testing.
  MIN_CONFIDENCE_SCORE: 0
  # Staging Cloudflare credentials and IDs for e2e tests
  CLOUDFLARE_API_TOKEN: '${{ secrets.CLOUDFLARE_API_TOKEN }}'
  CLOUDFLARE_ZONE_ID: '${{ secrets.CLOUDFLARE_ZONE_ID }}'
  CLOUDFLARE_RULESET_ID: '${{ secrets.CLOUDFLARE_RULESET_ID }}'

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # This takes 20s but does not seem necessary for our current setup,
      # as ubuntu-latest already has a reasonable version of Node
      # Add this to all jobs if you encounter problems with Node installation
      # This also makes use of global yarn cache
      # - uses: actions/setup-node@v3
      #   with:
      #     node-version: 18
      #     cache: 'yarn'

      - name: 'Cache'
        uses: actions/cache@v4
        with:
          path: node_modules
          key: nodemodules-${{ hashFiles('yarn.lock') }}
          restore-keys: nodemodules-

      - name: Install packages
        run: yarn install --prefer-offline --frozen-lockfile

      - name: Lint
        run: yarn lint
  unit-tests:
    name: Unit tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: 'Cache'
        uses: actions/cache@v4
        with:
          path: node_modules
          key: nodemodules-${{ hashFiles('yarn.lock') }}
          restore-keys: nodemodules-

      - name: Install packages
        run: yarn install --prefer-offline --frozen-lockfile

      - name: Run unit tests
        run: yarn test
  e2e:
    name: Playwright e2e tests
    timeout-minutes: 60
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2, 3]
        shardTotal: [3]
    steps:
      - uses: actions/checkout@v4

      - name: Cache node modules
        uses: actions/cache@v4
        with:
          path: node_modules
          key: nodemodules-${{ hashFiles('yarn.lock') }}
          restore-keys: nodemodules-

      - name: Install node modules
        run: yarn install --prefer-offline --frozen-lockfile

      - name: Get installed Playwright version (used in cache key)
        id: playwright-version
        run: echo "PLAYWRIGHT_VERSION=$(node -e "process.stdout.write(require('@playwright/test/package.json').version)")" >> $GITHUB_ENV

      - name: Cache Playwright browser binaries
        uses: actions/cache@v4
        id: playwright-cache
        with:
          path: |
            ~/.cache/ms-playwright
          key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}

      - name: Install Playwright browsers binaries if cache missed
        run: yarn playwright install --with-deps
        if: steps.playwright-cache.outputs.cache-hit != 'true'

      # Ubuntu needs extra stuff to run webkit tests, alternative is using a Playwright docker container but
      # that is slower in CI.
      - name: If browser binaries cache hit, install just webkit dependencies
        run: yarn playwright install-deps webkit
        if: steps.playwright-cache.outputs.cache-hit == 'true'

      - name: Cache Next build
        uses: actions/cache@v4
        with:
          path: ${{ github.workspace }}/.next/cache
          # Generate a new cache whenever packages or source files change.
          key: ${{ runner.os }}-nextjs-${{ hashFiles('yarn.lock') }}-${{ hashFiles('src/*') }}
          # If source files changed but packages didn't, rebuild from a prior cache.
          restore-keys: |
            ${{ runner.os }}-nextjs-${{ hashFiles('yarn.lock') }}-

      - name: Build website
        run: yarn build

      - name: Run Playwright tests
        run: npx playwright test --grep-invert CHROME_ONLY --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}

      # Some tests are only run on Chrome, marked with CHROME_ONLY in their name
      - name: Run Chrome-only Playwright tests
        run: npx playwright test --grep CHROME_ONLY --project='chromium'
        if: matrix.shardIndex == 1

      - name: Upload Playwright report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: playwright-report-${{ matrix.shardIndex }}
          path: playwright-report/
          retention-days: 30