Skip to content

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

chore(mcp): split notion of workspace and output dirs (#39094)

Pavel Feldman2df819d1be23
diff --git a/packages/playwright/src/mcp/browser/browserContextFactory.ts b/packages/playwright/src/mcp/browser/browserContextFactory.ts
index 819a680e2d..fe79c2282a 100644
--- a/packages/playwright/src/mcp/browser/browserContextFactory.ts
+++ b/packages/playwright/src/mcp/browser/browserContextFactory.ts
@@ -354,13 +354,13 @@ export class SharedContextFactory implements BrowserContextFactory {
async function computeTracesDir(config: FullConfig, clientInfo: ClientInfo): Promise<string | undefined> {
if (!config.saveTrace && !config.capabilities?.includes('devtools'))
return;
- return await outputFile(config, clientInfo, `traces`, { origin: 'code', title: 'Collecting trace' });
+ return await outputFile(config, clientInfo, `traces`, { origin: 'code' });
}
async function browserContextOptionsFromConfig(config: FullConfig, clientInfo: ClientInfo): Promise<playwright.BrowserContextOptions> {
const result = { ...config.browser.contextOptions };
if (config.saveVideo) {
- const dir = await outputFile(config, clientInfo, `videos`, { origin: 'code', title: 'Saving video' });
+ const dir = await outputFile(config, clientInfo, `videos`, { origin: 'code' });
result.recordVideo = {
dir,
size: config.saveVideo,
diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.ts
index 916a2e81bf..342be44d48 100644
--- a/packages/playwright/src/mcp/browser/config.ts
+++ b/packages/playwright/src/mcp/browser/config.ts
@@ -387,42 +387,47 @@ async function loadConfig(configFile: string | undefined): Promise<Config> {
}
}
-function tmpDir(): string {
- return path.join(process.env.PW_TMPDIR_FOR_TEST ?? os.tmpdir(), 'playwright-mcp-output');
+// These methods should return resolved absolute file names.
+
+export function workspaceDir(clientInfo: ClientInfo): string {
+ return path.resolve(firstRootPath(clientInfo) ?? process.cwd());
+}
+
+export async function workspaceFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, perCallWorkspaceDir?: string): Promise<string> {
+ const workspace = perCallWorkspaceDir ?? workspaceDir(clientInfo);
+ const resolvedName = path.resolve(workspace, fileName);
+ await checkFile(config, clientInfo, resolvedName, { origin: 'code' });
+ return resolvedName;
}
export function outputDir(config: FullConfig, clientInfo: ClientInfo): string {
+ if (config.outputDir)
+ return path.resolve(config.outputDir);
const rootPath = firstRootPath(clientInfo);
- return config.outputDir
- ?? (rootPath ? path.join(rootPath, '.playwright-mcp') : undefined)
- ?? path.join(tmpDir(), String(clientInfo.timestamp));
+ if (rootPath)
+ return path.resolve(rootPath, config.skillMode ? '.playwright-cli' : '.playwright-mcp');
+ const tmpDir = process.env.PW_TMPDIR_FOR_TEST ?? os.tmpdir();
+ return path.resolve(tmpDir, 'playwright-mcp-output', String(clientInfo.timestamp));
}
-export async function outputFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' | 'web', title: string }): Promise<string> {
- const file = await resolveFile(config, clientInfo, fileName, options);
- await fs.promises.mkdir(path.dirname(file), { recursive: true });
- debug('pw:mcp:file')(options.title, file);
- return file;
+export async function outputFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' }): Promise<string> {
+ const resolvedFile = path.resolve(outputDir(config, clientInfo), fileName);
+ await checkFile(config, clientInfo, resolvedFile, options);
+ await fs.promises.mkdir(path.dirname(resolvedFile), { recursive: true });
+ debug('pw:mcp:file')(resolvedFile);
+ return resolvedFile;
}
-async function resolveFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' | 'web' }): Promise<string> {
- const dir = outputDir(config, clientInfo);
-
+async function checkFile(config: FullConfig, clientInfo: ClientInfo, resolvedFilename: string, options: { origin: 'code' | 'llm' }) {
// Trust code.
if (options.origin === 'code')
- return path.resolve(dir, fileName);
+ return;
// Trust llm to use valid characters in file names.
- if (options.origin === 'llm') {
- fileName = fileName.split('\\').join('/');
- const resolvedFile = path.resolve(dir, fileName);
- if (!resolvedFile.startsWith(path.resolve(dir) + path.sep))
- throw new Error(`Resolved file path ${resolvedFile} is outside of the output directory ${dir}. Use relative file names to stay within the output directory.`);
- return resolvedFile;
- }
-
- // Do not trust web, at all.
- return path.join(dir, sanitizeForFilePath(fileName));
+ const output = outputDir(config, clientInfo);
+ const workspace = workspaceDir(clientInfo);
+ if (!resolvedFilename.startsWith(output) && !resolvedFilename.startsWith(workspace))
+ throw new Error(`Resolved file path ${resolvedFilename} is outside of the output directory ${output} and workspace directory ${workspace}. Use relative file names to stay within the output directory.`);
}
function pickDefined<T extends object>(obj: T | undefined): Partial<T> {
@@ -549,11 +554,3 @@ function envToBoolean(value: string | undefined): boolean | undefined {
function envToString(value: string | undefined): string | undefined {
return value ? value.trim() : undefined;
}
-
-function sanitizeForFilePath(s: string) {
- const sanitize = (s: string) => s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
- const separator = s.lastIndexOf('.');
- if (separator === -1)
- return sanitize(s);
- return sanitize(s.substring(0, separator)) + '.' + sanitize(s.substring(separator + 1));
-}
diff --git a/packages/playwright/src/mcp/browser/context.ts b/packages/playwright/src/mcp/browser/context.ts
index fe28c2de71..2afec4d974 100644
--- a/packages/playwright/src/mcp/browser/context.ts
+++ b/packages/playwright/src/mcp/browser/context.ts
@@ -14,15 +14,16 @@
* limitations under the License.
*/
+import os from 'os';
+
import { debug } from 'playwright-core/lib/utilsBundle';
import { escapeWithQuotes } from 'playwright-core/lib/utils';
import { selectors } from 'playwright-core';
import { fileURLToPath } from 'url';
-import os from 'os';
import { logUnhandledError } from '../log';
import { Tab } from './tab';
-import { outputFile } from './config';
+import { outputFile, workspaceFile } from './config';
import type * as playwright from '../../../types/test';
import type { FullConfig } from './config';
@@ -50,6 +51,13 @@ export type RouteEntry = {
handler: (route: playwright.Route) => Promise<void>;
};
+export type FilenameTemplate = {
+ prefix: string;
+ ext: string;
+ suggestedFilename?: string;
+ date?: Date;
+};
+
export class Context {
readonly config: FullConfig;
readonly sessionLog: SessionLog | undefined;
@@ -129,8 +137,13 @@ export class Context {
return url;
}
- async outputFile(fileName: string, options: { origin: 'code' | 'llm' | 'web', title: string }): Promise<string> {
- return outputFile(this.config, this._clientInfo, fileName, options);
+ async workspaceFile(fileName: string, perCallWorkspaceDir: string | undefined): Promise<string> {
+ return await workspaceFile(this.config, this._clientInfo, fileName, perCallWorkspaceDir);
+ }
+
+ async outputFile(template: FilenameTemplate, options: { origin: 'code' | 'llm' }): Promise<string> {
+ const baseName = template.suggestedFilename || `${template.prefix}-${(template.date ?? new Date()).toISOString().replace(/[:.]/g, '-')}${template.ext ? '.' + template.ext : ''}`;
+ return await outputFile(this.config, this._clientInfo, baseName, options);
}
private _onPageCreated(page: playwright.Page) {
diff --git a/packages/playwright/src/mcp/browser/logFile.ts b/packages/playwright/src/mcp/browser/logFile.ts
index 05773d8efc..5fb2312af6 100644
--- a/packages/playwright/src/mcp/browser/logFile.ts
+++ b/packages/playwright/src/mcp/browser/logFile.ts
@@ -16,7 +16,6 @@
import fs from 'fs';
-import { dateAsFileName } from './tools/utils';
import { logUnhandledError } from '../log';
import type { Context } from './context';
@@ -79,7 +78,7 @@ export class LogFile {
private async _write(wallTime: number, text: () => string | Promise<string>) {
if (this._stopped)
return;
- this._file ??= await this._context.outputFile(dateAsFileName(this._filePrefix, 'log', new Date(this._startTime)), { origin: 'code', title: this._title });
+ this._file ??= await this._context.outputFile({ prefix: this._filePrefix, ext: 'log', date: new Date(this._startTime) }, { origin: 'code' });
const relativeTime = Math.round(wallTime - this._startTime);
const renderedText = await text();
const logLine = `[${String(relativeTime).padStart(8, ' ')}ms] ${renderedText}\n`;
diff --git a/packages/playwright/src/mcp/browser/response.ts b/packages/playwright/src/mcp/browser/response.ts
index ff5d20452c..b93827ea6b 100644
--- a/packages/playwright/src/mcp/browser/response.ts
+++ b/packages/playwright/src/mcp/browser/response.ts
@@ -19,22 +19,15 @@ import path from 'path';
import { debug } from 'playwright-core/lib/utilsBundle';
import { renderModalStates, shouldIncludeMessage } from './tab';
-import { dateAsFileName } from './tools/utils';
import { scaleImageToFitMessage } from './tools/screenshot';
import type { TabHeader } from './tab';
import type { LogChunk } from './logFile';
import type { CallToolResult, ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';
-import type { Context } from './context';
+import type { Context, FilenameTemplate } from './context';
export const requestDebug = debug('pw:mcp:request');
-type FilenameTemplate = {
- prefix: string;
- ext: string;
- suggestedFilename?: string;
-};
-
type ResolvedFile = {
fileName: string;
relativeName: string;
@@ -58,28 +51,28 @@ export class Response {
readonly toolName: string;
readonly toolArgs: Record<string, any>;
- private _relativeTo: string | undefined;
+ private _clientWorkspace: string | undefined;
private _imageResults: { data: Buffer, imageType: 'png' | 'jpeg' }[] = [];
constructor(context: Context, toolName: string, toolArgs: Record<string, any>, relativeTo?: string) {
this._context = context;
this.toolName = toolName;
this.toolArgs = toolArgs;
- this._relativeTo = relativeTo ?? context.firstRootPath();
+ this._clientWorkspace = relativeTo ?? context.firstRootPath();
}
private _computRelativeTo(fileName: string): string {
- if (this._relativeTo)
- return path.relative(this._relativeTo, fileName);
+ if (this._clientWorkspace)
+ return path.relative(this._clientWorkspace, fileName);
return fileName;
}
- async resolveFile(template: FilenameTemplate, title: string): Promise<ResolvedFile> {
+ async resolveClientFile(template: FilenameTemplate, title: string): Promise<ResolvedFile> {
let fileName: string;
if (template.suggestedFilename)
- fileName = await this._context.outputFile(template.suggestedFilename, { origin: 'llm', title });
+ fileName = await this._context.workspaceFile(template.suggestedFilename, this._clientWorkspace);
else
- fileName = await this._context.outputFile(dateAsFileName(template.prefix, template.ext), { origin: 'code', title });
+ fileName = await this._context.outputFile(template, { origin: 'llm' });
const relativeName = this._computRelativeTo(fileName);
const printableLink = `- [${title}](${relativeName})`;
return { fileName, relativeName, printableLink };
@@ -91,7 +84,7 @@ export class Response {
async addResult(title: string, data: Buffer | string, file: FilenameTemplate) {
if (this._context.config.outputMode === 'file' || file.suggestedFilename || typeof data !== 'string') {
- const resolvedFile = await this.resolveFile(file, title);
+ const resolvedFile = await this.resolveClientFile(file, title);
await this.addFileResult(resolvedFile, data);
} else {
this.addTextResult(data);
@@ -209,7 +202,7 @@ export class Response {
if (tabSnapshot && this._includeSnapshot !== 'none') {
const snapshot = this._includeSnapshot === 'full' ? tabSnapshot.ariaSnapshot : tabSnapshot.ariaSnapshotDiff ?? tabSnapshot.ariaSnapshot;
if (this._context.config.outputMode === 'file' || this._includeSnapshotFileName) {
- const resolvedFile = await this.resolveFile({ prefix: 'page', ext: 'yml', suggestedFilename: this._includeSnapshotFileName }, 'Snapshot');
+ const resolvedFile = await this.resolveClientFile({ prefix: 'page', ext: 'yml', suggestedFilename: this._includeSnapshotFileName }, 'Snapshot');
await fs.promises.writeFile(resolvedFile.fileName, snapshot, 'utf-8');
addSection('Snapshot', [resolvedFile.printableLink]);
} else {
diff --git a/packages/playwright/src/mcp/browser/sessionLog.ts b/packages/playwright/src/mcp/browser/sessionLog.ts
index 2abae731f5..8edae8fd02 100644
--- a/packages/playwright/src/mcp/browser/sessionLog.ts
+++ b/packages/playwright/src/mcp/browser/sessionLog.ts
@@ -34,7 +34,7 @@ export class SessionLog {
}
static async create(config: FullConfig, clientInfo: mcpServer.ClientInfo): Promise<SessionLog> {
- const sessionFolder = await outputFile(config, clientInfo, `session-${Date.now()}`, { origin: 'code', title: 'Saving session' });
+ const sessionFolder = await outputFile(config, clientInfo, `session-${Date.now()}`, { origin: 'code' });
await fs.promises.mkdir(sessionFolder, { recursive: true });
// eslint-disable-next-line no-console
console.error(`Session: ${sessionFolder}`);
diff --git a/packages/playwright/src/mcp/browser/tab.ts b/packages/playwright/src/mcp/browser/tab.ts
index 6e77f154b4..d3799d8b6b 100644
--- a/packages/playwright/src/mcp/browser/tab.ts
+++ b/packages/playwright/src/mcp/browser/tab.ts
@@ -187,10 +187,12 @@ export class Tab extends EventEmitter<TabEventsInterface> {
}
private async _downloadStarted(download: playwright.Download) {
+ // Do not trust web names.
+ const outputFile = await this.context.outputFile({ suggestedFilename: sanitizeForFilePath(download.suggestedFilename()), prefix: 'download', ext: 'bin' }, { origin: 'code' });
const entry = {
download,
finished: false,
- outputFile: await this.context.outputFile(download.suggestedFilename(), { origin: 'web', title: 'Saving download' })
+ outputFile,
};
this._downloads.push(entry);
this._addLogEntry({ type: 'download-start', wallTime: Date.now(), download: entry });
@@ -505,3 +507,11 @@ function consoleLevelForMessageType(type: ConsoleMessageType): ConsoleMessageLev
}
const tabSymbol = Symbol('tabSymbol');
+
+function sanitizeForFilePath(s: string) {
+ const sanitize = (s: string) => s.replace(/[\x00-\x2C\x2E-\x2F\x3A-\x40\x5B-\x60\x7B-\x7F]+/g, '-');
+ const separator = s.lastIndexOf('.');
+ if (separator === -1)
+ return sanitize(s);
+ return sanitize(s.substring(0, separator)) + '.' + sanitize(s.substring(separator + 1));
+}
diff --git a/packages/playwright/src/mcp/browser/tools/pdf.ts b/packages/playwright/src/mcp/browser/tools/pdf.ts
index ce28280742..cbbc3a5fe6 100644
--- a/packages/playwright/src/mcp/browser/tools/pdf.ts
+++ b/packages/playwright/src/mcp/browser/tools/pdf.ts
@@ -36,7 +36,7 @@ const pdf = defineTabTool({
handle: async (tab, params, response) => {
const data = await tab.page.pdf();
- const result = await response.resolveFile({ prefix: 'page', ext: 'pdf', suggestedFilename: params.filename }, 'Page as pdf');
+ const result = await response.resolveClientFile({ prefix: 'page', ext: 'pdf', suggestedFilename: params.filename }, 'Page as pdf');
await response.addFileResult(result, data);
response.addCode(`await page.pdf(${formatObject({ path: result.relativeName })});`);
},
diff --git a/packages/playwright/src/mcp/browser/tools/screenshot.ts b/packages/playwright/src/mcp/browser/tools/screenshot.ts
index 29fdad7d7c..a36af23ab8 100644
--- a/packages/playwright/src/mcp/browser/tools/screenshot.ts
+++ b/packages/playwright/src/mcp/browser/tools/screenshot.ts
@@ -57,7 +57,7 @@ const screenshot = defineTabTool({
const ref = params.ref ? await tab.refLocator({ element: params.element || '', ref: params.ref }) : null;
const data = ref ? await ref.locator.screenshot(options) : await tab.page.screenshot(options);
- const resolvedFile = await response.resolveFile({ prefix: ref ? 'element' : 'page', ext: fileType, suggestedFilename: params.filename }, `Screenshot of ${screenshotTarget}`);
+ const resolvedFile = await response.resolveClientFile({ prefix: ref ? 'element' : 'page', ext: fileType, suggestedFilename: params.filename }, `Screenshot of ${screenshotTarget}`);
response.addCode(`// Screenshot ${screenshotTarget} and save it as ${resolvedFile.relativeName}`);
if (ref)
diff --git a/packages/playwright/src/mcp/browser/tools/storage.ts b/packages/playwright/src/mcp/browser/tools/storage.ts
index e83bb231a9..63f97043bf 100644
--- a/packages/playwright/src/mcp/browser/tools/storage.ts
+++ b/packages/playwright/src/mcp/browser/tools/storage.ts
@@ -34,7 +34,7 @@ const storageState = defineTool({
const browserContext = await context.ensureBrowserContext();
const state = await browserContext.storageState();
const serializedState = JSON.stringify(state, null, 2);
- const resolvedFile = await response.resolveFile({ prefix: 'storage-state', ext: 'json', suggestedFilename: params.filename }, 'Storage state');
+ const resolvedFile = await response.resolveClientFile({ prefix: 'storage-state', ext: 'json', suggestedFilename: params.filename }, 'Storage state');
response.addCode(`await page.context().storageState({ path: '${resolvedFile.relativeName}' });`);
await response.addFileResult(resolvedFile, serializedState);
},
diff --git a/packages/playwright/src/mcp/browser/tools/tracing.ts b/packages/playwright/src/mcp/browser/tools/tracing.ts
index 7c2471076e..6a164ab330 100644
--- a/packages/playwright/src/mcp/browser/tools/tracing.ts
+++ b/packages/playwright/src/mcp/browser/tools/tracing.ts
@@ -32,7 +32,7 @@ const tracingStart = defineTool({
handle: async (context, params, response) => {
const browserContext = await context.ensureBrowserContext();
- const tracesDir = await context.outputFile(`traces`, { origin: 'code', title: 'Collecting trace' });
+ const tracesDir = await context.outputFile({ prefix: '', suggestedFilename: `traces`, ext: '' }, { origin: 'code' });
const name = 'trace-' + Date.now();
await (browserContext.tracing as Tracing).start({
name,
diff --git a/packages/playwright/src/mcp/browser/tools/utils.ts b/packages/playwright/src/mcp/browser/tools/utils.ts
index d4b530c88b..9c909b6bf2 100644
--- a/packages/playwright/src/mcp/browser/tools/utils.ts
+++ b/packages/playwright/src/mcp/browser/tools/utils.ts
@@ -59,11 +59,6 @@ export async function callOnPageNoTrace<T>(page: playwright.Page, callback: (pag
return await (page as any)._wrapApiCall(() => callback(page), { internal: true });
}
-export function dateAsFileName(prefix: string, extension: string, date?: Date): string {
- date = date ?? new Date();
- return `${prefix}-${date.toISOString().replace(/[:.]/g, '-')}.${extension}`;
-}
-
export function eventWaiter<T>(page: playwright.Page, event: string, timeout: number): { promise: Promise<T | undefined>, abort: () => void } {
const disposables: (() => void)[] = [];
diff --git a/packages/playwright/src/mcp/browser/tools/video.ts b/packages/playwright/src/mcp/browser/tools/video.ts
index 607abed047..69b4bfcadb 100644
--- a/packages/playwright/src/mcp/browser/tools/video.ts
+++ b/packages/playwright/src/mcp/browser/tools/video.ts
@@ -53,7 +53,7 @@ const stopVideo = defineTabTool({
},
handle: async (tab, params, response) => {
- const resolvedFile = await response.resolveFile({ prefix: 'video', ext: 'webm', suggestedFilename: params.filename }, 'Video');
+ const resolvedFile = await response.resolveClientFile({ prefix: 'video', ext: 'webm', suggestedFilename: params.filename }, 'Video');
await tab.page.video().stop();
await tab.page.video().saveAs(resolvedFile.fileName);
await response.addFileResult(resolvedFile, null);
diff --git a/packages/playwright/src/mcp/terminal/program.ts b/packages/playwright/src/mcp/terminal/program.ts
index 72a472d4e0..a759a03b3e 100644
--- a/packages/playwright/src/mcp/terminal/program.ts
+++ b/packages/playwright/src/mcp/terminal/program.ts
@@ -236,7 +236,6 @@ to restart the session daemon.`);
const args = [
cliPath,
'run-mcp-server',
- `--output-dir=${outputDir}`,
`--daemon-session=${sessionConfigFile}`,
];
@@ -550,8 +549,6 @@ async function installSkills() {
console.log(`Skills installed to ${path.relative(process.cwd(), skillDestDir)}`);
}
-const outputDir = path.join(process.cwd(), '.playwright-cli');
-
function daemonSocketPath(clientInfo: ClientInfo, sessionName: string): string {
const socketName = `${sessionName}.sock`;
if (os.platform() === 'win32')
diff --git a/packages/playwright/src/skill/SKILL.md b/packages/playwright/src/skill/SKILL.md
index de63c48dda..cbf8b3209e 100644
--- a/packages/playwright/src/skill/SKILL.md
+++ b/packages/playwright/src/skill/SKILL.md
@@ -39,6 +39,7 @@ playwright-cli upload ./document.pdf
playwright-cli check e12
playwright-cli uncheck e12
playwright-cli snapshot
+playwright-cli snapshot --filename=after-click.yaml
playwright-cli eval "document.title"
playwright-cli eval "el => el.textContent" e5
playwright-cli dialog-accept
@@ -80,7 +81,8 @@ playwright-cli mousewheel 0 100
```bash
playwright-cli screenshot
playwright-cli screenshot e5
-playwright-cli pdf
+playwright-cli screenshot --filename=page.png
+playwright-cli pdf --filename=page.pdf
```
### Tabs
diff --git a/tests/mcp/cli-devtools.spec.ts b/tests/mcp/cli-devtools.spec.ts
index 09c60dcdac..7843422a5e 100644
--- a/tests/mcp/cli-devtools.spec.ts
+++ b/tests/mcp/cli-devtools.spec.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import path from 'path';
import { test, expect } from './cli-fixtures';
test('console', async ({ cli, server }) => {
@@ -91,5 +90,5 @@ test('video-start-stop', async ({ cli, server }) => {
}
`);
const { output: videoStopOutput } = await cli('video-stop', '--filename=video.webm');
- expect(videoStopOutput).toContain(`### Result\n- [Video](.playwright-cli${path.sep}video.webm)`);
+ expect(videoStopOutput).toContain(`### Result\n- [Video](video.webm)`);
});
diff --git a/tests/mcp/cli-save-as.spec.ts b/tests/mcp/cli-save-as.spec.ts
index 9e0bd0efbc..bc557e4c36 100644
--- a/tests/mcp/cli-save-as.spec.ts
+++ b/tests/mcp/cli-save-as.spec.ts
@@ -14,7 +14,6 @@
* limitations under the License.
*/
-import path from 'path';
import { test, expect } from './cli-fixtures';
test('screenshot', async ({ cli, server, mcpBrowser }) => {
@@ -42,7 +41,7 @@ test('screenshot --full-page', async ({ cli, server, mcpBrowser }) => {
test('screenshot --filename', async ({ cli, server, mcpBrowser }) => {
await cli('open', server.HELLO_WORLD);
const { output, attachments } = await cli('screenshot', '--filename=screenshot.png');
- expect(output).toContain('.playwright-cli' + path.sep + 'screenshot.png');
+ expect(output).toContain('[Screenshot of viewport](screenshot.png)');
expect(attachments[0].name).toEqual('Screenshot of viewport');
expect(attachments[0].data).toEqual(expect.any(Buffer));
});
@@ -59,7 +58,7 @@ test('pdf --filename', async ({ cli, server, mcpBrowser }) => {
test.skip(mcpBrowser !== 'chromium' && mcpBrowser !== 'chrome', 'PDF is only supported in Chromium and Chrome');
await cli('open', server.HELLO_WORLD);
const { output, attachments } = await cli('pdf', '--filename=pdf.pdf');
- expect(output).toContain('.playwright-cli' + path.sep + 'pdf.pdf');
+ expect(output).toContain('[Page as pdf](pdf.pdf)');
expect(attachments[0].name).toEqual('Page as pdf');
expect(attachments[0].data).toEqual(expect.any(Buffer));
});
diff --git a/tests/mcp/cli-storage.spec.ts b/tests/mcp/cli-storage.spec.ts
index 6ee7237faa..0c6238febd 100644
--- a/tests/mcp/cli-storage.spec.ts
+++ b/tests/mcp/cli-storage.spec.ts
@@ -54,7 +54,7 @@ test('state-save saves to custom filename', async ({ cli, server }, testInfo) =>
const { output } = await cli('state-save', 'my-state.json');
expect(output).toContain('my-state.json');
- const stateFile = testInfo.outputPath('.playwright-cli', 'my-state.json');
+ const stateFile = testInfo.outputPath('my-state.json');
expect(await fs.promises.stat(stateFile).catch(() => null)).not.toBeNull();
});
@@ -62,9 +62,6 @@ test('state-load restores storage state from file', async ({ cli, server, mcpBro
const config = { capabilities: ['storage'] };
await fs.promises.writeFile(testInfo.outputPath('playwright-cli.json'), JSON.stringify(config, null, 2));
- const outputDir = testInfo.outputPath('.playwright-cli');
- await fs.promises.mkdir(outputDir, { recursive: true });
-
// Create a storage state file
const storageState = {
cookies: [{
@@ -82,13 +79,13 @@ test('state-load restores storage state from file', async ({ cli, server, mcpBro
}],
};
- const stateFile = path.join(outputDir, 'state.json');
+ const stateFile = testInfo.outputPath('state.json');
await fs.promises.writeFile(stateFile, JSON.stringify(storageState));
await cli('open', server.EMPTY_PAGE);
// Restore storage state
- const { output } = await cli('state-load', stateFile);
+ const { output } = await cli('state-load', 'state.json');
expect(output).toContain('Storage state restored');
// Verify the cookie was restored
@@ -120,7 +117,7 @@ test('state-save and state-load roundtrip', async ({ cli, server, mcpBrowser },
expect(clearedResult).toContain('|null');
// Restore storage state
- await cli('state-load', testInfo.outputPath('.playwright-cli', 'roundtrip-state.json'));
+ await cli('state-load', testInfo.outputPath('roundtrip-state.json'));
// Reload to pick up cookies
await cli('open', server.EMPTY_PAGE);
diff --git a/tests/mcp/pdf.spec.ts b/tests/mcp/pdf.spec.ts
index 5f0710302b..029c1cc6c0 100644
--- a/tests/mcp/pdf.spec.ts
+++ b/tests/mcp/pdf.spec.ts
@@ -56,10 +56,9 @@ test('save as pdf', async ({ startClient, mcpBrowser, server }, testInfo) => {
});
test('save as pdf (filename: output.pdf)', async ({ startClient, mcpBrowser, server }, testInfo) => {
- const outputDir = testInfo.outputPath('output');
test.skip(!!mcpBrowser && !['chromium', 'chrome', 'msedge'].includes(mcpBrowser), 'Save as PDF is only supported in Chromium.');
const { client } = await startClient({
- config: { outputDir, capabilities: ['pdf'] },
+ config: { capabilities: ['pdf'] },
});
expect(await client.callTool({
@@ -79,9 +78,9 @@ test('save as pdf (filename: output.pdf)', async ({ startClient, mcpBrowser, ser
code: expect.stringContaining(`await page.pdf(`),
});
- const files = [...fs.readdirSync(outputDir)];
+ const files = [...fs.readdirSync(testInfo.outputPath())];
- expect(fs.existsSync(outputDir)).toBeTruthy();
+ expect(fs.existsSync(testInfo.outputPath())).toBeTruthy();
const pdfFiles = files.filter(f => f.endsWith('.pdf'));
expect(pdfFiles).toHaveLength(1);
expect(pdfFiles[0]).toMatch(/^output.pdf$/);
diff --git a/tests/mcp/roots.spec.ts b/tests/mcp/roots.spec.ts
index 0a5a44eac3..322e72d166 100644
--- a/tests/mcp/roots.spec.ts
+++ b/tests/mcp/roots.spec.ts
@@ -133,7 +133,6 @@ test('should return relative paths when root is specified', async ({ startClient
const { client } = await startClient({
clientName: 'test-client',
- config: { outputDir: path.join(rootPath, 'output') },
roots: [
{
name: 'workspace',
@@ -151,6 +150,6 @@ test('should return relative paths when root is specified', async ({ startClient
name: 'browser_take_screenshot',
arguments: { filename: 'screenshot.png' },
})).toHaveResponse({
- result: expect.stringContaining(`[Screenshot of viewport](output${path.sep}screenshot.png)`),
+ result: expect.stringContaining(`[Screenshot of viewport](screenshot.png)`),
});
});
diff --git a/tests/mcp/screenshot.spec.ts b/tests/mcp/screenshot.spec.ts
index ed0598f7e0..bcca8165d1 100644
--- a/tests/mcp/screenshot.spec.ts
+++ b/tests/mcp/screenshot.spec.ts
@@ -219,11 +219,7 @@ test('browser_take_screenshot (filename is empty string)', async ({ startClient,
});
-test('browser_take_screenshot (filename: "output.png")', async ({ startClient, server }, testInfo) => {
- const outputDir = testInfo.outputPath('output');
- const { client } = await startClient({
- config: { outputDir },
- });
+test('browser_take_screenshot (filename: "output.png")', async ({ client, server }, testInfo) => {
expect(await client.callTool({
name: 'browser_navigate',
arguments: { url: server.HELLO_WORLD },
@@ -250,9 +246,7 @@ test('browser_take_screenshot (filename: "output.png")', async ({ startClient, s
],
});
- const files = [...fs.readdirSync(outputDir)].filter(f => f.endsWith('.png'));
-
- expect(fs.existsSync(outputDir)).toBeTruthy();
+ const files = [...fs.readdirSync(testInfo.outputPath())].filter(f => f.endsWith('.png'));
expect(files).toHaveLength(1);
expect(files[0]).toMatch(/^output\.png$/);
});
diff --git a/tests/mcp/snapshot-mode.spec.ts b/tests/mcp/snapshot-mode.spec.ts
index 46a3265d9d..d4467d3360 100644
--- a/tests/mcp/snapshot-mode.spec.ts
+++ b/tests/mcp/snapshot-mode.spec.ts
@@ -115,14 +115,9 @@ test('should respect --snapshot-mode=none', async ({ startClient, server }) => {
});
});
-test('should respect snapshot[filename]', async ({ startClient, server }, testInfo) => {
+test('should respect snapshot[filename]', async ({ client, server }, testInfo) => {
server.setContent('/', `<button>Button 1</button>`, 'text/html');
- const outputDir = testInfo.outputPath('output');
- const { client } = await startClient({
- config: { outputDir },
- });
-
await client.callTool({
name: 'browser_navigate',
arguments: {
@@ -135,7 +130,7 @@ test('should respect snapshot[filename]', async ({ startClient, server }, testIn
arguments: {
filename: 'snapshot1.yml',
},
- })).toHaveTextResponse(expect.stringContaining('output' + path.sep + 'snapshot1.yml'));
+ })).toHaveTextResponse(expect.stringContaining('snapshot1.yml'));
- expect(await fs.promises.readFile(path.join(outputDir, 'snapshot1.yml'), 'utf8')).toContain(`- button "Button 1" [ref=e2]`);
+ expect(await fs.promises.readFile(path.join(testInfo.outputPath(), 'snapshot1.yml'), 'utf8')).toContain(`- button "Button 1" [ref=e2]`);
});
diff --git a/tests/mcp/storage.spec.ts b/tests/mcp/storage.spec.ts
index 0840b609f8..748b509277 100644
--- a/tests/mcp/storage.spec.ts
+++ b/tests/mcp/storage.spec.ts
@@ -82,10 +82,8 @@ test('browser_storage_state saves storage state to file', async ({ startClient,
});
test('browser_storage_state saves to custom filename', async ({ startClient, server }, testInfo) => {
- const outputDir = testInfo.outputPath('output');
-
const { client } = await startClient({
- config: { outputDir, capabilities: ['storage'] },
+ config: { capabilities: ['storage'] },
});
await client.callTool({
@@ -102,7 +100,7 @@ test('browser_storage_state saves to custom filename', async ({ startClient, ser
result: expect.stringContaining('my-state.json'),
});
- const stateFile = path.join(outputDir, 'my-state.json');
+ const stateFile = testInfo.outputPath('my-state.json');
expect(await fs.promises.stat(stateFile).catch(() => null)).not.toBeNull();
});
@@ -172,10 +170,8 @@ test('browser_set_storage_state restores storage state from file', async ({ star
});
test('browser_storage_state and browser_set_storage_state roundtrip', async ({ startClient, server, mcpBrowser }, testInfo) => {
- const outputDir = testInfo.outputPath('output');
-
const { client } = await startClient({
- config: { outputDir, capabilities: ['storage'] },
+ config: { capabilities: ['storage'] },
});
// Navigate and set data
@@ -214,7 +210,7 @@ test('browser_storage_state and browser_set_storage_state roundtrip', async ({ s
// Restore storage state
await client.callTool({
name: 'browser_set_storage_state',
- arguments: { filename: path.join(outputDir, 'roundtrip-state.json') },
+ arguments: { filename: testInfo.outputPath('roundtrip-state.json') },
});
// Reload to pick up cookies