Skip to content

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

fix(mcp): ignore browser config when attaching to extension (#40475)

Yury Semikhatsky5ec1b3f81222
diff --git a/packages/playwright-core/src/tools/cli-daemon/program.ts b/packages/playwright-core/src/tools/cli-daemon/program.ts
index 5bb2271087..2d1b0afe83 100644
--- a/packages/playwright-core/src/tools/cli-daemon/program.ts
+++ b/packages/playwright-core/src/tools/cli-daemon/program.ts
@@ -58,7 +58,7 @@ export function decorateProgram(program: Command) {
};
try {
- const { browser, browserInfo, canBind, ownership } = await createBrowserWithInfo(mcpConfig, mcpClientInfo);
+ const { browser, browserInfo, canBind, ownership } = await createBrowserWithInfo(mcpConfig, mcpClientInfo, options);
if (canBind)
await browser.bind(sessionName, { workspaceDir: clientInfo.workspaceDir });
const browserContext = mcpConfig.browser.isolated ? await browser.newContext(mcpConfig.browser.contextOptions) : browser.contexts()[0];
diff --git a/packages/playwright-core/src/tools/mcp/browserFactory.ts b/packages/playwright-core/src/tools/mcp/browserFactory.ts
index b22b8629c8..ad08a527f6 100644
--- a/packages/playwright-core/src/tools/mcp/browserFactory.ts
+++ b/packages/playwright-core/src/tools/mcp/browserFactory.ts
@@ -25,10 +25,11 @@ import { outputDir } from '../backend/context';
import { createExtensionBrowser } from './extensionContextFactory';
import { connectToBrowserAcrossVersions } from '../utils/connect';
import { serverRegistry } from '../../serverRegistry';
+import { resolveChannelForExtension } from './config';
// eslint-disable-next-line no-restricted-imports
import { connectToBrowser } from '../../client/connect';
-import type { FullConfig } from './config';
+import type { CLIOptions, FullConfig } from './config';
import type { ClientInfo } from '../utils/mcp/server';
// eslint-disable-next-line no-restricted-imports
import type { Playwright } from '../../client/playwright';
@@ -43,11 +44,11 @@ type BrowserWithInfo = {
};
export async function createBrowser(config: FullConfig, clientInfo: ClientInfo): Promise<playwrightTypes.Browser> {
- const { browser } = await createBrowserWithInfo(config, clientInfo);
+ const { browser } = await createBrowserWithInfo(config, clientInfo, {});
return browser;
}
-export async function createBrowserWithInfo(config: FullConfig, clientInfo: ClientInfo): Promise<BrowserWithInfo> {
+export async function createBrowserWithInfo(config: FullConfig, clientInfo: ClientInfo, cliOptions: CLIOptions): Promise<BrowserWithInfo> {
if (config.browser.remoteEndpoint)
return await createRemoteBrowser(config);
@@ -63,7 +64,8 @@ export async function createBrowserWithInfo(config: FullConfig, clientInfo: Clie
canBind = true;
ownership = 'own';
} else if (config.extension) {
- browser = await createExtensionBrowser(config, clientInfo.clientName);
+ const channel = resolveChannelForExtension(cliOptions);
+ browser = await createExtensionBrowser(channel, clientInfo.clientName);
ownership = 'attached';
} else {
browser = await createPersistentBrowser(config, clientInfo);
diff --git a/packages/playwright-core/src/tools/mcp/config.ts b/packages/playwright-core/src/tools/mcp/config.ts
index 97851b8f87..91935f40ba 100644
--- a/packages/playwright-core/src/tools/mcp/config.ts
+++ b/packages/playwright-core/src/tools/mcp/config.ts
@@ -110,8 +110,8 @@ export async function resolveConfig(config: Config): Promise<FullConfig> {
return { ...merged, browser };
}
-export async function resolveCLIConfigForMCP(cliOptions: CLIOptions, env?: NodeJS.ProcessEnv): Promise<FullConfig> {
- const envOverrides = configFromEnv(env);
+export async function resolveCLIConfigForMCP(cliOptions: CLIOptions): Promise<FullConfig> {
+ const envOverrides = configFromEnv();
const cliOverrides = configFromCLIOptions(cliOptions);
const configFile = cliOverrides.configFile ?? envOverrides.configFile;
const configInFile = await loadConfig(configFile);
@@ -129,7 +129,7 @@ export async function resolveCLIConfigForMCP(cliOptions: CLIOptions, env?: NodeJ
return { ...result, browser, configFile };
}
-export async function resolveCLIConfigForCLI(daemonProfilesDir: string, sessionName: string, options: any, env?: NodeJS.ProcessEnv): Promise<FullConfig> {
+export async function resolveCLIConfigForCLI(daemonProfilesDir: string, sessionName: string, options: any): Promise<FullConfig> {
const config = options.config ? path.resolve(options.config) : undefined;
try {
const defaultConfigFile = path.resolve('.playwright', 'cli.config.json');
@@ -149,11 +149,11 @@ export async function resolveCLIConfigForCLI(daemonProfilesDir: string, sessionN
snapshotMode: 'full',
});
- const envOverrides = configFromEnv(env);
+ const envOverrides = configFromEnv();
const configFile = daemonOverrides.configFile ?? envOverrides.configFile;
const configInFile = await loadConfig(configFile);
const configDir = configFile ? path.dirname(path.resolve(configFile)) : process.cwd();
- const globalConfigPath = path.join((env ?? process.env)['PWTEST_CLI_GLOBAL_CONFIG'] ?? os.homedir(), '.playwright', 'cli.config.json');
+ const globalConfigPath = path.join(process.env['PWTEST_CLI_GLOBAL_CONFIG'] ?? os.homedir(), '.playwright', 'cli.config.json');
const globalConfigExists = fs.existsSync(globalConfigPath);
const globalConfigInFile = await loadConfig(globalConfigExists ? globalConfigPath : undefined);
const globalConfigDir = globalConfigExists ? path.dirname(globalConfigPath) : process.cwd();
@@ -182,6 +182,12 @@ export async function resolveCLIConfigForCLI(daemonProfilesDir: string, sessionN
return { ...result, browser, configFile, skillMode: true };
}
+export function resolveChannelForExtension(cliOptions: CLIOptions): string {
+ const browser = cliOptions.browser ?? envToString(process.env.PLAYWRIGHT_MCP_BROWSER);
+ const { channel } = resolveBrowserParam(browser);
+ return channel ?? 'chrome';
+}
+
async function validateBrowserConfig(browser: MergedConfig['browser']): Promise<FullConfig['browser']> {
let browserName = browser.browserName;
if (!browserName) {
@@ -229,10 +235,8 @@ async function validateBrowserConfig(browser: MergedConfig['browser']): Promise<
return { ...browser, browserName };
}
-function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: string } {
- let browserName: 'chromium' | 'firefox' | 'webkit' | undefined;
- let channel: string | undefined;
- switch (cliOptions.browser) {
+function resolveBrowserParam(browserOption: string | undefined): { browserName: 'chromium' | 'firefox' | 'webkit', channel?: string } {
+ switch (browserOption) {
case 'chrome':
case 'chrome-beta':
case 'chrome-canary':
@@ -241,21 +245,20 @@ function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: s
case 'msedge-beta':
case 'msedge-canary':
case 'msedge-dev':
- browserName = 'chromium';
- channel = cliOptions.browser;
- break;
+ return { browserName: 'chromium', channel: browserOption };
case 'chromium':
- // Never use old headless.
- browserName = 'chromium';
- channel = 'chrome-for-testing';
- break;
+ return { browserName: 'chromium', channel: 'chrome-for-testing' };
case 'firefox':
- browserName = 'firefox';
- break;
+ return { browserName: 'firefox' };
case 'webkit':
- browserName = 'webkit';
- break;
+ return { browserName: 'webkit' };
+ default:
+ return { browserName: 'chromium', channel: 'chrome' };
}
+}
+
+function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: string } {
+ const { browserName, channel } = resolveBrowserParam(cliOptions.browser);
// Launch options
const launchOptions: playwrightTypes.LaunchOptions = {
@@ -349,8 +352,8 @@ function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: s
return { ...config, configFile: cliOptions.config };
}
-export function configFromEnv(env?: NodeJS.ProcessEnv): Config & { configFile?: string } {
- const e = env ?? process.env;
+export function configFromEnv(): Config & { configFile?: string } {
+ const e = process.env;
const options: CLIOptions = {};
options.allowedHosts = commaSeparatedList(e.PLAYWRIGHT_MCP_ALLOWED_HOSTS);
options.allowedOrigins = semicolonSeparatedList(e.PLAYWRIGHT_MCP_ALLOWED_ORIGINS);
diff --git a/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts b/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts
index cf78af1bc5..cf3e4ac72e 100644
--- a/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts
+++ b/packages/playwright-core/src/tools/mcp/extensionContextFactory.ts
@@ -22,23 +22,17 @@ import { isPlaywrightExtensionInstalled, playwrightExtensionInstallUrl } from '.
import { CDPRelayServer } from './cdpRelay';
import type * as playwrightTypes from '../../..';
-import type { FullConfig } from './config';
const debugLogger = debug('pw:mcp:relay');
-export async function createExtensionBrowser(config: FullConfig, clientName: string): Promise<playwrightTypes.Browser> {
- const channel = config.browser.launchOptions.channel || 'chrome';
- const userDataDir = config.browser.userDataDir ?? defaultUserDataDirForChannel(channel);
+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}`);
const httpServer = createHttpServer();
await startHttpServer(httpServer, {});
- const relay = new CDPRelayServer(
- httpServer,
- channel,
- config.browser.userDataDir,
- config.browser.launchOptions.executablePath);
+ const relay = new CDPRelayServer(httpServer, channel, userDataDir);
debugLogger(`CDP relay server started, extension endpoint: ${relay.extensionEndpoint()}.`);
try {
diff --git a/packages/playwright-core/src/tools/mcp/program.ts b/packages/playwright-core/src/tools/mcp/program.ts
index e6157cb1a8..602860358a 100644
--- a/packages/playwright-core/src/tools/mcp/program.ts
+++ b/packages/playwright-core/src/tools/mcp/program.ts
@@ -123,13 +123,13 @@ export function decorateMCPCommand(command: Command) {
toolSchemas: tools.map(tool => tool.schema),
create: async (clientInfo: ClientInfo) => {
if (useSharedBrowser && clientCount === 0) {
- const { browser, canBind } = await createBrowserWithInfo(config, clientInfo);
+ const { browser, canBind } = await createBrowserWithInfo(config, clientInfo, options);
sharedBrowser = browser;
if (canBind)
await browser.bind(clientInfo.clientName, { workspaceDir: clientInfo.cwd });
}
clientCount++;
- const { browser, canBind } = sharedBrowser ? { browser: sharedBrowser, canBind: false } : await createBrowserWithInfo(config, clientInfo);
+ const { browser, canBind } = sharedBrowser ? { browser: sharedBrowser, canBind: false } : await createBrowserWithInfo(config, clientInfo, options);
if (canBind) {
const count = (clientNameCounters.get(clientInfo.clientName) ?? 0) + 1;
clientNameCounters.set(clientInfo.clientName, count);
diff --git a/tests/extension/cli.spec.ts b/tests/extension/cli.spec.ts
index 4125b667f3..11a6a73242 100644
--- a/tests/extension/cli.spec.ts
+++ b/tests/extension/cli.spec.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import fs from 'fs/promises';
import { test as base, expect, extensionId, clickAllowAndSelect } from './extension-fixtures';
import type { CliResult } from './extension-fixtures';
@@ -23,18 +22,15 @@ import type { Page } from 'playwright';
const test = base.extend<{
startAttach: () => Promise<{ confirmationPage: Page, cliPromise: Promise<CliResult> }>,
}>({
- startAttach: async ({ browserWithExtension, cli }, use, testInfo) => {
+ startAttach: async ({ browserWithExtension, cli }, use) => {
await use(async () => {
- await fs.writeFile(testInfo.outputPath('cli-config.json'), JSON.stringify({
- browser: {
- userDataDir: browserWithExtension.userDataDir,
- }
- }, null, 2));
const browserContext = await browserWithExtension.launch();
const confirmationPagePromise = browserContext.waitForEvent('page', page =>
page.url().startsWith(`chrome-extension://${extensionId}/connect.html`)
);
- const cliPromise = cli('attach', '--extension=chromium', `--config=cli-config.json`);
+ const cliPromise = cli(['attach', '--extension=chromium'], {
+ env: { PWTEST_EXTENSION_USER_DATA_DIR: browserWithExtension.userDataDir },
+ });
const confirmationPage = await confirmationPagePromise;
return { confirmationPage, cliPromise };
});
@@ -81,7 +77,7 @@ test('attach <url> --extension', async ({ startAttach, cli, server }) => {
}
{
- const { output } = await cli('-s=chromium', 'goto', server.HELLO_WORLD);
+ const { output } = await cli(['-s=chromium', 'goto', server.HELLO_WORLD]);
expect(output).toContain(`### Page`);
expect(output).toContain(`- Page URL: ${server.HELLO_WORLD}`);
expect(output).toContain(`- Page Title: Title`);
diff --git a/tests/extension/extension-fixtures.ts b/tests/extension/extension-fixtures.ts
index b2936e5dc0..b53fc598c2 100644
--- a/tests/extension/extension-fixtures.ts
+++ b/tests/extension/extension-fixtures.ts
@@ -44,7 +44,7 @@ export type TestFixtures = {
browserWithExtension: BrowserWithExtension,
pathToExtension: string,
startExtensionClient: (env?: Record<string, string>) => Promise<{ browserContext: BrowserContext, client: Client }>,
- cli: (...args: string[]) => Promise<CliResult>;
+ cli: (args: string[], options?: { env?: Record<string, string> }) => Promise<CliResult>;
};
type WorkerFixtures = {
@@ -120,8 +120,8 @@ export const test = base.extend<TestFixtures, WorkerFixtures & ExtensionTestOpti
},
cli: async ({ mcpBrowser }, use, testInfo) => {
- await use(async (...args: string[]) => {
- return await runCli(args, { mcpBrowser, testInfo });
+ await use(async (args, options) => {
+ return await runCli(args, { mcpBrowser, testInfo, env: options?.env });
});
// Cleanup sessions
@@ -156,7 +156,7 @@ function cliEnv() {
async function runCli(
args: string[],
- options: { mcpBrowser?: string, testInfo: any },
+ options: { mcpBrowser?: string, testInfo: any, env?: Record<string, string> },
): Promise<CliResult> {
const stepTitle = `cli ${args.join(' ')}`;
@@ -177,6 +177,7 @@ async function runCli(
...cliEnv(),
PLAYWRIGHT_MCP_BROWSER: options.mcpBrowser,
PLAYWRIGHT_MCP_HEADLESS: 'false',
+ ...options.env,
},
detached: true,
});
@@ -207,11 +208,9 @@ async function runCli(
export async function startWithExtensionFlag(browserWithExtension: BrowserWithExtension, startClient: StartClient, env?: Record<string, string>): Promise<Client> {
const { client } = await startClient({
args: [`--extension`],
- env,
- config: {
- browser: {
- userDataDir: browserWithExtension.userDataDir,
- }
+ env: {
+ ...env,
+ PWTEST_EXTENSION_USER_DATA_DIR: browserWithExtension.userDataDir,
},
});
return client;
diff --git a/tests/extension/extension.spec.ts b/tests/extension/extension.spec.ts
index 35a9d11fe1..42b9b19c1c 100644
--- a/tests/extension/extension.spec.ts
+++ b/tests/extension/extension.spec.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import fs from 'fs/promises';
import { test, testWithOldExtensionVersion, expect, extensionId, clickAllowAndSelect, startWithExtensionFlag } from './extension-fixtures';
test(`navigate with extension`, async ({ startExtensionClient, server }) => {
@@ -229,40 +228,12 @@ 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`, 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 });
-
- const { client } = await startClient({
- args: [`--extension`],
- config: {
- browser: {
- launchOptions: {
- executablePath,
- },
- }
- },
- });
-
- // The call hangs as MCP server never connects to the extension.
- 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');
const { client } = await startClient({
args: [`--extension`],
- config: {
- browser: { userDataDir },
- },
+ env: { PWTEST_EXTENSION_USER_DATA_DIR: userDataDir },
});
expect(await client.callTool({
@@ -284,13 +255,9 @@ test(`bypass connection dialog with token`, async ({ browserWithExtension, start
const { client } = await startClient({
args: [`--extension`],
- config: {
- browser: {
- userDataDir: browserWithExtension.userDataDir,
- }
- },
env: {
PLAYWRIGHT_MCP_EXTENSION_TOKEN: value,
+ PWTEST_EXTENSION_USER_DATA_DIR: browserWithExtension.userDataDir,
},
});