e2e.yml

# SPDX-License-Identifier: MPL-2.0
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
#
# Full test suite for BoJ Server: E2E, aspect tests, and benchmarks.
# Covers all merge requirement categories: P2P (zig-test.yml), E2E (here),
# aspect, execution, lifecycle, and benchmarks.

name: E2E + Aspect + Bench

on:
  push:
    branches: [main, master, develop]
    paths:
      - 'adapter/**'
      - 'cartridges/**'
      - 'ffi/**'
      - 'mcp-bridge/**'
      - 'tests/**'
      - 'src/**'
      - '.github/workflows/e2e.yml'
  pull_request:
    branches: [main, master]
    paths:
      - 'adapter/**'
      - 'cartridges/**'
      - 'ffi/**'
      - 'mcp-bridge/**'
      - 'tests/**'
      - 'src/**'
  workflow_dispatch:

permissions: read-all

concurrency:
  group: e2e-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # ─── End-to-End: Full REST + MCP Bridge ────────────────────────────
  e2e-full:
    name: E2E — Full REST + MCP Bridge
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Install Zig
        uses: goto-bus-stop/setup-zig@9566bb3e8749893055694249726756f25e099b30  # v2
        with:
          version: 0.15.1

      - name: Install Deno
        uses: denoland/setup-deno@667a34cdef165d8d2b2e98dde39547c9daac7282  # v2.0.4
        with:
          deno-version: v2.x

      - name: Install Elixir + OTP
        # tests/e2e_full.sh requires `mix` on PATH to start the Elixir
        # backend (elixir/ — `mix run --no-halt`). Pinned to match the
        # estate convention (see hypatia-scan.yml across the org).
        uses: erlef/setup-beam@fc68ffb90438ef2936bbb3251622353b3dcb2f93  # v1.18.2
        with:
          elixir-version: '1.18'
          otp-version: '27'

      - name: Install system dependencies
        run: sudo apt-get update && sudo apt-get install -y curl jq

      - name: Fetch Elixir deps
        working-directory: elixir
        run: mix deps.get

      - name: Compile Elixir deps
        # Pre-compile so the in-test `mix run --no-halt` doesn't have
        # to do it on the critical path of the 60s server-start window.
        working-directory: elixir
        run: mix compile

      - name: Build FFI libraries
        run: |
          cd ffi/zig && zig build
          for cart in cartridges/*/ffi; do
            [ -f "$cart/build.zig" ] && (cd "$cart" && zig build) || true
          done

      - name: Run E2E full test suite
        run: bash tests/e2e_full.sh

      - name: Upload test logs
        if: always()
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4
        with:
          name: e2e-full-logs
          path: /tmp/boj-e2e-test.*
          retention-days: 7

  # ─── End-to-End: Order Ticket (FFI layer) ──────────────────────────
  e2e-order-ticket:
    name: E2E — Order Ticket (FFI layer)
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Install Zig
        uses: goto-bus-stop/setup-zig@9566bb3e8749893055694249726756f25e099b30  # v2
        with:
          version: 0.15.1

      - name: Build FFI libraries
        run: cd ffi/zig && zig build

      - name: Run order ticket E2E
        run: bash tests/order_ticket_e2e.sh

  # ─── Aspect Tests: Cross-Cutting Concerns ──────────────────────────
  aspect-tests:
    name: Aspect — Thread Safety + ABI Contract + SPDX
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Run aspect tests
        run: bash tests/aspect_tests.sh

  # ─── Benchmarks: Performance Regression Detection ──────────────────
  benchmarks:
    name: Bench — FFI Catalogue + Mount/Unmount + Hash
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Install Zig
        uses: goto-bus-stop/setup-zig@9566bb3e8749893055694249726756f25e099b30  # v2
        with:
          version: 0.15.1

      - name: Build FFI libraries
        run: cd ffi/zig && zig build

      - name: Run benchmarks
        run: cd ffi/zig && zig build bench

      - name: Upload benchmark results
        if: always()
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4
        with:
          name: benchmark-results
          path: ffi/zig/zig-out/bench*
          retention-days: 30

  # ─── Bench Bridge: mcp-bridge JS perf (path-claims) ────────────────
  # Separate job from `benchmarks` above because the bridge has no Zig
  # toolchain dependency — keeps logs untangled and lets the JS bench
  # run in parallel on its own runner. Posts a sticky PR comment so
  # deltas across pushes are visible inline.
  bench-bridge:
    name: Bench — mcp-bridge (path-claims)
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: read
      # Per-job override: only this step needs to write PR comments.
      # Workflow-level permissions stay read-all.
      pull-requests: write

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Setup Node
        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version: '22'

      - name: Run bridge bench
        run: node mcp-bridge/tests/path_claims_bench.js | tee bench-bridge.txt

      - name: Upload bridge bench artifact
        if: always()
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4
        with:
          name: bench-bridge-results
          path: bench-bridge.txt
          retention-days: 30

      - name: Sticky PR comment with bench numbers
        if: github.event_name == 'pull_request'
        # Advisory — a comment failure must never gate the bench job.
        # Same reasoning as the hypatia-scan PR-comment step.
        continue-on-error: true
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v7
        with:
          script: |
            const fs = require('fs');
            const MARKER = '<!-- bench-bridge:path-claims -->';
            const output = fs.readFileSync('bench-bridge.txt', 'utf8');
            const body = `${MARKER}\n## 🏁 path-claims bench\n\nCommit \`${context.sha.slice(0, 7)}\`\n\n<details open><summary>Numbers</summary>\n\n\`\`\`\n${output}\n\`\`\`\n</details>\n\n*Host-dependent — compare deltas across commits, not absolute values.*`;

            const { owner, repo } = context.repo;
            const issue_number = context.issue.number;

            const existing = await github.paginate(
              github.rest.issues.listComments,
              { owner, repo, issue_number, per_page: 100 },
            );
            const prior = existing.find((c) => c.body && c.body.includes(MARKER));

            if (prior) {
              await github.rest.issues.updateComment({
                owner, repo, comment_id: prior.id, body,
              });
            } else {
              await github.rest.issues.createComment({
                owner, repo, issue_number, body,
              });
            }