coverage.yml

name: Coverage Reporting

# Issue #957 – Measure and report coverage per package.
#
# Runs on every push to main/develop and on pull requests.
# Each package job produces a coverage-summary.json, which is then
# aggregated by the "report" job into a single markdown table that is
# posted as a PR comment and uploaded as a workflow artifact.

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

jobs:
  # ---------------------------------------------------------------------------
  # Frontend coverage (vitest + @vitest/coverage-v8)
  # ---------------------------------------------------------------------------
  frontend-coverage:
    name: Frontend Coverage
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: npm
          cache-dependency-path: frontend/package-lock.json

      - name: Install dependencies
        run: npm ci
        working-directory: frontend

      - name: Run tests with coverage
        run: npm run test:coverage -- --reporter=json --outputFile=../coverage-vitest.json
        working-directory: frontend
        env:
          CI: true

      # Vitest writes coverage to frontend/coverage/ by default; move to
      # the shared coverage/ directory at repo root.
      - name: Move coverage summary
        run: |
          mkdir -p coverage/frontend
          cp frontend/coverage/coverage-summary.json coverage/frontend/coverage-summary.json

      - uses: actions/upload-artifact@v4
        with:
          name: coverage-frontend
          path: coverage/frontend/coverage-summary.json
          retention-days: 7

  # ---------------------------------------------------------------------------
  # Indexer coverage (jest)
  # ---------------------------------------------------------------------------
  indexer-coverage:
    name: Indexer Coverage
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: npm
          cache-dependency-path: indexer/package-lock.json

      - name: Install dependencies
        run: npm ci
        working-directory: indexer

      - name: Run tests with coverage
        run: npm run test:coverage -- --coverageDirectory=../coverage/indexer
        working-directory: indexer
        env:
          CI: true

      - uses: actions/upload-artifact@v4
        with:
          name: coverage-indexer
          path: coverage/indexer/coverage-summary.json
          retention-days: 7

  # ---------------------------------------------------------------------------
  # Contract tests coverage (jest in tests/contract/)
  # ---------------------------------------------------------------------------
  contract-coverage:
    name: Contract Tests Coverage
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: npm
          cache-dependency-path: tests/contract/package-lock.json

      - name: Install dependencies
        run: npm install
        working-directory: tests/contract

      - name: Run contract tests with coverage
        run: npx jest --coverage
        working-directory: tests/contract
        env:
          CI: true

      - uses: actions/upload-artifact@v4
        with:
          name: coverage-contract
          path: coverage/contract/coverage-summary.json
          retention-days: 7

  # ---------------------------------------------------------------------------
  # Aggregate: collect all summaries and post a combined report
  # ---------------------------------------------------------------------------
  report:
    name: Aggregate Coverage Report
    runs-on: ubuntu-latest
    needs: [frontend-coverage, indexer-coverage, contract-coverage]
    # Run even if individual coverage jobs fail so the report always appears
    if: always()

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install ts-node and pg (for the script)
        run: npm install --no-save ts-node typescript pg @types/pg @types/node

      - name: Download frontend coverage
        uses: actions/download-artifact@v4
        with:
          name: coverage-frontend
          path: coverage/frontend
        continue-on-error: true

      - name: Download indexer coverage
        uses: actions/download-artifact@v4
        with:
          name: coverage-indexer
          path: coverage/indexer
        continue-on-error: true

      - name: Download contract coverage
        uses: actions/download-artifact@v4
        with:
          name: coverage-contract
          path: coverage/contract
        continue-on-error: true

      - name: Generate combined report
        run: npx ts-node scripts/coverage-report.ts
        continue-on-error: true   # don't block the workflow on threshold failure

      - name: Upload combined report
        uses: actions/upload-artifact@v4
        with:
          name: coverage-combined
          path: |
            coverage/combined-summary.json
            coverage/combined-report.md
          retention-days: 30

      # Post the markdown table as a PR comment (only on pull_request events)
      - name: Post coverage comment on PR
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const mdPath = 'coverage/combined-report.md';
            if (!fs.existsSync(mdPath)) {
              console.log('No combined-report.md found, skipping comment.');
              return;
            }
            const body = fs.readFileSync(mdPath, 'utf8');
            const { data: comments } = await github.rest.issues.listComments({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
            });
            const marker = '<!-- scavngr-coverage-report -->';
            const existing = comments.find(c => c.body && c.body.includes(marker));
            const fullBody = marker + '\n' + body;
            if (existing) {
              await github.rest.issues.updateComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                comment_id: existing.id,
                body: fullBody,
              });
            } else {
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body: fullBody,
              });
            }

      # Fail the workflow if the threshold was not met
      - name: Enforce coverage thresholds
        run: npx ts-node scripts/coverage-report.ts