Skip to content

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

chore(cli): shutdown on launch failure (#39051)

Simon Knotta74302c1cb46
diff --git a/packages/playwright/src/mcp/browser/browserServerBackend.ts b/packages/playwright/src/mcp/browser/browserServerBackend.ts
index 52cdff07d9..6812b32531 100644
--- a/packages/playwright/src/mcp/browser/browserServerBackend.ts
+++ b/packages/playwright/src/mcp/browser/browserServerBackend.ts
@@ -35,6 +35,7 @@ export class BrowserServerBackend implements ServerBackend {
private _browserContextFactory: BrowserContextFactory;
onBrowserContextClosed: (() => void) | undefined;
+ onBrowserLaunchFailed: ((error: Error) => void) | undefined;
constructor(config: FullConfig, factory: BrowserContextFactory, options: { allTools?: boolean, structuredOutput?: boolean } = {}) {
this._config = config;
@@ -51,6 +52,7 @@ export class BrowserServerBackend implements ServerBackend {
clientInfo,
});
this._context.onBrowserContextClosed = () => this.onBrowserContextClosed?.();
+ this._context.onBrowserLaunchFailed = error => this.onBrowserLaunchFailed?.(error);
}
async listTools(): Promise<mcpServer.Tool[]> {
diff --git a/packages/playwright/src/mcp/browser/context.ts b/packages/playwright/src/mcp/browser/context.ts
index 4e346245ef..b224899fe9 100644
--- a/packages/playwright/src/mcp/browser/context.ts
+++ b/packages/playwright/src/mcp/browser/context.ts
@@ -56,6 +56,7 @@ export class Context {
private _abortController = new AbortController();
onBrowserContextClosed: (() => void) | undefined;
+ onBrowserLaunchFailed: ((error: Error) => void) | undefined;
constructor(options: ContextOptions) {
this.config = options.config;
@@ -201,8 +202,9 @@ export class Context {
return this._browserContextPromise;
this._browserContextPromise = this._setupBrowserContext();
- this._browserContextPromise.catch(() => {
+ this._browserContextPromise.catch(error => {
this._browserContextPromise = undefined;
+ this.onBrowserLaunchFailed?.(error);
});
return this._browserContextPromise;
}
diff --git a/packages/playwright/src/mcp/sdk/server.ts b/packages/playwright/src/mcp/sdk/server.ts
index 97348a88e6..6fa53cf1a4 100644
--- a/packages/playwright/src/mcp/sdk/server.ts
+++ b/packages/playwright/src/mcp/sdk/server.ts
@@ -48,6 +48,7 @@ export interface ServerBackend {
callTool(name: string, args: CallToolRequest['params']['arguments'], progress: ProgressCallback): Promise<CallToolResult>;
serverClosed?(server: Server): void;
onBrowserContextClosed?: (() => void) | undefined;
+ onBrowserLaunchFailed?: ((error: Error) => void) | undefined;
}
export type ServerBackendFactory = {
diff --git a/packages/playwright/src/mcp/terminal/daemon.ts b/packages/playwright/src/mcp/terminal/daemon.ts
index bf39d9b126..75ac62fcb7 100644
--- a/packages/playwright/src/mcp/terminal/daemon.ts
+++ b/packages/playwright/src/mcp/terminal/daemon.ts
@@ -75,6 +75,14 @@ export async function startMcpDaemonServer(
await fs.mkdir(path.dirname(socketPath), { recursive: true });
+ let shutdownPending = false;
+
+ const shutdown = (exitCode: number) => {
+ daemonDebug(`shutting down daemon with exit code ${exitCode}`);
+ server.close();
+ gracefullyProcessExitDoNotHang(exitCode);
+ };
+
const server = net.createServer(socket => {
daemonDebug('new client connection');
const connection = new SocketConnection(socket, daemonVersion);
@@ -113,20 +121,28 @@ export async function startMcpDaemonServer(
toolParams._meta = { cwd: params.cwd };
const response = await backend.callTool(toolName, toolParams, () => {});
await connection.send({ id, result: formatResult(response) });
+ if (shutdownPending)
+ shutdown(1);
} else {
throw new Error(`Unknown method: ${method}`);
}
} catch (e) {
daemonDebug('command failed', e);
await connection.send({ id, error: (e as Error).message });
+ if (shutdownPending)
+ shutdown(1);
}
};
});
backend.onBrowserContextClosed = () => {
daemonDebug('browser closed, shutting down daemon');
- server.close();
- gracefullyProcessExitDoNotHang(0);
+ shutdown(0);
+ };
+
+ backend.onBrowserLaunchFailed = error => {
+ daemonDebug('browser launch failed, will shut down after response', error);
+ shutdownPending = true;
};
return new Promise((resolve, reject) => {
diff --git a/tests/mcp/cli-fixtures.ts b/tests/mcp/cli-fixtures.ts
index 9dc73db3c0..793d2c0936 100644
--- a/tests/mcp/cli-fixtures.ts
+++ b/tests/mcp/cli-fixtures.ts
@@ -56,7 +56,7 @@ export const test = baseTest.extend<{
},
});
-async function runCli(childProcess: CommonFixtures['childProcess'], args: string[], cliOptions: { cwd?: string }, options: { mcpBrowser: string, mcpHeadless: boolean }, sessions: { name: string, pid: number }[]) {
+async function runCli(childProcess: CommonFixtures['childProcess'], args: string[], cliOptions: { cwd?: string, env?: Record<string, string> }, options: { mcpBrowser: string, mcpHeadless: boolean }, sessions: { name: string, pid: number }[]) {
const stepTitle = `cli ${args.join(' ')}`;
return await test.step(stepTitle, async () => {
const testInfo = test.info();
@@ -70,6 +70,7 @@ async function runCli(childProcess: CommonFixtures['childProcess'], args: string
PLAYWRIGHT_DAEMON_SOCKETS_DIR: path.join(testInfo.project.outputDir, 'daemon-sockets'),
PLAYWRIGHT_MCP_BROWSER: options.mcpBrowser,
PLAYWRIGHT_MCP_HEADLESS: String(options.mcpHeadless),
+ ...cliOptions.env,
},
});
await cli.exited.finally(async () => {
diff --git a/tests/mcp/cli.spec.ts b/tests/mcp/cli.spec.ts
index 5a327af81d..e1a993fefe 100644
--- a/tests/mcp/cli.spec.ts
+++ b/tests/mcp/cli.spec.ts
@@ -656,3 +656,14 @@ test.describe('isolated', () => {
expect(listOutput).toContain('default (live)');
});
});
+
+test.describe('browser launch failure', () => {
+ test('daemon shuts down on browser launch failure', async ({ cli, server }) => {
+ const first = await cli('open', server.PREFIX, { env: { PLAYWRIGHT_MCP_EXECUTABLE_PATH: '/nonexistent/browser/path' } });
+ expect(first.output).toContain('Failed to launch');
+
+ const second = await cli('open', server.PREFIX);
+ expect(second.exitCode).toBe(0);
+ expect(second.output).toContain('Page URL');
+ });
+});