Skip to content

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

chore(test_debug): print console messages upon pause (#37612)

Dmitry Gozmanb090609bd85f
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
index e9b36e61c6..1866e05a21 100644
--- a/packages/playwright-core/src/server/browserContext.ts
+++ b/packages/playwright-core/src/server/browserContext.ts
@@ -62,7 +62,6 @@ export abstract class BrowserContext extends SdkObject {
RequestAborted: 'requestaborted',
RequestFulfilled: 'requestfulfilled',
RequestContinued: 'requestcontinued',
- RequestCollected: 'requestcollected',
BeforeClose: 'beforeclose',
VideoStarted: 'videostarted',
RecorderEvent: 'recorderevent',
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 98c9438143..4b32fbd9b8 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -151,7 +151,6 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
if (!redirectFromDispatcher && !this._shouldDispatchNetworkEvent(request, 'request') && !request.isNavigationRequest())
return;
const requestDispatcher = RequestDispatcher.from(this, request);
- requestDispatcher.reportedThroughEvent = true;
this._dispatchEvent('request', {
request: requestDispatcher,
page: PageDispatcher.fromNullable(this, request.frame()?._page.initializedOrUndefined())
@@ -188,11 +187,6 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
page: PageDispatcher.fromNullable(this, request.frame()?._page.initializedOrUndefined()),
});
});
- this.addObjectListener(BrowserContext.Events.RequestCollected, (request: Request) => {
- const requestDispatcher = this.connection.existingDispatcher<RequestDispatcher>(request);
- if (requestDispatcher && !requestDispatcher.reportedThroughEvent)
- requestDispatcher._dispose('gc');
- });
this.addObjectListener(BrowserContext.Events.RecorderEvent, ({ event, data, page, code }: { event: 'actionAdded' | 'actionUpdated' | 'signalAdded', data: any, page: Page, code: string }) => {
this._dispatchEvent('recorderEvent', { event, data, code, page: PageDispatcher.from(this, page) });
});
diff --git a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts b/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
index ba34add8a1..286a11ae57 100644
--- a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
+++ b/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
@@ -32,7 +32,6 @@ import type { Progress } from '@protocol/progress';
export class RequestDispatcher extends Dispatcher<Request, channels.RequestChannel, BrowserContextDispatcher | PageDispatcher | FrameDispatcher> implements channels.RequestChannel {
_type_Request: boolean;
private _browserContextDispatcher: BrowserContextDispatcher;
- reportedThroughEvent = false;
static from(scope: BrowserContextDispatcher, request: Request): RequestDispatcher {
const result = scope.connection.existingDispatcher<RequestDispatcher>(request);
diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
index 3043192996..97443690fa 100644
--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
@@ -288,6 +288,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
}
async consoleMessages(params: channels.PageConsoleMessagesParams, progress: Progress): Promise<channels.PageConsoleMessagesResult> {
+ // Send all future console messages to the client, so that it can reliably receive all of them.
+ // Otherwise, if subscription is added in a different task from this call (either before or after),
+ // there is a chance for a duplicate or a lost console message.
+ this._subscriptions.add('console');
return { messages: this._page.consoleMessages().map(message => this.serializeConsoleMessage(message)) };
}
@@ -340,6 +344,10 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
}
async requests(params: channels.PageRequestsParams, progress: Progress): Promise<channels.PageRequestsResult> {
+ // Send all future requests to the client, so that it can reliably receive all of them.
+ // Otherwise, if subscription is added in a different task from this call (either before or after),
+ // there is a chance for a duplicate or a lost request.
+ this._subscriptions.add('request');
return { requests: this._page.networkRequests().map(request => RequestDispatcher.from(this.parentScope(), request)) };
}
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index fda0e14dcc..5df5bf4614 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -353,8 +353,7 @@ export class Page extends SdkObject {
addNetworkRequest(request: network.Request) {
this._networkRequests.push(request);
- for (const collected of ensureArrayLimit(this._networkRequests, 100))
- this.emitOnContext(BrowserContext.Events.RequestCollected, collected);
+ ensureArrayLimit(this._networkRequests, 100);
}
networkRequests() {
diff --git a/packages/playwright/src/mcp/browser/tab.ts b/packages/playwright/src/mcp/browser/tab.ts
index 77687432c4..c855931bfb 100644
--- a/packages/playwright/src/mcp/browser/tab.ts
+++ b/packages/playwright/src/mcp/browser/tab.ts
@@ -90,13 +90,20 @@ export class Tab extends EventEmitter<TabEventsInterface> {
return (page as any)[tabSymbol];
}
- private async _initialize() {
- const messages = await this.page.consoleMessages().catch(() => []);
+ static async collectConsoleMessages(page: playwright.Page): Promise<ConsoleMessage[]> {
+ const result: ConsoleMessage[] = [];
+ const messages = await page.consoleMessages().catch(() => []);
for (const message of messages)
- this._handleConsoleMessage(messageToConsoleMessage(message));
- const errors = await this.page.pageErrors().catch(() => []);
+ result.push(messageToConsoleMessage(message));
+ const errors = await page.pageErrors().catch(() => []);
for (const error of errors)
- this._handleConsoleMessage(pageErrorToConsoleMessage(error));
+ result.push(pageErrorToConsoleMessage(error));
+ return result;
+ }
+
+ private async _initialize() {
+ for (const message of await Tab.collectConsoleMessages(this.page))
+ this._handleConsoleMessage(message);
const requests = await this.page.requests().catch(() => []);
for (const request of requests)
this._requests.add(request);
diff --git a/packages/playwright/src/mcp/test/DEPS.list b/packages/playwright/src/mcp/test/DEPS.list
index 2fedd91a30..4c8362b509 100644
--- a/packages/playwright/src/mcp/test/DEPS.list
+++ b/packages/playwright/src/mcp/test/DEPS.list
@@ -2,6 +2,7 @@
../sdk/
../browser/config.ts
../browser/browserServerBackend.ts
+../browser/tab.ts
../browser/tools/
../../reporters
../../runner
diff --git a/packages/playwright/src/mcp/test/browserBackend.ts b/packages/playwright/src/mcp/test/browserBackend.ts
index 3653e7c4e7..8b5b90c6a1 100644
--- a/packages/playwright/src/mcp/test/browserBackend.ts
+++ b/packages/playwright/src/mcp/test/browserBackend.ts
@@ -19,6 +19,7 @@ import { currentTestInfo } from '../../common/globals';
import { stripAnsiEscapes } from '../../util';
import { defaultConfig, FullConfig } from '../browser/config';
import { BrowserServerBackend } from '../browser/browserServerBackend';
+import { Tab } from '../browser/tab';
import type * as playwright from '../../../index';
import type { Page } from '../../../../playwright-core/src/client/page';
@@ -47,7 +48,17 @@ export async function runBrowserBackendAtEnd(context: playwright.BrowserContext,
'',
`### Page ${stateSuffix}`,
`- Page URL: ${page.url()}`,
- `- Page Title: ${await page.title()}`.trim(),
+ `- Page Title: ${await page.title()}`.trim()
+ );
+ // Only print console errors when pausing on error, not when everything works as expected.
+ let console = errorMessage ? await Tab.collectConsoleMessages(page) : [];
+ console = console.filter(msg => !msg.type || msg.type === 'error');
+ if (console.length) {
+ lines.push('- Console Messages:');
+ for (const message of console)
+ lines.push(` - ${message.toString()}`);
+ }
+ lines.push(
`- Page Snapshot:`,
'```yaml',
await (page as Page)._snapshotForAI(),
diff --git a/tests/mcp/test-debug.spec.ts b/tests/mcp/test-debug.spec.ts
index 094784dba7..0c52d06e31 100644
--- a/tests/mcp/test-debug.spec.ts
+++ b/tests/mcp/test-debug.spec.ts
@@ -122,12 +122,12 @@ test('test_debug (browser_snapshot/network/console)', async ({ startClient, serv
});
});
-test('test_debug (multiple pages and custom errors)', async ({ startClient, server }) => {
+test('test_debug (multiple pages and custom error)', async ({ startClient, server }) => {
const { client, id } = await prepareDebugTest(startClient, `
import { test, expect } from '@playwright/test';
test('fail', async ({ page }) => {
const page2 = await page.context().newPage();
- await page.goto(${JSON.stringify(server.PREFIX + '/frames/frame.html')});
+ await page.goto(${JSON.stringify(server.EMPTY_PAGE)});
await page2.goto(${JSON.stringify(server.PREFIX + '/wrappedlink.html')});
throw new Error('non-api error');
});
@@ -143,11 +143,11 @@ Running 1 test using 1 worker
Error: non-api error
### Page 1 of 2
-- Page URL: ${server.PREFIX + '/frames/frame.html'}
+- Page URL: ${server.EMPTY_PAGE}
- Page Title:
- Page Snapshot:
\`\`\`yaml
-- generic [ref=e2]: Hi, I'm frame
+
\`\`\`
### Page 2 of 2
@@ -296,10 +296,16 @@ test('test_debug w/ console_messages', async ({ startClient }) => {
import { test, expect } from '@playwright/test';
test('fail', async ({ page }) => {
await page.evaluate(() => {
- console.log('console.log');
console.error('console.error');
+ console.log('console.log'); // Log should be ignored in the initial message.
+ setTimeout(() => {
+ const error = new Error('Error from page');
+ error.stack = '';
+ throw error;
+ }, 0);
+ return new Promise(f => setTimeout(f, 10));
});
- await expect(page.getByRole('button', { name: 'Missing' })).toBeVisible({ timeout: 1000 });
+ throw new Error('failure');
});
`);
@@ -311,12 +317,21 @@ test('test_debug w/ console_messages', async ({ startClient }) => {
})).toHaveTextResponse(expect.stringContaining(`
Running 1 test using 1 worker
### Paused on error:
-Error: expect(locator).toBeVisible() failed`));
+Error: failure
+
+### Page state
+- Page URL: about:blank
+- Page Title:
+- Console Messages:
+ - [ERROR] console.error @ :1
+ - Error from page
+- Page Snapshot:
+`));
expect(await client.callTool({
name: 'browser_console_messages',
})).toHaveResponse({
- result: expect.stringMatching(/\[LOG] console.log.*\n\[ERROR\] console.error/),
+ result: expect.stringMatching(/\[ERROR\] console.error.*\n\[LOG] console.log/),
});
});
diff --git a/tests/page/page-event-request.spec.ts b/tests/page/page-event-request.spec.ts
index 4bf4df5410..bf7643f0c2 100644
--- a/tests/page/page-event-request.spec.ts
+++ b/tests/page/page-event-request.spec.ts
@@ -383,38 +383,24 @@ it('should return last requests', async ({ page, server }) => {
server.setRoute('/fetch?' + i, (req, res) => res.end('url:' + server.PREFIX + req.url));
// #0 is the navigation request, so start with #1.
- for (let i = 1; i < 50; ++i)
+ for (let i = 0; i < 99; ++i)
await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);
- const first50Requests = await page.requests();
- const firstReponse = await first50Requests[1].response();
- expect(await firstReponse.text()).toBe('url:' + server.PREFIX + '/fetch?1');
-
- page.on('request', () => {});
- for (let i = 50; i < 100; ++i)
- await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);
- const first100Requests = await page.requests();
-
- for (let i = 100; i < 200; ++i)
+ const first99Requests = await page.requests();
+ first99Requests.shift();
+ for (let i = 99; i < 199; ++i)
await page.evaluate(url => fetch(url), server.PREFIX + '/fetch?' + i);
const last100Requests = await page.requests();
+ const allRequests = [...first99Requests, ...last100Requests];
- // Last 100 requests are fully functional.
- const received = await Promise.all(last100Requests.map(async request => {
+ // All 199 requests are fully functional.
+ const received = await Promise.all(allRequests.map(async request => {
const response = await request.response();
return { text: await response.text(), url: request.url() };
}));
const expected = [];
- for (let i = 100; i < 200; ++i) {
+ for (let i = 0; i < 199; ++i) {
const url = server.PREFIX + '/fetch?' + i;
expected.push({ url, text: 'url:' + url });
}
expect(received).toEqual(expected);
-
- // First 50 requests were collected.
- const error = await first50Requests[1].response().catch(e => e);
- expect(error.message).toContain('request.response: The object has been collected to prevent unbounded heap growth.');
-
- // Second 50 requests are functional, because they were reported through the event and not collected.
- const reponse50 = await first100Requests[50].response();
- expect(await reponse50.text()).toBe('url:' + server.PREFIX + '/fetch?50');
});