e2e.yml

# SPDX-FileCopyrightText: © 2025 StreamKit Contributors
#
# SPDX-License-Identifier: MPL-2.0

name: E2E Tests

on:
  workflow_call:

env:
  CARGO_TERM_COLOR: always
  RUSTC_WRAPPER: sccache

jobs:
  pipeline-validation:
    name: Pipeline Validation
    runs-on: ubuntu-22.04
    steps:
      - name: Free disk space
        uses: jlumbroso/free-disk-space@main
        with:
          tool-cache: false
          android: true
          dotnet: true
          haskell: true
          large-packages: false
          docker-images: true
          swap-storage: false

      - uses: actions/checkout@v5

      - name: Setup Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: "1.3.5"

      - name: Build UI
        working-directory: ./ui
        run: |
          bun install --frozen-lockfile
          bun run build

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: "1.92.0"

      - uses: mozilla-actions/sccache-action@v0.0.9

      - uses: Swatinem/rust-cache@v2

      - name: Install system dependencies
        run: sudo apt-get update && sudo apt-get install -y libvpx-dev nasm cmake ninja-build yasm meson ffmpeg

      - name: Build and install SVT-AV1 from source (v4.1.0)
        run: |
          cd /tmp
          git clone --depth 1 --branch v4.1.0 https://gitlab.com/AOMediaCodec/SVT-AV1.git
          cd SVT-AV1
          cmake -S . -B build -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_INSTALL_PREFIX=/usr/local
          cmake --build build -j"$(nproc)"
          sudo cmake --install build
          sudo ldconfig

      - name: Build skit
        run: cargo build -p streamkit-server --bin skit --features "svt_av1 dav1d_static"

      - name: Start skit server
        run: |
          SK_SERVER__ADDRESS=127.0.0.1:4545 ./target/debug/skit &
          # Wait for the server to be healthy
          HEALTHY=0
          for i in $(seq 1 30); do
            if curl -sf http://127.0.0.1:4545/healthz > /dev/null 2>&1; then
              echo "skit is healthy"
              HEALTHY=1
              break
            fi
            sleep 1
          done
          if [ "$HEALTHY" -ne 1 ]; then
            echo "ERROR: skit did not become healthy within 30s"
            exit 1
          fi

      - name: Run pipeline validation tests (SW codecs only)
        run: |
          cd tests/pipeline-validation
          PIPELINE_TEST_URL=http://127.0.0.1:4545 cargo test --test validate

  pipeline-validation-gpu:
    name: Pipeline Validation (GPU)
    # Skip for fork PRs — self-hosted runners must not execute untrusted code.
    # NOTE: we check `github.event.pull_request == null` instead of
    # `github.event_name != 'pull_request'` because this workflow is invoked
    # via `workflow_call`, which sets event_name to "workflow_call" regardless
    # of the original trigger, making the event_name check always true.
    if: github.event.pull_request == null || github.event.pull_request.head.repo.full_name == github.repository
    runs-on: self-hosted
    steps:
      - uses: actions/checkout@v5

      - name: Setup Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: "1.3.5"

      - name: Build UI
        working-directory: ./ui
        run: |
          bun install --frozen-lockfile
          bun run build

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: "1.92.0"

      - uses: mozilla-actions/sccache-action@v0.0.9

      - uses: Swatinem/rust-cache@v2

      - name: Install system dependencies
        run: sudo apt-get update && sudo apt-get install -y libvpx-dev nasm cmake ninja-build yasm meson ffmpeg libopus-dev pkg-config libssl-dev

      - name: Build and install SVT-AV1 from source (v4.1.0)
        run: |
          cd /tmp
          if pkg-config --atleast-version=2.0.0 SvtAv1Enc 2>/dev/null; then
            echo "SVT-AV1 already installed, skipping build"
          else
            rm -rf SVT-AV1
            git clone --depth 1 --branch v4.1.0 https://gitlab.com/AOMediaCodec/SVT-AV1.git
            cd SVT-AV1
            cmake -S . -B build -G Ninja \
              -DCMAKE_BUILD_TYPE=Release \
              -DCMAKE_INSTALL_PREFIX=/usr/local
            cmake --build build -j"$(nproc)"
            sudo cmake --install build
            sudo ldconfig
          fi

      - name: Build skit (with GPU + HW codecs + SVT-AV1 + dav1d)
        env:
          VPX_LIB_DIR: /usr/lib/x86_64-linux-gnu
          VPX_INCLUDE_DIR: /usr/include
          VPX_VERSION: "1.13.0"
          CUDA_INCLUDE_PATH: /usr/include
          # bindgen (used by shiguredo_nvcodec) needs the clang builtin include
          # path so it can find stddef.h and other compiler-provided headers.
          BINDGEN_EXTRA_CLANG_ARGS: "-I/usr/lib/llvm-18/lib/clang/18/include"
        run: |
          cargo build -p streamkit-server --bin skit --features "gpu nvcodec vulkan_video svt_av1 dav1d_static"

      - name: Start skit server
        run: |
          # Use a non-default port to avoid conflicts with any persistent skit
          # instance that may be running on the self-hosted runner.
          SKIT_PORT=4546
          RUST_LOG=info,streamkit_nodes::codec_utils=debug,streamkit_nodes::video::vulkan_video=debug,streamkit_nodes::core::bytes_output=debug SK_SERVER__ADDRESS=127.0.0.1:${SKIT_PORT} ./target/debug/skit > /tmp/skit-gpu.log 2>&1 &
          echo $! > /tmp/skit-gpu.pid
          # Wait for the server to be healthy
          HEALTHY=0
          for i in $(seq 1 30); do
            if curl -sf http://127.0.0.1:${SKIT_PORT}/healthz > /dev/null 2>&1; then
              echo "skit is healthy on port ${SKIT_PORT}"
              HEALTHY=1
              break
            fi
            sleep 1
          done
          if [ "$HEALTHY" -ne 1 ]; then
            echo "ERROR: skit did not become healthy within 30s"
            exit 1
          fi

      - name: Run pipeline validation tests (all codecs including GPU)
        run: |
          cd tests/pipeline-validation
          PIPELINE_REQUIRE_NODES=1 PIPELINE_TEST_URL=http://127.0.0.1:4546 cargo test --test validate -- --test-threads=1

      - name: Show skit server logs
        if: always()
        run: |
          if [ -f /tmp/skit-gpu.log ]; then
            echo "=== skit server logs (last 500 lines) ==="
            tail -500 /tmp/skit-gpu.log
          fi

      - name: Stop skit server
        if: always()
        run: |
          if [ -f /tmp/skit-gpu.pid ]; then
            kill "$(cat /tmp/skit-gpu.pid)" 2>/dev/null || true
            rm -f /tmp/skit-gpu.pid
          fi
          rm -f /tmp/skit-gpu.log

  e2e:
    name: Playwright E2E
    runs-on: ubuntu-22.04
    steps:
      - name: Free disk space
        uses: jlumbroso/free-disk-space@main
        with:
          tool-cache: false
          android: true
          dotnet: true
          haskell: true
          large-packages: false
          docker-images: true
          swap-storage: false

      - uses: actions/checkout@v5

      - name: Setup Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: "1.3.5"

      - name: Build UI
        working-directory: ./ui
        run: |
          bun install --frozen-lockfile
          bun run build

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: "1.92.0"

      - uses: mozilla-actions/sccache-action@v0.0.9

      - uses: Swatinem/rust-cache@v2

      - name: Install system dependencies (libvpx for VP9, nasm for AV1 assembly, meson for dav1d)
        run: sudo apt-get update && sudo apt-get install -y libvpx-dev nasm cmake ninja-build yasm meson

      - name: Build and install SVT-AV1 from source (v4.1.0)
        run: |
          cd /tmp
          git clone --depth 1 --branch v4.1.0 https://gitlab.com/AOMediaCodec/SVT-AV1.git
          cd SVT-AV1
          cmake -S . -B build -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_INSTALL_PREFIX=/usr/local
          cmake --build build -j"$(nproc)"
          sudo cmake --install build
          sudo ldconfig
          pkg-config --modversion SvtAv1Enc

      - name: Build skit (debug, with SVT-AV1 + dav1d)
        run: cargo build -p streamkit-server --bin skit --features "svt_av1 dav1d_static"

      - name: Build moq-relay for relay e2e tests
        run: |
          set -euo pipefail
          MOQ_RELAY_COMMIT="8b1d09c7a53bad1c573bff648c593cb1903c96f7"
          RELAY_BIN="target/moq-relay/moq-relay"
          COMMIT_FILE="target/moq-relay/.commit"
          if [ -f "$RELAY_BIN" ] && [ -f "$COMMIT_FILE" ] && [ "$(cat "$COMMIT_FILE")" = "$MOQ_RELAY_COMMIT" ]; then
            echo "moq-relay binary already exists for commit $MOQ_RELAY_COMMIT — skipping build"
            exit 0
          fi
          CLONE_DIR="target/moq-relay-src"
          echo "Cloning moq-dev/moq at $MOQ_RELAY_COMMIT..."
          if [ ! -d "$CLONE_DIR/.git" ]; then
            rm -rf "$CLONE_DIR"
            git clone --depth 1 https://github.com/moq-dev/moq.git "$CLONE_DIR"
          fi
          cd "$CLONE_DIR"
          git fetch origin "$MOQ_RELAY_COMMIT" --depth 1
          git checkout "$MOQ_RELAY_COMMIT"
          echo "Building moq-relay (release)..."
          cargo build -p moq-relay --release
          cd ../..
          mkdir -p target/moq-relay
          cp "$CLONE_DIR/target/release/moq-relay" "$RELAY_BIN"
          echo "$MOQ_RELAY_COMMIT" > "$COMMIT_FILE"
          echo "moq-relay binary ready at $RELAY_BIN"

      - name: Install E2E dependencies
        working-directory: ./e2e
        run: bun install --frozen-lockfile

      - name: Install Playwright browsers
        working-directory: ./e2e
        run: bunx playwright install chromium --with-deps

      - name: Lint E2E (typecheck + prettier)
        working-directory: ./e2e
        run: bun run lint

      - name: Run E2E tests
        working-directory: ./e2e
        run: bun run test

      - name: Run E2E tests (auth enabled)
        working-directory: ./e2e
        run: E2E_AUTH=1 bun run test

      - name: Run E2E perf tests (dev server)
        run: .github/scripts/run-perf-e2e.sh

      - name: Upload Playwright report
        uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: playwright-report
          path: e2e/playwright-report/
          retention-days: 7

      - name: Upload test artifacts
        uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: playwright-results
          path: e2e/test-results/
          retention-days: 7