Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(build): lazy-load trace CLI modules and convert dynamic import to require (#39877)

Pavel Feldman9232953e2ca7
diff --git a/packages/playwright-core/src/cli/DEPS.list b/packages/playwright-core/src/cli/DEPS.list
index d434054ab6..c14a86f58e 100644
--- a/packages/playwright-core/src/cli/DEPS.list
+++ b/packages/playwright-core/src/cli/DEPS.list
@@ -9,3 +9,5 @@
../server/trace/viewer/
../tools/cli-client/program.ts
../tools/trace/traceCli.ts
+./browserActions.ts
+./installActions.ts
diff --git a/packages/playwright-core/src/cli/browserActions.ts b/packages/playwright-core/src/cli/browserActions.ts
new file mode 100644
index 0000000000..cbefe7ddd4
--- /dev/null
+++ b/packages/playwright-core/src/cli/browserActions.ts
@@ -0,0 +1,370 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable no-console */
+
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+import * as playwright from '../..';
+import { gracefullyProcessExitDoNotHang, ManualPromise } from '../utils';
+import { dotenv, program } from '../utilsBundle';
+
+import type { Browser } from '../client/browser';
+import type { BrowserContext } from '../client/browserContext';
+import type { BrowserType } from '../client/browserType';
+import type { Page } from '../client/page';
+import type { BrowserContextOptions, LaunchOptions } from '../client/types';
+
+export type Options = {
+ browser: string;
+ channel?: string;
+ colorScheme?: string;
+ device?: string;
+ geolocation?: string;
+ ignoreHttpsErrors?: boolean;
+ lang?: string;
+ loadStorage?: string;
+ proxyServer?: string;
+ proxyBypass?: string;
+ blockServiceWorkers?: boolean;
+ saveHar?: string;
+ saveHarGlob?: string;
+ saveStorage?: string;
+ timeout: string;
+ timezone?: string;
+ viewportSize?: string;
+ userAgent?: string;
+ userDataDir?: string;
+};
+
+export type CaptureOptions = {
+ waitForSelector?: string;
+ waitForTimeout?: string;
+ fullPage: boolean;
+ paperFormat?: string;
+};
+
+async function launchContext(options: Options, extraOptions: LaunchOptions): Promise<{ browser: Browser, browserName: string, launchOptions: LaunchOptions, contextOptions: BrowserContextOptions, context: BrowserContext, closeBrowser: () => Promise<void> }> {
+ validateOptions(options);
+ const browserType = lookupBrowserType(options);
+ const launchOptions: LaunchOptions = extraOptions;
+ if (options.channel)
+ launchOptions.channel = options.channel as any;
+ launchOptions.handleSIGINT = false;
+
+ const contextOptions: BrowserContextOptions =
+ // Copy the device descriptor since we have to compare and modify the options.
+ options.device ? { ...playwright.devices[options.device] } : {};
+
+ // In headful mode, use host device scale factor for things to look nice.
+ // In headless, keep things the way it works in Playwright by default.
+ // Assume high-dpi on MacOS. TODO: this is not perfect.
+ if (!extraOptions.headless)
+ contextOptions.deviceScaleFactor = os.platform() === 'darwin' ? 2 : 1;
+
+ // Work around the WebKit GTK scrolling issue.
+ if (browserType.name() === 'webkit' && process.platform === 'linux') {
+ delete contextOptions.hasTouch;
+ delete contextOptions.isMobile;
+ }
+
+ if (contextOptions.isMobile && browserType.name() === 'firefox')
+ contextOptions.isMobile = undefined;
+
+ if (options.blockServiceWorkers)
+ contextOptions.serviceWorkers = 'block';
+
+ // Proxy
+
+ if (options.proxyServer) {
+ launchOptions.proxy = {
+ server: options.proxyServer
+ };
+ if (options.proxyBypass)
+ launchOptions.proxy.bypass = options.proxyBypass;
+ }
+
+ // Viewport size
+ if (options.viewportSize) {
+ try {
+ const [width, height] = options.viewportSize.split(',').map(n => +n);
+ if (isNaN(width) || isNaN(height))
+ throw new Error('bad values');
+ contextOptions.viewport = { width, height };
+ } catch (e) {
+ throw new Error('Invalid viewport size format: use "width,height", for example --viewport-size="800,600"');
+ }
+ }
+
+ // Geolocation
+
+ if (options.geolocation) {
+ try {
+ const [latitude, longitude] = options.geolocation.split(',').map(n => parseFloat(n.trim()));
+ contextOptions.geolocation = {
+ latitude,
+ longitude
+ };
+ } catch (e) {
+ throw new Error('Invalid geolocation format, should be "lat,long". For example --geolocation="37.819722,-122.478611"');
+ }
+ contextOptions.permissions = ['geolocation'];
+ }
+
+ // User agent
+
+ if (options.userAgent)
+ contextOptions.userAgent = options.userAgent;
+
+ // Lang
+
+ if (options.lang)
+ contextOptions.locale = options.lang;
+
+ // Color scheme
+
+ if (options.colorScheme)
+ contextOptions.colorScheme = options.colorScheme as 'dark' | 'light';
+
+ // Timezone
+
+ if (options.timezone)
+ contextOptions.timezoneId = options.timezone;
+
+ // Storage
+
+ if (options.loadStorage)
+ contextOptions.storageState = options.loadStorage;
+
+ if (options.ignoreHttpsErrors)
+ contextOptions.ignoreHTTPSErrors = true;
+
+ // HAR
+
+ if (options.saveHar) {
+ contextOptions.recordHar = { path: path.resolve(process.cwd(), options.saveHar), mode: 'minimal' };
+ if (options.saveHarGlob)
+ contextOptions.recordHar.urlFilter = options.saveHarGlob;
+ contextOptions.serviceWorkers = 'block';
+ }
+
+ let browser: Browser;
+ let context: BrowserContext;
+
+ if (options.userDataDir) {
+ context = await browserType.launchPersistentContext(options.userDataDir, { ...launchOptions, ...contextOptions });
+ browser = context.browser()!;
+ } else {
+ browser = await browserType.launch(launchOptions);
+ context = await browser.newContext(contextOptions);
+ }
+
+ let closingBrowser = false;
+ async function closeBrowser() {
+ // We can come here multiple times. For example, saving storage creates
+ // a temporary page and we call closeBrowser again when that page closes.
+ if (closingBrowser)
+ return;
+ closingBrowser = true;
+ if (options.saveStorage)
+ await context.storageState({ path: options.saveStorage }).catch(e => null);
+ if (options.saveHar)
+ await context.close();
+ await browser.close();
+ }
+
+ context.on('page', page => {
+ page.on('dialog', () => {}); // Prevent dialogs from being automatically dismissed.
+ page.on('close', () => {
+ const hasPage = browser.contexts().some(context => context.pages().length > 0);
+ if (hasPage)
+ return;
+ // Avoid the error when the last page is closed because the browser has been closed.
+ closeBrowser().catch(() => {});
+ });
+ });
+ process.on('SIGINT', async () => {
+ await closeBrowser();
+ gracefullyProcessExitDoNotHang(130);
+ });
+
+ const timeout = options.timeout ? parseInt(options.timeout, 10) : 0;
+ context.setDefaultTimeout(timeout);
+ context.setDefaultNavigationTimeout(timeout);
+
+ // Omit options that we add automatically for presentation purpose.
+ delete launchOptions.headless;
+ delete launchOptions.executablePath;
+ delete launchOptions.handleSIGINT;
+ delete contextOptions.deviceScaleFactor;
+ return { browser, browserName: browserType.name(), context, contextOptions, launchOptions, closeBrowser };
+}
+
+async function openPage(context: BrowserContext, url: string | undefined): Promise<Page> {
+ let page = context.pages()[0];
+ if (!page)
+ page = await context.newPage();
+ if (url) {
+ if (fs.existsSync(url))
+ url = 'file://' + path.resolve(url);
+ else if (!url.startsWith('http') && !url.startsWith('file://') && !url.startsWith('about:') && !url.startsWith('data:'))
+ url = 'http://' + url;
+ await page.goto(url);
+ }
+ return page;
+}
+
+export async function open(options: Options, url: string | undefined) {
+ const { context } = await launchContext(options, { headless: !!process.env.PWTEST_CLI_HEADLESS, executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH });
+ await context._exposeConsoleApi();
+ await openPage(context, url);
+}
+
+export async function codegen(options: Options & { target: string, output?: string, testIdAttribute?: string }, url: string | undefined) {
+ const { target: language, output: outputFile, testIdAttribute: testIdAttributeName } = options;
+ const tracesDir = path.join(os.tmpdir(), `playwright-recorder-trace-${Date.now()}`);
+ const { context, browser, launchOptions, contextOptions, closeBrowser } = await launchContext(options, {
+ headless: !!process.env.PWTEST_CLI_HEADLESS,
+ executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH,
+ tracesDir,
+ });
+ const donePromise = new ManualPromise<void>();
+ maybeSetupTestHooks(browser, closeBrowser, donePromise);
+ dotenv.config({ path: 'playwright.env' });
+ await context._enableRecorder({
+ language,
+ launchOptions,
+ contextOptions,
+ device: options.device,
+ saveStorage: options.saveStorage,
+ mode: 'recording',
+ testIdAttributeName,
+ outputFile: outputFile ? path.resolve(outputFile) : undefined,
+ handleSIGINT: false,
+ });
+ await openPage(context, url);
+ donePromise.resolve();
+}
+
+async function maybeSetupTestHooks(browser: Browser, closeBrowser: () => Promise<void>, donePromise: Promise<void>) {
+ if (!process.env.PWTEST_CLI_IS_UNDER_TEST)
+ return;
+
+ // Make sure we exit abnormally when browser crashes.
+ const logs: string[] = [];
+ require('playwright-core/lib/utilsBundle').debug.log = (...args: any[]) => {
+ const line = require('util').format(...args) + '\n';
+ logs.push(line);
+ // eslint-disable-next-line no-restricted-properties
+ process.stderr.write(line);
+ };
+ browser.on('disconnected', () => {
+ const hasCrashLine = logs.some(line => line.includes('process did exit:') && !line.includes('process did exit: exitCode=0, signal=null'));
+ if (hasCrashLine) {
+ // eslint-disable-next-line no-restricted-properties
+ process.stderr.write('Detected browser crash.\n');
+ gracefullyProcessExitDoNotHang(1);
+ }
+ });
+
+ const close = async () => {
+ await donePromise;
+ await closeBrowser();
+ };
+
+ if (process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT) {
+ setTimeout(close, +process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT);
+ return;
+ }
+
+ // Note: we cannot use SIGINT, as it is not available on Windows.
+ let stdin = '';
+ process.stdin.on('data', data => {
+ stdin += data.toString();
+ if (stdin.startsWith('exit')) {
+ process.stdin.destroy();
+ close();
+ }
+ });
+}
+
+async function waitForPage(page: Page, captureOptions: CaptureOptions) {
+ if (captureOptions.waitForSelector) {
+ console.log(`Waiting for selector ${captureOptions.waitForSelector}...`);
+ await page.waitForSelector(captureOptions.waitForSelector);
+ }
+ if (captureOptions.waitForTimeout) {
+ console.log(`Waiting for timeout ${captureOptions.waitForTimeout}...`);
+ await page.waitForTimeout(parseInt(captureOptions.waitForTimeout, 10));
+ }
+}
+
+export async function screenshot(options: Options, captureOptions: CaptureOptions, url: string, path: string) {
+ const { context } = await launchContext(options, { headless: true });
+ console.log('Navigating to ' + url);
+ const page = await openPage(context, url);
+ await waitForPage(page, captureOptions);
+ console.log('Capturing screenshot into ' + path);
+ await page.screenshot({ path, fullPage: !!captureOptions.fullPage });
+ // launchContext takes care of closing the browser.
+ await page.close();
+}
+
+export async function pdf(options: Options, captureOptions: CaptureOptions, url: string, path: string) {
+ if (options.browser !== 'chromium')
+ throw new Error('PDF creation is only working with Chromium');
+ const { context } = await launchContext({ ...options, browser: 'chromium' }, { headless: true });
+ console.log('Navigating to ' + url);
+ const page = await openPage(context, url);
+ await waitForPage(page, captureOptions);
+ console.log('Saving as pdf into ' + path);
+ await page.pdf!({ path, format: captureOptions.paperFormat });
+ // launchContext takes care of closing the browser.
+ await page.close();
+}
+
+function lookupBrowserType(options: Options): BrowserType {
+ let name = options.browser;
+ if (options.device) {
+ const device = playwright.devices[options.device];
+ name = device.defaultBrowserType;
+ }
+ let browserType: any;
+ switch (name) {
+ case 'chromium': browserType = playwright.chromium; break;
+ case 'webkit': browserType = playwright.webkit; break;
+ case 'firefox': browserType = playwright.firefox; break;
+ case 'cr': browserType = playwright.chromium; break;
+ case 'wk': browserType = playwright.webkit; break;
+ case 'ff': browserType = playwright.firefox; break;
+ }
+ if (browserType)
+ return browserType;
+ program.help();
+}
+
+function validateOptions(options: Options) {
+ if (options.device && !(options.device in playwright.devices)) {
+ const lines = [`Device descriptor not found: '${options.device}', available devices are:`];
+ for (const name in playwright.devices)
+ lines.push(` "${name}"`);
+ throw new Error(lines.join('\n'));
+ }
+ if (options.colorScheme && !['light', 'dark'].includes(options.colorScheme))
+ throw new Error('Invalid color scheme, should be one of "light", "dark"');
+}
diff --git a/packages/playwright-core/src/cli/installActions.ts b/packages/playwright-core/src/cli/installActions.ts
new file mode 100644
index 0000000000..ada718f941
--- /dev/null
+++ b/packages/playwright-core/src/cli/installActions.ts
@@ -0,0 +1,157 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* eslint-disable no-console */
+
+import path from 'path';
+
+import { registry, writeDockerVersion } from '../server';
+import { isLikelyNpxGlobal } from '../utils';
+import { assert } from '../utils';
+import { wrapInASCIIBox } from '../server/utils/ascii';
+
+import type { BrowserInfo } from '../server';
+
+function printInstalledBrowsers(browsers: BrowserInfo[]) {
+ const browserPaths = new Set<string>();
+ for (const browser of browsers)
+ browserPaths.add(browser.browserPath);
+ console.log(` Browsers:`);
+ for (const browserPath of [...browserPaths].sort())
+ console.log(` ${browserPath}`);
+ console.log(` References:`);
+
+ const references = new Set<string>();
+ for (const browser of browsers)
+ references.add(browser.referenceDir);
+ for (const reference of [...references].sort())
+ console.log(` ${reference}`);
+}
+
+function printGroupedByPlaywrightVersion(browsers: BrowserInfo[]) {
+ const dirToVersion = new Map<string, string>();
+ for (const browser of browsers) {
+ if (dirToVersion.has(browser.referenceDir))
+ continue;
+ const packageJSON = require(path.join(browser.referenceDir, 'package.json'));
+ const version = packageJSON.version;
+ dirToVersion.set(browser.referenceDir, version);
+ }
+
+ const groupedByPlaywrightMinorVersion = new Map<string, BrowserInfo[]>();
+ for (const browser of browsers) {
+ const version = dirToVersion.get(browser.referenceDir)!;
+ let entries = groupedByPlaywrightMinorVersion.get(version);
+ if (!entries) {
+ entries = [];
+ groupedByPlaywrightMinorVersion.set(version, entries);
+ }
+ entries.push(browser);
+ }
+
+ const sortedVersions = [...groupedByPlaywrightMinorVersion.keys()].sort((a, b) => {
+ const aComponents = a.split('.');
+ const bComponents = b.split('.');
+ const aMajor = parseInt(aComponents[0], 10);
+ const bMajor = parseInt(bComponents[0], 10);
+ if (aMajor !== bMajor)
+ return aMajor - bMajor;
+ const aMinor = parseInt(aComponents[1], 10);
+ const bMinor = parseInt(bComponents[1], 10);
+ if (aMinor !== bMinor)
+ return aMinor - bMinor;
+ return aComponents.slice(2).join('.').localeCompare(bComponents.slice(2).join('.'));
+ });
+
+ for (const version of sortedVersions) {
+ console.log(`\nPlaywright version: ${version}`);
+ printInstalledBrowsers(groupedByPlaywrightMinorVersion.get(version)!);
+ }
+}
+
+export async function markDockerImage(dockerImageNameTemplate: string) {
+ assert(dockerImageNameTemplate, 'dockerImageNameTemplate is required');
+ await writeDockerVersion(dockerImageNameTemplate);
+}
+
+export async function installBrowsers(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean, list?: boolean, shell?: boolean, noShell?: boolean, onlyShell?: boolean }) {
+ if (isLikelyNpxGlobal()) {
+ console.error(wrapInASCIIBox([
+ `WARNING: It looks like you are running 'npx playwright install' without first`,
+ `installing your project's dependencies.`,
+ ``,
+ `To avoid unexpected behavior, please install your dependencies first, and`,
+ `then run Playwright's install command:`,
+ ``,
+ ` npm install`,
+ ` npx playwright install`,
+ ``,
+ `If your project does not yet depend on Playwright, first install the`,
+ `applicable npm package (most commonly @playwright/test), and`,
+ `then run Playwright's install command to download the browsers:`,
+ ``,
+ ` npm install @playwright/test`,
+ ` npx playwright install`,
+ ``,
+ ].join('\n'), 1));
+ }
+ if (options.shell === false && options.onlyShell)
+ throw new Error(`Only one of --no-shell and --only-shell can be specified`);
+ const shell = options.shell === false ? 'no' : options.onlyShell ? 'only' : undefined;
+ const executables = registry.resolveBrowsers(args, { shell });
+ if (options.withDeps)
+ await registry.installDeps(executables, !!options.dryRun);
+ if (options.dryRun && options.list)
+ throw new Error(`Only one of --dry-run and --list can be specified`);
+ if (options.dryRun) {
+ for (const executable of executables) {
+ console.log(registry.calculateDownloadTitle(executable));
+ console.log(` Install location: ${executable.directory ?? '<system>'}`);
+ if (executable.downloadURLs?.length) {
+ const [url, ...fallbacks] = executable.downloadURLs;
+ console.log(` Download url: ${url}`);
+ for (let i = 0; i < fallbacks.length; ++i)
+ console.log(` Download fallback ${i + 1}: ${fallbacks[i]}`);
+ }
+ console.log(``);
+ }
+ } else if (options.list) {
+ const browsers = await registry.listInstalledBrowsers();
+ printGroupedByPlaywrightVersion(browsers);
+ } else {
+ await registry.install(executables, { force: options.force });
+ await registry.validateHostRequirementsForExecutablesIfNeeded(executables, process.env.PW_LANG_NAME || 'javascript').catch((e: Error) => {
+ e.name = 'Playwright Host validation warning';
+ console.error(e);
+ });
+ }
+}
+
+export async function uninstallBrowsers(options: { all?: boolean }) {
+ delete process.env.PLAYWRIGHT_SKIP_BROWSER_GC;
+ await registry.uninstall(!!options.all).then(({ numberOfBrowsersLeft }) => {
+ if (!options.all && numberOfBrowsersLeft > 0) {
+ console.log('Successfully uninstalled Playwright browsers for the current Playwright installation.');
+ console.log(`There are still ${numberOfBrowsersLeft} browsers left, used by other Playwright installations.\nTo uninstall Playwright browsers for all installations, re-run with --all flag.`);
+ }
+ });
+}
+
+export async function installDeps(args: string[], options: { dryRun?: boolean }) {
+ await registry.installDeps(registry.resolveBrowsers(args, {}), !!options.dryRun);
+}
+
+export { registry };
diff --git a/packages/playwright-core/src/cli/program.ts b/packages/playwright-core/src/cli/program.ts
index ab7d0902ab..fad903e04d 100644
--- a/packages/playwright-core/src/cli/program.ts
+++ b/packages/playwright-core/src/cli/program.ts
@@ -16,27 +16,10 @@
/* eslint-disable no-console */
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
-
-import * as playwright from '../..';
-import { launchBrowserServer, printApiJson, runDriver, runServer } from './driver';
-import { registry, writeDockerVersion } from '../server';
-import { gracefullyProcessExitDoNotHang, isLikelyNpxGlobal, ManualPromise } from '../utils';
-import { runTraceInBrowser, runTraceViewerApp } from '../server/trace/viewer/traceViewer';
+import { gracefullyProcessExitDoNotHang, getPackageManagerExecCommand } from '../utils';
import { addTraceCommands } from '../tools/trace/traceCli';
-import { assert, getPackageManagerExecCommand } from '../utils';
-import { wrapInASCIIBox } from '../server/utils/ascii';
-import { dotenv, program } from '../utilsBundle';
-import { program as cliProgram } from '../tools/cli-client/program';
-
-import type { Browser } from '../client/browser';
-import type { BrowserContext } from '../client/browserContext';
-import type { BrowserType } from '../client/browserType';
-import type { Page } from '../client/page';
-import type { BrowserContextOptions, LaunchOptions } from '../client/types';
-import type { BrowserInfo } from '../server';
+import { program } from '../utilsBundle';
+
import type { TraceViewerServerOptions } from '../server/trace/viewer/traceViewer';
import type { Command } from '../utilsBundle';
@@ -52,13 +35,14 @@ program
.command('mark-docker-image [dockerImageNameTemplate]', { hidden: true })
.description('mark docker image')
.allowUnknownOption(true)
- .action(function(dockerImageNameTemplate) {
- assert(dockerImageNameTemplate, 'dockerImageNameTemplate is required');
- writeDockerVersion(dockerImageNameTemplate).catch(logErrorAndExit);
+ .action(async function(dockerImageNameTemplate) {
+ const { markDockerImage } = await import('./installActions');
+ markDockerImage(dockerImageNameTemplate).catch(logErrorAndExit);
});
commandWithOpenOptions('open [url]', 'open page in browser specified via -b, --browser', [])
- .action(function(url, options) {
+ .action(async function(url, options) {
+ const { open } = await import('./browserActions');
open(options, url).catch(logErrorAndExit);
})
.addHelpText('afterAll', `
@@ -73,6 +57,7 @@ commandWithOpenOptions('codegen [url]', 'open page and generate code for user ac
['--target <language>', `language to generate, one of javascript, playwright-test, python, python-async, python-pytest, csharp, csharp-mstest, csharp-nunit, java, java-junit`, codegenId()],
['--test-id-attribute <attributeName>', 'use the specified attribute to generate data test ID selectors'],
]).action(async function(url, options) {
+ const { codegen } = await import('./browserActions');
await codegen(options, url);
}).addHelpText('afterAll', `
Examples:
@@ -81,63 +66,6 @@ Examples:
$ codegen --target=python
$ codegen -b webkit https://example.com`);
-function printInstalledBrowsers(browsers: BrowserInfo[]) {
- const browserPaths = new Set<string>();
- for (const browser of browsers)
- browserPaths.add(browser.browserPath);
- console.log(` Browsers:`);
- for (const browserPath of [...browserPaths].sort())
- console.log(` ${browserPath}`);
- console.log(` References:`);
-
- const references = new Set<string>();
- for (const browser of browsers)
- references.add(browser.referenceDir);
- for (const reference of [...references].sort())
- console.log(` ${reference}`);
-}
-
-function printGroupedByPlaywrightVersion(browsers: BrowserInfo[]) {
- const dirToVersion = new Map<string, string>();
- for (const browser of browsers) {
- if (dirToVersion.has(browser.referenceDir))
- continue;
- const packageJSON = require(path.join(browser.referenceDir, 'package.json'));
- const version = packageJSON.version;
- dirToVersion.set(browser.referenceDir, version);
- }
-
- const groupedByPlaywrightMinorVersion = new Map<string, BrowserInfo[]>();
- for (const browser of browsers) {
- const version = dirToVersion.get(browser.referenceDir)!;
- let entries = groupedByPlaywrightMinorVersion.get(version);
- if (!entries) {
- entries = [];
- groupedByPlaywrightMinorVersion.set(version, entries);
- }
- entries.push(browser);
- }
-
- const sortedVersions = [...groupedByPlaywrightMinorVersion.keys()].sort((a, b) => {
- const aComponents = a.split('.');
- const bComponents = b.split('.');
- const aMajor = parseInt(aComponents[0], 10);
- const bMajor = parseInt(bComponents[0], 10);
- if (aMajor !== bMajor)
- return aMajor - bMajor;
- const aMinor = parseInt(aComponents[1], 10);
- const bMinor = parseInt(bComponents[1], 10);
- if (aMinor !== bMinor)
- return aMinor - bMinor;
- return aComponents.slice(2).join('.').localeCompare(bComponents.slice(2).join('.'));
- });
-
- for (const version of sortedVersions) {
- console.log(`\nPlaywright version: ${version}`);
- printInstalledBrowsers(groupedByPlaywrightMinorVersion.get(version)!);
- }
-}
-
program
.command('install [browser...]')
.description('ensure browsers necessary for this version of Playwright are installed')
@@ -148,57 +76,9 @@ program
.option('--only-shell', 'only install headless shell when installing chromium')
.option('--no-shell', 'do not install chromium headless shell')
.action(async function(args: string[], options: { withDeps?: boolean, force?: boolean, dryRun?: boolean, list?: boolean, shell?: boolean, noShell?: boolean, onlyShell?: boolean }) {
- if (isLikelyNpxGlobal()) {
- console.error(wrapInASCIIBox([
- `WARNING: It looks like you are running 'npx playwright install' without first`,
- `installing your project's dependencies.`,
- ``,
- `To avoid unexpected behavior, please install your dependencies first, and`,
- `then run Playwright's install command:`,
- ``,
- ` npm install`,
- ` npx playwright install`,
- ``,
- `If your project does not yet depend on Playwright, first install the`,
- `applicable npm package (most commonly @playwright/test), and`,
- `then run Playwright's install command to download the browsers:`,
- ``,
- ` npm install @playwright/test`,
- ` npx playwright install`,
- ``,
- ].join('\n'), 1));
- }
try {
- if (options.shell === false && options.onlyShell)
- throw new Error(`Only one of --no-shell and --only-shell can be specified`);
- const shell = options.shell === false ? 'no' : options.onlyShell ? 'only' : undefined;
- const executables = registry.resolveBrowsers(args, { shell });
- if (options.withDeps)
- await registry.installDeps(executables, !!options.dryRun);
- if (options.dryRun && options.list)
- throw new Error(`Only one of --dry-run and --list can be specified`);
- if (options.dryRun) {
- for (const executable of executables) {
- console.log(registry.calculateDownloadTitle(executable));
- console.log(` Install location: ${executable.directory ?? '<system>'}`);
- if (executable.downloadURLs?.length) {
- const [url, ...fallbacks] = executable.downloadURLs;
- console.log(` Download url: ${url}`);
- for (let i = 0; i < fallbacks.length; ++i)
- console.log(` Download fallback ${i + 1}: ${fallbacks[i]}`);
- }
- console.log(``);
- }
- } else if (options.list) {
- const browsers = await registry.listInstalledBrowsers();
- printGroupedByPlaywrightVersion(browsers);
- } else {
- await registry.install(executables, { force: options.force });
- await registry.validateHostRequirementsForExecutablesIfNeeded(executables, process.env.PW_LANG_NAME || 'javascript').catch((e: Error) => {
- e.name = 'Playwright Host validation warning';
- console.error(e);
- });
- }
+ const { installBrowsers } = await import('./installActions');
+ await installBrowsers(args, options);
} catch (e) {
console.log(`Failed to install browsers\n${e}`);
gracefullyProcessExitDoNotHang(1);
@@ -210,20 +90,15 @@ Examples:
Install default browsers.
- $ install chrome firefox
- Install custom browsers, supports ${registry.suggestedBrowsersToInstall()}.`);
+ Install custom browsers, supports chromium, firefox, webkit, chromium-headless-shell.`);
program
.command('uninstall')
.description('Removes browsers used by this installation of Playwright from the system (chromium, firefox, webkit, ffmpeg). This does not include branded channels.')
.option('--all', 'Removes all browsers used by any Playwright installation from the system.')
.action(async (options: { all?: boolean }) => {
- delete process.env.PLAYWRIGHT_SKIP_BROWSER_GC;
- await registry.uninstall(!!options.all).then(({ numberOfBrowsersLeft }) => {
- if (!options.all && numberOfBrowsersLeft > 0) {
- console.log('Successfully uninstalled Playwright browsers for the current Playwright installation.');
- console.log(`There are still ${numberOfBrowsersLeft} browsers left, used by other Playwright installations.\nTo uninstall Playwright browsers for all installations, re-run with --all flag.`);
- }
- }).catch(logErrorAndExit);
+ const { uninstallBrowsers } = await import('./installActions');
+ uninstallBrowsers(options).catch(logErrorAndExit);
});
program
@@ -232,7 +107,8 @@ program
.option('--dry-run', 'Do not execute installation commands, only print them')
.action(async function(args: string[], options: { dryRun?: boolean }) {
try {
- await registry.installDeps(registry.resolveBrowsers(args, {}), !!options.dryRun);
+ const { installDeps } = await import('./installActions');
+ await installDeps(args, options);
} catch (e) {
console.log(`Failed to install browser dependencies\n${e}`);
gracefullyProcessExitDoNotHang(1);
@@ -243,7 +119,7 @@ Examples:
Install dependencies for default browsers.
- $ install-deps chrome firefox
- Install dependencies for specific browsers, supports ${registry.suggestedBrowsersToInstall()}.`);
+ Install dependencies for specific browsers, supports chromium, firefox, webkit, chromium-headless-shell.`);
const browsers = [
{ alias: 'cr', name: 'Chromium', type: 'chromium' },
@@ -253,7 +129,8 @@ const browsers = [
for (const { alias, name, type } of browsers) {
commandWithOpenOptions(`${alias} [url]`, `open page in ${name}`, [])
- .action(function(url, options) {
+ .action(async function(url, options) {
+ const { open } = await import('./browserActions');
open({ ...options, browser: type }, url).catch(logErrorAndExit);
}).addHelpText('afterAll', `
Examples:
@@ -266,7 +143,8 @@ commandWithOpenOptions('screenshot <url> <filename>', 'capture a page screenshot
['--wait-for-selector <selector>', 'wait for selector before taking a screenshot'],
['--wait-for-timeout <timeout>', 'wait for timeout in milliseconds before taking a screenshot'],
['--full-page', 'whether to take a full page screenshot (entire scrollable area)'],
- ]).action(function(url, filename, command) {
+ ]).action(async function(url, filename, command) {
+ const { screenshot } = await import('./browserActions');
screenshot(command, command, url, filename).catch(logErrorAndExit);
}).addHelpText('afterAll', `
Examples:
@@ -278,7 +156,8 @@ commandWithOpenOptions('pdf <url> <filename>', 'save page as pdf',
['--paper-format <format>', 'paper format: Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6'],
['--wait-for-selector <selector>', 'wait for given selector before saving as pdf'],
['--wait-for-timeout <timeout>', 'wait for given timeout in milliseconds before saving as pdf'],
- ]).action(function(url, filename, options) {
+ ]).action(async function(url, filename, options) {
+ const { pdf } = await import('./browserActions');
pdf(options, options, url, filename).catch(logErrorAndExit);
}).addHelpText('afterAll', `
Examples:
@@ -287,7 +166,8 @@ Examples:
program
.command('run-driver', { hidden: true })
- .action(function(options) {
+ .action(async function(options) {
+ const { runDriver } = await import('./driver');
runDriver();
});
@@ -299,7 +179,8 @@ program
.option('--max-clients <maxClients>', 'Maximum clients')
.option('--mode <mode>', 'Server mode, either "default" or "extension"')
.option('--artifacts-dir <artifactsDir>', 'Artifacts directory')
- .action(function(options) {
+ .action(async function(options) {
+ const { runServer } = await import('./driver');
runServer({
port: options.port ? +options.port : undefined,
host: options.host,
@@ -312,7 +193,8 @@ program
program
.command('print-api-json', { hidden: true })
- .action(function(options) {
+ .action(async function(options) {
+ const { printApiJson } = await import('./driver');
printApiJson();
});
@@ -320,7 +202,8 @@ program
.command('launch-server', { hidden: true })
.requiredOption('--browser <browserName>', 'Browser name, one of "chromium", "firefox" or "webkit"')
.option('--config <path-to-config-file>', 'JSON file with launchServer options')
- .action(function(options) {
+ .action(async function(options) {
+ const { launchBrowserServer } = await import('./driver');
launchBrowserServer(options.browser, options.config);
});
@@ -331,7 +214,7 @@ program
.option('-p, --port <port>', 'Port to serve trace on, 0 for any free port; specifying this option opens trace in a browser tab')
.option('--stdin', 'Accept trace URLs over stdin to update the viewer')
.description('show trace viewer')
- .action(function(trace, options) {
+ .action(async function(trace, options) {
if (options.browser === 'cr')
options.browser = 'chromium';
if (options.browser === 'ff')
@@ -345,6 +228,7 @@ program
isServer: !!options.stdin,
};
+ const { runTraceInBrowser, runTraceViewerApp } = await import('../server/trace/viewer/traceViewer');
if (options.port !== undefined || options.host !== undefined)
runTraceInBrowser(trace, openOptions).catch(logErrorAndExit);
else
@@ -362,349 +246,11 @@ program
.allowExcessArguments(true)
.allowUnknownOption(true)
.action(async options => {
+ const { program: cliProgram } = await import('../tools/cli-client/program');
process.argv.splice(process.argv.indexOf('cli'), 1);
cliProgram();
});
-type Options = {
- browser: string;
- channel?: string;
- colorScheme?: string;
- device?: string;
- geolocation?: string;
- ignoreHttpsErrors?: boolean;
- lang?: string;
- loadStorage?: string;
- proxyServer?: string;
- proxyBypass?: string;
- blockServiceWorkers?: boolean;
- saveHar?: string;
- saveHarGlob?: string;
- saveStorage?: string;
- timeout: string;
- timezone?: string;
- viewportSize?: string;
- userAgent?: string;
- userDataDir?: string;
-};
-
-type CaptureOptions = {
- waitForSelector?: string;
- waitForTimeout?: string;
- fullPage: boolean;
- paperFormat?: string;
-};
-
-async function launchContext(options: Options, extraOptions: LaunchOptions): Promise<{ browser: Browser, browserName: string, launchOptions: LaunchOptions, contextOptions: BrowserContextOptions, context: BrowserContext, closeBrowser: () => Promise<void> }> {
- validateOptions(options);
- const browserType = lookupBrowserType(options);
- const launchOptions: LaunchOptions = extraOptions;
- if (options.channel)
- launchOptions.channel = options.channel as any;
- launchOptions.handleSIGINT = false;
-
- const contextOptions: BrowserContextOptions =
- // Copy the device descriptor since we have to compare and modify the options.
- options.device ? { ...playwright.devices[options.device] } : {};
-
- // In headful mode, use host device scale factor for things to look nice.
- // In headless, keep things the way it works in Playwright by default.
- // Assume high-dpi on MacOS. TODO: this is not perfect.
- if (!extraOptions.headless)
- contextOptions.deviceScaleFactor = os.platform() === 'darwin' ? 2 : 1;
-
- // Work around the WebKit GTK scrolling issue.
- if (browserType.name() === 'webkit' && process.platform === 'linux') {
- delete contextOptions.hasTouch;
- delete contextOptions.isMobile;
- }
-
- if (contextOptions.isMobile && browserType.name() === 'firefox')
- contextOptions.isMobile = undefined;
-
- if (options.blockServiceWorkers)
- contextOptions.serviceWorkers = 'block';
-
- // Proxy
-
- if (options.proxyServer) {
- launchOptions.proxy = {
- server: options.proxyServer
- };
- if (options.proxyBypass)
- launchOptions.proxy.bypass = options.proxyBypass;
- }
-
- // Viewport size
- if (options.viewportSize) {
- try {
- const [width, height] = options.viewportSize.split(',').map(n => +n);
- if (isNaN(width) || isNaN(height))
- throw new Error('bad values');
- contextOptions.viewport = { width, height };
- } catch (e) {
- throw new Error('Invalid viewport size format: use "width,height", for example --viewport-size="800,600"');
- }
- }
-
- // Geolocation
-
- if (options.geolocation) {
- try {
- const [latitude, longitude] = options.geolocation.split(',').map(n => parseFloat(n.trim()));
- contextOptions.geolocation = {
- latitude,
- longitude
- };
- } catch (e) {
- throw new Error('Invalid geolocation format, should be "lat,long". For example --geolocation="37.819722,-122.478611"');
- }
- contextOptions.permissions = ['geolocation'];
- }
-
- // User agent
-
- if (options.userAgent)
- contextOptions.userAgent = options.userAgent;
-
- // Lang
-
- if (options.lang)
- contextOptions.locale = options.lang;
-
- // Color scheme
-
- if (options.colorScheme)
- contextOptions.colorScheme = options.colorScheme as 'dark' | 'light';
-
- // Timezone
-
- if (options.timezone)
- contextOptions.timezoneId = options.timezone;
-
- // Storage
-
- if (options.loadStorage)
- contextOptions.storageState = options.loadStorage;
-
- if (options.ignoreHttpsErrors)
- contextOptions.ignoreHTTPSErrors = true;
-
- // HAR
-
- if (options.saveHar) {
- contextOptions.recordHar = { path: path.resolve(process.cwd(), options.saveHar), mode: 'minimal' };
- if (options.saveHarGlob)
- contextOptions.recordHar.urlFilter = options.saveHarGlob;
- contextOptions.serviceWorkers = 'block';
- }
-
- let browser: Browser;
- let context: BrowserContext;
-
- if (options.userDataDir) {
- context = await browserType.launchPersistentContext(options.userDataDir, { ...launchOptions, ...contextOptions });
- browser = context.browser()!;
- } else {
- browser = await browserType.launch(launchOptions);
- context = await browser.newContext(contextOptions);
- }
-
- let closingBrowser = false;
- async function closeBrowser() {
- // We can come here multiple times. For example, saving storage creates
- // a temporary page and we call closeBrowser again when that page closes.
- if (closingBrowser)
- return;
- closingBrowser = true;
- if (options.saveStorage)
- await context.storageState({ path: options.saveStorage }).catch(e => null);
- if (options.saveHar)
- await context.close();
- await browser.close();
- }
-
- context.on('page', page => {
- page.on('dialog', () => {}); // Prevent dialogs from being automatically dismissed.
- page.on('close', () => {
- const hasPage = browser.contexts().some(context => context.pages().length > 0);
- if (hasPage)
- return;
- // Avoid the error when the last page is closed because the browser has been closed.
- closeBrowser().catch(() => {});
- });
- });
- process.on('SIGINT', async () => {
- await closeBrowser();
- gracefullyProcessExitDoNotHang(130);
- });
-
- const timeout = options.timeout ? parseInt(options.timeout, 10) : 0;
- context.setDefaultTimeout(timeout);
- context.setDefaultNavigationTimeout(timeout);
-
- // Omit options that we add automatically for presentation purpose.
- delete launchOptions.headless;
- delete launchOptions.executablePath;
- delete launchOptions.handleSIGINT;
- delete contextOptions.deviceScaleFactor;
- return { browser, browserName: browserType.name(), context, contextOptions, launchOptions, closeBrowser };
-}
-
-async function openPage(context: BrowserContext, url: string | undefined): Promise<Page> {
- let page = context.pages()[0];
- if (!page)
- page = await context.newPage();
- if (url) {
- if (fs.existsSync(url))
- url = 'file://' + path.resolve(url);
- else if (!url.startsWith('http') && !url.startsWith('file://') && !url.startsWith('about:') && !url.startsWith('data:'))
- url = 'http://' + url;
- await page.goto(url);
- }
- return page;
-}
-
-async function open(options: Options, url: string | undefined) {
- const { context } = await launchContext(options, { headless: !!process.env.PWTEST_CLI_HEADLESS, executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH });
- await context._exposeConsoleApi();
- await openPage(context, url);
-}
-
-async function codegen(options: Options & { target: string, output?: string, testIdAttribute?: string }, url: string | undefined) {
- const { target: language, output: outputFile, testIdAttribute: testIdAttributeName } = options;
- const tracesDir = path.join(os.tmpdir(), `playwright-recorder-trace-${Date.now()}`);
- const { context, browser, launchOptions, contextOptions, closeBrowser } = await launchContext(options, {
- headless: !!process.env.PWTEST_CLI_HEADLESS,
- executablePath: process.env.PWTEST_CLI_EXECUTABLE_PATH,
- tracesDir,
- });
- const donePromise = new ManualPromise<void>();
- maybeSetupTestHooks(browser, closeBrowser, donePromise);
- dotenv.config({ path: 'playwright.env' });
- await context._enableRecorder({
- language,
- launchOptions,
- contextOptions,
- device: options.device,
- saveStorage: options.saveStorage,
- mode: 'recording',
- testIdAttributeName,
- outputFile: outputFile ? path.resolve(outputFile) : undefined,
- handleSIGINT: false,
- });
- await openPage(context, url);
- donePromise.resolve();
-}
-
-async function maybeSetupTestHooks(browser: Browser, closeBrowser: () => Promise<void>, donePromise: Promise<void>) {
- if (!process.env.PWTEST_CLI_IS_UNDER_TEST)
- return;
-
- // Make sure we exit abnormally when browser crashes.
- const logs: string[] = [];
- require('playwright-core/lib/utilsBundle').debug.log = (...args: any[]) => {
- const line = require('util').format(...args) + '\n';
- logs.push(line);
- // eslint-disable-next-line no-restricted-properties
- process.stderr.write(line);
- };
- browser.on('disconnected', () => {
- const hasCrashLine = logs.some(line => line.includes('process did exit:') && !line.includes('process did exit: exitCode=0, signal=null'));
- if (hasCrashLine) {
- // eslint-disable-next-line no-restricted-properties
- process.stderr.write('Detected browser crash.\n');
- gracefullyProcessExitDoNotHang(1);
- }
- });
-
- const close = async () => {
- await donePromise;
- await closeBrowser();
- };
-
- if (process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT) {
- setTimeout(close, +process.env.PWTEST_CLI_EXIT_AFTER_TIMEOUT);
- return;
- }
-
- // Note: we cannot use SIGINT, as it is not available on Windows.
- let stdin = '';
- process.stdin.on('data', data => {
- stdin += data.toString();
- if (stdin.startsWith('exit')) {
- process.stdin.destroy();
- close();
- }
- });
-}
-
-async function waitForPage(page: Page, captureOptions: CaptureOptions) {
- if (captureOptions.waitForSelector) {
- console.log(`Waiting for selector ${captureOptions.waitForSelector}...`);
- await page.waitForSelector(captureOptions.waitForSelector);
- }
- if (captureOptions.waitForTimeout) {
- console.log(`Waiting for timeout ${captureOptions.waitForTimeout}...`);
- await page.waitForTimeout(parseInt(captureOptions.waitForTimeout, 10));
- }
-}
-
-async function screenshot(options: Options, captureOptions: CaptureOptions, url: string, path: string) {
- const { context } = await launchContext(options, { headless: true });
- console.log('Navigating to ' + url);
- const page = await openPage(context, url);
- await waitForPage(page, captureOptions);
- console.log('Capturing screenshot into ' + path);
- await page.screenshot({ path, fullPage: !!captureOptions.fullPage });
- // launchContext takes care of closing the browser.
- await page.close();
-}
-
-async function pdf(options: Options, captureOptions: CaptureOptions, url: string, path: string) {
- if (options.browser !== 'chromium')
- throw new Error('PDF creation is only working with Chromium');
- const { context } = await launchContext({ ...options, browser: 'chromium' }, { headless: true });
- console.log('Navigating to ' + url);
- const page = await openPage(context, url);
- await waitForPage(page, captureOptions);
- console.log('Saving as pdf into ' + path);
- await page.pdf!({ path, format: captureOptions.paperFormat });
- // launchContext takes care of closing the browser.
- await page.close();
-}
-
-function lookupBrowserType(options: Options): BrowserType {
- let name = options.browser;
- if (options.device) {
- const device = playwright.devices[options.device];
- name = device.defaultBrowserType;
- }
- let browserType: any;
- switch (name) {
- case 'chromium': browserType = playwright.chromium; break;
- case 'webkit': browserType = playwright.webkit; break;
- case 'firefox': browserType = playwright.firefox; break;
- case 'cr': browserType = playwright.chromium; break;
- case 'wk': browserType = playwright.webkit; break;
- case 'ff': browserType = playwright.firefox; break;
- }
- if (browserType)
- return browserType;
- program.help();
-}
-
-function validateOptions(options: Options) {
- if (options.device && !(options.device in playwright.devices)) {
- const lines = [`Device descriptor not found: '${options.device}', available devices are:`];
- for (const name in playwright.devices)
- lines.push(` "${name}"`);
- throw new Error(lines.join('\n'));
- }
- if (options.colorScheme && !['light', 'dark'].includes(options.colorScheme))
- throw new Error('Invalid color scheme, should be one of "light", "dark"');
-}
-
function logErrorAndExit(e: Error) {
if (process.env.PWDEBUGIMPL)
console.error(e);
diff --git a/packages/playwright-core/src/tools/trace/traceCli.ts b/packages/playwright-core/src/tools/trace/traceCli.ts
index 6dca36453a..79cc46f6a0 100644
--- a/packages/playwright-core/src/tools/trace/traceCli.ts
+++ b/packages/playwright-core/src/tools/trace/traceCli.ts
@@ -14,16 +14,6 @@
* limitations under the License.
*/
-import { traceOpen } from './traceOpen';
-import { traceActions, traceAction } from './traceActions';
-import { traceRequests, traceRequest } from './traceRequests';
-import { traceConsole } from './traceConsole';
-import { traceErrors } from './traceErrors';
-import { traceSnapshot } from './traceSnapshot';
-import { traceScreenshot } from './traceScreenshot';
-import { traceAttachments, traceAttachment } from './traceAttachments';
-import { installSkill } from './installSkill';
-
import type { Command } from '../../utilsBundle';
export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) => void) {
@@ -34,7 +24,8 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
traceCommand
.command('open <trace>')
.description('extract trace file for inspection')
- .action((trace: string) => {
+ .action(async (trace: string) => {
+ const { traceOpen } = await import('./traceOpen');
traceOpen(trace).catch(logErrorAndExit);
});
@@ -43,14 +34,16 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.description('list actions in the trace')
.option('--grep <pattern>', 'filter actions by title pattern')
.option('--errors-only', 'only show failed actions')
- .action((options: { grep?: string, errorsOnly?: boolean }) => {
+ .action(async (options: { grep?: string, errorsOnly?: boolean }) => {
+ const { traceActions } = await import('./traceActions');
traceActions(options).catch(logErrorAndExit);
});
traceCommand
.command('action <action-id>')
.description('show details of a specific action')
- .action((actionId: string) => {
+ .action(async (actionId: string) => {
+ const { traceAction } = await import('./traceActions');
traceAction(actionId).catch(logErrorAndExit);
});
@@ -61,14 +54,16 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.option('--method <method>', 'filter by HTTP method')
.option('--status <code>', 'filter by status code')
.option('--failed', 'only show failed requests (status >= 400)')
- .action((options: { grep?: string, method?: string, status?: string, failed?: boolean }) => {
+ .action(async (options: { grep?: string, method?: string, status?: string, failed?: boolean }) => {
+ const { traceRequests } = await import('./traceRequests');
traceRequests(options).catch(logErrorAndExit);
});
traceCommand
.command('request <request-id>')
.description('show details of a specific network request')
- .action((requestId: string) => {
+ .action(async (requestId: string) => {
+ const { traceRequest } = await import('./traceRequests');
traceRequest(requestId).catch(logErrorAndExit);
});
@@ -79,14 +74,16 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.option('--warnings', 'show errors and warnings')
.option('--browser', 'only browser console messages')
.option('--stdio', 'only stdout/stderr')
- .action((options: { errorsOnly?: boolean, warnings?: boolean, browser?: boolean, stdio?: boolean }) => {
+ .action(async (options: { errorsOnly?: boolean, warnings?: boolean, browser?: boolean, stdio?: boolean }) => {
+ const { traceConsole } = await import('./traceConsole');
traceConsole(options).catch(logErrorAndExit);
});
traceCommand
.command('errors')
.description('show errors with stack traces')
- .action(() => {
+ .action(async () => {
+ const { traceErrors } = await import('./traceErrors');
traceErrors().catch(logErrorAndExit);
});
@@ -99,6 +96,7 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.allowExcessArguments(true)
.action(async (actionId: string, options: { name?: string, serve?: boolean }, cmd: Command) => {
try {
+ const { traceSnapshot } = await import('./traceSnapshot');
// Collect everything after '--' as the browser command.
const browserArgs = cmd.args.slice(1);
await traceSnapshot(actionId, { ...options, browserArgs });
@@ -111,14 +109,16 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.command('screenshot <action-id>')
.description('save screencast screenshot for an action')
.option('-o, --output <path>', 'output file path')
- .action((actionId: string, options: { output?: string }) => {
+ .action(async (actionId: string, options: { output?: string }) => {
+ const { traceScreenshot } = await import('./traceScreenshot');
traceScreenshot(actionId, options).catch(logErrorAndExit);
});
traceCommand
.command('attachments')
.description('list trace attachments')
- .action(() => {
+ .action(async () => {
+ const { traceAttachments } = await import('./traceAttachments');
traceAttachments().catch(logErrorAndExit);
});
@@ -126,14 +126,16 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
.command('attachment <attachment-id>')
.description('extract a trace attachment by its number')
.option('-o, --output <path>', 'output file path')
- .action((attachmentId: string, options: { output?: string }) => {
+ .action(async (attachmentId: string, options: { output?: string }) => {
+ const { traceAttachment } = await import('./traceAttachments');
traceAttachment(attachmentId, options).catch(logErrorAndExit);
});
traceCommand
.command('install-skill')
.description('install SKILL.md for LLM integration')
- .action(() => {
+ .action(async () => {
+ const { installSkill } = await import('./installSkill');
installSkill().catch(logErrorAndExit);
});
}
diff --git a/packages/playwright/src/DEPS.list b/packages/playwright/src/DEPS.list
index 1db4544ec5..0ff8cb9f20 100644
--- a/packages/playwright/src/DEPS.list
+++ b/packages/playwright/src/DEPS.list
@@ -6,6 +6,12 @@ common/
[program.ts]
**
+[testActions.ts]
+**
+
+[reportActions.ts]
+**
+
[index.ts]
@testIsomorphic/**
./prompt.ts
diff --git a/packages/playwright/src/program.ts b/packages/playwright/src/program.ts
index 801c88bc98..4f6430eded 100644
--- a/packages/playwright/src/program.ts
+++ b/packages/playwright/src/program.ts
@@ -16,31 +16,15 @@
/* eslint-disable no-console */
-import fs from 'fs';
-import path from 'path';
+import { gracefullyProcessExitDoNotHang } from 'playwright-core/lib/utils';
import { program } from 'playwright-core/lib/cli/program';
-import { gracefullyProcessExitDoNotHang, startProfiling, stopProfiling } from 'playwright-core/lib/utils';
-import * as tools from 'playwright-core/lib/tools/exports';
-import { setupExitWatchdog } from 'playwright-core/lib/tools/exports';
-
import { builtInReporters, defaultReporter, defaultTimeout } from './common/config';
-import { loadConfigFromFile, loadEmptyConfigForMergeReports, resolveConfigLocation } from './common/configLoader';
+
export { program } from 'playwright-core/lib/cli/program';
-import { terminalScreen } from './reporters/base';
-import { showHTMLReport } from './reporters/html';
-import { createMergedReport } from './reporters/merge';
-import { filterProjects } from './runner/projectUtils';
-import * as testServer from './runner/testServer';
-import { runWatchModeLoop } from './runner/watchMode';
-import { runAllTestsWithConfig, TestRunner } from './runner/testRunner';
-import { createErrorCollectingReporter } from './runner/reporters';
-import { TestServerBackend, testServerBackendTools } from './mcp/test/testBackend';
-import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
-import type { ConfigCLIOverrides } from './common/ipc';
+import type { ServerBackendFactory } from 'playwright-core/lib/tools/exports';
import type { TraceMode } from '../types/test';
-import type { ReporterDescription } from '../types/test';
import type { Command } from 'playwright-core/lib/utilsBundle';
const packageJSON = require('../package.json');
@@ -62,6 +46,7 @@ function addTestCommand(program: Command) {
});
command.action(async (args, opts) => {
try {
+ const { runTests } = await import('./testActions');
await runTests(args, opts);
} catch (e) {
console.error(e);
@@ -84,10 +69,8 @@ function addClearCacheCommand(program: Command) {
command.description('clears build and test caches');
command.option('-c, --config <file>', `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
command.action(async opts => {
- const runner = new TestRunner(resolveConfigLocation(opts.config), {});
- const { status } = await runner.clearCache(createErrorCollectingReporter(terminalScreen));
- const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
- gracefullyProcessExitDoNotHang(exitCode);
+ const { clearCache } = await import('./testActions');
+ await clearCache(opts);
});
}
@@ -96,8 +79,8 @@ function addDevServerCommand(program: Command) {
command.description('start dev server');
command.option('-c, --config <file>', `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
command.action(async options => {
- const runner = new TestRunner(resolveConfigLocation(options.config), {});
- await runner.startDevServer(createErrorCollectingReporter(terminalScreen), 'in-process');
+ const { startDevServer } = await import('./testActions');
+ await startDevServer(options);
});
}
@@ -107,13 +90,19 @@ function addTestServerCommand(program: Command) {
command.option('-c, --config <file>', `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
command.option('--host <host>', 'Host to start the server on', 'localhost');
command.option('--port <port>', 'Port to start the server on', '0');
- command.action(opts => runTestServer(opts));
+ command.action(async opts => {
+ const { runTestServerAction } = await import('./testActions');
+ await runTestServerAction(opts);
+ });
}
function addShowReportCommand(program: Command) {
const command = program.command('show-report [report]');
command.description('show HTML report');
- command.action((report, options) => showHTMLReport(report, options.host, +options.port));
+ command.action(async (report, options) => {
+ const { showReport } = await import('./reportActions');
+ await showReport(report, options.host, +options.port);
+ });
command.option('--host <host>', 'Host to serve report on', 'localhost');
command.option('--port <port>', 'Port to serve report on', '9323');
command.addHelpText('afterAll', `
@@ -130,6 +119,7 @@ function addMergeReportsCommand(program: Command) {
command.description('merge multiple blob reports (for sharded tests) into a single report');
command.action(async (dir, options) => {
try {
+ const { mergeReports } = await import('./reportActions');
await mergeReports(dir, options);
} catch (e) {
console.error(e);
@@ -154,8 +144,10 @@ function addTestMCPServerCommand(program: Command) {
command.option('--host <host>', 'host to bind server to. Default is localhost. Use 0.0.0.0 to bind to all interfaces.');
command.option('--port <port>', 'port to listen on for SSE transport.');
command.action(async options => {
+ const { start, setupExitWatchdog } = await import('playwright-core/lib/tools/exports');
+ const { TestServerBackend, testServerBackendTools } = await import('./mcp/test/testBackend');
setupExitWatchdog();
- const factory: tools.ServerBackendFactory = {
+ const factory: ServerBackendFactory = {
name: 'Playwright Test Runner',
nameInConfig: 'playwright-test-runner',
version: packageJSON.version,
@@ -164,7 +156,7 @@ function addTestMCPServerCommand(program: Command) {
disposed: async () => { }
};
// TODO: add all options from mcp.startHttpServer.
- await tools.start(factory, { port: options.port === undefined ? undefined : +options.port, host: options.host });
+ await start(factory, { port: options.port === undefined ? undefined : +options.port, host: options.host });
});
}
@@ -178,6 +170,8 @@ function addInitAgentsCommand(program: Command) {
command.option('--project <project>', 'Project to use for seed test');
command.option('--prompts', 'Whether to include prompts in the agent initialization');
command.action(async opts => {
+ const { loadConfigFromFile } = await import('./common/configLoader');
+ const { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } = await import('./agents/generateAgents');
const config = await loadConfigFromFile(opts.config);
if (opts.loop === 'opencode') {
await OpencodeGenerator.init(config, opts.project, opts.prompts);
@@ -192,209 +186,6 @@ function addInitAgentsCommand(program: Command) {
});
}
-async function runTests(args: string[], opts: { [key: string]: any }) {
- await startProfiling();
- const cliOverrides = overridesFromOptions(opts);
-
- const config = await loadConfigFromFile(opts.config, cliOverrides, opts.deps === false);
- config.cliArgs = args;
- config.cliGrep = opts.grep as string | undefined;
- config.cliOnlyChanged = opts.onlyChanged === true ? 'HEAD' : opts.onlyChanged;
- config.cliGrepInvert = opts.grepInvert as string | undefined;
- config.cliListOnly = !!opts.list;
- config.cliProjectFilter = opts.project || undefined;
- config.cliPassWithNoTests = !!opts.passWithNoTests;
- config.cliLastFailed = !!opts.lastFailed;
- config.cliTestList = opts.testList ? path.resolve(process.cwd(), opts.testList) : undefined;
- config.cliTestListInvert = opts.testListInvert ? path.resolve(process.cwd(), opts.testListInvert) : undefined;
-
- // Evaluate project filters against config before starting execution. This enables a consistent error message across run modes
- filterProjects(config.projects, config.cliProjectFilter);
-
- if (opts.ui || opts.uiHost || opts.uiPort) {
- if (opts.onlyChanged)
- throw new Error(`--only-changed is not supported in UI mode. If you'd like that to change, see https://github.com/microsoft/playwright/issues/15075 for more details.`);
-
- const status = await testServer.runUIMode(opts.config, cliOverrides, {
- host: opts.uiHost,
- port: opts.uiPort ? +opts.uiPort : undefined,
- args,
- grep: opts.grep as string | undefined,
- grepInvert: opts.grepInvert as string | undefined,
- project: opts.project || undefined,
- reporter: Array.isArray(opts.reporter) ? opts.reporter : opts.reporter ? [opts.reporter] : undefined,
- });
- await stopProfiling('runner');
- const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
- gracefullyProcessExitDoNotHang(exitCode);
- return;
- }
-
- if (process.env.PWTEST_WATCH) {
- if (opts.onlyChanged)
- throw new Error(`--only-changed is not supported in watch mode. If you'd like that to change, file an issue and let us know about your usecase for it.`);
-
- const status = await runWatchModeLoop(
- resolveConfigLocation(opts.config),
- {
- projects: opts.project,
- files: args,
- grep: opts.grep
- }
- );
- await stopProfiling('runner');
- const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
- gracefullyProcessExitDoNotHang(exitCode);
- return;
- }
-
- const status = await runAllTestsWithConfig(config);
- await stopProfiling('runner');
- const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
- gracefullyProcessExitDoNotHang(exitCode);
-}
-
-async function runTestServer(opts: { [key: string]: any }) {
- const host = opts.host;
- const port = opts.port ? +opts.port : undefined;
- const status = await testServer.runTestServer(opts.config, { }, { host, port });
- const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
- gracefullyProcessExitDoNotHang(exitCode);
-}
-
-async function mergeReports(reportDir: string | undefined, opts: { [key: string]: any }) {
- const configFile = opts.config;
- const config = configFile ? await loadConfigFromFile(configFile) : await loadEmptyConfigForMergeReports();
-
- const dir = path.resolve(process.cwd(), reportDir || '');
- const dirStat = await fs.promises.stat(dir).catch(e => null);
- if (!dirStat)
- throw new Error('Directory does not exist: ' + dir);
- if (!dirStat.isDirectory())
- throw new Error(`"${dir}" is not a directory`);
- let reporterDescriptions: ReporterDescription[] | undefined = resolveReporterOption(opts.reporter);
- if (!reporterDescriptions && configFile)
- reporterDescriptions = config.config.reporter;
- if (!reporterDescriptions)
- reporterDescriptions = [[defaultReporter]];
- const rootDirOverride = configFile ? config.config.rootDir : undefined;
- await createMergedReport(config, dir, reporterDescriptions!, rootDirOverride);
- gracefullyProcessExitDoNotHang(0);
-}
-
-function overridesFromOptions(options: { [key: string]: any }): ConfigCLIOverrides {
- if (options.ui) {
- options.debug = undefined;
- options.trace = undefined;
- }
-
- const overrides: ConfigCLIOverrides = {
- debug: options.debug,
- failOnFlakyTests: options.failOnFlakyTests ? true : undefined,
- forbidOnly: options.forbidOnly ? true : undefined,
- fullyParallel: options.fullyParallel ? true : undefined,
- globalTimeout: options.globalTimeout ? parseInt(options.globalTimeout, 10) : undefined,
- maxFailures: options.x ? 1 : (options.maxFailures ? parseInt(options.maxFailures, 10) : undefined),
- outputDir: options.output ? path.resolve(process.cwd(), options.output) : undefined,
- pause: !!process.env.PWPAUSE,
- quiet: options.quiet ? options.quiet : undefined,
- repeatEach: options.repeatEach ? parseInt(options.repeatEach, 10) : undefined,
- retries: options.retries ? parseInt(options.retries, 10) : undefined,
- reporter: resolveReporterOption(options.reporter),
- shard: resolveShardOption(options.shard),
- shardWeights: resolveShardWeightsOption(),
- timeout: options.timeout ? parseInt(options.timeout, 10) : undefined,
- tsconfig: options.tsconfig ? path.resolve(process.cwd(), options.tsconfig) : undefined,
- ignoreSnapshots: options.ignoreSnapshots ? !!options.ignoreSnapshots : undefined,
- updateSnapshots: options.updateSnapshots,
- updateSourceMethod: options.updateSourceMethod,
- use: {
- trace: options.trace,
- },
- workers: options.workers,
- };
-
- if (options.browser) {
- const browserOpt = options.browser.toLowerCase();
- if (!['all', 'chromium', 'firefox', 'webkit'].includes(browserOpt))
- throw new Error(`Unsupported browser "${options.browser}", must be one of "all", "chromium", "firefox" or "webkit"`);
- const browserNames = browserOpt === 'all' ? ['chromium', 'firefox', 'webkit'] : [browserOpt];
- overrides.projects = browserNames.map(browserName => {
- return {
- name: browserName,
- use: { browserName },
- };
- });
- }
-
- if (options.headed)
- overrides.use.headless = false;
- if (options.debug === 'inspector') {
- overrides.use.headless = false;
- process.env.PWDEBUG = '1';
- }
- if (overrides.tsconfig && !fs.existsSync(overrides.tsconfig))
- throw new Error(`--tsconfig "${options.tsconfig}" does not exist`);
-
- return overrides;
-}
-
-function resolveReporterOption(reporter?: string): ReporterDescription[] | undefined {
- if (!reporter || !reporter.length)
- return undefined;
- return reporter.split(',').map((r: string) => [resolveReporter(r)]);
-}
-
-function resolveShardOption(shard?: string): ConfigCLIOverrides['shard'] {
- if (!shard)
- return undefined;
-
- const shardPair = shard.split('/');
-
- if (shardPair.length !== 2) {
- throw new Error(
- `--shard "${shard}", expected format is "current/all", 1-based, for example "3/5".`,
- );
- }
-
- const current = parseInt(shardPair[0], 10);
- const total = parseInt(shardPair[1], 10);
-
- if (isNaN(total) || total < 1)
- throw new Error(`--shard "${shard}" total must be a positive number`);
-
-
- if (isNaN(current) || current < 1 || current > total) {
- throw new Error(
- `--shard "${shard}" current must be a positive number, not greater than shard total`,
- );
- }
-
- return { current, total };
-}
-
-function resolveShardWeightsOption(): ConfigCLIOverrides['shardWeights'] {
- const shardWeights = process.env.PWTEST_SHARD_WEIGHTS;
- if (!shardWeights)
- return undefined;
-
- return shardWeights.split(':').map(w => {
- const weight = parseInt(w, 10);
- if (isNaN(weight) || weight < 0)
- throw new Error(`PWTEST_SHARD_WEIGHTS="${shardWeights}" weights must be non-negative numbers`);
- return weight;
- });
-}
-
-function resolveReporter(id: string) {
- if (builtInReporters.includes(id as any))
- return id;
- const localPath = path.resolve(process.cwd(), id);
- if (fs.existsSync(localPath))
- return localPath;
- return require.resolve(id, { paths: [process.cwd()] });
-}
-
const kTraceModes: TraceMode[] = ['on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure', 'retain-on-first-failure', 'retain-on-failure-and-retries'];
// Note: update docs/src/test-cli-js.md when you update this, program is the source of truth.
diff --git a/packages/playwright/src/reportActions.ts b/packages/playwright/src/reportActions.ts
new file mode 100644
index 0000000000..f6479dca10
--- /dev/null
+++ b/packages/playwright/src/reportActions.ts
@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import fs from 'fs';
+import path from 'path';
+
+import { gracefullyProcessExitDoNotHang } from 'playwright-core/lib/utils';
+
+import { builtInReporters, defaultReporter } from './common/config';
+import { loadConfigFromFile, loadEmptyConfigForMergeReports } from './common/configLoader';
+import { showHTMLReport } from './reporters/html';
+import { createMergedReport } from './reporters/merge';
+
+import type { ReporterDescription } from '../types/test';
+
+export async function showReport(report: string | undefined, host: string, port: number) {
+ await showHTMLReport(report, host, port);
+}
+
+export async function mergeReports(reportDir: string | undefined, opts: { [key: string]: any }) {
+ const configFile = opts.config;
+ const config = configFile ? await loadConfigFromFile(configFile) : await loadEmptyConfigForMergeReports();
+
+ const dir = path.resolve(process.cwd(), reportDir || '');
+ const dirStat = await fs.promises.stat(dir).catch(e => null);
+ if (!dirStat)
+ throw new Error('Directory does not exist: ' + dir);
+ if (!dirStat.isDirectory())
+ throw new Error(`"${dir}" is not a directory`);
+ let reporterDescriptions: ReporterDescription[] | undefined = resolveReporterOption(opts.reporter);
+ if (!reporterDescriptions && configFile)
+ reporterDescriptions = config.config.reporter;
+ if (!reporterDescriptions)
+ reporterDescriptions = [[defaultReporter]];
+ const rootDirOverride = configFile ? config.config.rootDir : undefined;
+ await createMergedReport(config, dir, reporterDescriptions!, rootDirOverride);
+ gracefullyProcessExitDoNotHang(0);
+}
+
+function resolveReporterOption(reporter?: string): ReporterDescription[] | undefined {
+ if (!reporter || !reporter.length)
+ return undefined;
+ return reporter.split(',').map((r: string) => [resolveReporter(r)]);
+}
+
+function resolveReporter(id: string) {
+ if (builtInReporters.includes(id as any))
+ return id;
+ const localPath = path.resolve(process.cwd(), id);
+ if (fs.existsSync(localPath))
+ return localPath;
+ return require.resolve(id, { paths: [process.cwd()] });
+}
diff --git a/packages/playwright/src/testActions.ts b/packages/playwright/src/testActions.ts
new file mode 100644
index 0000000000..bc5f1171ee
--- /dev/null
+++ b/packages/playwright/src/testActions.ts
@@ -0,0 +1,227 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import fs from 'fs';
+import path from 'path';
+
+import { gracefullyProcessExitDoNotHang, startProfiling, stopProfiling } from 'playwright-core/lib/utils';
+
+import { builtInReporters } from './common/config';
+import { loadConfigFromFile, resolveConfigLocation } from './common/configLoader';
+import { terminalScreen } from './reporters/base';
+import { filterProjects } from './runner/projectUtils';
+import * as testServer from './runner/testServer';
+import { runWatchModeLoop } from './runner/watchMode';
+import { runAllTestsWithConfig, TestRunner } from './runner/testRunner';
+import { createErrorCollectingReporter } from './runner/reporters';
+
+import type { ConfigCLIOverrides } from './common/ipc';
+import type { ReporterDescription } from '../types/test';
+
+export async function runTests(args: string[], opts: { [key: string]: any }) {
+ await startProfiling();
+ const cliOverrides = overridesFromOptions(opts);
+
+ const config = await loadConfigFromFile(opts.config, cliOverrides, opts.deps === false);
+ config.cliArgs = args;
+ config.cliGrep = opts.grep as string | undefined;
+ config.cliOnlyChanged = opts.onlyChanged === true ? 'HEAD' : opts.onlyChanged;
+ config.cliGrepInvert = opts.grepInvert as string | undefined;
+ config.cliListOnly = !!opts.list;
+ config.cliProjectFilter = opts.project || undefined;
+ config.cliPassWithNoTests = !!opts.passWithNoTests;
+ config.cliLastFailed = !!opts.lastFailed;
+ config.cliTestList = opts.testList ? path.resolve(process.cwd(), opts.testList) : undefined;
+ config.cliTestListInvert = opts.testListInvert ? path.resolve(process.cwd(), opts.testListInvert) : undefined;
+
+ // Evaluate project filters against config before starting execution. This enables a consistent error message across run modes
+ filterProjects(config.projects, config.cliProjectFilter);
+
+ if (opts.ui || opts.uiHost || opts.uiPort) {
+ if (opts.onlyChanged)
+ throw new Error(`--only-changed is not supported in UI mode. If you'd like that to change, see https://github.com/microsoft/playwright/issues/15075 for more details.`);
+
+ const status = await testServer.runUIMode(opts.config, cliOverrides, {
+ host: opts.uiHost,
+ port: opts.uiPort ? +opts.uiPort : undefined,
+ args,
+ grep: opts.grep as string | undefined,
+ grepInvert: opts.grepInvert as string | undefined,
+ project: opts.project || undefined,
+ reporter: Array.isArray(opts.reporter) ? opts.reporter : opts.reporter ? [opts.reporter] : undefined,
+ });
+ await stopProfiling('runner');
+ const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
+ gracefullyProcessExitDoNotHang(exitCode);
+ return;
+ }
+
+ if (process.env.PWTEST_WATCH) {
+ if (opts.onlyChanged)
+ throw new Error(`--only-changed is not supported in watch mode. If you'd like that to change, file an issue and let us know about your usecase for it.`);
+
+ const status = await runWatchModeLoop(
+ resolveConfigLocation(opts.config),
+ {
+ projects: opts.project,
+ files: args,
+ grep: opts.grep
+ }
+ );
+ await stopProfiling('runner');
+ const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
+ gracefullyProcessExitDoNotHang(exitCode);
+ return;
+ }
+
+ const status = await runAllTestsWithConfig(config);
+ await stopProfiling('runner');
+ const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
+ gracefullyProcessExitDoNotHang(exitCode);
+}
+
+export async function runTestServerAction(opts: { [key: string]: any }) {
+ const host = opts.host;
+ const port = opts.port ? +opts.port : undefined;
+ const status = await testServer.runTestServer(opts.config, { }, { host, port });
+ const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
+ gracefullyProcessExitDoNotHang(exitCode);
+}
+
+export async function clearCache(opts: { [key: string]: any }) {
+ const runner = new TestRunner(resolveConfigLocation(opts.config), {});
+ const { status } = await runner.clearCache(createErrorCollectingReporter(terminalScreen));
+ const exitCode = status === 'interrupted' ? 130 : (status === 'passed' ? 0 : 1);
+ gracefullyProcessExitDoNotHang(exitCode);
+}
+
+export async function startDevServer(options: { [key: string]: any }) {
+ const runner = new TestRunner(resolveConfigLocation(options.config), {});
+ await runner.startDevServer(createErrorCollectingReporter(terminalScreen), 'in-process');
+}
+
+function overridesFromOptions(options: { [key: string]: any }): ConfigCLIOverrides {
+ if (options.ui) {
+ options.debug = undefined;
+ options.trace = undefined;
+ }
+
+ const overrides: ConfigCLIOverrides = {
+ debug: options.debug,
+ failOnFlakyTests: options.failOnFlakyTests ? true : undefined,
+ forbidOnly: options.forbidOnly ? true : undefined,
+ fullyParallel: options.fullyParallel ? true : undefined,
+ globalTimeout: options.globalTimeout ? parseInt(options.globalTimeout, 10) : undefined,
+ maxFailures: options.x ? 1 : (options.maxFailures ? parseInt(options.maxFailures, 10) : undefined),
+ outputDir: options.output ? path.resolve(process.cwd(), options.output) : undefined,
+ pause: !!process.env.PWPAUSE,
+ quiet: options.quiet ? options.quiet : undefined,
+ repeatEach: options.repeatEach ? parseInt(options.repeatEach, 10) : undefined,
+ retries: options.retries ? parseInt(options.retries, 10) : undefined,
+ reporter: resolveReporterOption(options.reporter),
+ shard: resolveShardOption(options.shard),
+ shardWeights: resolveShardWeightsOption(),
+ timeout: options.timeout ? parseInt(options.timeout, 10) : undefined,
+ tsconfig: options.tsconfig ? path.resolve(process.cwd(), options.tsconfig) : undefined,
+ ignoreSnapshots: options.ignoreSnapshots ? !!options.ignoreSnapshots : undefined,
+ updateSnapshots: options.updateSnapshots,
+ updateSourceMethod: options.updateSourceMethod,
+ use: {
+ trace: options.trace,
+ },
+ workers: options.workers,
+ };
+
+ if (options.browser) {
+ const browserOpt = options.browser.toLowerCase();
+ if (!['all', 'chromium', 'firefox', 'webkit'].includes(browserOpt))
+ throw new Error(`Unsupported browser "${options.browser}", must be one of "all", "chromium", "firefox" or "webkit"`);
+ const browserNames = browserOpt === 'all' ? ['chromium', 'firefox', 'webkit'] : [browserOpt];
+ overrides.projects = browserNames.map(browserName => {
+ return {
+ name: browserName,
+ use: { browserName },
+ };
+ });
+ }
+
+ if (options.headed)
+ overrides.use.headless = false;
+ if (options.debug === 'inspector') {
+ overrides.use.headless = false;
+ process.env.PWDEBUG = '1';
+ }
+ if (overrides.tsconfig && !fs.existsSync(overrides.tsconfig))
+ throw new Error(`--tsconfig "${options.tsconfig}" does not exist`);
+
+ return overrides;
+}
+
+function resolveReporterOption(reporter?: string): ReporterDescription[] | undefined {
+ if (!reporter || !reporter.length)
+ return undefined;
+ return reporter.split(',').map((r: string) => [resolveReporter(r)]);
+}
+
+function resolveShardOption(shard?: string): ConfigCLIOverrides['shard'] {
+ if (!shard)
+ return undefined;
+
+ const shardPair = shard.split('/');
+
+ if (shardPair.length !== 2) {
+ throw new Error(
+ `--shard "${shard}", expected format is "current/all", 1-based, for example "3/5".`,
+ );
+ }
+
+ const current = parseInt(shardPair[0], 10);
+ const total = parseInt(shardPair[1], 10);
+
+ if (isNaN(total) || total < 1)
+ throw new Error(`--shard "${shard}" total must be a positive number`);
+
+
+ if (isNaN(current) || current < 1 || current > total) {
+ throw new Error(
+ `--shard "${shard}" current must be a positive number, not greater than shard total`,
+ );
+ }
+
+ return { current, total };
+}
+
+function resolveShardWeightsOption(): ConfigCLIOverrides['shardWeights'] {
+ const shardWeights = process.env.PWTEST_SHARD_WEIGHTS;
+ if (!shardWeights)
+ return undefined;
+
+ return shardWeights.split(':').map(w => {
+ const weight = parseInt(w, 10);
+ if (isNaN(weight) || weight < 0)
+ throw new Error(`PWTEST_SHARD_WEIGHTS="${shardWeights}" weights must be non-negative numbers`);
+ return weight;
+ });
+}
+
+function resolveReporter(id: string) {
+ if (builtInReporters.includes(id as any))
+ return id;
+ const localPath = path.resolve(process.cwd(), id);
+ if (fs.existsSync(localPath))
+ return localPath;
+ return require.resolve(id, { paths: [process.cwd()] });
+}
diff --git a/utils/build/build.js b/utils/build/build.js
index 8c848e42fa..147c8eca04 100644
--- a/utils/build/build.js
+++ b/utils/build/build.js
@@ -432,6 +432,27 @@ class CustomCallbackStep extends Step {
}
}
+// Plugin to convert dynamic import() of relative paths to require().
+// esbuild preserves dynamic import() even in CJS format, but we want
+// all local imports to use require() for consistency.
+const dynamicImportToRequirePlugin = {
+ name: 'dynamic-import-to-require',
+ setup(build) {
+ build.onLoad({ filter: /\.ts$/ }, async (args) => {
+ const contents = await fs.promises.readFile(args.path, 'utf8');
+ if (!contents.includes('await import('))
+ return undefined;
+ return {
+ contents: contents.replace(
+ /\bawait import\((['"]\..*?['"])\)/g,
+ (_, specifier) => `require(${specifier})`
+ ),
+ loader: 'ts',
+ };
+ });
+ }
+};
+
// Run esbuild.
for (const pkg of workspace.packages()) {
if (!fs.existsSync(path.join(pkg.path, 'src')))
@@ -446,6 +467,7 @@ for (const pkg of workspace.packages()) {
sourcemap: withSourceMaps ? 'linked' : false,
platform: 'node',
format: 'cjs',
+ plugins: [dynamicImportToRequirePlugin],
}));
}