docker-compose.yml

# =============================================================================
# Docker Compose — Copilot Metrics Viewer
# =============================================================================
#
# This file supports two main use cases:
#
#   1. LOCAL DEVELOPMENT — Run the app with a database for realistic testing
#   2. TESTING — Run Playwright E2E tests (mock mode and full storage pipeline)
#
# ─── Quick Start ─────────────────────────────────────────────────────────────
#
#   Run the app with mock data (no GitHub token needed):
#     docker compose up web
#     → Open http://localhost:3000/orgs/your-org?mock=true
#
#   Run the app with real GitHub data (direct API, no DB):
#     export NUXT_GITHUB_TOKEN=github_pat_...
#     export NUXT_PUBLIC_GITHUB_ORG=your-org
#     export NUXT_PUBLIC_IS_DATA_MOCKED=false
#     docker compose up web
#     → Open http://localhost:3000/orgs/your-org
#
#   Run the app with historical mode (DB-backed, sync-on-miss):
#     export NUXT_GITHUB_TOKEN=github_pat_...
#     export NUXT_PUBLIC_GITHUB_ORG=your-org
#     export NUXT_PUBLIC_IS_DATA_MOCKED=false
#     export ENABLE_HISTORICAL_MODE=true
#     docker compose up db web
#     → First request auto-syncs from API to DB; subsequent requests read from DB
#
#   Run a one-time sync to populate the database:
#     docker compose run --rm sync
#
# ─── Testing ─────────────────────────────────────────────────────────────────
#
#   Run all Playwright E2E tests (mock data, 3 browsers):
#     docker compose run --rm playwright
#
#   Run full storage pipeline E2E test (sync → DB → dashboard):
#     docker compose run --rm sync-seed           # Phase 1: seed DB with mock data
#     docker compose run --rm playwright-storage  # Phase 2: verify dashboard reads from DB
#
# ─── Services Overview ───────────────────────────────────────────────────────
#
#   db                 — PostgreSQL 15 (data persistence)
#   web                — Main app (Nuxt 3, port 3000 → container port 80)
#   sync               — Standalone sync service (downloads metrics → PostgreSQL)
#   playwright         — E2E tests with mock data (test profile)
#   sync-seed          — Seeds DB with mock data for storage E2E (test profile)
#   playwright-storage — E2E tests reading from DB, no GitHub token (test profile)
#
# ─── Environment Variables ───────────────────────────────────────────────────
#
#   NUXT_PUBLIC_GITHUB_ORG      — Target GitHub organization
#   NUXT_PUBLIC_IS_DATA_MOCKED  — "true" for mock data, "false" for real API
#   NUXT_GITHUB_TOKEN           — GitHub PAT (fine-grained, "Copilot metrics" permission)
#   ENABLE_HISTORICAL_MODE      — "true" to read from DB with sync-on-miss
#   USE_LEGACY_API              — set to "true" to use deprecated /copilot/metrics endpoint
#   NUXT_SESSION_PASSWORD       — Session secret (min 32 chars, auto-set below)
#   DATABASE_URL                — PostgreSQL connection string (auto-set for docker-compose)
#
# =============================================================================

