/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import fs from 'node:fs';
import { test, expect, parseResponse } from './fixtures';
import type { Config } from '../../packages/playwright-core/src/tools/mcp/config.d';
test('config user data dir', async ({ startClient, server }, testInfo) => {
server.setContent('/', `
Title
Hello, world!
`, 'text/html');
const config: Config = {
browser: {
userDataDir: testInfo.outputPath('user-data-dir'),
},
};
const configPath = testInfo.outputPath('config.json');
await fs.promises.writeFile(configPath, JSON.stringify(config, null, 2));
const { client } = await startClient({ args: ['--config', configPath] });
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toHaveResponse({
snapshot: expect.stringContaining(`Hello, world!`),
});
const files = await fs.promises.readdir(config.browser!.userDataDir!);
expect(files.length).toBeGreaterThan(0);
});
test('config with UTF-8 BOM', async ({ startClient, server }, testInfo) => {
server.setContent('/', `
Title
Hello, world!
`, 'text/html');
const config: Config = {
browser: {
userDataDir: testInfo.outputPath('user-data-dir'),
},
};
const configPath = testInfo.outputPath('config.json');
// Write config with UTF-8 BOM prefix, as some Windows editors (Notepad, PowerShell) do.
await fs.promises.writeFile(configPath, '\uFEFF' + JSON.stringify(config, null, 2));
const { client } = await startClient({ args: ['--config', configPath] });
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toHaveResponse({
snapshot: expect.stringContaining(`Hello, world!`),
});
const files = await fs.promises.readdir(config.browser!.userDataDir!);
expect(files.length).toBeGreaterThan(0);
});
test('executable path', async ({ startClient, server }, testInfo) => {
const { client } = await startClient({ args: ['--executable-path', testInfo.outputPath('missing-executable')] });
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.PREFIX },
})).toHaveResponse({
isError: true,
error: expect.stringMatching(/Failed to launch.*missing-executable/),
});
});
test.describe(() => {
test.use({ mcpBrowser: '' });
test('browserName', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright-mcp/issues/458' } }, async ({ startClient }, testInfo) => {
const config: Config = {
browser: {
browserName: 'firefox',
},
};
const configPath = testInfo.outputPath('config.json');
await fs.promises.writeFile(configPath, JSON.stringify(config, null, 2));
const { client } = await startClient({ args: ['--config', configPath] });
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: 'data:text/html,' },
})).toHaveResponse({
page: expect.stringContaining(`Firefox`),
});
});
});
test('config ignoreDefaultArgs merged with persistent mode defaults', async ({ startClient, mcpBrowser }, testInfo) => {
test.skip(!['chrome', 'chromium', 'msedge'].includes(mcpBrowser!), 'chrome://version is Chromium-specific');
const config: Config = {
browser: {
userDataDir: testInfo.outputPath('user-data-dir'),
launchOptions: {
ignoreDefaultArgs: ['--password-store=basic'],
},
},
};
const { client } = await startClient({ config });
await client.callTool({
name: 'browser_navigate',
arguments: { url: 'chrome://version' },
});
const result = await client.callTool({
name: 'browser_evaluate',
arguments: { function: '() => document.getElementById("command_line").innerText' },
});
const commandLine = result.content[0].text;
// User-specified arg should be removed.
expect(commandLine).not.toContain('--password-store=basic');
// Persistent mode's built-in --disable-extensions should also be removed.
expect(commandLine).not.toContain('--disable-extensions');
// Other default args should still be present.
expect(commandLine).toContain('--use-mock-keychain');
});
test('browser_get_config returns merged config from file, env and cli', async ({ startClient }) => {
const { client } = await startClient({
config: {
browser: {
contextOptions: {
viewport: { width: 800, height: 600 },
},
},
capabilities: ['config'],
timeouts: {
action: 10000,
navigation: 30000,
},
},
args: ['--isolated'],
env: {
PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION: '45000',
},
});
const result = await client.callTool({
name: 'browser_get_config',
});
expect(result.isError).toBeFalsy();
const parsed = parseResponse(result);
const config = JSON.parse(parsed.result);
// From config file.
expect(config.browser.contextOptions.viewport).toEqual({ width: 800, height: 600 });
expect(config.timeouts.action).toBe(10000);
// Env var overrides file value.
expect(config.timeouts.navigation).toBe(45000);
// From CLI arg (--isolated).
expect(config.browser.isolated).toBe(true);
});