Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore(cli): handle version mismatch (#39016)
Pavel Feldman2bef809b1b1c
diff --git a/packages/playwright/src/mcp/program.ts b/packages/playwright/src/mcp/program.tsindex c832d64ae7..67c8234f4c 100644--- a/packages/playwright/src/mcp/program.ts+++ b/packages/playwright/src/mcp/program.ts@@ -80,6 +80,7 @@ export function decorateCommand(command: Command, version: string) {.addOption(new ProgramOption('--daemon <socket>', 'run as daemon').hideHelp()).addOption(new ProgramOption('--daemon-data-dir <path>', 'path to the daemon data directory.').hideHelp()).addOption(new ProgramOption('--daemon-headed', 'run daemon in headed mode').hideHelp())+ .addOption(new ProgramOption('--daemon-version <version>', 'version of this daemon').hideHelp()).action(async options => {// normalize the --no-sandbox option: sandbox = true => nothing was passed, sandbox = false => --no-sandbox was passed.@@ -117,7 +118,7 @@ export function decorateCommand(command: Command, version: string) {version,create: () => new BrowserServerBackend(config, contextFactory, { allTools: true, structuredOutput: true })};- const socketPath = await startMcpDaemonServer(options.daemon, serverBackendFactory);+ const socketPath = await startMcpDaemonServer(options.daemon, serverBackendFactory, options.daemonVersion);console.error(`Daemon server listening on ${socketPath}`);return;}diff --git a/packages/playwright/src/mcp/terminal/daemon.ts b/packages/playwright/src/mcp/terminal/daemon.tsindex 880e17e7a8..7dd871dedf 100644--- a/packages/playwright/src/mcp/terminal/daemon.ts+++ b/packages/playwright/src/mcp/terminal/daemon.ts@@ -49,7 +49,8 @@ async function socketExists(socketPath: string): Promise<boolean> {*/export async function startMcpDaemonServer(socketPath: string,- serverBackendFactory: ServerBackendFactory+ serverBackendFactory: ServerBackendFactory,+ daemonVersion: string): Promise<string> {// Clean up existing socket file on Unixif (os.platform() !== 'win32' && await socketExists(socketPath)) {@@ -78,10 +79,26 @@ export async function startMcpDaemonServer(const server = net.createServer(socket => {daemonDebug('new client connection');- const connection = new SocketConnection(socket);+ const connection = new SocketConnection(socket, daemonVersion);connection.onclose = () => {daemonDebug('client disconnected');};+ connection.onversionerror = (id, e) => {+ if (daemonVersion === 'undefined-for-test')+ return false;++ if (semverGreater(daemonVersion, e.received)) {+ // eslint-disable-next-line no-console+ connection.send({ id, error: `Client is too old: daemon is ${daemonVersion}, client is ${e.received}.` }).catch(e => console.error(e));+ } else {+ gracefullyProcessExitDoNotHang(0, async () => {+ // eslint-disable-next-line no-console+ await connection.send({ id, error: `Daemon is too old: daemon is ${daemonVersion}, client is ${e.received}. Stopping it.` }).catch(e => console.error(e));+ server.close();+ });+ }+ return true;+ };connection.onmessage = async message => {const { id, method, params } = message;try {@@ -138,3 +155,17 @@ function parseCliCommand(args: Record<string, string> & { _: string[] }): { toolthrow new Error('Command is required');return parseCommand(command, args);}++function semverGreater(a: string, b: string): boolean {+ a = a.replace(/-next$/, '');+ b = b.replace(/-next$/, '');+ const aParts = a.split('.').map(Number);+ const bParts = b.split('.').map(Number);+ for (let i = 0; i < 4; i++) {+ if (aParts[i] > bParts[i])+ return true;+ if (aParts[i] < bParts[i])+ return false;+ }+ return false;+}diff --git a/packages/playwright/src/mcp/terminal/program.ts b/packages/playwright/src/mcp/terminal/program.tsindex 5ecf624e64..71c17c7228 100644--- a/packages/playwright/src/mcp/terminal/program.ts+++ b/packages/playwright/src/mcp/terminal/program.ts@@ -34,7 +34,7 @@ export type StructuredResponse = {sections: Section[];};-type SessionOptions = { config?: string, headed?: boolean, extension?: boolean };+type SessionOptions = { config?: string, headed?: boolean, extension?: boolean, daemonVersion: string };class Session {readonly name: string;@@ -71,7 +71,7 @@ class Session {console.log(`Session '${this.name}' stopped.`);}- async restart(options: { config?: string, headed?: boolean }): Promise<void> {+ async restart(options: SessionOptions): Promise<void> {await this.stop();this._options = options;@@ -85,6 +85,7 @@ class Session {id: messageId,method,params,+ version: this._options.daemonVersion,};const responsePromise = new Promise<any>((resolve, reject) => {this._callbacks.set(messageId, { resolve, reject, method, params });@@ -163,13 +164,25 @@ class Session {if (!socket)socket = await this._startDaemon();- this._connection = new SocketConnection(socket);+ this._connection = new SocketConnection(socket, this._options.daemonVersion);this._connection.onmessage = message => this._onMessage(message);+ this._connection.onversionerror = (id, e) => {+ if (e.received && e.received !== 'undefined-for-test') {+ // This is daemon telling us the version is bad.+ return false;+ }++ // This will only happen once when hitting the non-versione-aware daemon.+ // Only kill daemon if it is older.+ console.error(`Daemon is older than client, killing it.`);+ this.stop().then(() => process.exit(1)).catch(() => process.exit(1));+ return true;+ };this._connection.onclose = () => this.close();return this._connection;}- private _onMessage(object: any) {+ private _onMessage(object: { id: number, error?: string, result: any }) {if (object.id && this._callbacks.has(object.id)) {const callback = this._callbacks.get(object.id)!;this._callbacks.delete(object.id);@@ -204,6 +217,7 @@ class Session {`--output-dir=${outputDir}`,`--daemon=${this._socketPath}`,`--daemon-data-dir=${userDataDir}`,+ `--daemon-version=${this._options.daemonVersion}`,...configArg,...headedArg,...extensionArg,@@ -259,9 +273,11 @@ class Session {class SessionManager {readonly sessions: Map<string, Session>;+ readonly options: SessionOptions;- private constructor(sessions: Map<string, Session>) {+ private constructor(sessions: Map<string, Session>, options: SessionOptions) {this.sessions = sessions;+ this.options = options;}static async create(options: SessionOptions): Promise<SessionManager> {@@ -280,14 +296,14 @@ class SessionManager {}} catch {}- return new SessionManager(sessions);+ return new SessionManager(sessions, options);}async run(args: any): Promise<void> {const sessionName = this._resolveSessionName(args.session);let session = this.sessions.get(sessionName);if (!session) {- session = new Session(sessionName, args);+ session = new Session(sessionName, { ...this.options, ...args });this.sessions.set(sessionName, session);}@@ -322,10 +338,10 @@ class SessionManager {const sessionName = this._resolveSessionName(args.session);let session = this.sessions.get(sessionName);if (!session) {- session = new Session(sessionName, {});+ session = new Session(sessionName, this.options);this.sessions.set(sessionName, session);}- await session.restart({ ...args, config: args._[1] });+ await session.restart({ ...this.options, ...args, config: args._[1] });session.close();}@@ -433,7 +449,7 @@ export async function program(options: { version: string }) {process.exit(1);}- const sessionManager = await SessionManager.create(args);+ const sessionManager = await SessionManager.create({ daemonVersion: options.version, ...args });if (commandName.startsWith('session')) {const subcommand = args._[0].split('-').slice(1).join('-');await handleSessionCommand(sessionManager, subcommand, args);diff --git a/packages/playwright/src/mcp/terminal/socketConnection.ts b/packages/playwright/src/mcp/terminal/socketConnection.tsindex ff86662644..ba72baa63c 100644--- a/packages/playwright/src/mcp/terminal/socketConnection.ts+++ b/packages/playwright/src/mcp/terminal/socketConnection.ts@@ -19,12 +19,15 @@ import net from 'net';export class SocketConnection {private _socket: net.Socket;private _pendingBuffers: Buffer[] = [];+ private _version: string;onclose?: () => void;onmessage?: (message: any) => void;+ onversionerror?: (id: number, versions: { expected: string, received: string }) => boolean;- constructor(socket: net.Socket) {+ constructor(socket: net.Socket, version: string) {this._socket = socket;+ this._version = version;socket.on('data', buffer => this._onData(buffer));socket.on('close', () => {this.onclose?.();@@ -34,9 +37,9 @@ export class SocketConnection {socket.on('error', e => console.error(`error: ${e.message}`));}- async send(message: any) {+ async send(message: { id: number, error?: string, result?: any }) {await new Promise((resolve, reject) => {- this._socket.write(`${JSON.stringify(message)}\n`, error => {+ this._socket.write(`${JSON.stringify({ ...message, version: this._version })}\n`, error => {if (error)reject(error);else@@ -72,7 +75,12 @@ export class SocketConnection {private _dispatchMessage(message: string) {try {- this.onmessage?.(JSON.parse(message));+ const parsedMessage = JSON.parse(message);+ if (parsedMessage.version !== this._version) {+ if (this.onversionerror?.(parsedMessage.id, { expected: this._version, received: parsedMessage.version }))+ return;+ }+ this.onmessage?.(parsedMessage);} catch (e) {// eslint-disable-next-line no-consoleconsole.error('failed to dispatch message', e);diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.tsindex c41cc2ee10..d5367f9edd 100644--- a/tests/mcp/cli-fixtures.ts+++ b/tests/mcp/cli-fixtures.ts@@ -27,6 +27,7 @@ export const test = baseTest.extend<{cli: (...args: string[]) => Promise<{output: string,error: string,+ exitCode: number | undefined,snapshot?: string,attachments?: { name: string, data: Buffer | null }[],}>;@@ -69,7 +70,7 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: stringPLAYWRIGHT_MCP_HEADLESS: String(options.mcpHeadless),},});- await cli.cleanExit().finally(async () => {+ await cli.exited.finally(async () => {await testInfo.attach(stepTitle, { body: cli.output, contentType: 'text/plain' });});@@ -83,6 +84,7 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: stringif (sessionName && pid)sessions.push({ name: sessionName, pid: +pid });return {+ exitCode: await cli.exitCode,output: cli.stdout.trim(),error: cli.stderr.trim(),snapshot,diff --git a/tests/mcp/cli.spec.ts b/tests/mcp/cli.spec.tsindex 9a82dff38b..12bb983a90 100644--- a/tests/mcp/cli.spec.ts+++ b/tests/mcp/cli.spec.ts@@ -544,3 +544,38 @@ test.describe('config', () => {expect(afterOutput).toContain('700x500');});});++test.describe('versions', () => {+ test('old client', async ({ cli, server }) => {+ await cli('config', '--daemonVersion=2.0.0');+ const { error, exitCode } = await cli('open', server.PREFIX);+ expect(exitCode).toBe(1);+ expect(error).toMatch(/Client is too old: daemon is 2\.0\.0, client is 1.*/);+ });++ test('old daemon', async ({ cli, server }) => {+ await cli('config');+ {+ const { error, exitCode } = await cli('open', server.PREFIX, '--daemonVersion=2.0.0');+ expect(exitCode).toBe(1);+ expect(error).toMatch(/Daemon is too old: daemon is 1.*, client is 2\.0\.0. Stopping it/);+ }+ {+ const { output } = await cli('open', server.PREFIX, '--daemonVersion=2.0.0');+ expect(output).toContain('Daemon for `default` session started with pid');+ }+ });++ test('very old daemon', async ({ cli, server }) => {+ {+ const { exitCode } = await cli('open', server.PREFIX, '--daemonVersion=undefined-for-test');+ expect(exitCode).toBe(0);+ }++ {+ const { exitCode, error } = await cli('open', server.PREFIX);+ expect(exitCode).toBe(1);+ expect(error).toContain('Daemon is older than client, killing it.');+ }+ });+});