Skip to content

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

chore: split daemon and client folders (#39245)

Pavel Feldman951911cefedb
diff --git a/package.json b/package.json
index 812df6211f..1b692e728d 100644
--- a/package.json
+++ b/package.json
@@ -44,7 +44,7 @@
"check-deps": "node utils/check_deps.js",
"build-android-driver": "./utils/build_android_driver.sh",
"innerloop": "playwright run-server --reuse-browser",
- "playwright-cli": "node packages/playwright/lib/mcp/terminal/cli.js",
+ "playwright-cli": "node packages/playwright/lib/cli/client/program.js",
"test-playwright-cli": "playwright test --config=tests/mcp/playwright.config.ts --project=chrome cli-",
"playwright-cli-readme": "node utils/generate_cli_help.js --readme"
},
diff --git a/packages/devtools/src/grid.tsx b/packages/devtools/src/grid.tsx
index 47eab140fe..e474aa87a1 100644
--- a/packages/devtools/src/grid.tsx
+++ b/packages/devtools/src/grid.tsx
@@ -19,7 +19,7 @@ import './grid.css';
import { navigate } from './index';
import { Screencast } from './screencast';
-import type { SessionConfig } from '../../playwright/src/mcp/terminal/registry';
+import type { SessionConfig } from '../../playwright/src/cli/client/registry';
import type { SessionModel, SessionStatus } from './sessionModel';
export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {
diff --git a/packages/devtools/src/sessionModel.ts b/packages/devtools/src/sessionModel.ts
index 597fd0dc8a..15b132d255 100644
--- a/packages/devtools/src/sessionModel.ts
+++ b/packages/devtools/src/sessionModel.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { ClientInfo, SessionConfig } from '../../playwright/src/mcp/terminal/registry';
+import type { ClientInfo, SessionConfig } from '../../playwright/src/cli/client/registry';
export type SessionStatus = {
config: SessionConfig;
diff --git a/packages/playwright/src/mcp/terminal/DEPS.list b/packages/playwright/src/cli/client/DEPS.list
similarity index 56%
rename from packages/playwright/src/mcp/terminal/DEPS.list
rename to packages/playwright/src/cli/client/DEPS.list
index 6827d182e4..0f79a6e8a2 100644
--- a/packages/playwright/src/mcp/terminal/DEPS.list
+++ b/packages/playwright/src/cli/client/DEPS.list
@@ -1,12 +1,3 @@
-[daemon.ts]
-../browser/browserServerBackend.ts
-../browser/tools
-../cli/socketConnection.ts
-
-[cli.ts]
-"strict"
-./program.ts
-
[program.ts]
"strict"
./session.ts
diff --git a/packages/playwright/src/mcp/terminal/appIcon.png b/packages/playwright/src/cli/client/appIcon.png
similarity index 100%
rename from packages/playwright/src/mcp/terminal/appIcon.png
rename to packages/playwright/src/cli/client/appIcon.png
diff --git a/packages/playwright/src/mcp/terminal/devtoolsApp.ts b/packages/playwright/src/cli/client/devtoolsApp.ts
similarity index 100%
rename from packages/playwright/src/mcp/terminal/devtoolsApp.ts
rename to packages/playwright/src/cli/client/devtoolsApp.ts
diff --git a/packages/playwright/src/mcp/terminal/program.ts b/packages/playwright/src/cli/client/program.ts
similarity index 96%
rename from packages/playwright/src/mcp/terminal/program.ts
rename to packages/playwright/src/cli/client/program.ts
index 405e2f33ee..0478304641 100644
--- a/packages/playwright/src/mcp/terminal/program.ts
+++ b/packages/playwright/src/cli/client/program.ts
@@ -25,7 +25,7 @@ import path from 'path';
import { createClientInfo, Registry } from './registry';
import { Session, renderResolvedConfig } from './session';
-import type { Config } from '../config';
+import type { Config } from '../../mcp/config';
import type { SessionConfig, ClientInfo } from './registry';
type MinimistArgs = {
@@ -74,7 +74,7 @@ const booleanOptions: (keyof (GlobalOptions & OpenOptions & { all?: boolean }))[
'version',
];
-export async function program() {
+async function program() {
const clientInfo = createClientInfo();
const help = require('./help.json');
@@ -327,7 +327,7 @@ async function killAllDaemons(): Promise<void> {
const result = execSync(
`powershell -NoProfile -NonInteractive -Command `
+ `"Get-CimInstance Win32_Process `
- + `| Where-Object { $_.CommandLine -like '*run-mcp-server*' -and $_.CommandLine -like '*--daemon-session*' } `
+ + `| Where-Object { $_.CommandLine -like '*-server*' -and $_.CommandLine -like '*--daemon-session*' } `
+ `| ForEach-Object { Stop-Process -Id $_.ProcessId -Force -ErrorAction SilentlyContinue; $_.ProcessId }"`,
{ encoding: 'utf-8' }
);
@@ -341,7 +341,7 @@ async function killAllDaemons(): Promise<void> {
const result = execSync('ps aux', { encoding: 'utf-8' });
const lines = result.split('\n');
for (const line of lines) {
- if (line.includes('run-mcp-server') && line.includes('--daemon-session')) {
+ if ((line.includes('-server')) && line.includes('--daemon-session')) {
const parts = line.trim().split(/\s+/);
const pid = parts[1];
if (pid && /^\d+$/.test(pid)) {
@@ -424,3 +424,10 @@ async function renderSessionStatus(session: Session) {
text.push(...renderResolvedConfig(config.resolvedConfig));
return text.join('\n');
}
+
+program().catch(e => {
+ /* eslint-disable no-console */
+ console.error(e.message);
+ /* eslint-disable no-restricted-properties */
+ process.exit(1);
+});
diff --git a/packages/playwright/src/mcp/terminal/registry.ts b/packages/playwright/src/cli/client/registry.ts
similarity index 98%
rename from packages/playwright/src/mcp/terminal/registry.ts
rename to packages/playwright/src/cli/client/registry.ts
index e03eae6474..15c69ad517 100644
--- a/packages/playwright/src/mcp/terminal/registry.ts
+++ b/packages/playwright/src/cli/client/registry.ts
@@ -19,7 +19,7 @@ import fs from 'fs';
import os from 'os';
import path from 'path';
-import type { FullConfig } from '../browser/config';
+import type { FullConfig } from '../../mcp/browser/config';
export type ClientInfo = {
version: string;
diff --git a/packages/playwright/src/mcp/terminal/session.ts b/packages/playwright/src/cli/client/session.ts
similarity index 97%
rename from packages/playwright/src/mcp/terminal/session.ts
rename to packages/playwright/src/cli/client/session.ts
index 60daf0ebed..c336eaba1e 100644
--- a/packages/playwright/src/mcp/terminal/session.ts
+++ b/packages/playwright/src/cli/client/session.ts
@@ -23,9 +23,9 @@ import fs from 'fs';
import net from 'net';
import os from 'os';
import path from 'path';
-import { SocketConnection } from './socketConnection';
+import { compareSemver, SocketConnection } from './socketConnection';
-import type { FullConfig } from '../browser/config';
+import type { FullConfig } from '../../mcp/browser/config';
import type { SessionConfig, ClientInfo } from './registry';
type MinimistArgs = {
@@ -48,7 +48,7 @@ export class Session {
}
isCompatible(): boolean {
- return this._clientInfo.version === this.config.version;
+ return compareSemver(this._clientInfo.version, this.config.version) >= 0;
}
checkCompatible() {
@@ -212,7 +212,7 @@ to restart the browser session.`);
const args = [
cliPath,
- 'run-mcp-server',
+ 'run-cli-server',
`--daemon-session=${sessionConfigFile}`,
];
diff --git a/packages/playwright/src/mcp/terminal/socketConnection.ts b/packages/playwright/src/cli/client/socketConnection.ts
similarity index 97%
rename from packages/playwright/src/mcp/terminal/socketConnection.ts
rename to packages/playwright/src/cli/client/socketConnection.ts
index 9ea6dc5761..7ebaa01519 100644
--- a/packages/playwright/src/mcp/terminal/socketConnection.ts
+++ b/packages/playwright/src/cli/client/socketConnection.ts
@@ -89,8 +89,8 @@ export class SocketConnection {
}
export function compareSemver(a: string, b: string): number {
- a = a.replace(/-[\w]+$/, '');
- b = b.replace(/-[\w]+$/, '');
+ a = a.replace(/-.*$/, '');
+ b = b.replace(/-.*$/, '');
const aParts = a.split('.').map(Number);
const bParts = b.split('.').map(Number);
for (let i = 0; i < 3; i++) {
diff --git a/packages/playwright/src/cli/daemon/DEPS.list b/packages/playwright/src/cli/daemon/DEPS.list
new file mode 100644
index 0000000000..0d46ee2f4f
--- /dev/null
+++ b/packages/playwright/src/cli/daemon/DEPS.list
@@ -0,0 +1,4 @@
+[*]
+../../mcp/browser/**
+../../mcp/extension/**
+../client/socketConnection.ts
diff --git a/packages/playwright/src/mcp/terminal/command.ts b/packages/playwright/src/cli/daemon/command.ts
similarity index 100%
rename from packages/playwright/src/mcp/terminal/command.ts
rename to packages/playwright/src/cli/daemon/command.ts
diff --git a/packages/playwright/src/mcp/terminal/commands.ts b/packages/playwright/src/cli/daemon/commands.ts
similarity index 100%
rename from packages/playwright/src/mcp/terminal/commands.ts
rename to packages/playwright/src/cli/daemon/commands.ts
diff --git a/packages/playwright/src/mcp/terminal/daemon.ts b/packages/playwright/src/cli/daemon/daemon.ts
similarity index 93%
rename from packages/playwright/src/mcp/terminal/daemon.ts
rename to packages/playwright/src/cli/daemon/daemon.ts
index 321e9f790b..25945300b4 100644
--- a/packages/playwright/src/mcp/terminal/daemon.ts
+++ b/packages/playwright/src/cli/daemon/daemon.ts
@@ -23,14 +23,14 @@ import url from 'url';
import { debug } from 'playwright-core/lib/utilsBundle';
import { gracefullyProcessExitDoNotHang } from 'playwright-core/lib/utils';
-import { BrowserServerBackend } from '../browser/browserServerBackend';
-import { SocketConnection } from './socketConnection';
+import { BrowserServerBackend } from '../../mcp/browser/browserServerBackend';
+import { SocketConnection } from '../client/socketConnection';
import { commands } from './commands';
import { parseCommand } from './command';
-import type * as mcp from '../sdk/exports';
-import type { BrowserContextFactory } from '../browser/browserContextFactory';
-import type { FullConfig } from '../browser/config';
+import type * as mcp from '../../mcp/sdk/exports';
+import type { BrowserContextFactory } from '../../mcp/browser/browserContextFactory';
+import type { FullConfig } from '../../mcp/browser/config';
const daemonDebug = debug('pw:daemon');
diff --git a/packages/playwright/src/mcp/terminal/helpGenerator.ts b/packages/playwright/src/cli/daemon/helpGenerator.ts
similarity index 98%
rename from packages/playwright/src/mcp/terminal/helpGenerator.ts
rename to packages/playwright/src/cli/daemon/helpGenerator.ts
index 800ee61155..d5e03406d9 100644
--- a/packages/playwright/src/mcp/terminal/helpGenerator.ts
+++ b/packages/playwright/src/cli/daemon/helpGenerator.ts
@@ -16,10 +16,10 @@
import { z } from 'playwright-core/lib/mcpBundle';
-import { commands } from './commands';
+import { commands } from '../daemon/commands';
import type zodType from 'zod';
-import type { AnyCommandSchema, Category } from './command';
+import type { AnyCommandSchema, Category } from '../daemon/command';
type CommandArg = { name: string, description: string, optional: boolean };
diff --git a/packages/playwright/src/cli/daemon/program.ts b/packages/playwright/src/cli/daemon/program.ts
new file mode 100644
index 0000000000..c25ef796a2
--- /dev/null
+++ b/packages/playwright/src/cli/daemon/program.ts
@@ -0,0 +1,107 @@
+/**
+ * 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 { startMcpDaemonServer } from './daemon';
+import { setupExitWatchdog } from '../../mcp/browser/watchdog';
+import { contextFactory } from '../../mcp/browser/browserContextFactory';
+import { ExtensionContextFactory } from '../../mcp/extension/extensionContextFactory';
+import { configFromCLIOptions, configFromEnv, defaultConfig, loadConfig, mergeConfig, validateConfig } from '../../mcp/browser/config';
+
+import type { Command } from 'playwright-core/lib/utilsBundle';
+import type { SessionConfig } from '../client/registry';
+import type { FullConfig } from '../../mcp/browser/config';
+
+export function decorateCLICommand(command: Command, version: string) {
+ command
+ .version(version)
+ .option('--daemon-session <path>', 'path to the daemon config.')
+ .action(async options => {
+ // normalize the --no-chromium-sandbox option: chromiumSandbox = true => nothing was passed, chromiumSandbox = false => --no-chromium-sandbox was passed.
+ options.chromiumSandbox = options.chromiumSandbox === true ? undefined : false;
+ setupExitWatchdog();
+
+ const config = await resolveCLIConfig(options.daemonSession);
+ const browserContextFactory = contextFactory(config);
+ const extensionContextFactory = new ExtensionContextFactory(config.browser.launchOptions.channel || 'chrome', config.browser.userDataDir, config.browser.launchOptions.executablePath);
+
+ const cf = config.extension ? extensionContextFactory : browserContextFactory;
+ try {
+ const socketPath = await startMcpDaemonServer(config, cf);
+ console.log(`### Config`);
+ console.log('```json');
+ console.log(JSON.stringify(config, null, 2));
+ console.log('```');
+ console.log(`### Success\nDaemon listening on ${socketPath}`);
+ console.log('<EOF>');
+ } catch (error) {
+ const message = process.env.PWDEBUGIMPL ? (error as Error).stack || (error as Error).message : (error as Error).message;
+ console.log(`### Error\n${message}`);
+ console.log('<EOF>');
+ }
+ });
+}
+
+export async function resolveCLIConfig(daemonSession: string): Promise<FullConfig> {
+ const sessionConfig = await fs.promises.readFile(daemonSession, 'utf-8').then(data => JSON.parse(data) as SessionConfig);
+ const daemonOverrides = configFromCLIOptions({
+ config: sessionConfig.cli.config,
+ browser: sessionConfig.cli.browser,
+ isolated: sessionConfig.cli.persistent === true ? false : undefined,
+ headless: sessionConfig.cli.headed ? false : undefined,
+ extension: sessionConfig.cli.extension,
+ userDataDir: sessionConfig.cli.profile,
+ outputMode: 'file',
+ snapshotMode: 'full',
+ });
+
+ const envOverrides = configFromEnv();
+ const configFile = envOverrides.configFile ?? daemonOverrides.configFile;
+ const configInFile = await loadConfig(configFile);
+
+ let result = mergeConfig(defaultConfig, {
+ browser: {
+ launchOptions: {
+ headless: true,
+ },
+ isolated: true,
+ }
+ });
+
+ result = mergeConfig(result, configInFile);
+ result = mergeConfig(result, daemonOverrides);
+ result = mergeConfig(result, envOverrides);
+
+ if (!result.extension && !result.browser.userDataDir && sessionConfig.userDataDirPrefix) {
+ // No custom value provided, use the daemon data dir.
+ const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;
+ const userDataDir = `${sessionConfig.userDataDirPrefix}-${browserToken}`;
+ result.browser.userDataDir = userDataDir;
+ }
+
+ result.configFile = configFile;
+ result.sessionConfig = sessionConfig;
+ result.skillMode = true;
+ if (result.sessionConfig && result.browser.launchOptions.headless !== false)
+ result.browser.contextOptions.viewport ??= { width: 1280, height: 720 };
+
+ await validateConfig(result);
+
+ return result;
+}
diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.ts
index 4f4bb5fff7..9b3e189cfd 100644
--- a/packages/playwright/src/mcp/browser/config.ts
+++ b/packages/playwright/src/mcp/browser/config.ts
@@ -18,15 +18,17 @@ import fs from 'fs';
import os from 'os';
import path from 'path';
+import { registry } from 'playwright-core/lib/server';
import { devices } from 'playwright-core';
import { dotenv, debug } from 'playwright-core/lib/utilsBundle';
+
import { fileExistsAsync } from '../../util';
import { firstRootPath } from '../sdk/server';
import type * as playwright from '../../../types/test';
import type { Config, ToolCapability } from '../config';
import type { ClientInfo } from '../sdk/server';
-import type { SessionConfig } from '../terminal/registry';
+import type { SessionConfig } from '../../cli/client/registry';
type ViewportSize = { width: number; height: number };
@@ -45,7 +47,6 @@ export type CLIOptions = {
codegen?: 'typescript' | 'none';
config?: string;
consoleLevel?: 'error' | 'warning' | 'info' | 'debug';
- daemonSession?: string;
device?: string;
extension?: boolean;
executablePath?: string;
@@ -108,15 +109,6 @@ export const defaultConfig: FullConfig = {
},
};
-const defaultDaemonConfig: FullConfig = mergeConfig(defaultConfig, {
- browser: {
- launchOptions: {
- headless: true,
- },
- isolated: true,
- }
-});
-
type BrowserUserConfig = NonNullable<Config['browser']>;
export type FullConfig = Config & {
@@ -151,48 +143,38 @@ export async function resolveConfig(config: Config): Promise<FullConfig> {
export async function resolveCLIConfig(cliOptions: CLIOptions): Promise<FullConfig> {
const envOverrides = configFromEnv();
- const daemonOverrides = await configForDaemonSession(cliOptions);
const cliOverrides = configFromCLIOptions(cliOptions);
- const configFile = cliOverrides.configFile ?? envOverrides.configFile ?? daemonOverrides.configFile;
+ const configFile = cliOverrides.configFile ?? envOverrides.configFile;
const configInFile = await loadConfig(configFile);
- let result = cliOptions.daemonSession ? defaultDaemonConfig : defaultConfig;
+ let result = defaultConfig;
result = mergeConfig(result, configInFile);
- result = mergeConfig(result, daemonOverrides);
result = mergeConfig(result, envOverrides);
result = mergeConfig(result, cliOverrides);
+ result.configFile = configFile;
+ await validateConfig(result);
+ return result;
+}
- if (daemonOverrides.sessionConfig) {
- result.skillMode = true;
-
- if (!result.extension && !result.browser.userDataDir && daemonOverrides.sessionConfig.userDataDirPrefix) {
- // No custom value provided, use the daemon data dir.
- const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;
- const userDataDir = `${daemonOverrides.sessionConfig.userDataDirPrefix}-${browserToken}`;
- result.browser.userDataDir = userDataDir;
- }
- }
-
- if (result.browser.browserName === 'chromium' && result.browser.launchOptions.chromiumSandbox === undefined) {
+export async function validateConfig(config: FullConfig): Promise<void> {
+ if (config.browser.browserName === 'chromium' && config.browser.launchOptions.chromiumSandbox === undefined) {
if (process.platform === 'linux')
- result.browser.launchOptions.chromiumSandbox = result.browser.launchOptions.channel !== 'chromium';
+ config.browser.launchOptions.chromiumSandbox = config.browser.launchOptions.channel !== 'chromium';
else
- result.browser.launchOptions.chromiumSandbox = true;
+ config.browser.launchOptions.chromiumSandbox = true;
}
- result.configFile = configFile;
- result.sessionConfig = daemonOverrides.sessionConfig;
-
- // Daemon has different defaults.
- if (result.sessionConfig && result.browser.launchOptions.headless !== false)
- result.browser.contextOptions.viewport ??= { width: 1280, height: 720 };
-
- await validateConfig(result);
-
- return result;
-}
+ if (config.saveVideo && !checkFfmpeg()) {
+ // eslint-disable-next-line no-console
+ console.error(`\nError: ffmpeg required to save the video is not installed.`);
+ // eslint-disable-next-line no-console
+ console.error(`\nPlease run the command below. It will install a local copy of ffmpeg and will not change any system-wide settings.`);
+ // eslint-disable-next-line no-console
+ console.error(`\n npx playwright install ffmpeg\n`);
+ // eslint-disable-next-line no-restricted-properties
+ process.exit(1);
+ }
-async function validateConfig(config: FullConfig): Promise<void> {
if (config.browser.initScript) {
for (const script of config.browser.initScript) {
if (!await fileExistsAsync(script))
@@ -324,7 +306,7 @@ export function configFromCLIOptions(cliOptions: CLIOptions): Config & { configF
return { ...config, configFile: cliOptions.config };
}
-function configFromEnv(): Config & { configFile?: string } {
+export function configFromEnv(): Config & { configFile?: string } {
const options: CLIOptions = {};
options.allowedHosts = commaSeparatedList(process.env.PLAYWRIGHT_MCP_ALLOWED_HOSTNAMES);
options.allowedOrigins = semicolonSeparatedList(process.env.PLAYWRIGHT_MCP_ALLOWED_ORIGINS);
@@ -373,25 +355,7 @@ function configFromEnv(): Config & { configFile?: string } {
return configFromCLIOptions(options);
}
-async function configForDaemonSession(cliOptions: CLIOptions): Promise<Config & { configFile?: string, sessionConfig?: SessionConfig }> {
- if (!cliOptions.daemonSession)
- return {};
-
- const sessionConfig = await fs.promises.readFile(cliOptions.daemonSession, 'utf-8').then(data => JSON.parse(data) as SessionConfig);
- const config = configFromCLIOptions({
- config: sessionConfig.cli.config,
- browser: sessionConfig.cli.browser,
- isolated: sessionConfig.cli.persistent === true ? false : undefined,
- headless: sessionConfig.cli.headed ? false : undefined,
- extension: sessionConfig.cli.extension,
- userDataDir: sessionConfig.cli.profile,
- outputMode: 'file',
- snapshotMode: 'full',
- });
- return { ...config, sessionConfig };
-}
-
-async function loadConfig(configFile: string | undefined): Promise<Config> {
+export async function loadConfig(configFile: string | undefined): Promise<Config> {
if (!configFile)
return {};
@@ -451,7 +415,7 @@ function pickDefined<T extends object>(obj: T | undefined): Partial<T> {
) as Partial<T>;
}
-function mergeConfig(base: FullConfig, overrides: Config): FullConfig {
+export function mergeConfig(base: FullConfig, overrides: Config): FullConfig {
const browser: FullConfig['browser'] = {
...pickDefined(base.browser),
...pickDefined(overrides.browser),
@@ -569,3 +533,12 @@ function envToBoolean(value: string | undefined): boolean | undefined {
function envToString(value: string | undefined): string | undefined {
return value ? value.trim() : undefined;
}
+
+function checkFfmpeg(): boolean {
+ try {
+ const executable = registry.findExecutable('ffmpeg')!;
+ return fs.existsSync(executable.executablePath()!);
+ } catch (error) {
+ return false;
+ }
+}
diff --git a/packages/playwright/src/mcp/program.ts b/packages/playwright/src/mcp/program.ts
index bb515bee37..fda9347a8d 100644
--- a/packages/playwright/src/mcp/program.ts
+++ b/packages/playwright/src/mcp/program.ts
@@ -14,15 +14,9 @@
* limitations under the License.
*/
-/* eslint-disable no-console */
-
-import fs from 'fs';
-
-import { colors, ProgramOption } from 'playwright-core/lib/utilsBundle';
-import { registry } from 'playwright-core/lib/server';
+import { ProgramOption } from 'playwright-core/lib/utilsBundle';
import * as mcpServer from './sdk/server';
-import { startMcpDaemonServer } from './terminal/daemon';
import { commaSeparatedList, dotenvFileLoader, enumParser, headerParser, numberParser, resolutionParser, resolveCLIConfig, semicolonSeparatedList } from './browser/config';
import { setupExitWatchdog } from './browser/watchdog';
import { contextFactory } from './browser/browserContextFactory';
@@ -31,7 +25,7 @@ import { ExtensionContextFactory } from './extension/extensionContextFactory';
import type { Command } from 'playwright-core/lib/utilsBundle';
-export function decorateCommand(command: Command, version: string) {
+export function decorateMCPCommand(command: Command, version: string) {
command
.option('--allowed-hosts <hosts...>', 'comma-separated list of hosts this server is allowed to serve from. Defaults to the host the server is bound to. Pass \'*\' to disable the host check.', commaSeparatedList)
.option('--allowed-origins <origins>', 'semicolon-separated list of TRUSTED origins to allow the browser to request. Default is to allow all.\nImportant: *does not* serve as a security boundary and *does not* affect redirects. ', semicolonSeparatedList)
@@ -78,7 +72,6 @@ export function decorateCommand(command: Command, version: string) {
.option('--user-data-dir <path>', 'path to the user data directory. If not specified, a temporary directory will be created.')
.option('--viewport-size <size>', 'specify browser viewport size in pixels, for example "1280x720"', resolutionParser.bind(null, '--viewport-size'))
.addOption(new ProgramOption('--vision', 'Legacy option, use --caps=vision instead').hideHelp())
- .addOption(new ProgramOption('--daemon-session <path>', 'path to the daemon config.').hideHelp())
.action(async options => {
// normalize the --no-chromium-sandbox option: chromiumSandbox = true => nothing was passed, chromiumSandbox = false => --no-chromium-sandbox was passed.
@@ -87,6 +80,7 @@ export function decorateCommand(command: Command, version: string) {
setupExitWatchdog();
if (options.vision) {
+ // eslint-disable-next-line no-console
console.error('The --vision option is deprecated, use --caps=vision instead');
options.caps = 'vision';
}
@@ -95,37 +89,9 @@ export function decorateCommand(command: Command, version: string) {
options.caps.push('devtools');
const config = await resolveCLIConfig(options);
-
- // Chromium browsers require ffmpeg to be installed to save video.
- if (config.saveVideo && !checkFfmpeg()) {
- console.error(colors.red(`\nError: ffmpeg required to save the video is not installed.`));
- console.error(`\nPlease run the command below. It will install a local copy of ffmpeg and will not change any system-wide settings.`);
- console.error(`\n npx playwright install ffmpeg\n`);
- // eslint-disable-next-line no-restricted-properties
- process.exit(1);
- }
-
const browserContextFactory = contextFactory(config);
const extensionContextFactory = new ExtensionContextFactory(config.browser.launchOptions.channel || 'chrome', config.browser.userDataDir, config.browser.launchOptions.executablePath);
- if (config.sessionConfig) {
- const contextFactory = config.extension ? extensionContextFactory : browserContextFactory;
- try {
- const socketPath = await startMcpDaemonServer(config, contextFactory);
- console.log(`### Config`);
- console.log('```json');
- console.log(JSON.stringify(config, null, 2));
- console.log('```');
- console.log(`### Success\nDaemon listening on ${socketPath}`);
- console.log('<EOF>');
- } catch (error) {
- const message = process.env.PWDEBUGIMPL ? (error as Error).stack || (error as Error).message : (error as Error).message;
- console.log(`### Error\n${message}`);
- console.log('<EOF>');
- }
- return;
- }
-
if (config.extension) {
const serverBackendFactory: mcpServer.ServerBackendFactory = {
name: 'Playwright w/ extension',
@@ -146,12 +112,3 @@ export function decorateCommand(command: Command, version: string) {
await mcpServer.start(factory, config.server);
});
}
-
-function checkFfmpeg(): boolean {
- try {
- const executable = registry.findExecutable('ffmpeg')!;
- return fs.existsSync(executable.executablePath()!);
- } catch (error) {
- return false;
- }
-}
diff --git a/packages/playwright/src/mcp/sdk/server.ts b/packages/playwright/src/mcp/sdk/server.ts
index 9346c720a8..aa5e5428b9 100644
--- a/packages/playwright/src/mcp/sdk/server.ts
+++ b/packages/playwright/src/mcp/sdk/server.ts
@@ -104,7 +104,7 @@ export function createServer(name: string, version: string, backend: ServerBacke
total: params.total,
message: params.message,
},
- }).catch(serverDebug);
+ }).catch(e => serverDebug('notification', e));
} : () => {};
try {
diff --git a/packages/playwright/src/mcp/terminal/cli.ts b/packages/playwright/src/mcp/terminal/cli.ts
deleted file mode 100644
index 6db3e40ee0..0000000000
--- a/packages/playwright/src/mcp/terminal/cli.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-/**
- * 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 { program } from './program';
-
-program().catch(e => {
- /* eslint-disable no-console */
- console.error(e.message);
- /* eslint-disable no-restricted-properties */
- process.exit(1);
-});
diff --git a/packages/playwright/src/mcp/terminal/icon.ico b/packages/playwright/src/mcp/terminal/icon.ico
deleted file mode 100644
index 30bf01f485..0000000000
Binary files a/packages/playwright/src/mcp/terminal/icon.ico and /dev/null differ
diff --git a/packages/playwright/src/mcp/terminal/icon.png b/packages/playwright/src/mcp/terminal/icon.png
deleted file mode 100644
index 40eab8ca05..0000000000
Binary files a/packages/playwright/src/mcp/terminal/icon.png and /dev/null differ
diff --git a/packages/playwright/src/program.ts b/packages/playwright/src/program.ts
index da4ad0f648..5059c633d5 100644
--- a/packages/playwright/src/program.ts
+++ b/packages/playwright/src/program.ts
@@ -35,8 +35,9 @@ import { runAllTestsWithConfig, TestRunner } from './runner/testRunner';
import { createErrorCollectingReporter } from './runner/reporters';
import * as mcp from './mcp/sdk/exports';
import { TestServerBackend } from './mcp/test/testBackend';
-import { decorateCommand } from './mcp/program';
+import { decorateMCPCommand } from './mcp/program';
import { setupExitWatchdog } from './mcp/browser/watchdog';
+import { decorateCLICommand } from './cli/daemon/program';
import { ClaudeGenerator, OpencodeGenerator, VSCodeGenerator, CopilotGenerator } from './agents/generateAgents';
import type { ConfigCLIOverrides } from './common/ipc';
@@ -150,7 +151,13 @@ Examples:
function addBrowserMCPServerCommand(program: Command) {
const command = program.command('run-mcp-server', { hidden: true });
command.description('Interact with the browser over MCP');
- decorateCommand(command, packageJSON.version);
+ decorateMCPCommand(command, packageJSON.version);
+}
+
+function addBrowserCLIServerCommand(program: Command) {
+ const command = program.command('run-cli-server', { hidden: true });
+ command.description('Interact with the browser over CLI');
+ decorateCLICommand(command, packageJSON.version);
}
function addTestMCPServerCommand(program: Command) {
@@ -445,6 +452,7 @@ addShowReportCommand(program);
addMergeReportsCommand(program);
addClearCacheCommand(program);
addBrowserMCPServerCommand(program);
+addBrowserCLIServerCommand(program);
addTestMCPServerCommand(program);
addDevServerCommand(program);
addTestServerCommand(program);
diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.ts
index eaef8a9774..b90ed6d251 100644
--- a/tests/mcp/cli-fixtures.ts
+++ b/tests/mcp/cli-fixtures.ts
@@ -62,7 +62,7 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: string
return await test.step(stepTitle, async () => {
const testInfo = test.info();
const cli = childProcess({
- command: [process.execPath, require.resolve('../../packages/playwright/lib/mcp/terminal/cli.js'), ...args],
+ command: [process.execPath, require.resolve('../../packages/playwright/lib/cli/client/program.js'), ...args],
cwd: cliOptions.cwd ?? testInfo.outputPath(),
env: {
...process.env,
diff --git a/tests/mcp/cli-session.spec.ts b/tests/mcp/cli-session.spec.ts
index e437530225..4c0e72498c 100644
--- a/tests/mcp/cli-session.spec.ts
+++ b/tests/mcp/cli-session.spec.ts
@@ -208,32 +208,39 @@ test('list --all lists sessions from all workspaces', async ({ cli, server }, te
await cli('-s', 'session2', 'close', { cwd: workspace2 });
});
-test('incompatible version - command fails with version mismatch error', async ({ cli, server }) => {
+test('newer client with older daemon is compatible', async ({ cli, server }) => {
await cli('open', server.HELLO_WORLD);
- const { output, error, exitCode } = await cli('eval', '1+1', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '9.9.9' } });
+ const { exitCode } = await cli('eval', '1+1', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '9.9.9' } });
+ expect(exitCode).toBe(0);
+});
+
+test('older client with newer daemon fails with version mismatch error', async ({ cli, server }) => {
+ await cli('open', server.HELLO_WORLD);
+
+ const { output, error, exitCode } = await cli('eval', '1+1', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '0.0.1' } });
expect(exitCode).not.toBe(0);
const fullOutput = output + error;
- expect(fullOutput).toContain('Client is v9.9.9');
+ expect(fullOutput).toContain('Client is v0.0.1');
expect(fullOutput).toContain('playwright-cli open');
expect(fullOutput).toContain('to restart the browser session');
});
-test('incompatible version - named session includes session name in error', async ({ cli, server }) => {
+test('older client with newer daemon - named session includes session name in error', async ({ cli, server }) => {
await cli('-s', 'mysession', 'open', server.HELLO_WORLD);
- const { output, error, exitCode } = await cli('-s', 'mysession', 'eval', '1+1', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '9.9.9' } });
+ const { output, error, exitCode } = await cli('-s', 'mysession', 'eval', '1+1', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '0.0.1' } });
expect(exitCode).not.toBe(0);
const fullOutput = output + error;
- expect(fullOutput).toContain('Client is v9.9.9');
+ expect(fullOutput).toContain('Client is v0.0.1');
expect(fullOutput).toContain(`session 'mysession'`);
expect(fullOutput).toContain('playwright-cli -s=mysession open');
});
-test('incompatible version - list shows incompatible warning', async ({ cli, server }) => {
+test('older client with newer daemon - list shows incompatible warning', async ({ cli, server }) => {
await cli('open', server.HELLO_WORLD);
- const { output } = await cli('list', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '9.9.9' } });
+ const { output } = await cli('list', { env: { PLAYWRIGHT_CLI_VERSION_FOR_TEST: '0.0.1' } });
expect(output).toContain('### Browsers');
expect(output).toContain('- default:');
expect(output).toContain('[incompatible please re-open]');
diff --git a/utils/build/build.js b/utils/build/build.js
index a58e99096e..543a3eb76f 100644
--- a/utils/build/build.js
+++ b/utils/build/build.js
@@ -654,7 +654,7 @@ copyFiles.push({
});
copyFiles.push({
- files: 'packages/playwright/src/mcp/terminal/*.{png,ico}',
+ files: 'packages/playwright/src/cli/client/*.{png,ico}',
from: 'packages/playwright/src',
to: 'packages/playwright/lib',
});
diff --git a/utils/generate_cli_help.js b/utils/generate_cli_help.js
index 4097f96e54..1bb4869dd0 100644
--- a/utils/generate_cli_help.js
+++ b/utils/generate_cli_help.js
@@ -19,7 +19,7 @@
const fs = require('fs')
const path = require('path')
-const { generateHelp, generateReadme, generateHelpJSON } = require('../packages/playwright/lib/mcp/terminal/helpGenerator.js');
+const { generateHelp, generateReadme, generateHelpJSON } = require('../packages/playwright/lib/cli/daemon/helpGenerator.js');
if (process.argv[2] === '--readme') {
console.log(generateReadme());
@@ -31,6 +31,6 @@ if (process.argv[2] === '--print') {
process.exit(0);
}
-const fileName = path.resolve(__dirname, '../packages/playwright/lib/mcp/terminal/help.json');
+const fileName = path.resolve(__dirname, '../packages/playwright/lib/cli/client/help.json');
console.log('Writing ', path.relative(process.cwd(), fileName));
fs.writeFileSync(fileName, JSON.stringify(generateHelpJSON(), null, 2));