import { devices, type PlaywrightTestConfig } from "@playwright/test"; /** * Read environment variables from file. * https://github.com/motdotla/dotenv */ // require('dotenv').config(); /** * See https://playwright.dev/docs/test-configuration. */ const config: PlaywrightTestConfig = { testDir: "./tests", /* Maximum time one test can run for. */ timeout: 120 * 1000, expect: { /** * Maximum time expect() should wait for the condition to be met. * For example in `await expect(locator).toHaveText();` */ timeout: 10_000, }, /* Fail the build on CI if you accidentally left test.only in the source code. */ forbidOnly: !!process.env.CI, /* Retry on CI only, unless NO_FLAKY is set */ retries: process.env.NO_FLAKY === "true" ? 0 : process.env.CI ? 1 : 0, /* Opt out of parallel tests. */ workers: 1, /* Limit failures to 9 in CI (to finish early) */ maxFailures: process.env.CI ? 9 : undefined, /* Reporter to use. See https://playwright.dev/docs/test-reporters */ reporter: process.env.CI ? [["html"], ["github"], ["list"]] : [["html"], ["list"]], /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ use: { /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */ actionTimeout: 20_000, /* Base URL to use in actions like `await page.goto('/')`. */ baseURL: process.env.PLAY_URL ?? "http://play.workadventure.localhost/", /* * Keep a trace of the attempt that actually FAILED. See https://playwright.dev/docs/trace-viewer * * This was 'on-first-retry' in CI, which records only the retry โ€” and since a flaky test passes on * retry by definition, the attempt that failed shipped no trace at all. That left flaky CI failures * to be diagnosed from the text call log alone, which is a good way to mistake whatever the log * happens to mention for the actual cause. * * 'retain-on-first-failure' records the first run of each test and keeps it only when that run * failed, so a flake leaves behind a trace of the failure itself. It also covers NO_FLAKY, where * retries are disabled and there is only ever one run. * * `snapshots: false` is what keeps this affordable. Recording has to happen on every first run, * since we cannot know in advance which one will fail, and at the default settings that cost * +23.5% of test time on the chromium 1/4 shard. Benchmarking the trace options separately shows * the cost is almost entirely DOM snapshots, not screenshots: * * off 25.3s * screenshots + snapshots 42.3s (+67%) * snapshots only (screenshots off) 42.6s (+68%) * screenshots only (snapshots off) 26.5s (+5%) * * Confirmed against CI rather than only the benchmark: on the 55 tests that passed in four * comparable chromium 1/4 runs, snapshots on cost +23.5% while snapshots off cost +1.0%, the latter * being inside the run-to-run noise between two baseline runs. * * Dropping snapshots loses the time-travel DOM viewer but keeps what a flaky timeout is actually * diagnosed from: the action timeline with timings, the screencast, network, console and sources. * Page structure at the moment of failure is still covered by the screenshot below and by the * error-context.md that Playwright writes alongside it. * * When that is not enough โ€” you are hunting a specific flake and want the DOM viewer back โ€” add the * "full-trace" label to the PR and re-run. Keeping the cheap trace as the floor rather than making * all tracing opt-in matters because these flakes are roughly 1 in 8 and non-deterministic: a label * requires knowing in advance which run will fail, so on its own it would leave the common case * (a flake on an unrelated PR) with no trace at all. */ trace: { mode: "retain-on-first-failure", screenshots: true, snapshots: process.env.FULL_TRACE === "true", sources: true, }, /* A screenshot shows what actually rendered, which is the question whenever a test times out waiting for UI that should have been there. Only kept for failures. */ screenshot: "only-on-failure", navigationTimeout: 60_000, // Emulates the user locale. See https://playwright.dev/docs/api/class-browsertype#browsertypelaunchoptions locale: "en-US", }, /* Configure projects for major browsers */ projects: [ { name: "setup", testMatch: /.*\.setup\.ts/ }, { name: "chromium", use: { ...devices["Desktop Chrome"], permissions: ["microphone", "camera", "notifications"], ignoreHTTPSErrors: true, launchOptions: { args: ["--use-fake-ui-for-media-stream", "--use-fake-device-for-media-stream"], }, }, }, { name: "firefox", use: { launchOptions: { firefoxUserPrefs: { // use fake audio and video media "media.navigator.streams.fake": true, "permissions.default.microphone": 1, "permissions.default.camera": 1, }, }, ignoreHTTPSErrors: true, ...devices["Desktop Firefox"], }, }, { name: "webkit", use: { ignoreHTTPSErrors: true, ...devices["Desktop Safari"], }, }, /* Test against mobile viewports. */ { name: "mobilechromium", use: { ...devices["Pixel 5"], browserName: "chromium", permissions: ["microphone", "camera"], ignoreHTTPSErrors: true, launchOptions: { args: ["--use-fake-ui-for-media-stream", "--use-fake-device-for-media-stream"], }, }, }, { name: "mobilefirefox", use: { ...devices["Pixel 5"], browserName: "firefox", isMobile: false, ignoreHTTPSErrors: true, launchOptions: { firefoxUserPrefs: { // use fake audio and video media "media.navigator.streams.fake": true, "permissions.default.microphone": 1, "permissions.default.camera": 1, }, }, }, }, { name: "mobilewebkit", use: { ...devices["iPhone 7"], browserName: "webkit", ignoreHTTPSErrors: true, }, }, /* To use safari project and test on mobile safari, we need to have https test environment ยจ*/ //{ // name: 'mobilesafari', // use: { // ...devices['iPhone 13'], // }, //}, /* Test against branded browsers. */ // { // name: 'Microsoft Edge', // use: { // channel: 'msedge', // }, // }, // { // name: 'Google Chrome', // use: { // channel: 'chrome', // }, // }, ], /* Folder for test artifacts such as screenshots, videos, traces, etc. */ // outputDir: 'test-results/', /* Run your local dev server before starting the tests */ // webServer: { // command: 'npm run start', // port: 3000, // }, }; export default config;