element-call/playwright.config.ts

/*
Copyright 2025 New Vector Ltd.
Copyright 2026 Element Creations Ltd.

SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details.
*/

import { defineConfig, devices } from "@playwright/test";
import { join } from "path";
import path from "node:path";
import { fileURLToPath } from "node:url";

import { COMPONENT_HARNESS_URL } from "./playwright/component/harness.ts";
import { SDK_HARNESS_URL } from "./playwright/sdk/harness.ts";

const baseURL = process.env.USE_DOCKER
  ? "http://localhost:8080"
  : "https://localhost:3000";

const __dirname = path.dirname(fileURLToPath(import.meta.url));

// Needed by the synapse admin API called in fixtures
process.env.NODE_EXTRA_CA_CERTS = join(
  __dirname,
  "backend/dev_tls_local-ca.crt",
);

/**
 * See https://playwright.dev/docs/test-configuration.
 */
export default defineConfig({
  testDir: "./playwright",
  /* Run tests in files in parallel */
  fullyParallel: true,
  /* 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: process.env.CI ? 1 : undefined,
  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
  reporter: "html",
  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
  use: {
    /* Base URL to use in actions like `await page.goto('/')`. */
    baseURL,

    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
    trace: "on-first-retry",
  },
  /* Configure projects for major browsers */
  projects: [
    {
      name: "chromium",
      testIgnore: "**/mobile/**",
      use: {
        ...devices["Desktop Chrome"],
        permissions: [
          "clipboard-write",
          "clipboard-read",
          "microphone",
          "camera",
        ],
        ignoreHTTPSErrors: true,
        launchOptions: {
          args: [
            "--use-fake-ui-for-media-stream",
            "--use-fake-device-for-media-stream",
            "--mute-audio",
          ],
        },
      },
    },
    {
      name: "firefox",
      testIgnore: "**/mobile/**",
      use: {
        ...devices["Desktop Firefox"],
        ignoreHTTPSErrors: true,
        launchOptions: {
          firefoxUserPrefs: {
            "permissions.default.microphone": 1,
            "permissions.default.camera": 1,
            // Equivalent to Chromium's --use-fake-device-for-media-stream:
            // feeds a synthetic media stream so getUserMedia and
            // enumerateDevices work on CI runners without real hardware.
            "media.navigator.streams.fake": true,
            "media.navigator.permission.disabled": true,
            // Vite serves HTTPS over HTTP/2, and Firefox intermittently stalls
            // on Node's HTTP/2 server with a page that never finishes loading
            // (one run in five or so, locally). Every server in the suite
            // still speaks HTTP/1.1, so nothing is lost by insisting on it.
            "network.http.http2.enabled": false,
          },
        },
      },
    },
    {
      name: "mobile",
      testMatch: "**/mobile/**",
      use: {
        ...devices["Pixel 7"],
        ignoreHTTPSErrors: true,
        permissions: [
          "clipboard-write",
          "clipboard-read",
          "microphone",
          "camera",
        ],
        launchOptions: {
          args: [
            "--use-fake-ui-for-media-stream",
            "--use-fake-device-for-media-stream",
            "--mute-audio",
          ],
        },
      },
    },

    // No safari for now, until I find a solution to fix `Not allowed to request resource` due to calling
    // clear http to the homeserver
  ],

  /* Run your local dev server before starting the tests */
  webServer: [
    {
      command: "./scripts/playwright-webserver-command.sh",
      url: baseURL,
      reuseExistingServer: !process.env.CI,
      ignoreHTTPSErrors: true,
      gracefulShutdown: {
        signal: "SIGTERM",
        timeout: 500,
      },
    },
    {
      // The harness that embeds Element Call as a component. Always a Vite dev
      // server, whether or not the app itself is being served from Docker,
      // since there is nothing to build: it is a development page only.
      command: "pnpm dev:component",
      url: COMPONENT_HARNESS_URL,
      reuseExistingServer: !process.env.CI,
      ignoreHTTPSErrors: true,
      gracefulShutdown: {
        signal: "SIGTERM",
        timeout: 500,
      },
    },
    {
      // The harness that uses the MatrixRTC SDK without Element Call. A Vite
      // dev server for the same reason as the component's.
      command: "pnpm dev:sdk",
      url: SDK_HARNESS_URL,
      reuseExistingServer: !process.env.CI,
      ignoreHTTPSErrors: true,
      gracefulShutdown: {
        signal: "SIGTERM",
        timeout: 500,
      },
    },
  ],
});