playwright.config.ts

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

/**
 * Playwright configuration for QuickKee Chrome Extension E2E testing
 *
 * IMPORTANT: Before running E2E tests:
 * 1. Build the extension: npm run build (or yarn build)
 * 2. The extension will be loaded from ./dist folder
 *
 * Chrome extensions require:
 * - Headed mode (headless: false) - extensions don't work in headless
 * - Persistent context with userDataDir
 * - Chrome launch args to load the extension
 *
 * To get the extension ID after loading:
 * 1. Run a test that navigates to chrome://extensions
 * 2. Find the extension ID in the list
 * 3. Use chrome-extension://<ID>/src/popup/index.html to access the popup
 */

const extensionPath = path.resolve(__dirname, 'dist');

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

  /* Maximum time one test can run for */
  timeout: 30 * 1000,

  /* Run tests in files in parallel */
  fullyParallel: false, // Set to false for extension tests to avoid conflicts

  /* Fail the build on CI if you accidentally left test.only in the source code */
  forbidOnly: !!process.env.CI,

  /* Retry on CI only */
  retries: process.env.CI ? 2 : 0,

  /* Opt out of parallel tests on CI */
  workers: 1, // Single worker for extension testing

  /* Reporter to use */
  reporter: [
    ['html', { open: 'never' }],
    ['list']
  ],

  /* Shared settings for all the projects below */
  use: {
    /* Base URL for navigation - uses dev server */
    baseURL: 'http://localhost:3457',

    /* Collect trace when retrying the failed test */
    trace: 'on-first-retry',

    /* Screenshot on failure */
    screenshot: 'only-on-failure',
  },

  /* Configure projects */
  projects: [
    {
      name: 'chromium-extension',
      testMatch: /(extension|cloud-storage)\.spec\.ts/,
      use: {
        /* Chrome channel for extension support */
        channel: 'chrome',

        /* Extensions require headed mode */
        headless: false,

        /* Launch options for Chrome with extension */
        launchOptions: {
          args: [
            `--disable-extensions-except=${extensionPath}`,
            `--load-extension=${extensionPath}`,
            '--no-sandbox',
            '--disable-setuid-sandbox',
          ],
        },
      },
    },
    {
      name: 'dev-server',
      testMatch: /dev-server\.spec\.ts/,
      use: {
        /* Use Chromium for dev server testing (no extension needed) */
        ...devices['Desktop Chrome'],
        headless: true,
      },
    },
  ],

  /* Run your local dev server before starting the tests */
  webServer: {
    command: 'node serve.js',
    url: 'http://localhost:3457',
    reuseExistingServer: !process.env.CI,
    timeout: 120 * 1000,
  },
});

/**
 * Extension ID Retrieval Process:
 *
 * Chrome extension IDs are generated based on the extension's key or path.
 * For local development, the ID is based on the absolute path of the extension.
 *
 * To find your extension ID:
 *
 * 1. Manual method:
 *    - Open Chrome with the extension loaded (run a Playwright test)
 *    - Navigate to chrome://extensions
 *    - Find "QuickKee" and copy the ID shown below the name
 *
 * 2. Programmatic method (in test):
 *    ```typescript
 *    // Navigate to service worker to get extension context
 *    const [background] = context.serviceWorkers();
 *    const extensionId = background.url().split('/')[2];
 *    ```
 *
 * 3. Using chrome.runtime in test:
 *    ```typescript
 *    const extensionId = await page.evaluate(() => chrome.runtime.id);
 *    ```
 *
 * Once you have the extension ID, access extension pages via:
 * - Popup: chrome-extension://<ID>/src/popup/index.html
 * - Side Panel: chrome-extension://<ID>/src/sidepanel/index.html
 * - Settings: chrome-extension://<ID>/src/settings/index.html
 */