ci.yaml

name: CI

on:
  push:
    branches: [main]
  pull_request:

permissions:
  checks: write
  contents: read
  id-token: write
  pull-requests: write

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    concurrency:
      group: lint-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Lint AI Bot
        if: always()
        run: pnpm run lint
        working-directory: packages/ai-bot
      - name: Lint Boxel Motion
        # This addition to each step causes the job to proceed even if one lint job fails so we can see all errors
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-motion/addon
      - name: Build Boxel Motion
        # To faciliate linting of projects that depend on Boxel Motion
        if: always()
        run: pnpm run build
        working-directory: packages/boxel-motion/addon
      - name: Lint Boxel Motion Test App
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-motion/test-app
      - name: Lint Boxel UI
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-ui/addon
      - name: Build Boxel UI
        # To faciliate linting of projects that depend on Boxel UI
        if: always()
        run: pnpm run build
        working-directory: packages/boxel-ui/addon
      - name: Lint Boxel UI Test App
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-ui/test-app
      - name: Lint Boxel Motion
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-motion/addon
      - name: Build Boxel Motion
        # To faciliate linting of projects that depend on Boxel Motion
        if: always()
        run: pnpm run build
        working-directory: packages/boxel-motion/addon
      - name: Lint Boxel Motion Test App
        if: always()
        run: pnpm run lint
        working-directory: packages/boxel-motion/test-app
      - name: Lint Host
        if: always()
        run: pnpm run lint
        working-directory: packages/host
      - name: Lint Matrix
        if: always()
        run: pnpm run lint
        working-directory: packages/matrix
      - name: Lint Realm Server
        if: always()
        run: pnpm run lint
        working-directory: packages/realm-server
      - name: Lint Runtime Common
        if: always()
        run: pnpm run lint
        working-directory: packages/runtime-common

  ai-bot-test:
    name: AI bot Tests
    runs-on: ubuntu-latest
    concurrency:
      group: ai-bot-test-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: AI Bot test suite
        run: pnpm test
        working-directory: packages/ai-bot

  boxel-motion-test:
    name: Boxel Motion Tests
    runs-on: ubuntu-latest
    concurrency:
      group: boxel-motion-test-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-motion
        run: pnpm build
        working-directory: packages/boxel-motion/addon
      - name: Run test suite
        run: pnpm test
        working-directory: packages/boxel-motion/test-app

  boxel-ui-test:
    name: Boxel UI Tests
    runs-on: ubuntu-latest
    concurrency:
      group: boxel-ui-test-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-ui
        run: pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Run test suite
        run: pnpm test
        working-directory: packages/boxel-ui/test-app

  boxel-ui-raw-icon-changes-only:
    name: Boxel UI ensure raw icon changes only
    runs-on: ubuntu-latest
    concurrency:
      group: boxel-ui-raw-icon-changes-only-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Rebuild boxel-ui icons
        run: pnpm rebuild:icons
        working-directory: packages/boxel-ui/addon
      - name: Fail if generated icons have been changed without underlying raw icon changing
        run: git diff --exit-code

  host-test-in-memory-index:
    name: Host Tests - in-memory index
    runs-on: ubuntu-latest
    concurrency:
      group: boxel-host-test-in-memory-index${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-ui
        run: pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Build host dist/ for fastboot
        run: pnpm build
        env:
          NODE_OPTIONS: --max_old_space_size=4096
        working-directory: packages/host
      - name: Start realm servers
        run: pnpm start:all &
        working-directory: packages/realm-server
      - name: create realm users
        run: pnpm register-realm-users
        working-directory: packages/matrix
      - name: host test suite
        run: pnpm test-with-percy
        env:
          PERCY_TOKEN: ${{ secrets.PERCY_TOKEN_HOST }}
        working-directory: packages/host
      - name: Publish test results
        uses: EnricoMi/publish-unit-test-result-action@v2.9.0
        if: always()
        with:
          junit_files: junit/host.xml
          check_name: Host Tests (In-Memory Index) Test Results

  host-test-db-index:
    name: Host Tests - db index
    runs-on: ubuntu-latest
    concurrency:
      group: boxel-host-test-db-index${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-ui
        run: PG_INDEXER=true pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Build host dist/ for fastboot
        run: PG_INDEXER=true pnpm build
        env:
          NODE_OPTIONS: --max_old_space_size=4096
        working-directory: packages/host
      - name: Start realm servers
        run: pnpm start:all &
        working-directory: packages/realm-server
      - name: create realm users
        run: pnpm register-realm-users
        working-directory: packages/matrix
      - name: host test suite
        # don't run the db index host tests in percy until we remove the feature flag
        run: pnpm test:wait-for-servers
        env:
          PERCY_TOKEN: ${{ secrets.PERCY_TOKEN_HOST }}
        working-directory: packages/host
      - name: Publish test results
        uses: EnricoMi/publish-unit-test-result-action@v2.9.0
        if: always()
        with:
          junit_files: junit/host.xml
          check_name: Host Tests (DB Index) Test Results

  matrix-client-test:
    name: Matrix Client Tests
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2, 3, 4, 5, 6]
        shardTotal: [6]
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Install Playwright Browsers
        run: pnpm exec playwright install --with-deps
        working-directory: packages/matrix
      - name: Build boxel-ui
        run: pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Build boxel-motion
        run: pnpm build
        working-directory: packages/boxel-motion/addon
      - name: Build host dist/ for fastboot
        run: pnpm build
        env:
          NODE_OPTIONS: --max_old_space_size=4096
        working-directory: packages/host
      - name: Start realm servers
        run: pnpm start:without-matrix &
        working-directory: packages/realm-server
      - name: Run Playwright tests
        run: pnpm test:group ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
        working-directory: packages/matrix

      - name: Upload blob report to GitHub Actions Artifacts
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@v4
        with:
          name: blob-report-${{ matrix.shardIndex }}
          path: packages/matrix/blob-report
          retention-days: 1

  matrix-client-merge-reports-and-publish:
    name: Merge Matrix reports and publish
    if: always()
    needs: matrix-client-test
    runs-on: ubuntu-latest

    permissions:
      id-token: write
      contents: write
      checks: write
      statuses: write

    outputs:
      timestamp: ${{ steps.timestampid.outputs.timestamp }}

    steps:
      - name: Create a timestamp as a directory to store reports in
        id: timestampid
        run: echo "timestamp=$(date --utc +%Y%m%d_%H%M%SZ)" >> "$GITHUB_OUTPUT"
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init

      - name: Download blob reports from GitHub Actions Artifacts
        uses: actions/download-artifact@v4
        with:
          path: all-blob-reports
          pattern: blob-report-*
          merge-multiple: true

      - name: Merge blobs into one single report
        run: pnpm exec playwright merge-reports --reporter html ./all-blob-reports

      - name: Upload HTML report
        uses: actions/upload-artifact@v4
        with:
          name: html-report--attempt-${{ github.run_attempt }}
          path: playwright-report
          retention-days: 14

      - name: Set up env
        env:
          INPUT_ENVIRONMENT: ${{ inputs.environment }}
        run: |
          echo "AWS_REGION=us-east-1" >> $GITHUB_ENV
          echo "AWS_ROLE_ARN=arn:aws:iam::680542703984:role/boxel-matrix-playwright-reports" >> $GITHUB_ENV
          echo "AWS_S3_BUCKET=cardstack-boxel-matrix-playwright-reports-staging" >> $GITHUB_ENV

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v3
        with:
          role-to-assume: ${{ env.AWS_ROLE_ARN }}
          aws-region: us-east-1

      - name: Publish consolidated report to S3
        run: aws s3 sync ./playwright-report s3://cardstack-boxel-matrix-playwright-reports-staging/${{ github.head_ref || github.ref_name }}/${{ steps.timestampid.outputs.timestamp }}

      - name: Store Playwright report URL
        shell: bash
        run: echo "PLAYWRIGHT_REPORT_URL=https://boxel-matrix-playwright-reports.stack.cards/${{ github.head_ref || github.ref_name }}/${{ steps.timestampid.outputs.timestamp }}/index.html" >> $GITHUB_ENV

      - name: Add status with link to Playwright report
        shell: bash
        env:
          GITHUB_TOKEN: ${{ github.token }}
          REPOSITORY: ${{ github.repository }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
        run: |
          curl \
            -X POST \
            -H "Authorization: token $GITHUB_TOKEN" \
            -H "Accept: application/vnd.github.v3+json" \
            https://api.github.com/repos/$REPOSITORY/statuses/$HEAD_SHA \
            -d '{"context":"Matrix Playwright tests report","description":"","target_url":"'"$PLAYWRIGHT_REPORT_URL"'","state":"success"}'

  realm-server-in-memory-index-test:
    name: Realm Server Tests - in-memory index
    runs-on: ubuntu-latest
    concurrency:
      group: realm-server-in-memory-index-test-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-ui
        run: pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Build host dist/ for fastboot
        run: pnpm build
        env:
          NODE_OPTIONS: --max_old_space_size=4096
        working-directory: packages/host
      - name: Start realm servers
        run: pnpm start:all &
        working-directory: packages/realm-server
      - name: create realm users
        run: pnpm register-realm-users
        working-directory: packages/matrix
      - name: realm server test suite
        run: pnpm test:wait-for-servers
        working-directory: packages/realm-server
      - name: realm server DOM tests
        run: pnpm test:dom
        working-directory: packages/realm-server

  realm-server-db-index-test:
    name: Realm Server Tests - db index
    runs-on: ubuntu-latest
    concurrency:
      group: realm-server-db-index-test-${{ github.head_ref || github.run_id }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3
      - uses: ./.github/actions/init
      - name: Build boxel-ui
        run: pnpm build
        working-directory: packages/boxel-ui/addon
      - name: Build host dist/ for fastboot
        run: pnpm build
        env:
          NODE_OPTIONS: --max_old_space_size=4096
        working-directory: packages/host
      - name: Start matrix
        run: pnpm start:matrix &
        working-directory: packages/realm-server
      - name: Start realm servers
        run: PG_INDEXER=true pnpm start:all &
        working-directory: packages/realm-server
      - name: create realm users
        run: pnpm register-realm-users
        working-directory: packages/matrix
      - name: realm server test suite
        run: PG_INDEXER=true pnpm test:wait-for-servers
        working-directory: packages/realm-server
      - name: realm server DOM tests
        run: PG_INDEXER=true pnpm test:dom
        working-directory: packages/realm-server

  change-check:
    name: Check which packages changed
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    outputs:
      boxel: ${{ steps.filter.outputs.boxel }}
      ai-bot: ${{ steps.filter.outputs.ai-bot }}
    steps:
      - uses: actions/checkout@v3
      - uses: dorny/paths-filter@v2
        id: filter
        with:
          filters: |
            boxel:
              - '.github/workflows/build-host.yml'
              - '.github/workflows/deploy-host.yml'
              - '.github/workflows/manual-deploy.yml'
              - '.github/workflows/ci.yaml'
              - 'packages/base/**'
              - 'packages/boxel-ui/**'
              - 'packages/host/**'
              - 'packages/realm-server/**'
              - 'packages/runtime-common/**'
              - 'pnpm-lock.yaml'
            ai-bot:
              - '.github/workflows/manual-ai-bot.yml'
              - '.github/workflows/ci.yaml'
              - 'packages/runtime-common/**'
              - 'packages/ai-bot/**'
              - 'pnpm-lock.yaml'

  deploy:
    name: Deploy boxel to staging
    if: ${{ needs.change-check.outputs.boxel == 'true' }}
    needs:
      - change-check
      - boxel-ui-test
      # don't forget to change this after we remove the feature flag
      - host-test-in-memory-index
      - realm-server-in-memory-index-test
    uses: ./.github/workflows/manual-deploy.yml
    secrets: inherit
    with:
      environment: "staging"

  deploy-ai-bot:
    needs:
      - ai-bot-test
      - change-check
    if: ${{ needs.change-check.outputs.ai-bot == 'true' }}
    uses: ./.github/workflows/manual-ai-bot.yml
    secrets: inherit
    with:
      environment: "staging"