Skip to content

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

chore(cli): create profile folder unconditionally (#39044)

Pavel Feldman19c31c12d6bd
diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.ts
index 0eccd0d064..aa69f31445 100644
--- a/packages/playwright/src/mcp/browser/config.ts
+++ b/packages/playwright/src/mcp/browser/config.ts
@@ -109,7 +109,7 @@ export const defaultConfig: FullConfig = {
const defaultDaemonConfig = (cliOptions: CLIOptions) => mergeConfig(defaultConfig, {
browser: {
- userDataDir: cliOptions.extension ? undefined : '<daemon-data-dir>', // Use default user profile with extension.
+ userDataDir: '<daemon-data-dir>',
launchOptions: {
headless: !cliOptions.daemonHeaded,
},
@@ -167,7 +167,12 @@ export async function resolveCLIConfig(cliOptions: CLIOptions): Promise<FullConf
if (result.browser.userDataDir === '<daemon-data-dir>') {
// No custom value provided, use the daemon data dir.
const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;
- result.browser.userDataDir = `${cliOptions.daemonDataDir}-${browserToken}`;
+ const userDataDir = `${cliOptions.daemonDataDir}-${browserToken}`;
+ await fs.promises.mkdir(userDataDir, { recursive: true });
+
+ // Use default user profile with extension.
+ if (!result.extension)
+ result.browser.userDataDir = userDataDir;
}
if (result.browser.browserName === 'chromium' && result.browser.launchOptions.chromiumSandbox === undefined) {
diff --git a/packages/playwright/src/mcp/terminal/commands.ts b/packages/playwright/src/mcp/terminal/commands.ts
index fe74a66fb1..781ddc8ece 100644
--- a/packages/playwright/src/mcp/terminal/commands.ts
+++ b/packages/playwright/src/mcp/terminal/commands.ts
@@ -535,8 +535,11 @@ const config = declareCommand({
name: 'config',
description: 'Restart session with new config, defaults to `playwright-cli.json`',
category: 'config',
- args: z.object({
+ options: z.object({
+ browser: z.string().optional().describe('browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.'),
config: z.string().optional().describe('Path to the configuration file'),
+ isolated: z.boolean().optional().describe('keep the browser profile in memory, do not save it to disk.'),
+ headed: z.boolean().optional().describe('run browser in headed mode'),
}),
toolName: '',
toolParams: () => ({}),
diff --git a/packages/playwright/src/mcp/terminal/program.ts b/packages/playwright/src/mcp/terminal/program.ts
index 51ec1f3f37..8b2a8f9f81 100644
--- a/packages/playwright/src/mcp/terminal/program.ts
+++ b/packages/playwright/src/mcp/terminal/program.ts
@@ -34,7 +34,14 @@ export type StructuredResponse = {
sections: Section[];
};
-type SessionOptions = { config?: string, headed?: boolean, extension?: boolean, daemonVersion: string };
+type SessionOptions = {
+ config?: string;
+ headed?: boolean;
+ extension?: boolean;
+ daemonVersion: string;
+ browser?: string;
+ isolated?: boolean;
+};
class Session {
readonly name: string;
@@ -205,6 +212,8 @@ class Session {
const configArg = configFile !== undefined ? [`--config=${configFile}`] : [];
const headedArg = this._options.headed ? [`--daemon-headed`] : [];
const extensionArg = this._options.extension ? [`--extension`] : [];
+ const isolatedArg = this._options.isolated ? [`--isolated`] : [];
+ const browserArg = this._options.browser ? [`--browser=${this._options.browser}`] : [];
const outLog = path.join(daemonProfilesDir, 'out.log');
const errLog = path.join(daemonProfilesDir, 'err.log');
@@ -221,6 +230,8 @@ class Session {
...configArg,
...headedArg,
...extensionArg,
+ ...isolatedArg,
+ ...browserArg,
], {
detached: true,
stdio: ['ignore', out, err],
@@ -341,7 +352,7 @@ class SessionManager {
session = new Session(sessionName, this.options);
this.sessions.set(sessionName, session);
}
- await session.restart({ ...this.options, ...args, config: args._[1] });
+ await session.restart({ ...this.options, ...args });
session.close();
}
@@ -415,15 +426,21 @@ const daemonProfilesDir = (() => {
return path.join(localCacheDir, 'ms-playwright', 'daemon', installationDirHash);
})();
+const booleanOptions = [
+ 'extension',
+ 'headed',
+ 'help',
+ 'isolated',
+ 'version',
+];
+
export async function program(options: { version: string }) {
const argv = process.argv.slice(2);
- const args = require('minimist')(argv, {
- boolean: ['help', 'version', 'headed', 'extension'],
- });
- if (!argv.includes('--headed') && !argv.includes('--no-headed'))
- delete args.headed;
- if (!argv.includes('--extension'))
- delete args.extension;
+ const args = require('minimist')(argv, { boolean: booleanOptions });
+ for (const option of booleanOptions) {
+ if (!argv.includes(`--${option}`) && !argv.includes(`--no-${option}`))
+ delete args[option];
+ }
const help = require('./help.json');
const commandName = args._[0];
diff --git a/tests/mcp/cli.spec.ts b/tests/mcp/cli.spec.ts
index b6601adab5..fe817a6caa 100644
--- a/tests/mcp/cli.spec.ts
+++ b/tests/mcp/cli.spec.ts
@@ -539,7 +539,7 @@ test.describe('config', () => {
const configPath = testInfo.outputPath('session-config.json');
await fs.promises.writeFile(configPath, JSON.stringify(config, null, 2));
- const { output: configureOutput } = await cli('config', configPath);
+ const { output: configureOutput } = await cli('config', '--config=' + configPath);
expect(configureOutput).toContain(`- Using config file at \`session-config.json\`.`);
await cli('open', server.PREFIX);
@@ -597,3 +597,17 @@ test.describe('folders', () => {
}
});
});
+
+test.describe('isolated', () => {
+ test('should not save user data', async ({ cli, server, mcpBrowser }, testInfo) => {
+ await cli('open', server.HELLO_WORLD, '--isolated');
+ const dataDir = testInfo.outputPath('daemon', 'ud-default-' + mcpBrowser);
+ expect(fs.existsSync(dataDir)).toBe(true);
+ const listFiles = await fs.promises.readdir(dataDir);
+ expect(listFiles).toEqual([]);
+
+ const { output: listOutput } = await cli('session-list');
+ expect(listOutput).toContain('Sessions:');
+ expect(listOutput).toContain('default (live)');
+ });
+});