services:
  # ─── Database ────────────────────────────────────────────────────────────
  # PostgreSQL for persistent metrics storage.
  # Used by: web (when ENABLE_HISTORICAL_MODE=true), sync service.
  # Data persisted in the postgres_data volume.
  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: copilot_metrics
      POSTGRES_USER: metrics_user
      POSTGRES_PASSWORD: metrics_password
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U metrics_user -d copilot_metrics"]
      interval: 5s
      timeout: 3s
      retries: 5

  # ─── Web Application ────────────────────────────────────────────────────
  # Main Nuxt 3 dashboard. Accessible at http://localhost:3000.
  # Modes:
  #   - Mock data:       IS_DATA_MOCKED=true (default, no token needed)
  #   - Direct API:      IS_DATA_MOCKED=false, token required
  #   - Historical (DB): IS_DATA_MOCKED=false, ENABLE_HISTORICAL_MODE=true
  #                      Reads from PostgreSQL, auto-syncs missing data from API.
  web:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "3000:80"
    environment:
      - NUXT_PUBLIC_SCOPE=organization
      - NUXT_PUBLIC_GITHUB_ORG=${NUXT_PUBLIC_GITHUB_ORG:-your-org}
      - NUXT_PUBLIC_IS_DATA_MOCKED=${NUXT_PUBLIC_IS_DATA_MOCKED:-true}
      - NUXT_SESSION_PASSWORD=${NUXT_SESSION_PASSWORD:-at_least_32_characters_long_password_here}
      # API mode: "new" (download-based, default) or "legacy" (deprecated April 2026)
      - USE_LEGACY_API=${USE_LEGACY_API:-false}
      - ENABLE_HISTORICAL_MODE=${ENABLE_HISTORICAL_MODE:-false}
      # GitHub token — required unless using mock data
      - NUXT_GITHUB_TOKEN=${NUXT_GITHUB_TOKEN:-}
      # PostgreSQL — used when ENABLE_HISTORICAL_MODE=true
      - DATABASE_URL=postgresql://metrics_user:metrics_password@db:5432/copilot_metrics
      # Disable built-in scheduled sync (run separately via sync service)
      - SYNC_ENABLED=false
    # Note: DB is only needed when ENABLE_HISTORICAL_MODE=true.
    # For direct API or mock mode, just run: docker compose up web

  # ─── Sync Service ───────────────────────────────────────────────────────
  # Standalone container that downloads metrics from GitHub API and stores
  # them to PostgreSQL. Run on-demand or via cron.
  # Usage: docker compose run --rm sync
  sync:
    build:
      context: .
      dockerfile: Dockerfile.sync
    environment:
      - NUXT_PUBLIC_SCOPE=organization
      - NUXT_PUBLIC_GITHUB_ORG=${NUXT_PUBLIC_GITHUB_ORG:-your-org}
      - NUXT_GITHUB_TOKEN=${NUXT_GITHUB_TOKEN:-}
      - NUXT_PUBLIC_IS_DATA_MOCKED=${NUXT_PUBLIC_IS_DATA_MOCKED:-false}
      - USE_LEGACY_API=${USE_LEGACY_API:-false}
      - DATABASE_URL=postgresql://metrics_user:metrics_password@db:5432/copilot_metrics
      - SYNC_ENABLED=true
    depends_on:
      db:
        condition: service_healthy

  # ─── E2E Tests (Mock Mode) ──────────────────────────────────────────────
  # Runs all Playwright E2E tests using mock data (no GitHub token needed).
  # Tests run across 3 browsers: chromium, firefox, webkit.
  # Usage: docker compose run --rm playwright
  playwright:
    build:
      context: .
      dockerfile: Dockerfile
      args:
        mode: playwright
    environment:
      - NUXT_PUBLIC_IS_DATA_MOCKED=true
      - NUXT_PUBLIC_SCOPE=organization
      - NUXT_PUBLIC_GITHUB_ORG=mocked-org
      - NUXT_SESSION_PASSWORD=at_least_32_characters_long_password_here
      - NITRO_PORT=3000
    volumes:
      - ./test-results:/test-results
    profiles:
      - test

  # ─── E2E Tests: Storage Pipeline ────────────────────────────────────────
  # Two-phase E2E test verifying the full data pipeline:
  #   Phase 1 (sync-seed):          Writes mock data to PostgreSQL
  #   Phase 2 (playwright-storage): Reads from PostgreSQL, no GitHub token
  #
  # Usage:
  #   docker compose run --rm sync-seed           # Phase 1
  #   docker compose run --rm playwright-storage  # Phase 2
  #
  # Both services share the same PostgreSQL database. Phase 1 must run first.
  playwright-storage:
    build:
      context: .
      dockerfile: Dockerfile
      args:
        mode: playwright
    environment:
      - NUXT_PUBLIC_IS_DATA_MOCKED=false
      - NUXT_PUBLIC_SCOPE=organization
      - NUXT_PUBLIC_GITHUB_ORG=storage-test-org
      - NUXT_SESSION_PASSWORD=at_least_32_characters_long_password_here
      - ENABLE_HISTORICAL_MODE=true
      - DATABASE_URL=postgresql://metrics_user:metrics_password@db:5432/copilot_metrics
      - NITRO_PORT=3000
    entrypoint: ["npx", "playwright", "test", "-c", "playwright.docker.config.ts", "--workers", "1", "--grep", "@storage"]
    depends_on:
      db:
        condition: service_healthy
    volumes:
      - ./test-results:/test-results
    profiles:
      - test

  sync-seed:
    build:
      context: .
      dockerfile: Dockerfile
      args:
        mode: playwright
    environment:
      - NUXT_PUBLIC_IS_DATA_MOCKED=true
      - NUXT_PUBLIC_SCOPE=organization
      - NUXT_PUBLIC_GITHUB_ORG=storage-test-org
      - NUXT_SESSION_PASSWORD=at_least_32_characters_long_password_here
      - ENABLE_HISTORICAL_MODE=true
      - DATABASE_URL=postgresql://metrics_user:metrics_password@db:5432/copilot_metrics
      - NITRO_PORT=3000
    entrypoint: ["npx", "playwright", "test", "-c", "playwright.docker.config.ts", "--workers", "1", "--grep", "@seed"]
    depends_on:
      db:
        condition: service_healthy
    profiles:
      - test

# ─── Volumes ───────────────────────────────────────────────────────────────
# postgres_data — PostgreSQL data directory
volumes:
  postgres_data: