Skip to content

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

chore: move session config to daemon (#39534)

Pavel Feldman6aaaa2c35d42
diff --git a/packages/playwright-core/src/cli/client/program.ts b/packages/playwright-core/src/cli/client/program.ts
index 5b10e82ae6..8ad2dc97b6 100644
--- a/packages/playwright-core/src/cli/client/program.ts
+++ b/packages/playwright-core/src/cli/client/program.ts
@@ -23,25 +23,17 @@ import crypto from 'crypto';
import fs from 'fs';
import os from 'os';
import path from 'path';
-import { createClientInfo, Registry } from './registry';
+import { createClientInfo, Registry, resolveSessionName } from './registry';
import { Session, renderResolvedConfig } from './session';
import type { Config } from '../../mcp/config';
-import type { SessionConfig, ClientInfo, SessionFile } from './registry';
+import type { ClientInfo, SessionFile } from './registry';
type MinimistArgs = {
_: string[];
[key: string]: any;
};
-function resolveSessionName(sessionName?: string): string {
- if (sessionName)
- return sessionName;
- if (process.env.PLAYWRIGHT_CLI_SESSION)
- return process.env.PLAYWRIGHT_CLI_SESSION;
- return 'default';
-}
-
type GlobalOptions = {
help?: boolean;
session?: string;
@@ -157,24 +149,12 @@ export async function program(options?: { embedderVersion?: string}) {
const entry = registry.entry(clientInfo, sessionName);
if (entry)
await new Session(entry).stop(true);
- const config = sessionConfigFromArgs(clientInfo, sessionName, args);
- const sessionFile: SessionFile = {
- daemonDir: clientInfo.daemonProfilesDir,
- file: path.join(clientInfo.daemonProfilesDir, `${sessionName}.session`),
- config,
- };
- const session = new Session(sessionFile);
- // Stale session.
- if (await session.canConnect())
- await session.stop(true);
-
- for (const globalOption of globalOptions)
- delete args[globalOption];
- const result = await session.open(args);
- console.log(result.text);
+
+ await Session.startDaemon(clientInfo, args);
+ const newEntry = await registry.loadEntry(clientInfo, sessionName);
+ await runInSession(newEntry, clientInfo, args);
return;
}
-
case 'close':
const closeEntry = registry.entry(clientInfo, sessionName);
const session = closeEntry ? new Session(closeEntry) : undefined;
@@ -200,23 +180,26 @@ export async function program(options?: { embedderVersion?: string}) {
return;
}
default: {
- const defaultEntry = registry.entry(clientInfo, sessionName);
- if (!defaultEntry) {
+ const entry = registry.entry(clientInfo, sessionName);
+ if (!entry) {
console.log(`The browser '${sessionName}' is not open, please run open first`);
console.log('');
console.log(` playwright-cli${sessionName !== 'default' ? ` -s=${sessionName}` : ''} open [params]`);
process.exit(1);
}
-
- for (const globalOption of globalOptions)
- delete args[globalOption];
- const session = new Session(defaultEntry);
- const result = await session.run(clientInfo, args);
- console.log(result.text);
+ await runInSession(entry, clientInfo, args);
}
}
}
+async function runInSession(entry: SessionFile, clientInfo: ClientInfo, args: MinimistArgs) {
+ for (const globalOption of globalOptions)
+ delete args[globalOption];
+ const session = new Session(entry);
+ const result = await session.run(clientInfo, args);
+ console.log(result.text);
+}
+
async function install(args: MinimistArgs) {
const cwd = process.cwd();
@@ -298,48 +281,10 @@ async function findOrInstallDefaultBrowser() {
return 'chromium';
}
-function daemonSocketPath(clientInfo: ClientInfo, sessionName: string): string {
- const userNameHash = calculateSha1(process.env.USERNAME || 'default').slice(0, 8);
- const socketName = `${sessionName}-${userNameHash}.sock`;
- if (os.platform() === 'win32')
- return `\\\\.\\pipe\\${clientInfo.workspaceDirHash}-${socketName}`;
- const socketsDir = process.env.PLAYWRIGHT_DAEMON_SOCKETS_DIR || path.join(os.tmpdir(), 'playwright-cli');
- return path.join(socketsDir, clientInfo.workspaceDirHash, socketName);
-}
-
function defaultConfigFile(): string {
return path.resolve('.playwright', 'cli.config.json');
}
-export function sessionConfigFromArgs(clientInfo: ClientInfo, sessionName: string, args: MinimistArgs): SessionConfig {
- let config = args.config ? path.resolve(args.config) : undefined;
- try {
- if (!config && fs.existsSync(defaultConfigFile()))
- config = defaultConfigFile();
- } catch {
- }
-
- if (!args.persistent && args.profile)
- args.persistent = true;
-
- return {
- name: sessionName,
- version: clientInfo.version,
- timestamp: Date.now(),
- socketPath: daemonSocketPath(clientInfo, sessionName),
- cli: {
- headed: args.headed,
- extension: args.extension,
- browser: args.browser,
- persistent: args.persistent,
- profile: args.profile,
- config,
- },
- userDataDirPrefix: path.resolve(clientInfo.daemonProfilesDir, `ud-${sessionName}`),
- workspaceDir: clientInfo.workspaceDir,
- };
-}
-
async function killAllDaemons(): Promise<void> {
const platform = os.platform();
let killed = 0;
@@ -349,7 +294,7 @@ async function killAllDaemons(): Promise<void> {
const result = execSync(
`powershell -NoProfile -NonInteractive -Command `
+ `"Get-CimInstance Win32_Process `
- + `| Where-Object { $_.CommandLine -like '*-server*' -and $_.CommandLine -like '*--daemon-session*' } `
+ + `| Where-Object { $_.CommandLine -like '*-server*' -and $_.CommandLine -like '*--daemon-dir*' } `
+ `| ForEach-Object { Stop-Process -Id $_.ProcessId -Force -ErrorAction SilentlyContinue; $_.ProcessId }"`,
{ encoding: 'utf-8' }
);
@@ -363,7 +308,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('-server')) && line.includes('--daemon-session')) {
+ if ((line.includes('-server')) && line.includes('--daemon-dir')) {
const parts = line.trim().split(/\s+/);
const pid = parts[1];
if (pid && /^\d+$/.test(pid)) {
diff --git a/packages/playwright-core/src/cli/client/registry.ts b/packages/playwright-core/src/cli/client/registry.ts
index 48a769fee2..8a9199ccda 100644
--- a/packages/playwright-core/src/cli/client/registry.ts
+++ b/packages/playwright-core/src/cli/client/registry.ts
@@ -34,16 +34,10 @@ export type SessionConfig = {
timestamp: number;
socketPath: string;
cli: {
- headed?: boolean;
- extension?: boolean;
- browser?: string;
persistent?: boolean;
- profile?: string;
- config?: string;
};
- userDataDirPrefix?: string;
workspaceDir?: string;
- resolvedConfig?: FullConfig
+ resolvedConfig?: FullConfig;
};
export type SessionFile = {
@@ -74,6 +68,24 @@ export class Registry {
return this._files;
}
+ async loadEntry(clientInfo: ClientInfo, sessionName: string): Promise<SessionFile> {
+ const entry = await Registry._loadSessionEntry(clientInfo.daemonProfilesDir, sessionName + '.session');
+ if (!entry)
+ throw new Error(`Could not start the session "${sessionName}"`);
+
+ const key = clientInfo.workspaceDir || clientInfo.workspaceDirHash;
+ let list = this._files.get(key);
+ if (!list) {
+ list = [];
+ this._files.set(key, list);
+ }
+ const oldIndex = list.findIndex(e => e.config.name === sessionName);
+ if (oldIndex !== -1)
+ list.splice(oldIndex, 1);
+ list.push(entry);
+ return entry;
+ }
+
private static async _loadSessionEntry(daemonDir: string, file: string): Promise<SessionFile | undefined> {
try {
const fileName = path.join(daemonDir, file);
@@ -169,3 +181,11 @@ function findWorkspaceDir(startDir: string): string | undefined {
const daemonProfilesDir = (workspaceDirHash: string) => {
return path.join(baseDaemonDir, workspaceDirHash);
};
+
+export function resolveSessionName(sessionName?: string): string {
+ if (sessionName)
+ return sessionName;
+ if (process.env.PLAYWRIGHT_CLI_SESSION)
+ return process.env.PLAYWRIGHT_CLI_SESSION;
+ return 'default';
+}
diff --git a/packages/playwright-core/src/cli/client/session.ts b/packages/playwright-core/src/cli/client/session.ts
index 44ca7f42c9..5ca1bb081f 100644
--- a/packages/playwright-core/src/cli/client/session.ts
+++ b/packages/playwright-core/src/cli/client/session.ts
@@ -15,7 +15,6 @@
*/
/* eslint-disable no-console */
-/* eslint-disable no-restricted-properties */
import { spawn } from 'child_process';
@@ -24,6 +23,7 @@ import net from 'net';
import os from 'os';
import path from 'path';
import { compareSemver, SocketConnection } from './socketConnection';
+import { resolveSessionName } from './registry';
import type { FullConfig } from '../../mcp/browser/config';
import type { SessionConfig, ClientInfo, SessionFile } from './registry';
@@ -48,11 +48,6 @@ export class Session {
return compareSemver(clientInfo.version, this.config.version) >= 0;
}
- async open(args: MinimistArgs, cwd?: string): Promise<{ text: string }> {
- const socket = await this._startDaemon();
- return await SocketConnectionClient.sendAndClose(socket, 'run', { args, cwd: cwd || process.cwd() });
- }
-
async run(clientInfo: ClientInfo, args: MinimistArgs, cwd?: string): Promise<{ text: string }> {
if (!this.isCompatible(clientInfo))
throw new Error(`Client is v${clientInfo.version}, session '${this.name}' is v${this.config.version}. Run\n\n playwright-cli${this.name !== 'default' ? ` -s=${this.name}` : ''} open\n\nto restart the browser session.`);
@@ -60,7 +55,7 @@ export class Session {
const { socket } = await this._connect();
if (!socket)
throw new Error(`Browser '${this.name}' is not open. Run\n\n playwright-cli${this.name !== 'default' ? ` -s=${this.name}` : ''} open\n\nto start the browser session.`);
- return await SocketConnectionClient.sendAndClose(socket, 'run', { args, cwd: cwd || process.cwd() });
+ return await SocketConnectionClient.sendAndClose(socket, 'run', { args, cwd: process.cwd() });
}
async stop(quiet: boolean = false): Promise<void> {
@@ -129,19 +124,32 @@ export class Session {
return false;
}
- private async _startDaemon(): Promise<net.Socket> {
- await fs.promises.mkdir(this._sessionFile.daemonDir, { recursive: true });
+ static async startDaemon(clientInfo: ClientInfo, cliArgs: MinimistArgs) {
+ await fs.promises.mkdir(clientInfo.daemonProfilesDir, { recursive: true });
+
const cliPath = path.join(__dirname, '../../../cli.js');
- await fs.promises.writeFile(this._sessionFile.file, JSON.stringify(this.config, null, 2));
- const errLog = this._sessionFile.file.replace(/\.session$/, '.err');
+ const sessionName = resolveSessionName(cliArgs.session);
+ const errLog = path.join(clientInfo.daemonProfilesDir, sessionName + '.err');
const err = fs.openSync(errLog, 'w');
const args = [
cliPath,
'run-cli-server',
- `--daemon-session=${this._sessionFile.file}`,
+ sessionName,
];
+ if (cliArgs.headed)
+ args.push('--headed');
+ if (cliArgs.extension)
+ args.push('--extension');
+ if (cliArgs.browser)
+ args.push(`--browser=${cliArgs.browser}`);
+ if (cliArgs.persistent)
+ args.push('--persistent');
+ if (cliArgs.profile)
+ args.push(`--profile=${cliArgs.profile}`);
+ if (cliArgs.config)
+ args.push(`--config=${cliArgs.config}`);
const child = spawn(process.execPath, args, {
detached: true,
@@ -190,24 +198,7 @@ export class Session {
child.stdout!.destroy();
child.unref();
- const { socket } = await this._connect();
- if (socket) {
- console.log(`### Browser \`${this.name}\` opened with pid ${child.pid}.`);
- const resolvedConfig = await parseResolvedConfig(outLog);
- if (resolvedConfig) {
- this.config.resolvedConfig = resolvedConfig;
- console.log(`- ${this.name}:`);
- console.log(renderResolvedConfig(resolvedConfig).join('\n'));
- }
- console.log(`---`);
-
- this.config.timestamp = Date.now();
- await fs.promises.writeFile(this._sessionFile.file, JSON.stringify(this.config, null, 2));
- return socket;
- }
-
- console.error(`Failed to connect to daemon at ${this.config.socketPath}`);
- process.exit(1);
+ console.log(`### Browser \`${sessionName}\` opened with pid ${child.pid}.`);
}
private async _stopDaemon(): Promise<void> {
@@ -219,10 +210,6 @@ export class Session {
let error: Error | undefined;
await SocketConnectionClient.sendAndClose(socket, 'stop', {}).catch(e => error = e);
- if (os.platform() !== 'win32')
- await fs.promises.unlink(this.config.socketPath).catch(() => {});
- if (!this.config.cli.persistent)
- await this.deleteSessionConfig();
if (error && !error?.message?.includes('Session closed'))
throw error;
}
@@ -245,23 +232,6 @@ export function renderResolvedConfig(resolvedConfig: FullConfig) {
return lines;
}
-async function parseResolvedConfig(errLog: string): Promise<FullConfig | null> {
- const marker = '### Config\n```json\n';
- const markerIndex = errLog.indexOf(marker);
- if (markerIndex === -1)
- return null;
- const jsonStart = markerIndex + marker.length;
- const jsonEnd = errLog.indexOf('\n```', jsonStart);
- if (jsonEnd === -1)
- throw null;
- const jsonString = errLog.substring(jsonStart, jsonEnd).trim();
- try {
- return JSON.parse(jsonString) as FullConfig;
- } catch {
- return null;
- }
-}
-
class SocketConnectionClient {
private _connection: SocketConnection;
private _nextMessageId = 1;
diff --git a/packages/playwright-core/src/cli/daemon/DEPS.list b/packages/playwright-core/src/cli/daemon/DEPS.list
index bde3c84988..781cf49382 100644
--- a/packages/playwright-core/src/cli/daemon/DEPS.list
+++ b/packages/playwright-core/src/cli/daemon/DEPS.list
@@ -2,6 +2,7 @@
../../mcp/browser/**
../../mcp/extension/**
../client/socketConnection.ts
+../client/registry.ts
../../utilsBundle.ts
../../utils/
../../mcpBundle.ts
diff --git a/packages/playwright-core/src/cli/daemon/daemon.ts b/packages/playwright-core/src/cli/daemon/daemon.ts
index d77a1d5940..51c3b8419e 100644
--- a/packages/playwright-core/src/cli/daemon/daemon.ts
+++ b/packages/playwright-core/src/cli/daemon/daemon.ts
@@ -14,12 +14,13 @@
* limitations under the License.
*/
-import fs from 'fs/promises';
+import fs from 'fs';
import net from 'net';
import os from 'os';
import path from 'path';
import url from 'url';
+import { calculateSha1 } from '../../utils';
import { debug } from '../../utilsBundle';
import { decorateServer } from '../../server/utils/network';
import { gracefullyProcessExitDoNotHang } from '../../server/utils/processLauncher';
@@ -29,16 +30,17 @@ import { browserTools } from '../../mcp/browser/tools';
import { SocketConnection } from '../client/socketConnection';
import { commands } from './commands';
import { parseCommand } from './command';
+import { createClientInfo } from '../client/registry';
import type * as playwright from '../../..';
import type * as mcp from '../../mcp/exports';
-import type { SessionConfig } from '../client/registry';
+import type { SessionConfig, ClientInfo } from '../client/registry';
const daemonDebug = debug('pw:daemon');
async function socketExists(socketPath: string): Promise<boolean> {
try {
- const stat = await fs.stat(socketPath);
+ const stat = await fs.promises.stat(socketPath);
if (stat?.isSocket())
return true;
} catch (e) {
@@ -47,31 +49,27 @@ async function socketExists(socketPath: string): Promise<boolean> {
}
export async function startMcpDaemonServer(
- config: mcp.ContextConfig,
- sessionConfig: SessionConfig,
+ sessionName: string,
browserContext: playwright.BrowserContext,
- noShutdown?: boolean,
-): Promise<() => Promise<void>> {
+ mcpConfig: mcp.FullConfig,
+ clientInfo = createClientInfo(),
+ persistent?: boolean,
+): Promise<string> {
+ const sessionConfig = createSessionConfig(clientInfo, sessionName, persistent);
const { socketPath } = sessionConfig;
+
// Clean up existing socket file on Unix
if (os.platform() !== 'win32' && await socketExists(socketPath)) {
daemonDebug(`Socket already exists, removing: ${socketPath}`);
try {
- await fs.unlink(socketPath);
+ await fs.promises.unlink(socketPath);
} catch (error) {
daemonDebug(`Failed to remove existing socket: ${error}`);
throw error;
}
}
- if (!noShutdown) {
- browserContext.on('close', () => {
- daemonDebug('browser closed, shutting down daemon');
- shutdown(0);
- });
- }
-
- const backend = new BrowserServerBackend(config, browserContext, browserTools);
+ const backend = new BrowserServerBackend(mcpConfig, browserContext, browserTools);
await backend.initialize({
name: 'playwright-cli',
version: sessionConfig.version,
@@ -82,13 +80,7 @@ export async function startMcpDaemonServer(
timestamp: Date.now(),
});
- await fs.mkdir(path.dirname(socketPath), { recursive: true });
-
- const shutdown = (exitCode: number) => {
- daemonDebug(`shutting down daemon with exit code ${exitCode}`);
- server.close();
- gracefullyProcessExitDoNotHang(exitCode);
- };
+ await fs.promises.mkdir(path.dirname(socketPath), { recursive: true });
const server = net.createServer(socket => {
daemonDebug('new client connection');
@@ -102,6 +94,11 @@ export async function startMcpDaemonServer(
daemonDebug('received command', method);
if (method === 'stop') {
daemonDebug('stop command received, shutting down');
+ if (process.platform !== 'win32')
+ await fs.promises.unlink(sessionConfig.socketPath).catch(() => {});
+ if (!sessionConfig.cli.persistent)
+ await deleteSessionFile(clientInfo, sessionConfig);
+
gracefullyProcessExitDoNotHang(0, async () => {
await connection.send({ id, result: 'ok' }).catch(() => {});
server.close();
@@ -124,20 +121,28 @@ export async function startMcpDaemonServer(
});
decorateServer(server);
- return new Promise((resolve, reject) => {
+ await new Promise<void>((resolve, reject) => {
server.on('error', (error: NodeJS.ErrnoException) => {
daemonDebug(`server error: ${error.message}`);
reject(error);
});
-
- server.listen(socketPath, () => {
- daemonDebug(`daemon server listening on ${socketPath}`);
- resolve(async () => {
- await backend.dispose();
- await new Promise(cb => server.close(cb));
- });
- });
+ server.listen(socketPath, () => resolve());
});
+
+ sessionConfig.resolvedConfig = mcpConfig;
+ await saveSessionFile(clientInfo, sessionConfig);
+ return socketPath;
+}
+
+async function saveSessionFile(clientInfo: ClientInfo, sessionConfig: SessionConfig) {
+ await fs.promises.mkdir(clientInfo.daemonProfilesDir, { recursive: true });
+ const sessionFile = path.join(clientInfo.daemonProfilesDir, `${sessionConfig.name}.session`);
+ await fs.promises.writeFile(sessionFile, JSON.stringify(sessionConfig, null, 2));
+}
+
+async function deleteSessionFile(clientInfo: ClientInfo, sessionConfig: SessionConfig) {
+ const sessionFile = path.join(clientInfo.daemonProfilesDir, `${sessionConfig.name}.session`);
+ await fs.promises.rm(sessionFile).catch(() => {});
}
function formatResult(result: mcp.CallToolResult) {
@@ -152,3 +157,23 @@ function parseCliCommand(args: Record<string, string> & { _: string[] }): { tool
throw new Error('Command is required');
return parseCommand(command, args);
}
+
+function daemonSocketPath(clientInfo: ClientInfo, sessionName: string): string {
+ const userNameHash = calculateSha1(process.env.USERNAME || 'default').slice(0, 8);
+ const socketName = `${sessionName}-${userNameHash}.sock`;
+ if (process.platform === 'win32')
+ return `\\\\.\\pipe\\${clientInfo.workspaceDirHash}-${socketName}`;
+ const socketsDir = process.env.PLAYWRIGHT_DAEMON_SOCKETS_DIR || path.join(os.tmpdir(), 'playwright-cli');
+ return path.join(socketsDir, clientInfo.workspaceDirHash, socketName);
+}
+
+function createSessionConfig(clientInfo: ClientInfo, sessionName: string, persistent?: boolean): SessionConfig {
+ return {
+ name: sessionName,
+ version: clientInfo.version,
+ timestamp: Date.now(),
+ socketPath: daemonSocketPath(clientInfo, sessionName),
+ workspaceDir: clientInfo.workspaceDir,
+ cli: { persistent },
+ };
+}
diff --git a/packages/playwright-core/src/cli/daemon/program.ts b/packages/playwright-core/src/cli/daemon/program.ts
index e79269b1d9..27e35aed09 100644
--- a/packages/playwright-core/src/cli/daemon/program.ts
+++ b/packages/playwright-core/src/cli/daemon/program.ts
@@ -18,52 +18,52 @@
import fs from 'fs';
import url from 'url';
+import path from 'path';
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 * as configUtils from '../../mcp/browser/config';
+import { gracefullyProcessExitDoNotHang } from '../../utils';
+import { ClientInfo, createClientInfo } from '../client/registry';
import type { Command } from '../../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;
+ .argument('[session-name]', 'name of the session to create or connect to', 'default')
+ .option('--headed', 'run in headed mode (non-headless)')
+ .option('--extension', 'run with the extension')
+ .option('--browser <name>', 'browser to use (chromium, chrome, firefox, webkit)')
+ .option('--persistent', 'use a persistent browser context')
+ .option('--profile <path>', 'path to the user data dir')
+ .option('--config <path>', 'path to the config file')
+
+ .action(async (sessionName: string, options: any) => {
setupExitWatchdog();
-
- const sessionConfig = await fs.promises.readFile(options.daemonSession, 'utf-8').then(data => JSON.parse(data) as SessionConfig);
-
- const cwd = url.pathToFileURL(process.cwd()).href;
- const clientInfo = {
+ const clientInfo = createClientInfo();
+ const mcpConfig = await resolveCLIConfig(clientInfo, sessionName, options);
+ const mcpClientInfo = {
name: 'playwright-cli',
- version: sessionConfig.version,
+ version: require('../../../package.json').version,
roots: [{
- uri: cwd,
+ uri: url.pathToFileURL(process.cwd()).href,
name: 'cwd'
}],
timestamp: Date.now(),
};
- const mcpConfig = await resolveCLIConfig(sessionConfig);
- const extensionContextFactory = new ExtensionContextFactory(mcpConfig.browser.launchOptions.channel || 'chrome', mcpConfig.browser.userDataDir, mcpConfig.browser.launchOptions.executablePath);
- const browserContextFactory = contextFactory(mcpConfig);
- const cf = mcpConfig.extension ? extensionContextFactory : browserContextFactory;
-
try {
- const browserContext = mcpConfig.browser.isolated ? await cf.createContext(clientInfo) : (await cf.contexts(clientInfo))[0];
- await startMcpDaemonServer(mcpConfig, sessionConfig, browserContext);
- console.log(`### Config`);
- console.log('```json');
- console.log(JSON.stringify(mcpConfig, null, 2));
- console.log('```');
- console.log(`### Success\nDaemon listening on ${sessionConfig.socketPath}`);
+ const extensionContextFactory = new ExtensionContextFactory(mcpConfig.browser.launchOptions.channel || 'chrome', mcpConfig.browser.userDataDir, mcpConfig.browser.launchOptions.executablePath);
+ const browserContextFactory = contextFactory(mcpConfig);
+ const cf = mcpConfig.extension ? extensionContextFactory : browserContextFactory;
+ const browserContext = mcpConfig.browser.isolated ? await cf.createContext(mcpClientInfo) : (await cf.contexts(mcpClientInfo))[0];
+ browserContext.on('close', () => gracefullyProcessExitDoNotHang(0));
+ const socketPath = await startMcpDaemonServer(sessionName, browserContext, mcpConfig, clientInfo, options.persistent);
+ 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;
@@ -73,23 +73,37 @@ export function decorateCLICommand(command: Command, version: string) {
});
}
-export async function resolveCLIConfig(sessionConfig: SessionConfig): Promise<FullConfig> {
- 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,
+function defaultConfigFile(): string {
+ return path.resolve('.playwright', 'cli.config.json');
+}
+
+export async function resolveCLIConfig(clientInfo: ClientInfo, sessionName: string, options: any): Promise<FullConfig> {
+ const config = options.config ? path.resolve(options.config) : undefined;
+ try {
+ if (!config && fs.existsSync(defaultConfigFile()))
+ options.config = defaultConfigFile();
+ } catch {
+ }
+
+ if (!options.persistent && options.profile)
+ options.persistent = true;
+
+ const daemonOverrides = configUtils.configFromCLIOptions({
+ config: options.config,
+ browser: options.browser,
+ isolated: options.persistent === true ? false : undefined,
+ headless: options.headed ? false : undefined,
+ extension: options.extension,
+ userDataDir: options.profile,
outputMode: 'file',
snapshotMode: 'full',
});
- const envOverrides = configFromEnv();
+ const envOverrides = configUtils.configFromEnv();
const configFile = envOverrides.configFile ?? daemonOverrides.configFile;
- const configInFile = await loadConfig(configFile);
+ const configInFile = await configUtils.loadConfig(configFile);
- let result = mergeConfig(defaultConfig, {
+ let result = configUtils.mergeConfig(configUtils.defaultConfig, {
browser: {
launchOptions: {
headless: true,
@@ -98,14 +112,14 @@ export async function resolveCLIConfig(sessionConfig: SessionConfig): Promise<Fu
}
});
- result = mergeConfig(result, configInFile);
- result = mergeConfig(result, daemonOverrides);
- result = mergeConfig(result, envOverrides);
+ result = configUtils.mergeConfig(result, configInFile);
+ result = configUtils.mergeConfig(result, daemonOverrides);
+ result = configUtils.mergeConfig(result, envOverrides);
- if (!result.extension && !result.browser.userDataDir && sessionConfig.userDataDirPrefix) {
+ if (!result.extension && !result.browser.userDataDir) {
// No custom value provided, use the daemon data dir.
const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;
- const userDataDir = `${sessionConfig.userDataDirPrefix}-${browserToken}`;
+ const userDataDir = path.resolve(clientInfo.daemonProfilesDir, `ud-${sessionName}-${browserToken}`);
result.browser.userDataDir = userDataDir;
}
@@ -114,7 +128,7 @@ export async function resolveCLIConfig(sessionConfig: SessionConfig): Promise<Fu
if (result.browser.launchOptions.headless !== false)
result.browser.contextOptions.viewport ??= { width: 1280, height: 720 };
- await validateConfig(result);
+ await configUtils.validateConfig(result);
return result;
}
diff --git a/packages/playwright-core/src/mcp/browser/config.ts b/packages/playwright-core/src/mcp/browser/config.ts
index 639a5f8b2a..304b8b632c 100644
--- a/packages/playwright-core/src/mcp/browser/config.ts
+++ b/packages/playwright-core/src/mcp/browser/config.ts
@@ -105,9 +105,8 @@ export type FullConfig = Config & {
browserName: 'chromium' | 'firefox' | 'webkit';
launchOptions: NonNullable<BrowserUserConfig['launchOptions']>;
contextOptions: NonNullable<BrowserUserConfig['contextOptions']>;
- isolated: boolean;
},
- server: NonNullable<Config['server']>,
+ server?: Config['server'],
skillMode?: boolean;
configFile?: string;
};
diff --git a/packages/playwright-core/src/mcp/exports.ts b/packages/playwright-core/src/mcp/exports.ts
index 16b84f6c6e..1d3ae9d128 100644
--- a/packages/playwright-core/src/mcp/exports.ts
+++ b/packages/playwright-core/src/mcp/exports.ts
@@ -25,7 +25,7 @@ export { setupExitWatchdog } from './browser/watchdog';
export type { Tool as BrowserTool } from './browser/tools/tool';
export { logUnhandledError } from './log';
export type { ContextConfig } from './browser/context';
+export type { FullConfig } from './browser/config';
export { startMcpDaemonServer } from '../cli/daemon/daemon';
-export { sessionConfigFromArgs } from '../cli/client/program';
export { createClientInfo } from '../cli/client/registry';
export { filteredTools } from './browser/tools';
diff --git a/packages/playwright-core/src/mcp/sdk/server.ts b/packages/playwright-core/src/mcp/sdk/server.ts
index b15b66c8a7..dee2f9bb72 100644
--- a/packages/playwright-core/src/mcp/sdk/server.ts
+++ b/packages/playwright-core/src/mcp/sdk/server.ts
@@ -195,7 +195,7 @@ function addServerListener(server: Server, event: 'close' | 'initialized', liste
};
}
-export async function start(serverBackendFactory: ServerBackendFactory, options: { host?: string; port?: number, allowedHosts?: string[], socketPath?: string }) {
+export async function start(serverBackendFactory: ServerBackendFactory, options: { host?: string; port?: number, allowedHosts?: string[], socketPath?: string } = {}) {
if (options.port === undefined) {
await connect(serverBackendFactory, new mcpBundle.StdioServerTransport(), false);
return;
diff --git a/packages/playwright/src/mcp/test/browserBackend.ts b/packages/playwright/src/mcp/test/browserBackend.ts
index 12b698f274..fc36578fe8 100644
--- a/packages/playwright/src/mcp/test/browserBackend.ts
+++ b/packages/playwright/src/mcp/test/browserBackend.ts
@@ -15,7 +15,6 @@
*/
import path from 'path';
-import fs from 'fs';
import { createGuid } from 'playwright-core/lib/utils';
import * as mcp from 'playwright-core/lib/mcp/exports';
import { BrowserServerBackend } from 'playwright-core/lib/mcp/exports';
@@ -125,17 +124,16 @@ export async function runDaemonForContext(testInfo: TestInfoImpl, context: playw
const outputDir = path.join(testInfo.artifactsDir(), '.playwright-mcp');
const sessionName = `test-worker-${createGuid().slice(0, 6)}`;
- const clientInfo = mcp.createClientInfo();
- const sessionConfig = mcp.sessionConfigFromArgs(clientInfo, sessionName, { _: [] });
- const sessionConfigFile = path.resolve(clientInfo.daemonProfilesDir, `${sessionName}.session`);
- await fs.promises.mkdir(path.dirname(sessionConfigFile), { recursive: true });
- await fs.promises.writeFile(sessionConfigFile, JSON.stringify(sessionConfig, null, 2));
-
- await mcp.startMcpDaemonServer({
+ await mcp.startMcpDaemonServer(sessionName, context, {
+ browser: {
+ browserName: 'chromium',
+ launchOptions: {},
+ contextOptions: {},
+ },
outputMode: 'file',
snapshot: { mode: 'full' },
outputDir,
- }, sessionConfig, context, true /* noShutdown */);
+ });
const lines = [''];
if (testInfo.errors.length) {
diff --git a/tests/mcp/cli-isolated.spec.ts b/tests/mcp/cli-isolated.spec.ts
index aedc266e28..7d7b072841 100644
--- a/tests/mcp/cli-isolated.spec.ts
+++ b/tests/mcp/cli-isolated.spec.ts
@@ -28,7 +28,6 @@ test('should not save user data by default (in-memory mode)', async ({ cli, serv
cli: {},
socketPath: expect.any(String),
timestamp: expect.any(Number),
- userDataDirPrefix: expect.any(String),
version: expect.any(String),
workspaceDir: testInfo.outputPath(),
resolvedConfig: expect.any(Object),
@@ -55,7 +54,6 @@ test('should save user data with --persistent flag', async ({ cli, server, mcpBr
},
socketPath: expect.any(String),
timestamp: expect.any(Number),
- userDataDirPrefix: expect.any(String),
version: expect.any(String),
workspaceDir: testInfo.outputPath(),
resolvedConfig: expect.any(Object),
@@ -71,11 +69,9 @@ test('should use custom user data dir with --profile=<dir>', async ({ cli, serve
name: 'default',
cli: {
persistent: true,
- profile: customDir,
},
socketPath: expect.any(String),
timestamp: expect.any(Number),
- userDataDirPrefix: expect.any(String),
version: expect.any(String),
workspaceDir: testInfo.outputPath(),
resolvedConfig: expect.any(Object),
diff --git a/tests/mcp/cli-session.spec.ts b/tests/mcp/cli-session.spec.ts
index b1adb837ce..746e885ef7 100644
--- a/tests/mcp/cli-session.spec.ts
+++ b/tests/mcp/cli-session.spec.ts
@@ -140,16 +140,6 @@ test('session reopen with different config', async ({ cli, server }, testInfo) =
}
});
-test('session start should print browser config', async ({ cli, server }, testInfo) => {
- const configPath = testInfo.outputPath('my-config.json');
- await fs.promises.writeFile(configPath, JSON.stringify({}, null, 2));
-
- const { output } = await cli('open', '--headed', '--config=' + configPath, server.HELLO_WORLD);
- expect(output).toContain('### Browser `default` opened');
- expect(output).toContain('- default:');
- expect(output).toContain('- headed:');
-});
-
test('workspace isolation - sessions in different workspaces are isolated', async ({ cli, server }, testInfo) => {
// Create two separate workspaces with their own daemon dirs
const workspace1 = testInfo.outputPath('workspace1');