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
feat(mcp): store console events to per-tab log file (#39042)
Yury Semikhatskyca4f35486f23
diff --git a/packages/playwright/src/mcp/browser/browserServerBackend.ts b/packages/playwright/src/mcp/browser/browserServerBackend.tsindex c64037ce0c..52cdff07d9 100644--- a/packages/playwright/src/mcp/browser/browserServerBackend.ts+++ b/packages/playwright/src/mcp/browser/browserServerBackend.ts@@ -68,7 +68,7 @@ export class BrowserServerBackend implements ServerBackend {const parsedArguments = tool.schema.inputSchema.parse(rawArguments || {}) as any;const cwd = rawArguments?._meta && typeof rawArguments?._meta === 'object' && (rawArguments._meta as any)?.cwd;const context = this._context!;- const response = Response.create(context, name, parsedArguments, cwd);+ const response = new Response(context, name, parsedArguments, cwd);context.setRunningTool(name);let responseObject: mcpServer.CallToolResult;try {diff --git a/packages/playwright/src/mcp/browser/response.ts b/packages/playwright/src/mcp/browser/response.tsindex 5fe2c39efa..6c57185c5a 100644--- a/packages/playwright/src/mcp/browser/response.ts+++ b/packages/playwright/src/mcp/browser/response.ts@@ -22,7 +22,7 @@ import { renderModalStates, shouldIncludeMessage } from './tab';import { dateAsFileName } from './tools/utils';import { scaleImageToFitMessage } from './tools/screenshot';-import type { TabHeader } from './tab';+import type { LogChunk, TabHeader } from './tab';import type { CallToolResult, ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';import type { Context } from './context';@@ -60,17 +60,13 @@ export class Response {private _relativeTo: string | undefined;private _imageResults: { data: Buffer, imageType: 'png' | 'jpeg' }[] = [];- private constructor(context: Context, toolName: string, toolArgs: Record<string, any>, relativeTo?: string) {+ 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();}- static create(context: Context, toolName: string, toolArgs: Record<string, any>, relativeTo?: string) {- return new Response(context, toolName, toolArgs, relativeTo);- }-private _computRelativeTo(fileName: string): string {if (this._relativeTo)return path.relative(this._relativeTo, fileName);@@ -219,10 +215,10 @@ export class Response {}// Handle tab log+ const text: string[] = renderLogChunk(tabSnapshot?.logChunk, 'console', file => this._computRelativeTo(file));if (tabSnapshot?.events.filter(event => event.type !== 'request').length) {- const text: string[] = [];for (const event of tabSnapshot.events) {- if (event.type === 'console') {+ if (event.type === 'console' && !tabSnapshot.logChunk) {if (shouldIncludeMessage(this._context.config.console.level, event.message.type))text.push(`- ${trimMiddle(event.message.toString(), 100)}`);} else if (event.type === 'download-start') {@@ -232,8 +228,8 @@ export class Response {text.push(`- Downloaded file ${event.download.download.suggestedFilename()} to "${this._computRelativeTo(event.download.outputFile)}"`);}}- addSection('Events', text);}+ addSection('Events', text);return sections;}}@@ -258,6 +254,19 @@ export function renderTabsMarkdown(tabs: TabHeader[]): string[] {return lines;}+function renderLogChunk(logChunk: LogChunk | undefined, type: string, relativeTo: (fileName: string) => string): string[] {+ if (!logChunk)+ return [];+ const lines: string[] = [];+ const logFilePath = relativeTo(logChunk.file);+ const entryWord = logChunk.entryCount === 1 ? 'entry' : 'entries';+ const lineRange = logChunk.fromLine === logChunk.toLine+ ? `#L${logChunk.fromLine}`+ : `#L${logChunk.fromLine}-L${logChunk.toLine}`;+ lines.push(`- ${logChunk.entryCount} new ${type} ${entryWord} in "${logFilePath}${lineRange}"`);+ return lines;+}+function trimMiddle(text: string, maxLength: number) {if (text.length <= maxLength)return text;diff --git a/packages/playwright/src/mcp/browser/tab.ts b/packages/playwright/src/mcp/browser/tab.tsindex 3d94e2a5a8..2c4932b0de 100644--- a/packages/playwright/src/mcp/browser/tab.ts+++ b/packages/playwright/src/mcp/browser/tab.ts@@ -14,11 +14,12 @@* limitations under the License.*/+import fs from 'fs';import { EventEmitter } from 'events';import * as playwright from 'playwright-core';import { asLocator, ManualPromise } from 'playwright-core/lib/utils';-import { callOnPageNoTrace, waitForCompletion, eventWaiter } from './tools/utils';+import { callOnPageNoTrace, waitForCompletion, eventWaiter, dateAsFileName } from './tools/utils';import { logUnhandledError } from '../log';import { ModalState } from './tools/tool';import { handleDialog } from './tools/dialogs';@@ -77,13 +78,81 @@ export type TabHeader = {current: boolean;};+export type LogChunk = {+ file: string;+ fromLine: number;+ toLine: number;+ entryCount: number;+};+export type TabSnapshot = {ariaSnapshot: string;ariaSnapshotDiff?: string;modalStates: ModalState[];events: EventEntry[];+ logChunk?: LogChunk;};+class LogFile {+ private _startTime: number = Date.now();+ private _context: Context;+ private _filePrefix: string;+ private _title: string;++ private _file: string | undefined;+ private _stopped: boolean = false;++ private _line: number = 0;+ private _entries: number = 0;+ private _lastLine: number = 0;+ private _lastEntries: number = 0;++ private _writeChain: Promise<void> = Promise.resolve();++ constructor(context: Context, filePrefix: string, title: string) {+ this._context = context;+ this._filePrefix = filePrefix;+ this._title = title;+ }++ appendLine(wallTime: number, text: string) {+ this._writeChain = this._writeChain.then(() => this._write(wallTime, text)).catch(logUnhandledError);+ }++ stop() {+ this._stopped = true;+ }++ async take(): Promise<LogChunk | undefined> {+ await this._writeChain;+ if (!this._file || this._entries === this._lastEntries)+ return undefined;+ const chunk: LogChunk = {+ file: this._file,+ fromLine: this._lastLine + 1,+ toLine: this._line,+ entryCount: this._entries - this._lastEntries,+ };+ this._lastLine = this._line;+ this._lastEntries = this._entries;+ return chunk;+ }++ private async _write(wallTime: number, text: string) {+ if (this._stopped)+ return;+ this._file ??= await this._context.outputFile(dateAsFileName(this._filePrefix, 'log', new Date(this._startTime)), { origin: 'code', title: this._title });+ const relativeTime = wallTime - this._startTime;++ const logLine = `[${String(relativeTime).padStart(8, ' ')}ms] ${text}\n`;+ await fs.promises.appendFile(this._file, logLine);++ const lineCount = logLine.split('\n').length - 1;+ this._line += lineCount;+ this._entries++;+ }+}+export class Tab extends EventEmitter<TabEventsInterface> {readonly context: Context;readonly page: Page;@@ -95,8 +164,8 @@ export class Tab extends EventEmitter<TabEventsInterface> {private _modalStates: ModalState[] = [];private _initializedPromise: Promise<void>;private _needsFullSnapshot = false;- private _eventEntries: EventEntry[] = [];private _recentEventEntries: EventEntry[] = [];+ private _consoleLog: LogFile | undefined;constructor(context: Context, page: playwright.Page, onPageClose: (tab: Tab) => void) {super();@@ -122,6 +191,7 @@ export class Tab extends EventEmitter<TabEventsInterface> {page.setDefaultNavigationTimeout(this.context.config.timeouts.navigation);page.setDefaultTimeout(this.context.config.timeouts.action);(page as any)[tabSymbol] = this;+ this._resetConsoleLogFile();this._initializedPromise = this._initialize();}@@ -195,8 +265,15 @@ export class Tab extends EventEmitter<TabEventsInterface> {this._consoleMessages.length = 0;this._downloads.length = 0;this._requests.clear();- this._eventEntries.length = 0;this._recentEventEntries.length = 0;+ this._resetConsoleLogFile();+ }++ private _resetConsoleLogFile() {+ if (this.context.config.outputMode !== 'file')+ return;+ this._consoleLog?.stop();+ this._consoleLog = new LogFile(this.context, 'console', 'Console');}private _handleRequest(request: playwright.Request) {@@ -206,11 +283,12 @@ export class Tab extends EventEmitter<TabEventsInterface> {private _handleConsoleMessage(message: ConsoleMessage) {this._consoleMessages.push(message);- this._addLogEntry({ type: 'console', wallTime: Date.now(), message });+ const wallTime = Date.now();+ this._addLogEntry({ type: 'console', wallTime, message });+ this._consoleLog?.appendLine(wallTime, message.toString());}private _addLogEntry(entry: EventEntry) {- this._eventEntries.push(entry);this._recentEventEntries.push(entry);}@@ -302,6 +380,7 @@ export class Tab extends EventEmitter<TabEventsInterface> {};});if (tabSnapshot) {+ tabSnapshot.logChunk = await this._consoleLog?.take();tabSnapshot.events = this._recentEventEntries;this._recentEventEntries = [];}diff --git a/packages/playwright/src/mcp/browser/tools/utils.ts b/packages/playwright/src/mcp/browser/tools/utils.tsindex 696fee0943..d4b530c88b 100644--- a/packages/playwright/src/mcp/browser/tools/utils.ts+++ b/packages/playwright/src/mcp/browser/tools/utils.ts@@ -59,8 +59,8 @@ export async function callOnPageNoTrace<T>(page: playwright.Page, callback: (pagreturn await (page as any)._wrapApiCall(() => callback(page), { internal: true });}-export function dateAsFileName(prefix: string, extension: string): string {- const date = new Date();+export function dateAsFileName(prefix: string, extension: string, date?: Date): string {+ date = date ?? new Date();return `${prefix}-${date.toISOString().replace(/[:.]/g, '-')}.${extension}`;}diff --git a/tests/mcp/console.spec.ts b/tests/mcp/console.spec.tsindex 2fa1e6efca..810778651a 100644--- a/tests/mcp/console.spec.ts+++ b/tests/mcp/console.spec.ts@@ -14,6 +14,8 @@* limitations under the License.*/+import fs from 'fs';+import path from 'path';import { test, expect, parseResponse } from './fixtures';test('browser_console_messages', async ({ client, server }) => {@@ -192,3 +194,257 @@ test('browser_console_messages errors only', async ({ client, server }) => {expect.soft(response.result).not.toContain('console.log');expect.soft(response.result).not.toContain('console.warn');});++test('console log file is created on snapshot', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <script>+ console.log("Hello from console");+ console.error("Error message");+ </script>+ </html>+ `, 'text/html');++ const response = parseResponse(await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX },+ }));++ // Check events section mentions the log file with line range+ expect(response.events).toMatch(/\d+ new console entr(y|ies) in ".+\.log#L\d+(-L\d+)?"/);++ // Verify log file exists and contains the messages+ const files = await fs.promises.readdir(outputDir);+ const logFile = files.find(f => f.startsWith('console-') && f.endsWith('.log'));+ expect(logFile).toBeTruthy();++ const logContent = await fs.promises.readFile(path.join(outputDir, logFile!), 'utf-8');+ expect(logContent).toContain('Hello from console');+ expect(logContent).toContain('Error message');+});++test('console log file shows correct entry count', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <script>+ console.log("Message 1");+ console.log("Message 2");+ console.log("Message 3");+ </script>+ </html>+ `, 'text/html');++ const response = parseResponse(await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX },+ }));++ expect(response.events).toContain('3 new console entries');+});++test('console log file shows singular entry', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <script>+ console.log("Single message");+ </script>+ </html>+ `, 'text/html');++ const response = parseResponse(await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX },+ }));++ expect(response.events).toContain('1 new console entry');+});++test('new console log file after navigation', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/page1', `+ <!DOCTYPE html>+ <html>+ <script>console.log("Page 1 message");</script>+ </html>+ `, 'text/html');++ server.setContent('/page2', `+ <!DOCTYPE html>+ <html>+ <script>console.log("Page 2 message");</script>+ </html>+ `, 'text/html');++ // Navigate to first page+ await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX + '/page1' },+ });++ // Navigate to second page (should create new log file)+ await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX + '/page2' },+ });++ // Verify two log files exist+ const files = await fs.promises.readdir(outputDir);+ const logFiles = files.filter(f => f.startsWith('console-') && f.endsWith('.log'));+ expect(logFiles.length).toBe(2);++ // Each file should have only its own message+ const contents = await Promise.all(+ logFiles.map(f => fs.promises.readFile(path.join(outputDir, f), 'utf-8'))+ );+ const allContent = contents.join('\n');+ expect(allContent).toContain('Page 1 message');+ expect(allContent).toContain('Page 2 message');+});++test('console log file appends on multiple snapshots', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <button onclick="console.log('Button clicked');">Click me</button>+ </html>+ `, 'text/html');++ await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX },+ });++ // Click button to generate console message+ await client.callTool({+ name: 'browser_click',+ arguments: { element: 'Click me', ref: 'e2' },+ });++ // Click again+ await client.callTool({+ name: 'browser_click',+ arguments: { element: 'Click me', ref: 'e2' },+ });++ // Verify only one log file exists (same page, appended)+ const files = await fs.promises.readdir(outputDir);+ const logFiles = files.filter(f => f.startsWith('console-') && f.endsWith('.log'));+ expect(logFiles.length).toBe(1);++ // File should contain both click messages+ const logContent = await fs.promises.readFile(path.join(outputDir, logFiles[0]), 'utf-8');+ const matches = logContent.match(/Button clicked/g);+ expect(matches?.length).toBe(2);+});++test('console log file stores message type and content', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <script>+ console.log("Log message");+ console.warn("Warning message");+ console.error("Error message");+ console.info("Info message");+ console.debug("Debug message");+ </script>+ </html>+ `, 'text/html');++ await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.PREFIX },+ });++ const files = await fs.promises.readdir(outputDir);+ const logFile = files.find(f => f.startsWith('console-') && f.endsWith('.log'));+ expect(logFile).toBeTruthy();++ const logContent = await fs.promises.readFile(path.join(outputDir, logFile!), 'utf-8');++ // Check that message types are stored+ expect(logContent).toContain('[LOG] Log message');+ expect(logContent).toContain('[WARNING] Warning message');+ expect(logContent).toContain('[ERROR] Error message');+ expect(logContent).toContain('[INFO] Info message');+ expect(logContent).toContain('[DEBUG] Debug message');++ // Check that source location is stored+ expect(logContent).toMatch(/@ http:\/\/localhost:\d+\/:5/); // console.log line+ expect(logContent).toMatch(/@ http:\/\/localhost:\d+\/:6/); // console.warn line+ expect(logContent).toMatch(/@ http:\/\/localhost:\d+\/:7/); // console.error line+});++test('console log is updated without taking snapshots', async ({ startClient, server }, testInfo) => {+ const outputDir = testInfo.outputPath('output');+ const { client } = await startClient({+ config: { outputDir, outputMode: 'file' },+ });++ // Navigate to the page (this takes a snapshot)+ await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.EMPTY_PAGE },+ });++ async function getLogContent() {+ const files = await fs.promises.readdir(outputDir);+ const logFile = files.find(f => f.startsWith('console-') && f.endsWith('.log'));+ if (!logFile)+ return '<no log file>';+ return await fs.promises.readFile(path.join(outputDir, logFile!), 'utf-8');+ }++ // Use browser_evaluate to trigger console messages without taking a snapshot+ await client.callTool({+ name: 'browser_evaluate',+ arguments: {+ function: `() => {+ for (let i = 0; i < 5; i++) {+ console.log('Evaluated message ' + i);+ }+ }`,+ },+ });++ // Verify log file contains the evaluated messages without needing another snapshot+ await expect.poll(async () => await getLogContent()).toContain('Evaluated message 4');++ const logContent = await getLogContent();+ expect(logContent).toContain('Evaluated message 0');+ expect(logContent).toContain('Evaluated message 1');+ expect(logContent).toContain('Evaluated message 2');+ expect(logContent).toContain('Evaluated message 3');+});