copilotkit__copilotkit/.github/workflows/test_e2e-dojo.yml

name: test / e2e / dojo

on:
  push:
    branches: [main]
    paths:
      - "packages/**"
      - "sdk-python/**"
      - ".github/workflows/test_e2e-dojo.yml"
      - ".changeset"
  pull_request:
    branches: [main]
    paths:
      - "packages/**"
      - "sdk-python/**"
      - ".github/workflows/test_e2e-dojo.yml"
      - ".changeset"
  workflow_dispatch:
    inputs:
      branch:
        description: "Branch to run the workflow on"
        required: true
        default: "main"
        type: string

env:
  NX_VERBOSE_LOGGING: true
  NX_CI_EXECUTION_ID: ${{ github.head_ref }}-${{ github.sha }}-${{ github.run_attempt }}
  NX_CI_EXECUTION_ENV: "E2E Dojo"

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

permissions:
  contents: read

jobs:
  detect-changes:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    outputs:
      ts-changed: ${{ steps.changes.outputs.ts }}
      python-changed: ${{ steps.changes.outputs.python }}
    steps:
      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          persist-credentials: false
      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
        id: changes
        with:
          filters: |
            ts:
              - 'packages/**'
              - '.github/workflows/test_e2e-dojo.yml'
              - '.changeset'
            python:
              - 'sdk-python/**'

  dojo:
    needs: detect-changes
    name: ${{ matrix.suite }}
    runs-on: depot-ubuntu-24.04
    timeout-minutes: 30
    permissions:
      contents: read
    strategy:
      fail-fast: false
      matrix:
        include:
          - suite: a2a-middleware
            test_path: tests/a2aMiddlewareTests
            services: ["dojo", "a2a-middleware"]
            wait_on: http://localhost:9999,tcp:localhost:8011,tcp:localhost:8012,tcp:localhost:8013,tcp:localhost:8014
            needs_python: true
          - suite: adk-middleware
            test_path: tests/adkMiddlewareTests
            services: ["dojo", "adk-middleware"]
            wait_on: http://localhost:9999,tcp:localhost:8010
            needs_python: true
          - suite: agno
            test_path: tests/agnoTests
            services: ["dojo", "agno"]
            wait_on: http://localhost:9999,tcp:localhost:8002
            needs_python: true
          - suite: crew-ai
            test_path: tests/crewAITests
            services: ["dojo", "crew-ai"]
            wait_on: http://localhost:9999,tcp:localhost:8003
            needs_python: true
          - suite: langgraph-python
            test_path: tests/langgraphPythonTests
            services: ["dojo", "langgraph-platform-python"]
            wait_on: http://localhost:9999,tcp:localhost:8005
            needs_python: true
          - suite: langgraph-typescript
            test_path: tests/langgraphTypescriptTests
            services: ["dojo", "langgraph-platform-typescript"]
            wait_on: http://localhost:9999,tcp:localhost:8006
            needs_python: false
          - suite: langgraph-fastapi
            test_path: tests/langgraphFastAPITests
            services: ["dojo", "langgraph-fastapi"]
            wait_on: http://localhost:9999,tcp:localhost:8004
            needs_python: true
          - suite: llama-index
            test_path: tests/llamaIndexTests
            services: ["dojo", "llama-index"]
            wait_on: http://localhost:9999,tcp:localhost:8007
            needs_python: true
          - suite: mastra
            test_path: tests/mastraTests
            services: ["dojo", "mastra"]
            wait_on: http://localhost:9999,tcp:localhost:8008
            needs_python: false
          - suite: mastra-agent-local
            test_path: tests/mastraAgentLocalTests
            services: ["dojo"]
            wait_on: http://localhost:9999
            needs_python: false
          - suite: middleware-starter
            test_path: tests/middlewareStarterTests
            services: ["dojo"]
            wait_on: http://localhost:9999
            needs_python: false
          - suite: pydantic-ai
            test_path: tests/pydanticAITests
            services: ["dojo", "pydantic-ai"]
            wait_on: http://localhost:9999,tcp:localhost:8009
            needs_python: true
          - suite: server-starter
            test_path: tests/serverStarterTests
            services: ["dojo", "server-starter"]
            wait_on: http://localhost:9999,tcp:localhost:8000
            needs_python: true
          - suite: server-starter-all
            test_path: tests/serverStarterAllFeaturesTests
            services: ["dojo", "server-starter-all"]
            wait_on: http://localhost:9999,tcp:localhost:8001
            needs_python: true
          - suite: aws-strands
            test_path: tests/awsStrandsTests
            services: ["dojo", "aws-strands"]
            wait_on: http://localhost:9999,tcp:localhost:8017
            needs_python: true

    steps:
      - name: Check relevance
        id: should-run
        run: |
          if [[ "${{ needs.detect-changes.outputs.ts-changed }}" == "true" ]] || \
             [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
            echo "skip=false" >> $GITHUB_OUTPUT
          elif [[ "${{ needs.detect-changes.outputs.python-changed }}" == "true" ]] && \
               [[ "${{ matrix.needs_python }}" == "true" ]]; then
            echo "skip=false" >> $GITHUB_OUTPUT
          else
            echo "skip=true" >> $GITHUB_OUTPUT
            echo "⏭️ Skipping ${{ matrix.suite }} — no relevant changes"
          fi

      - name: Detect fork PR
        id: fork-check
        env:
          EVENT_NAME: ${{ github.event_name }}
          PR_HEAD_REPO: ${{ github.event.pull_request.head.repo.full_name }}
          REPO_FULL: ${{ github.repository }}
        run: |
          if [[ "$EVENT_NAME" == "pull_request" && \
                "$PR_HEAD_REPO" != "$REPO_FULL" ]]; then
            echo "prefix=fork-" >> "$GITHUB_OUTPUT"
          else
            echo "prefix=" >> "$GITHUB_OUTPUT"
          fi

      - name: Checkout CPK
        if: steps.should-run.outputs.skip != 'true'
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          lfs: true
          path: CopilotKit
          ref: ${{ github.event.inputs.branch || github.ref }}
          persist-credentials: false

      - name: Checkout AGUI
        if: steps.should-run.outputs.skip != 'true'
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          repository: ag-ui-protocol/ag-ui
          path: ag-ui
          ref: main
          persist-credentials: false

      - name: Set up Node.js
        if: steps.should-run.outputs.skip != 'true'
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: "22"

      - name: Install pnpm
        # Omit `version:` so pnpm/action-setup inherits from the repo's
        # `packageManager` field in package.json (via corepack).
        if: steps.should-run.outputs.skip != 'true'
        uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 # v6.0.8
        with:
          package_json_file: CopilotKit/package.json

      # Now that pnpm is available, cache its store to speed installs
      - name: Resolve pnpm store path
        if: steps.should-run.outputs.skip != 'true'
        id: pnpm-store
        run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_OUTPUT

      - name: Cache pnpm store
        if: steps.should-run.outputs.skip != 'true'
        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ${{ steps.pnpm-store.outputs.STORE_PATH }}
          key: ${{ steps.fork-check.outputs.prefix }}${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ steps.fork-check.outputs.prefix }}${{ runner.os }}-pnpm-store-

      # Cache Python tool caches and virtualenvs; restore only to avoid long saves
      - name: Cache Python dependencies (restore-only)
        if: steps.should-run.outputs.skip != 'true' && matrix.needs_python
        id: cache-python
        uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: |
            ~/.cache/pip
            ~/.cache/pypoetry
            ~/.cache/uv
            **/.venv
          key: ${{ steps.fork-check.outputs.prefix }}${{ runner.os }}-pydeps-${{ hashFiles('**/poetry.lock', '**/pyproject.toml') }}
          restore-keys: |
            ${{ steps.fork-check.outputs.prefix }}${{ runner.os }}-pydeps-

      - name: Install Poetry
        if: steps.should-run.outputs.skip != 'true' && matrix.needs_python
        uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a # v1
        with:
          version: latest
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Install uv
        if: steps.should-run.outputs.skip != 'true' && matrix.needs_python
        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6

      - name: Install cpk dependencies
        if: steps.should-run.outputs.skip != 'true'
        working-directory: CopilotKit
        run: pnpm install --frozen-lockfile

      - name: Configure Nx Cloud environment
        if: steps.should-run.outputs.skip != 'true'
        run: |
          echo "NX_CI_EXECUTION_ID=${{ github.run_id }}-${{ github.run_attempt }}-e2e-dojo-${{ matrix.suite }}" >> $GITHUB_ENV
          echo "NX_CLOUD_NO_TIMEOUTS=true" >> $GITHUB_ENV
          echo "NX_CLOUD_DISTRIBUTED_EXECUTION=false" >> $GITHUB_ENV
          echo "NX_NO_CLOUD=true" >> $GITHUB_ENV

      - name: Build cpk packages
        if: steps.should-run.outputs.skip != 'true'
        working-directory: CopilotKit
        env:
          NODE_OPTIONS: --max-old-space-size=8192
          NX_PARALLEL: 2
        run: pnpm build

      - name: Install ag-ui dependencies
        if: steps.should-run.outputs.skip != 'true'
        working-directory: ag-ui
        run: pnpm install --frozen-lockfile

      - name: Prepare dojo for e2e
        working-directory: ag-ui/apps/dojo
        env:
          NODE_OPTIONS: --max-old-space-size=8192
        if: steps.should-run.outputs.skip != 'true' && join(matrix.services, ',') != ''
        run: node ./scripts/prep-dojo-everything.js --only ${{ join(matrix.services, ',') }}

      - name: Link cpk into ag-ui
        if: steps.should-run.outputs.skip != 'true'
        working-directory: CopilotKit
        run: node ../ag-ui/apps/dojo/scripts/link-cpk.js ${{ github.workspace }}/CopilotKit/packages

      - name: Install e2e dependencies
        if: steps.should-run.outputs.skip != 'true'
        working-directory: ag-ui/apps/dojo/e2e
        run: |
          pnpm install

      - name: write langgraph env files
        working-directory: ag-ui/integrations/langgraph
        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          LANGSMITH_API_KEY: ${{ secrets.LANGSMITH_API_KEY }}
        if: steps.should-run.outputs.skip != 'true' && (contains(join(matrix.services, ','), 'langgraph-fastapi') || contains(join(matrix.services, ','), 'langgraph-platform-python') || contains(join(matrix.services, ','), 'langgraph-platform-typescript'))
        run: |
          echo "OPENAI_API_KEY=${OPENAI_API_KEY}" > python/examples/.env
          echo "LANGSMITH_API_KEY=${LANGSMITH_API_KEY}" >> python/examples/.env
          echo "OPENAI_API_KEY=${OPENAI_API_KEY}" > typescript/examples/.env
          echo "LANGSMITH_API_KEY=${LANGSMITH_API_KEY}" >> typescript/examples/.env

      - name: Run dojo+agents
        uses: JarvusInnovations/background-action@2428e7b970a846423095c79d43f759abf979a635 # v1
        env:
          NODE_OPTIONS: --max-old-space-size=8192
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          LANGSMITH_API_KEY: ${{ secrets.LANGSMITH_API_KEY }}
          GOOGLE_API_KEY: ${{ secrets.GOOGLE_GEMINI_API_KEY }}
        if: steps.should-run.outputs.skip != 'true' && join(matrix.services, ',') != '' && contains(join(matrix.services, ','), 'dojo')
        with:
          run: |
            node ../scripts/run-dojo-everything.js --only ${{ join(matrix.services, ',') }}
          working-directory: ag-ui/apps/dojo/e2e
          wait-on: ${{ matrix.wait_on }}
          wait-for: 300000

      - name: Run tests – ${{ matrix.suite }}
        if: steps.should-run.outputs.skip != 'true'
        working-directory: ag-ui/apps/dojo/e2e
        env:
          NODE_OPTIONS: --max-old-space-size=8192
          BASE_URL: http://localhost:9999
          PLAYWRIGHT_SUITE: ${{ matrix.suite }}
        run: |
          pnpm test -- ${{ matrix.test_path }}

      - name: Upload traces – ${{ matrix.suite }}
        if: always() && steps.should-run.outputs.skip != 'true'
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: ${{ matrix.suite }}-playwright-traces
          path: |
            ag-ui/apps/dojo/e2e/test-results/${{ matrix.suite }}/**/*
            ag-ui/apps/dojo/e2e/playwright-report/**/*
          retention-days: 7