playwright.config.ts

import { defineConfig, devices } from '@playwright/test'

/**
 * Playwright E2E Test Configuration for GitBox
 *
 * Features:
 * - Real local Supabase database for data persistence tests
 * - MSW for GitHub API mocking (external API stability)
 * - Auth setup with cookie injection for Supabase + GitHub OAuth
 * - Separate projects for authenticated vs unauthenticated tests
 * - V8 code coverage collection with monocart-reporter
 * - Global setup/teardown for database reset
 */

/** Path to store authenticated state for reuse across tests */
const AUTH_FILE = 'e2e/.auth/user.json'

/**
 * Local Supabase configuration
 * Using local instance for real database testing
 */
const LOCAL_SUPABASE_URL = 'http://127.0.0.1:54321'
const LOCAL_SUPABASE_ANON_KEY =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0'

/**
 * Parallel mode configuration.
 * When E2E_PARALLEL_MODE is set, the orchestrator script (scripts/e2e-parallel.sh)
 * manages server lifecycle and DB reset externally. Each shard gets its own
 * Next.js server on a unique port via E2E_SHARD_PORT.
 */
const isParallelMode = !!process.env.E2E_PARALLEL_MODE
const shardPort = process.env.E2E_SHARD_PORT || '3008'

export default defineConfig({
  testDir: './e2e',

  /**
   * Global setup: Reset database before all tests.
   * Global teardown: Clean up database after all tests.
   * Disabled in parallel mode — the orchestrator handles DB reset once.
   */
  globalSetup: isParallelMode ? undefined : './e2e/global-setup.ts',
  globalTeardown: isParallelMode ? undefined : './e2e/global-teardown.ts',

  /**
   * Disable full parallel execution for database state consistency.
   * Tests share the same database, so they must run sequentially
   * within each worker to avoid race conditions.
   */
  fullyParallel: false,

  forbidOnly: !!process.env.CI,
  retries: process.env.CI ? 2 : 0,

  /**
   * Worker configuration:
   * - CI: 1 worker per shard for database state consistency
   * - Local: 1 worker (during migration, can increase after verification)
   *
   * Note: With real database, parallel workers need careful test isolation.
   * Starting with 1 worker for reliability, can optimize later.
   */
  workers: process.env.CI ? 1 : 1,

  /**
   * Fail the test run if any tests are flaky (passed only after retry).
   * This enforces test reliability — flaky tests must be fixed, not ignored.
   */
  failOnFlakyTests: true,

  /**
   * Reporters:
   * - CI: blob (for shard merging) + monocart (for coverage)
   * - Local: list + monocart (for coverage)
   *
   * NOTE: blob reporter is required for CI sharding. It generates
   * `blob-report/` directory with test results that are merged by
   * `playwright merge-reports` in the merge-reports job.
   */
  reporter: isParallelMode
    ? [
        [
          'blob',
          {
            outputDir: `./blob-report/shard-${process.env.SHARD_INDEX || '1'}`,
          },
        ],
      ]
    : process.env.CI
      ? [
          ['blob'],
          [
            'monocart-reporter',
            {
              name: 'GitBox E2E Coverage Report',
              outputFile: './coverage-e2e/index.html',
              coverage: {
                reports: [
                  ['v8'],
                  ['html', { subdir: 'istanbul' }],
                  ['lcovonly', { file: 'lcov.info' }],
                  ['text-summary'],
                  ['json-summary', { file: 'coverage-summary.json' }],
                ],
                entryFilter: {
                  '**/node_modules/**': false,
                  '**/_next/static/chunks/webpack*': false,
                  '**/_next/static/chunks/polyfills*': false,
                  '**/_next/static/**': true,
                },
                sourceFilter: {
                  // Exclude: Server-side only code (E2E cannot trigger)
                  '**/lib/actions/**': false,
                  '**/lib/supabase/**': false,
                  '**/app/auth/callback/**': false,
                  '**/instrumentation*.ts': false,
                  '**/sentry.*.config.ts': false,
                  // Exclude: Test/dev infrastructure
                  '**/tests/**': false,
                  '**/mocks/**': false,
                  '**/*.spec.ts': false,
                  '**/*.test.ts': false,
                  '**/*.test.tsx': false,
                  '**/*.stories.tsx': false,
                  '**/.storybook/**': false,
                  // Exclude: Config & build
                  '**/*.config.ts': false,
                  '**/*.config.js': false,
                  '**/*.config.mjs': false,
                  '**/node_modules/**': false,
                  '**/.next/**': false,
                  // Include: Client code
                  '**/app/**': true,
                  '**/components/**': true,
                  '**/lib/**': true,
                  '**/packages/**': true,
                },
                sourcePath: (filePath: string) => {
                  return filePath
                    .replace(/^webpack:\/\/gitbox\//, '')
                    .replace(/^\.\//g, '')
                },
              },
            },
          ],
        ]
      : [
          ['list'],
          [
            'monocart-reporter',
            {
              name: 'GitBox E2E Coverage Report',
              outputFile: './coverage-e2e/index.html',
              coverage: {
                reports: [
                  ['v8'],
                  ['html', { subdir: 'istanbul' }],
                  ['lcovonly', { file: 'lcov.info' }],
                  ['text-summary'],
                  ['json-summary', { file: 'coverage-summary.json' }],
                ],
                entryFilter: {
                  '**/node_modules/**': false,
                  '**/_next/static/chunks/webpack*': false,
                  '**/_next/static/chunks/polyfills*': false,
                  '**/_next/static/**': true,
                },
                sourceFilter: {
                  // Exclude: Server-side only code (E2E cannot trigger)
                  '**/lib/actions/**': false,
                  '**/lib/supabase/**': false,
                  '**/app/auth/callback/**': false,
                  '**/instrumentation*.ts': false,
                  '**/sentry.*.config.ts': false,
                  // Exclude: Test/dev infrastructure
                  '**/tests/**': false,
                  '**/mocks/**': false,
                  '**/*.spec.ts': false,
                  '**/*.test.ts': false,
                  '**/*.test.tsx': false,
                  '**/*.stories.tsx': false,
                  '**/.storybook/**': false,
                  // Exclude: Config & build
                  '**/*.config.ts': false,
                  '**/*.config.js': false,
                  '**/*.config.mjs': false,
                  '**/node_modules/**': false,
                  '**/.next/**': false,
                  // Include: Client code
                  '**/app/**': true,
                  '**/components/**': true,
                  '**/lib/**': true,
                  '**/packages/**': true,
                },
                sourcePath: (filePath: string) => {
                  return filePath
                    .replace(/^webpack:\/\/gitbox\//, '')
                    .replace(/^\.\//g, '')
                },
              },
            },
          ],
        ],

  timeout: 30000,

  use: {
    baseURL: `http://localhost:${shardPort}`,
    trace: 'on-first-retry',
    screenshot: 'only-on-failure',
    video: 'retain-on-failure',
  },

  projects: [
    /**
     * Setup project: Injects auth cookies to bypass OAuth flow.
     * Runs before authenticated tests.
     */
    {
      name: 'setup',
      testMatch: 'auth.setup.ts',
    },

    /**
     * Unauthenticated tests: Landing page, login page, etc.
     * These don't require authentication state.
     */
    {
      name: 'unauthenticated',
      use: {
        ...devices['Desktop Chrome'],
      },
      testMatch: /unauthenticated\/.*[.]spec.ts/,
    },

    /**
     * Logged-in tests: Tests that require authenticated state.
     * Depends on 'setup' project and uses its stored auth state.
     */
    {
      name: 'logged-in',
      dependencies: ['setup'],
      use: {
        ...devices['Desktop Chrome'],
        storageState: AUTH_FILE,
      },
      testMatch: /logged-in\/.*[.]spec.ts/,
    },
  ],

  /**
   * webServer: Build and start a local Next.js server.
   *
   * Configuration:
   * - Uses local Supabase (127.0.0.1:54321) for real database testing
   * - MSW enabled for GitHub API mocking only (external API stability)
   * - APP_ENV=test enables test mode auth bypass
   *
   * CRITICAL: NEXT_PUBLIC_* vars must be set at BUILD time because Next.js
   * inlines them during the build process.
   *
   * NOTE: reuseExistingServer is set to false to ALWAYS use a fresh server
   * with correct test environment variables.
   *
   * Disabled in parallel mode — the orchestrator manages servers externally.
   */
  webServer: isParallelMode
    ? undefined
    : {
        command: `pnpm build && pnpm start`,
        url: 'http://localhost:3008',
        reuseExistingServer: false,
        timeout: 120000,
        env: {
          NEXT_PUBLIC_ENABLE_MSW_MOCK: 'true',
          APP_ENV: 'test',
          NEXT_PUBLIC_SUPABASE_URL: LOCAL_SUPABASE_URL,
          NEXT_PUBLIC_SUPABASE_ANON_KEY: LOCAL_SUPABASE_ANON_KEY,
        },
      },
})