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
chore(mcp): log request/response and fs operations (#37543)
Pavel Feldman8f586c2116c7
diff --git a/packages/playwright/src/mcp/browser/browserContextFactory.ts b/packages/playwright/src/mcp/browser/browserContextFactory.tsindex 7e75c7d56e..5018b5bf9c 100644--- a/packages/playwright/src/mcp/browser/browserContextFactory.ts+++ b/packages/playwright/src/mcp/browser/browserContextFactory.ts@@ -116,8 +116,8 @@ class IsolatedContextFactory extends BaseContextFactory {protected override async _doObtainBrowser(clientInfo: ClientInfo): Promise<playwright.Browser> {await injectCdpPort(this.config.browser);const browserType = playwright[this.config.browser.browserName];- const tracesDir = await outputFile(this.config, clientInfo, `traces`, { origin: 'code' });- if (this.config.saveTrace)+ const tracesDir = await computeTracesDir(this.config, clientInfo);+ if (tracesDir && this.config.saveTrace)await startTraceServer(this.config, tracesDir);return browserType.launch({tracesDir,@@ -183,8 +183,8 @@ class PersistentContextFactory implements BrowserContextFactory {await injectCdpPort(this.config.browser);testDebug('create browser context (persistent)');const userDataDir = this.config.browser.userDataDir ?? await this._createUserDataDir(clientInfo);- const tracesDir = await outputFile(this.config, clientInfo, `traces`, { origin: 'code' });- if (this.config.saveTrace)+ const tracesDir = await computeTracesDir(this.config, clientInfo);+ if (tracesDir && this.config.saveTrace)await startTraceServer(this.config, tracesDir);this._userDataDirs.add(userDataDir);@@ -326,3 +326,9 @@ export class SharedContextFactory implements BrowserContextFactory {await close(async () => {});}}++async function computeTracesDir(config: FullConfig, clientInfo: ClientInfo): Promise<string | undefined> {+ if (!config.saveTrace && !config.capabilities?.includes('tracing'))+ return;+ return await outputFile(config, clientInfo, `traces`, { origin: 'code', reason: 'Collecting trace' });+}diff --git a/packages/playwright/src/mcp/browser/browserServerBackend.ts b/packages/playwright/src/mcp/browser/browserServerBackend.tsindex bd7ab7fbda..e9ec5c0945 100644--- a/packages/playwright/src/mcp/browser/browserServerBackend.ts+++ b/packages/playwright/src/mcp/browser/browserServerBackend.ts@@ -61,6 +61,7 @@ export class BrowserServerBackend implements ServerBackend {const parsedArguments = tool.schema.inputSchema.parse(rawArguments || {});const context = this._context!;const response = new Response(context, name, parsedArguments);+ response.logBegin();context.setRunningTool(name);try {await tool.handle(context, parsedArguments, response);@@ -71,6 +72,7 @@ export class BrowserServerBackend implements ServerBackend {} finally {context.setRunningTool(undefined);}+ response.logEnd();return response.serialize();}diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.tsindex 4946709d53..5ffe2f8d3c 100644--- a/packages/playwright/src/mcp/browser/config.ts+++ b/packages/playwright/src/mcp/browser/config.ts@@ -19,9 +19,8 @@ import os from 'os';import path from 'path';import { devices } from 'playwright-core';-import { dotenv } from 'playwright-core/lib/utilsBundle';+import { dotenv, debug } from 'playwright-core/lib/utilsBundle';import { fileExistsAsync } from '../../util';-import { firstRootPath } from '../sdk/server';import type * as playwright from '../../../types/test';@@ -308,7 +307,13 @@ export function outputDir(config: FullConfig, clientInfo: ClientInfo): string {?? path.join(tmpDir(), String(clientInfo.timestamp));}-export async function outputFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' | 'web' }): Promise<string> {+export async function outputFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' | 'web', reason: string }): Promise<string> {+ const file = await resolveFile(config, clientInfo, fileName, options);+ debug('pw:mcp:file')(options.reason, file);+ return file;+}++async function resolveFile(config: FullConfig, clientInfo: ClientInfo, fileName: string, options: { origin: 'code' | 'llm' | 'web' }): Promise<string> {const dir = outputDir(config, clientInfo);// Trust code.diff --git a/packages/playwright/src/mcp/browser/context.ts b/packages/playwright/src/mcp/browser/context.tsindex 3c905a68d1..80eadfda1c 100644--- a/packages/playwright/src/mcp/browser/context.ts+++ b/packages/playwright/src/mcp/browser/context.ts@@ -15,6 +15,7 @@*/import fs from 'fs';+import path from 'path';import { debug } from 'playwright-core/lib/utilsBundle';@@ -116,7 +117,7 @@ export class Context {return url;}- async outputFile(fileName: string, options: { origin: 'code' | 'llm' | 'web' }): Promise<string> {+ async outputFile(fileName: string, options: { origin: 'code' | 'llm' | 'web', reason: string }): Promise<string> {return outputFile(this.config, this._clientInfo, fileName, options);}@@ -169,12 +170,13 @@ export class Context {const videos = browserContext.pages().map(page => page.video()).filter(video => !!video);await close(async () => {for (const video of videos) {- const name = await this.outputFile(dateAsFileName('webm'), { origin: 'code' });- const path = await video.path();+ const name = await this.outputFile(dateAsFileName('webm'), { origin: 'code', reason: 'Saving video' });+ await fs.promises.mkdir(path.dirname(name), { recursive: true });+ const p = await video.path();// video.saveAs() does not work for persistent contexts.try {- if (fs.existsSync(path))- await fs.promises.rename(path, name);+ if (fs.existsSync(p))+ await fs.promises.rename(p, name);} catch (e) {logUnhandledError(e);}diff --git a/packages/playwright/src/mcp/browser/response.ts b/packages/playwright/src/mcp/browser/response.tsindex db910cc222..3308dd827d 100644--- a/packages/playwright/src/mcp/browser/response.ts+++ b/packages/playwright/src/mcp/browser/response.ts@@ -14,12 +14,15 @@* limitations under the License.*/+import { debug } from 'playwright-core/lib/utilsBundle';import { renderModalStates } from './tab';import type { Tab, TabSnapshot } from './tab';import type { ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';import type { Context } from './context';+export const requestDebug = debug('pw:mcp:request');+export class Response {private _result: string[] = [];private _code: string[] = [];@@ -93,7 +96,17 @@ export class Response {return this._tabSnapshot;}- serialize(): { content: (TextContent | ImageContent)[], isError?: boolean } {+ logBegin() {+ if (requestDebug.enabled)+ requestDebug(this.toolName, this.toolArgs);+ }++ logEnd() {+ if (requestDebug.enabled)+ requestDebug(this.serialize({ omitSnapshot: true, omitBlobs: true }));+ }++ serialize(options: { omitSnapshot?: boolean, omitBlobs?: boolean } = {}): { content: (TextContent | ImageContent)[], isError?: boolean } {const response: string[] = [];// Start with command result.@@ -121,7 +134,7 @@ ${this._code.join('\n')}response.push(...renderModalStates(this._context, this._tabSnapshot.modalStates));response.push('');} else if (this._tabSnapshot) {- response.push(renderTabSnapshot(this._tabSnapshot));+ response.push(renderTabSnapshot(this._tabSnapshot, options));response.push('');}@@ -133,7 +146,7 @@ ${this._code.join('\n')}// Image attachments.if (this._context.config.imageResponses !== 'omit') {for (const image of this._images)- content.push({ type: 'image', data: image.data.toString('base64'), mimeType: image.contentType });+ content.push({ type: 'image', data: options.omitBlobs ? '<blob>' : image.data.toString('base64'), mimeType: image.contentType });}this._redactSecrets(content);@@ -153,7 +166,7 @@ ${this._code.join('\n')}}}-function renderTabSnapshot(tabSnapshot: TabSnapshot): string {+function renderTabSnapshot(tabSnapshot: TabSnapshot, options: { omitSnapshot?: boolean } = {}): string {const lines: string[] = [];if (tabSnapshot.consoleMessages.length) {@@ -179,7 +192,7 @@ function renderTabSnapshot(tabSnapshot: TabSnapshot): string {lines.push(`- Page Title: ${tabSnapshot.title}`);lines.push(`- Page Snapshot:`);lines.push('```yaml');- lines.push(tabSnapshot.ariaSnapshot);+ lines.push(options.omitSnapshot ? '<snapshot>' : tabSnapshot.ariaSnapshot);lines.push('```');return lines.join('\n');diff --git a/packages/playwright/src/mcp/browser/sessionLog.ts b/packages/playwright/src/mcp/browser/sessionLog.tsindex 6a1a7a2253..e0558b866c 100644--- a/packages/playwright/src/mcp/browser/sessionLog.ts+++ b/packages/playwright/src/mcp/browser/sessionLog.ts@@ -53,7 +53,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' });+ const sessionFolder = await outputFile(config, clientInfo, `session-${Date.now()}`, { origin: 'code', reason: 'Saving session' });await fs.promises.mkdir(sessionFolder, { recursive: true });// eslint-disable-next-line no-consoleconsole.error(`Session: ${sessionFolder}`);diff --git a/packages/playwright/src/mcp/browser/tab.ts b/packages/playwright/src/mcp/browser/tab.tsindex 45456d86c6..9babbbc4c5 100644--- a/packages/playwright/src/mcp/browser/tab.ts+++ b/packages/playwright/src/mcp/browser/tab.ts@@ -135,7 +135,7 @@ export class Tab extends EventEmitter<TabEventsInterface> {const entry = {download,finished: false,- outputFile: await this.context.outputFile(download.suggestedFilename(), { origin: 'web' })+ outputFile: await this.context.outputFile(download.suggestedFilename(), { origin: 'web', reason: 'Saving download' })};this._downloads.push(entry);await download.saveAs(entry.outputFile);diff --git a/packages/playwright/src/mcp/browser/tools/pdf.ts b/packages/playwright/src/mcp/browser/tools/pdf.tsindex a58035e7a2..13127f031b 100644--- a/packages/playwright/src/mcp/browser/tools/pdf.ts+++ b/packages/playwright/src/mcp/browser/tools/pdf.ts@@ -35,7 +35,7 @@ const pdf = defineTabTool({},handle: async (tab, params, response) => {- const fileName = await tab.context.outputFile(params.filename ?? dateAsFileName('pdf'), { origin: 'llm' });+ const fileName = await tab.context.outputFile(params.filename ?? dateAsFileName('pdf'), { origin: 'llm', reason: 'Saving PDF' });response.addCode(`await page.pdf(${javascript.formatObject({ path: fileName })});`);response.addResult(`Saved page as ${fileName}`);await tab.page.pdf({ path: fileName });diff --git a/packages/playwright/src/mcp/browser/tools/screenshot.ts b/packages/playwright/src/mcp/browser/tools/screenshot.tsindex a3df61000b..d074fe507c 100644--- a/packages/playwright/src/mcp/browser/tools/screenshot.ts+++ b/packages/playwright/src/mcp/browser/tools/screenshot.ts@@ -51,7 +51,7 @@ const screenshot = defineTabTool({handle: async (tab, params, response) => {const fileType = params.type || 'png';- const fileName = await tab.context.outputFile(params.filename ?? dateAsFileName(fileType), { origin: 'llm' });+ const fileName = await tab.context.outputFile(params.filename ?? dateAsFileName(fileType), { origin: 'llm', reason: 'Saving screenshot' });const options: playwright.PageScreenshotOptions = {type: fileType,quality: fileType === 'png' ? undefined : 90,diff --git a/packages/playwright/src/mcp/browser/tools/tracing.ts b/packages/playwright/src/mcp/browser/tools/tracing.tsindex 613a9ae0dc..ed1a41773a 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' });+ const tracesDir = await context.outputFile(`traces`, { origin: 'code', reason: 'Collecting trace' });const name = 'trace-' + Date.now();await (browserContext.tracing as Tracing).start({name,diff --git a/packages/playwright/src/mcp/log.ts b/packages/playwright/src/mcp/log.tsindex 072ec9ad47..cd71ef2531 100644--- a/packages/playwright/src/mcp/log.ts+++ b/packages/playwright/src/mcp/log.ts@@ -16,10 +16,10 @@import { debug } from 'playwright-core/lib/utilsBundle';-const errorsDebug = debug('pw:mcp:errors');+const errorDebug = debug('pw:mcp:error');export function logUnhandledError(error: unknown) {- errorsDebug(error);+ errorDebug(error);}export const testDebug = debug('pw:mcp:test');