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
fix(mcp): resolve extension channel/executablePath from CLI and env (#40572)
Yury Semikhatskya4ed1beaa2d8
diff --git a/packages/playwright-core/src/tools/mcp/browserFactory.ts b/packages/playwright-core/src/tools/mcp/browserFactory.tsindex bcd3cf281d..80c9d0b8d3 100644--- a/packages/playwright-core/src/tools/mcp/browserFactory.ts+++ b/packages/playwright-core/src/tools/mcp/browserFactory.ts@@ -25,7 +25,7 @@ import { outputDir } from '../backend/context';import { createExtensionBrowser } from './extensionContextFactory';import { connectToBrowserAcrossVersions } from '../utils/connect';import { serverRegistry } from '../../serverRegistry';-import { resolveChannelForExtension } from './config';+import { resolveExtensionOptions } from './config';// eslint-disable-next-line no-restricted-importsimport { connectToBrowser } from '../../client/connect';@@ -59,8 +59,8 @@ export async function createBrowserWithInfo(config: FullConfig, clientInfo: CliecanBind = true;ownership = 'own';} else if (config.extension) {- const channel = resolveChannelForExtension(cliOptions);- browser = await createExtensionBrowser(channel, clientInfo.clientName);+ const { channel, executablePath } = resolveExtensionOptions(cliOptions);+ browser = await createExtensionBrowser(channel, executablePath, clientInfo.clientName);ownership = 'attached';} else {browser = await createPersistentBrowser(config, clientInfo);diff --git a/packages/playwright-core/src/tools/mcp/cdpRelay.ts b/packages/playwright-core/src/tools/mcp/cdpRelay.tsindex 738163825f..c0a79d6828 100644--- a/packages/playwright-core/src/tools/mcp/cdpRelay.ts+++ b/packages/playwright-core/src/tools/mcp/cdpRelay.ts@@ -62,7 +62,6 @@ type CDPResponse = CDPMessage;export class CDPRelayServer {private _wsHost: string;private _browserChannel: string;- private _userDataDir?: string;private _executablePath?: string;private _cdpPath: string;private _extensionPath: string;@@ -73,10 +72,9 @@ export class CDPRelayServer {private _handler: ExtensionProtocolHandler;private _extensionConnectionPromise = new ManualPromise<void>();- constructor(server: http.Server, browserChannel: string, userDataDir?: string, executablePath?: string) {+ constructor(server: http.Server, browserChannel: string, executablePath?: string) {this._wsHost = addressToString(server.address(), { protocol: 'ws' });this._browserChannel = browserChannel;- this._userDataDir = userDataDir;this._executablePath = executablePath;this._protocolVersion = parseInt(process.env.PLAYWRIGHT_EXTENSION_PROTOCOL ?? protocol.DEFAULT_VERSION.toString(), 10);@@ -145,8 +143,9 @@ export class CDPRelayServer {}const args: string[] = [];- if (this._userDataDir)- args.push(`--user-data-dir=${this._userDataDir}`);+ const userDataDir = process.env.PWTEST_EXTENSION_USER_DATA_DIR;+ if (userDataDir)+ args.push(`--user-data-dir=${userDataDir}`);if (os.platform() === 'linux' && channel === 'chromium')args.push('--no-sandbox');args.push(href);diff --git a/packages/playwright-core/src/tools/mcp/config.ts b/packages/playwright-core/src/tools/mcp/config.tsindex 46b019eccf..cc85e23f6b 100644--- a/packages/playwright-core/src/tools/mcp/config.ts+++ b/packages/playwright-core/src/tools/mcp/config.ts@@ -194,10 +194,11 @@ export async function resolveCLIConfigForCLI(daemonProfilesDir: string, sessionNreturn { ...result, browser, configFile, skillMode: true };}-export function resolveChannelForExtension(cliOptions: CLIOptions): string {+export function resolveExtensionOptions(cliOptions: CLIOptions): { channel: string, executablePath?: string } {const browser = cliOptions.browser ?? envToString(process.env.PLAYWRIGHT_MCP_BROWSER);const { channel } = resolveBrowserParam(browser);- return channel ?? 'chrome';+ const executablePath = cliOptions.executablePath ?? envToString(process.env.PLAYWRIGHT_MCP_EXECUTABLE_PATH);+ return { channel: channel ?? 'chrome', executablePath };}async function validateBrowserConfig(browser: MergedConfig['browser']): Promise<FullConfig['browser']> {diff --git a/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts b/packages/playwright-core/src/tools/mcp/extensionContextFactory.tsindex cf3e4ac72e..ae2f2bedaf 100644--- a/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts+++ b/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts@@ -25,14 +25,17 @@ import type * as playwrightTypes from '../../..';const debugLogger = debug('pw:mcp:relay');-export async function createExtensionBrowser(channel: string, clientName: string): Promise<playwrightTypes.Browser> {- const userDataDir = process.env.PWTEST_EXTENSION_USER_DATA_DIR ?? defaultUserDataDirForChannel(channel);- if (userDataDir && !await isPlaywrightExtensionInstalled(userDataDir))- throw new Error(`Playwright Extension not found in "${userDataDir}". Install it from ${playwrightExtensionInstallUrl}`);+export async function createExtensionBrowser(channel: string, executablePath: string | undefined, clientName: string): Promise<playwrightTypes.Browser> {+ // Custom executablePath may target a browser in a different filesystem (e.g. Windows chrome.exe from WSL2), so the local profile path is not meaningful.+ if (!executablePath) {+ const userDataDir = process.env.PWTEST_EXTENSION_USER_DATA_DIR ?? defaultUserDataDirForChannel(channel);+ if (userDataDir && !await isPlaywrightExtensionInstalled(userDataDir))+ throw new Error(`Playwright Extension not found in "${userDataDir}". Install it from ${playwrightExtensionInstallUrl}`);+ }const httpServer = createHttpServer();await startHttpServer(httpServer, {});- const relay = new CDPRelayServer(httpServer, channel, userDataDir);+ const relay = new CDPRelayServer(httpServer, channel, executablePath);debugLogger(`CDP relay server started, extension endpoint: ${relay.extensionEndpoint()}.`);try {diff --git a/tests/extension/extension.spec.ts b/tests/extension/extension.spec.tsindex 9caaced632..52dd553877 100644--- a/tests/extension/extension.spec.ts+++ b/tests/extension/extension.spec.ts@@ -14,6 +14,8 @@* limitations under the License.*/+import fs from 'fs/promises';+import { test, testWithOldExtensionVersion, expect, extensionId, clickAllowAndSelect, startWithExtensionFlag } from './extension-fixtures';import { utils } from '../../packages/playwright-core/lib/coreBundle';@@ -231,6 +233,28 @@ test(`extension needs update`, async ({ startExtensionClient, server }) => {await expect(confirmationPage.locator('.status-banner')).toContainText(`Playwright client trying to connect requires newer extension version`);});+test(`custom executablePath skips local extension check`, {+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/1590' },+}, async ({ startClient, server }) => {+ const executablePath = test.info().outputPath('echo.sh');+ await fs.writeFile(executablePath, '#!/bin/bash\necho "Custom exec args: $@" > "$(dirname "$0")/output.txt"', { mode: 0o755 });++ // Empty profile would normally fail the extension-installed check; it is skipped when executablePath is set.+ const { client } = await startClient({+ args: [`--extension`, `--executable-path=${executablePath}`],+ env: { PWTEST_EXTENSION_USER_DATA_DIR: test.info().outputPath('empty-profile') },+ });++ client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.HELLO_WORLD },+ }).catch(() => {});+ await expect(async () => {+ const output = await fs.readFile(test.info().outputPath('output.txt'), 'utf8');+ expect(output).toMatch(new RegExp(`Custom exec args.*chrome-extension://${extensionId}/connect\\.html\\?`));+ }).toPass();+});+test(`fails when extension is missing in custom userDataDir`, async ({ startClient, server }) => {const userDataDir = test.info().outputPath('empty-profile');