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(cli): consider provided userDataDir a persistent session (#39578)
Pavel Feldmane5e81169541a
diff --git a/packages/playwright-core/src/cli/daemon/program.ts b/packages/playwright-core/src/cli/daemon/program.tsindex 7ef2059079..5ce7ceefa1 100644--- a/packages/playwright-core/src/cli/daemon/program.ts+++ b/packages/playwright-core/src/cli/daemon/program.ts@@ -49,7 +49,8 @@ export function decorateCLICommand(command: Command, version: string) {try {const browser = await createBrowser(mcpConfig, mcpClientInfo);const browserContext = mcpConfig.browser.isolated ? await browser.newContext(mcpConfig.browser.contextOptions) : browser.contexts()[0];- const socketPath = await startCliDaemonServer(sessionName, browserContext, mcpConfig, clientInfo, { ...options, exitOnClose: true });+ const persistent = options.persistent || options.profile || mcpConfig.browser.userDataDir ? true : undefined;+ const socketPath = await startCliDaemonServer(sessionName, browserContext, mcpConfig, clientInfo, { persistent, exitOnClose: true });console.log(`### Success\nDaemon listening on ${socketPath}`);console.log('<EOF>');try {@@ -79,13 +80,9 @@ export async function resolveCLIConfig(clientInfo: ClientInfo, sessionName: stri} catch {}- if (!options.persistent && options.profile)- options.persistent = true;-const daemonOverrides = configUtils.configFromCLIOptions({config: options.config,browser: options.browser,- isolated: options.persistent === true ? false : undefined,headless: options.headed ? false : undefined,extension: options.extension,userDataDir: options.profile,@@ -102,8 +99,7 @@ export async function resolveCLIConfig(clientInfo: ClientInfo, sessionName: stribrowser: {launchOptions: {headless: true,- },- isolated: true,+ }}});@@ -111,7 +107,10 @@ export async function resolveCLIConfig(clientInfo: ClientInfo, sessionName: striresult = configUtils.mergeConfig(result, daemonOverrides);result = configUtils.mergeConfig(result, envOverrides);- if (!result.extension && !result.browser.userDataDir) {+ if (result.browser.isolated === undefined)+ result.browser.isolated = !options.profile && !options.persistent && !result.browser.userDataDir;++ if (!result.extension && !result.browser.isolated && !result.browser.userDataDir) {// No custom value provided, use the daemon data dir.const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;const userDataDir = path.resolve(clientInfo.daemonProfilesDir, `ud-${sessionName}-${browserToken}`);diff --git a/packages/playwright-core/src/mcp/config.ts b/packages/playwright-core/src/mcp/config.tsindex 67a8a21be8..495d2d9a91 100644--- a/packages/playwright-core/src/mcp/config.ts+++ b/packages/playwright-core/src/mcp/config.ts@@ -85,7 +85,6 @@ export const defaultConfig: FullConfig = {contextOptions: {viewport: null,},- isolated: false,},server: {},timeouts: {@@ -135,6 +134,9 @@ export async function validateConfig(config: FullConfig): Promise<void> {config.browser.launchOptions.chromiumSandbox = true;}+ if (config.browser.isolated && config.browser.userDataDir)+ throw new Error('Browser userDataDir is not supported in isolated mode.');+if (config.browser.initScript) {for (const script of config.browser.initScript) {if (!await fileExistsAsync(script))@@ -339,7 +341,7 @@ export function mergeConfig(base: FullConfig, overrides: Config): FullConfig {...pickDefined(base.browser),...pickDefined(overrides.browser),browserName: overrides.browser?.browserName ?? base.browser?.browserName ?? 'chromium',- isolated: overrides.browser?.isolated ?? base.browser?.isolated ?? false,+ isolated: overrides.browser?.isolated ?? base.browser?.isolated,launchOptions: {...pickDefined(base.browser?.launchOptions),...pickDefined(overrides.browser?.launchOptions),diff --git a/tests/mcp/cli-config.spec.ts b/tests/mcp/cli-config.spec.tsindex af44c0f75d..e438b26018 100644--- a/tests/mcp/cli-config.spec.ts+++ b/tests/mcp/cli-config.spec.ts@@ -63,29 +63,16 @@ test('config-print prints merged config from file, env and cli', async ({ cli, s};await fs.promises.writeFile(testInfo.outputPath('.playwright', 'cli.config.json'), JSON.stringify(fileConfig, null, 2));- // Env var overrides navigation timeout (30000 from file → 45000 from env).const env = { PLAYWRIGHT_MCP_TIMEOUT_NAVIGATION: '45000' };-- // CLI arg: --in-memory sets browser.isolated = true.- await cli('open', '--in-memory', server.PREFIX, { env });-- // Query the resolved config from the running daemon.+ await cli('open', server.PREFIX, { env });const { output } = await cli('config-print', { env });const configBegin = output.indexOf('{');expect(configBegin).not.toBe(-1);const config = JSON.parse(output.slice(configBegin));-- // From Playwright cli defaults.expect(config.browser.launchOptions.headless).toBe(true);-- // 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 (--in-memory).expect(config.browser.isolated).toBe(true);});diff --git a/tests/mcp/cli-persistent.spec.ts b/tests/mcp/cli-persistent.spec.tsnew file mode 100644index 0000000000..69a49383b0--- /dev/null+++ b/tests/mcp/cli-persistent.spec.ts@@ -0,0 +1,34 @@+/**+ * 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 'fs';+import { test, expect } from './cli-fixtures';++test('should use userDataDir from config without --persistent flag', async ({ cli, server }, testInfo) => {+ const customDir = testInfo.outputPath('my-profile');+ const config = {+ browser: {+ userDataDir: customDir,+ },+ };+ await fs.promises.writeFile(testInfo.outputPath('config.json'), JSON.stringify(config, null, 2));+ await cli('open', `--config=config.json`, server.HELLO_WORLD);+ expect(fs.existsSync(customDir)).toBe(true);++ const { output: listOutput } = await cli('list');+ expect(listOutput).not.toContain('user-data-dir: <in-memory>');+ expect(listOutput).toContain(`user-data-dir: ${customDir}`);+});diff --git a/tests/mcp/http.spec.ts b/tests/mcp/http.spec.tsindex 555bf67c64..e3d997c1c8 100644--- a/tests/mcp/http.spec.ts+++ b/tests/mcp/http.spec.ts@@ -37,7 +37,7 @@ const test = baseTest.extend<{ serverEndpoint: (options?: { args?: string[], noPcp = spawn('node', [...mcpServerPath,...(options?.noPort ? [] : ['--port=0']),- '--user-data-dir=' + userDataDir,+ ...(!options?.args?.includes('--isolated') ? ['--user-data-dir=' + userDataDir] : []),...(mcpHeadless ? ['--headless'] : []),...(options?.args || []),], {diff --git a/tests/mcp/sse.spec.ts b/tests/mcp/sse.spec.tsindex 8af6c1a1e9..2785a0c81e 100644--- a/tests/mcp/sse.spec.ts+++ b/tests/mcp/sse.spec.ts@@ -34,7 +34,7 @@ const test = baseTest.extend<{ serverEndpoint: (options?: { args?: string[], noPcp = spawn('node', [...mcpServerPath,...(options?.noPort ? [] : ['--port=0']),- '--user-data-dir=' + userDataDir,+ ...(!options?.args?.includes('--isolated') ? ['--user-data-dir=' + userDataDir] : []),...(mcpHeadless ? ['--headless'] : []),...(options?.args || []),], {