Skip to content

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

fix: strip UTF-8 BOM when parsing JSON config files (#39420)

Yury Semikhatsky4085d4c2141c
diff --git a/packages/playwright/src/cli/client/program.ts b/packages/playwright/src/cli/client/program.ts
index c206d97818..c181c26ed4 100644
--- a/packages/playwright/src/cli/client/program.ts
+++ b/packages/playwright/src/cli/client/program.ts
@@ -264,7 +264,8 @@ async function ensureConfiguredBrowserInstalled() {
if (fs.existsSync(defaultConfigFile())) {
const { registry } = await import('playwright-core/lib/server/registry/index');
// Config exists, ensure configured browser is installed
- const config = JSON.parse(await fs.promises.readFile(defaultConfigFile(), 'utf-8')) as Config;
+ const data = await fs.promises.readFile(defaultConfigFile(), 'utf-8');
+ const config = JSON.parse(data.charCodeAt(0) === 0xFEFF ? data.slice(1) : data) as Config;
const browserName = config.browser?.browserName ?? 'chromium';
const channel = config.browser?.launchOptions?.channel;
if (!channel || channel.startsWith('chromium')) {
diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.ts
index 374e9d4597..725408c5e3 100644
--- a/packages/playwright/src/mcp/browser/config.ts
+++ b/packages/playwright/src/mcp/browser/config.ts
@@ -366,7 +366,8 @@ export async function loadConfig(configFile: string | undefined): Promise<Config
return configFromIniFile(configFile);
try {
- return JSON.parse(await fs.promises.readFile(configFile, 'utf8'));
+ const data = await fs.promises.readFile(configFile, 'utf8');
+ return JSON.parse(data.charCodeAt(0) === 0xFEFF ? data.slice(1) : data);
} catch {
return configFromIniFile(configFile);
}
diff --git a/tests/mcp/cli-config.spec.ts b/tests/mcp/cli-config.spec.ts
index a779393b9b..af44c0f75d 100644
--- a/tests/mcp/cli-config.spec.ts
+++ b/tests/mcp/cli-config.spec.ts
@@ -89,6 +89,21 @@ test('config-print prints merged config from file, env and cli', async ({ cli, s
expect(config.browser.isolated).toBe(true);
});
+test('context options with UTF-8 BOM', async ({ cli, server }, testInfo) => {
+ const config = {
+ browser: {
+ contextOptions: {
+ viewport: { width: 800, height: 600 },
+ },
+ },
+ };
+ // Write config with UTF-8 BOM prefix, as some Windows editors (Notepad, PowerShell) do.
+ await fs.promises.writeFile(testInfo.outputPath('.playwright', 'cli.config.json'), '\uFEFF' + JSON.stringify(config, null, 2));
+ await cli('open', server.PREFIX);
+ const { output } = await cli('eval', 'window.innerWidth + "x" + window.innerHeight');
+ expect(output).toContain('800x600');
+});
+
test('isolated', async ({ cli, server }, testInfo) => {
const config = {
browser: {
diff --git a/tests/mcp/config.spec.ts b/tests/mcp/config.spec.ts
index 9e0eaadfe8..3cfc229b8b 100644
--- a/tests/mcp/config.spec.ts
+++ b/tests/mcp/config.spec.ts
@@ -46,6 +46,33 @@ test('config user data dir', async ({ startClient, server }, testInfo) => {
expect(files.length).toBeGreaterThan(0);
});
+test('config with UTF-8 BOM', async ({ startClient, server }, testInfo) => {
+ server.setContent('/', `
+ <title>Title</title>
+ <body>Hello, world!</body>
+ `, '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({