Skip to content

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

chore: brush up result files (#38931)

Pavel Feldman1e81675f8502
diff --git a/packages/playwright/src/mcp/browser/response.ts b/packages/playwright/src/mcp/browser/response.ts
index 910833bb58..f30debc624 100644
--- a/packages/playwright/src/mcp/browser/response.ts
+++ b/packages/playwright/src/mcp/browser/response.ts
@@ -28,9 +28,8 @@ import type { Context } from './context';
export const requestDebug = debug('pw:mcp:request');
type Result = {
- text?: string;
- data?: Buffer;
- title?: string;
+ data: Buffer | string;
+ title: string;
filename?: string;
};
@@ -61,26 +60,22 @@ export class Response {
}
addTextResult(result: string) {
- this._results.push({ text: result });
+ this._results.push({ title: '', data: result });
}
- async addResult(result: { text?: string, data?: Buffer, title?: string, suggestedFilename?: string, ext?: string }): Promise<{ fileName?: string }> {
- // Binary always goes into a file.
- if (result.data && !result.suggestedFilename)
- result.suggestedFilename = dateAsFileName(result.ext ?? 'bin');
-
- // What can go into a file goes into a file in outputMode === file.
- if (this._context.config.outputMode === 'file') {
- if (!result.suggestedFilename)
- result.suggestedFilename = dateAsFileName(result.ext ?? (result.text !== undefined ? 'txt' : 'bin'));
+ async addResult(title: string, data: string | Buffer, file: { prefix: string, ext: string, suggestedFilename?: string }) {
+ let filename: string | undefined;
+ if (!file.suggestedFilename) {
+ // Binary always goes into a file.
+ if (typeof data !== 'string')
+ filename = dateAsFileName(file.prefix, file.ext);
+ // What can go into a file goes into a file in outputMode === file.
+ if (this._context.config.outputMode === 'file')
+ filename = dateAsFileName(file.prefix, file.ext);
+ } else {
+ filename = await this._context.outputFile(file.suggestedFilename, { origin: 'llm', title });
}
-
- const entry: Result = { text: result.text, data: result.data, title: result.title };
- if (result.suggestedFilename)
- entry.filename = await this._context.outputFile(result.suggestedFilename, { origin: 'llm', title: result.title || 'Saved result' });
-
- this._results.push(entry);
- return { fileName: entry.filename };
+ this._results.push({ data, title, filename });
}
addError(error: string) {
@@ -124,14 +119,13 @@ export class Response {
const text = addSection('Result');
for (const result of this._results) {
if (result.filename) {
- if (result.text !== undefined || result.data)
- text.push(`- [${result.title}](${rootPath ? path.relative(rootPath, result.filename) : result.filename})`);
- if (result.data)
+ text.push(`- [${result.title}](${rootPath ? path.relative(rootPath, result.filename) : result.filename})`);
+ if (typeof result.data === 'string')
+ await fs.promises.writeFile(result.filename, this._redactText(result.data), 'utf-8');
+ else
await fs.promises.writeFile(result.filename, result.data);
- else if (result.text !== undefined)
- await fs.promises.writeFile(result.filename, this._redactText(result.text));
- } else if (result.text) {
- text.push(result.text);
+ } else if (typeof result.data === 'string' && result.data.trim()) {
+ text.push(result.data);
}
}
}
@@ -167,9 +161,9 @@ export class Response {
if (this._includeSnapshotFileName)
fileName = await this._context.outputFile(this._includeSnapshotFileName, { origin: 'llm', title: 'Saved snapshot' });
else if (this._context.config.outputMode === 'file')
- fileName = await this._context.outputFile(`snapshot-${this._ordinal}.yml`, { origin: 'code', title: 'Saved snapshot' });
+ fileName = await this._context.outputFile(dateAsFileName('snapshot', 'yml'), { origin: 'code', title: 'Saved snapshot' });
if (fileName) {
- await fs.promises.writeFile(fileName, tabSnapshot.ariaSnapshot);
+ await fs.promises.writeFile(fileName, tabSnapshot.ariaSnapshot, 'utf-8');
const text = addSection('Snapshot');
text.push(`- File: ${rootPath ? path.relative(rootPath, fileName) : fileName}`);
} else {
diff --git a/packages/playwright/src/mcp/browser/tools/console.ts b/packages/playwright/src/mcp/browser/tools/console.ts
index bca8d3bff4..e5e121978c 100644
--- a/packages/playwright/src/mcp/browser/tools/console.ts
+++ b/packages/playwright/src/mcp/browser/tools/console.ts
@@ -32,7 +32,7 @@ const console = defineTabTool({
handle: async (tab, params, response) => {
const messages = await tab.consoleMessages(params.level);
const text = messages.map(message => message.toString()).join('\n');
- await response.addResult({ text, suggestedFilename: params.filename, title: 'Console' });
+ await response.addResult('Console', text, { prefix: 'console', ext: 'log', suggestedFilename: params.filename });
},
});
diff --git a/packages/playwright/src/mcp/browser/tools/network.ts b/packages/playwright/src/mcp/browser/tools/network.ts
index 3907dacbba..4038732e83 100644
--- a/packages/playwright/src/mcp/browser/tools/network.ts
+++ b/packages/playwright/src/mcp/browser/tools/network.ts
@@ -42,7 +42,7 @@ const requests = defineTabTool({
if (rendered)
text.push(rendered);
}
- await response.addResult({ text: text.join('\n'), suggestedFilename: params.filename, title: 'Network' });
+ await response.addResult('Network', text.join('\n'), { prefix: 'network', ext: 'log', suggestedFilename: params.filename });
},
});
diff --git a/packages/playwright/src/mcp/browser/tools/pdf.ts b/packages/playwright/src/mcp/browser/tools/pdf.ts
index 1cfa79f023..0de0405f87 100644
--- a/packages/playwright/src/mcp/browser/tools/pdf.ts
+++ b/packages/playwright/src/mcp/browser/tools/pdf.ts
@@ -37,8 +37,8 @@ const pdf = defineTabTool({
handle: async (tab, params, response) => {
const data = await tab.page.pdf();
- const suggestedFilename = params.filename ?? dateAsFileName('pdf');
- await response.addResult({ data, title: 'Page as pdf', suggestedFilename });
+ const suggestedFilename = params.filename ?? dateAsFileName('page', 'pdf');
+ await response.addResult('Page as pdf', data, { prefix: 'page', ext: 'pdf', suggestedFilename: suggestedFilename });
response.addCode(`await page.pdf(${formatObject({ path: suggestedFilename })});`);
},
});
diff --git a/packages/playwright/src/mcp/browser/tools/screenshot.ts b/packages/playwright/src/mcp/browser/tools/screenshot.ts
index c03118f3e5..8dbfd2e68f 100644
--- a/packages/playwright/src/mcp/browser/tools/screenshot.ts
+++ b/packages/playwright/src/mcp/browser/tools/screenshot.ts
@@ -58,15 +58,15 @@ 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 fileName = params.filename || dateAsFileName(fileType);
+ const suggestedFilename = params.filename || dateAsFileName(ref ? 'element' : 'page', fileType);
- response.addCode(`// Screenshot ${screenshotTarget} and save it as ${fileName}`);
+ response.addCode(`// Screenshot ${screenshotTarget} and save it as ${suggestedFilename}`);
if (ref)
- response.addCode(`await page.${ref.resolved}.screenshot(${formatObject({ ...options, path: fileName })});`);
+ response.addCode(`await page.${ref.resolved}.screenshot(${formatObject({ ...options, path: suggestedFilename })});`);
else
- response.addCode(`await page.screenshot(${formatObject({ ...options, path: fileName })});`);
+ response.addCode(`await page.screenshot(${formatObject({ ...options, path: suggestedFilename })});`);
- await response.addResult({ data, title: `Screenshot of ${screenshotTarget}`, suggestedFilename: fileName });
+ await response.addResult(`Screenshot of ${screenshotTarget}`, data, { prefix: ref ? 'element' : 'page', ext: fileType, suggestedFilename });
response.addImage({
contentType: fileType === 'png' ? 'image/png' : 'image/jpeg',
diff --git a/packages/playwright/src/mcp/browser/tools/utils.ts b/packages/playwright/src/mcp/browser/tools/utils.ts
index 7b2fa305f0..696fee0943 100644
--- a/packages/playwright/src/mcp/browser/tools/utils.ts
+++ b/packages/playwright/src/mcp/browser/tools/utils.ts
@@ -59,9 +59,9 @@ export async function callOnPageNoTrace<T>(page: playwright.Page, callback: (pag
return await (page as any)._wrapApiCall(() => callback(page), { internal: true });
}
-export function dateAsFileName(extension: string): string {
+export function dateAsFileName(prefix: string, extension: string): string {
const date = new Date();
- return `page-${date.toISOString().replace(/[:.]/g, '-')}.${extension}`;
+ return `${prefix}-${date.toISOString().replace(/[:.]/g, '-')}.${extension}`;
}
export function eventWaiter<T>(page: playwright.Page, event: string, timeout: number): { promise: Promise<T | undefined>, abort: () => void } {