Skip to content

Commit 8d30912

Browse files
fix(mcp): report event listener exceptions as console errors (#43686)
Co-authored-by: microsoft-playwright-automation[bot] <203992400+microsoft-playwright-automation[bot]@users.noreply.github.com>
1 parent daf7c1d commit 8d30912

8 files changed

Lines changed: 228 additions & 9 deletions

File tree

‎packages/playwright-core/src/client/eventEmitter.ts‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,17 @@ export class EventEmitter implements EventEmitterType {
8282
}
8383

8484
private _callHandler(type: EventType, handler: Listener, args: any[]): void {
85-
const promise = Reflect.apply(handler, this, args);
86-
if (!(promise instanceof Promise))
85+
let promise;
86+
try {
87+
const result = Reflect.apply(handler, this, args);
88+
const then = result?.then;
89+
if (typeof then !== 'function')
90+
return;
91+
promise = new Promise<void>((resolve, reject) => then.call(result, resolve, reject));
92+
} catch (error) {
93+
this._handleListenerError(type, error);
8794
return;
95+
}
8896
let set = this._pendingHandlers.get(type);
8997
if (!set) {
9098
set = new Set();
@@ -95,10 +103,16 @@ export class EventEmitter implements EventEmitterType {
95103
if (this._rejectionHandler)
96104
this._rejectionHandler(e);
97105
else
98-
throw e;
106+
this._handleListenerError(type, e);
99107
}).finally(() => set.delete(promise));
100108
}
101109

110+
private _handleListenerError(type: EventType, error: unknown): void {
111+
if (type === 'error' || !this.listenerCount('error'))
112+
throw error;
113+
this.emit('error', error);
114+
}
115+
102116
addListener(type: EventType, listener: Listener): this {
103117
return this._addListener(type, listener, false);
104118
}

‎packages/playwright-core/src/tools/backend/context.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,14 @@ export class Context {
468468
const browserContext = isolatedContext ? await this._createIsolatedContext(isolatedContext) : this._defaultBrowserContext;
469469
// Isolated contexts are closed in dispose(), which tears down their routes, scripts and listeners.
470470
const disposables = isolatedContext ? [] : this._disposables;
471+
disposables.push(eventsHelper.addEventListener(browserContext, 'error', error => {
472+
const tabs = this._tabs.filter(tab => tab.page.context() === browserContext);
473+
const tab = tabs.find(tab => tab.isCurrentTab()) ?? tabs[0];
474+
if (tab)
475+
tab.logError(error);
476+
else
477+
debug('pw:tools:error')(error);
478+
}));
471479
await this._setupRequestInterception(browserContext, disposables);
472480

473481
for (const initScript of this.config.browser?.initScript || [])

‎packages/playwright-core/src/tools/backend/tab.ts‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616

1717
import { EventEmitter } from 'events';
18+
import { types } from 'util';
1819
import debug from 'debug';
1920
import { asLocator } from '@isomorphic/locatorGenerators';
2021
import { locatorOrSelectorAsSelector } from '@isomorphic/locatorParser';
@@ -119,6 +120,7 @@ export class Tab extends EventEmitter<TabEventsInterface> {
119120
private _recentEventEntries: EventEntry[] = [];
120121
private _webmcpTools: WebMCPListing | undefined;
121122
private _consoleLog: LogFile;
123+
private _eventHandlerErrors: ConsoleMessage[] = [];
122124
private _disposables: Disposable[];
123125
readonly actionTimeoutOptions: { timeout?: number; };
124126
readonly navigationTimeoutOptions: { timeout?: number; };
@@ -134,6 +136,7 @@ export class Tab extends EventEmitter<TabEventsInterface> {
134136
this._disposables = [
135137
eventsHelper.addEventListener(p, 'console', event => this._handleConsoleMessage(messageToConsoleMessage(event))),
136138
eventsHelper.addEventListener(p, 'pageerror', error => this._handleConsoleMessage(pageErrorToConsoleMessage(error))),
139+
eventsHelper.addEventListener(p, 'error', error => this.logError(error)),
137140
eventsHelper.addEventListener(p, 'request', request => this._handleRequest(request)),
138141
eventsHelper.addEventListener(p, 'response', response => this._handleResponse(response)),
139142
eventsHelper.addEventListener(p, 'requestfailed', request => this._handleRequestFailed(request)),
@@ -308,6 +311,14 @@ export class Tab extends EventEmitter<TabEventsInterface> {
308311
this._handleConsoleMessage(pageErrorToConsoleMessage(new Error(text)));
309312
}
310313

314+
logError(error: unknown) {
315+
const message = pageErrorToConsoleMessage(error);
316+
this._eventHandlerErrors.push(message);
317+
if (this._eventHandlerErrors.length > 200)
318+
this._eventHandlerErrors.shift();
319+
this._handleConsoleMessage(message);
320+
}
321+
311322
private _addLogEntry(entry: EventEntry) {
312323
this._recentEventEntries.push(entry);
313324
}
@@ -425,15 +436,16 @@ export class Tab extends EventEmitter<TabEventsInterface> {
425436
const filter = all ? 'all' : 'since-navigation';
426437
const messages = await this.page.consoleMessages({ filter });
427438
const pageErrors = await this.page.pageErrors({ filter });
428-
let errors = pageErrors.length;
439+
const eventHandlerErrors = this._eventHandlerErrors;
440+
let errors = pageErrors.length + eventHandlerErrors.length;
429441
let warnings = 0;
430442
for (const message of messages) {
431443
if (message.type() === 'error')
432444
errors++;
433445
else if (message.type() === 'warning')
434446
warnings++;
435447
}
436-
return { total: messages.length + pageErrors.length, errors, warnings };
448+
return { total: messages.length + pageErrors.length + eventHandlerErrors.length, errors, warnings };
437449
}
438450

439451
async consoleMessages(level: ConsoleMessageLevel, all?: boolean): Promise<ConsoleMessage[]> {
@@ -449,12 +461,14 @@ export class Tab extends EventEmitter<TabEventsInterface> {
449461
const errors = await this.page.pageErrors({ filter: all ? 'all' : 'since-navigation' });
450462
for (const error of errors)
451463
result.push(pageErrorToConsoleMessage(error));
464+
result.push(...this._eventHandlerErrors);
452465
}
453466
return result;
454467
}
455468

456469
async clearConsoleMessages() {
457470
await this._initializedPromise;
471+
this._eventHandlerErrors.length = 0;
458472
await Promise.all([
459473
this.page.clearConsoleMessages(),
460474
this.page.clearPageErrors()
@@ -654,8 +668,8 @@ function messageToConsoleMessage(message: playwright.ConsoleMessage): ConsoleMes
654668
};
655669
}
656670

657-
function pageErrorToConsoleMessage(errorOrValue: Error | any): ConsoleMessage {
658-
if (errorOrValue instanceof Error) {
671+
function pageErrorToConsoleMessage(errorOrValue: unknown): ConsoleMessage {
672+
if (types.isNativeError(errorOrValue)) {
659673
return {
660674
type: 'error',
661675
timestamp: Date.now(),

‎packages/playwright-core/src/tools/skills/playwright-cli/references/running-code.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,8 @@ playwright-cli run-code "async page => {
218218
}"
219219
```
220220

221+
Event listener errors are reported as console errors.
222+
221223
## Complex Workflows
222224

223225
```bash
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/**
2+
* Copyright (c) Microsoft Corporation.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import { spawnSync } from 'child_process';
18+
import vm from 'vm';
19+
import { test, expect } from '@playwright/test';
20+
import { EventEmitter } from './utils';
21+
22+
test('EE-057 should report synchronous listener errors and continue dispatch', {
23+
annotation: { type: 'issue', description: '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/microsoft/playwright/issues/43770' },
24+
}, () => {
25+
const ee = new EventEmitter();
26+
const error = new Error('listener failed');
27+
ee.on('throw', () => { throw error; });
28+
expect(() => ee.emit('throw')).toThrow(error);
29+
30+
const errors = [];
31+
ee.on('error', error => errors.push(error));
32+
ee.on('throw', () => errors.push('next listener'));
33+
expect(ee.emit('throw')).toBe(true);
34+
expect(errors).toEqual([error, 'next listener']);
35+
36+
ee.removeAllListeners('error');
37+
expect(() => ee.emit('throw')).toThrow(error);
38+
ee.on('error', () => { throw new Error('error listener failed'); });
39+
expect(() => ee.emit('throw')).toThrow('error listener failed');
40+
});
41+
42+
test('EE-058 should capture rejections from promises and thenables', async () => {
43+
const ee = new EventEmitter();
44+
const error = new Error('listener failed');
45+
const event = Symbol('event');
46+
const errors = [];
47+
ee.on('error', function(this: EventEmitter, value) {
48+
expect(this).toBe(ee);
49+
errors.push(value);
50+
});
51+
ee.once(event, async function(this: EventEmitter, ...args) {
52+
expect(this).toBe(ee);
53+
expect(args).toEqual([1, 2]);
54+
throw error;
55+
});
56+
ee.on(event, () => errors.push('next listener'));
57+
expect(ee.emit(event, 1, 2)).toBe(true);
58+
expect(errors).toEqual(['next listener']);
59+
await expect.poll(() => errors).toEqual(['next listener', error]);
60+
ee.emit(event);
61+
expect(errors).toEqual(['next listener', error, 'next listener']);
62+
63+
ee.on('vm', () => vm.runInNewContext('Promise.reject("vm rejection")'));
64+
ee.emit('vm');
65+
await expect.poll(() => errors.at(-1)).toBe('vm rejection');
66+
67+
const thenable = {
68+
then(resolve, reject) {
69+
expect(this).toBe(thenable);
70+
reject(error);
71+
},
72+
};
73+
ee.on('thenable', () => thenable);
74+
ee.emit('thenable');
75+
await expect.poll(() => errors.at(-1)).toBe(error);
76+
});
77+
78+
test('EE-059 should read then only once and handle errors while inspecting thenables', {
79+
annotation: { type: 'issue', description: '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/microsoft/playwright/issues/43770' },
80+
}, async () => {
81+
const ee = new EventEmitter();
82+
const errors = [];
83+
ee.on('error', error => errors.push(error));
84+
const error = new Error('then getter failed');
85+
ee.on('getter', () => ({
86+
get then() {
87+
throw error;
88+
},
89+
}));
90+
expect(ee.emit('getter')).toBe(true);
91+
expect(errors).toEqual([error]);
92+
93+
let reads = 0;
94+
ee.on('thenable', () => ({
95+
get then() {
96+
expect(++reads).toBe(1);
97+
return () => { throw new Error('then call failed'); };
98+
},
99+
}));
100+
ee.emit('thenable');
101+
await expect.poll(() => errors.length).toBe(2);
102+
expect(errors[1].message).toBe('then call failed');
103+
expect(reads).toBe(1);
104+
});
105+
106+
test('EE-060 should not swallow unhandled rejections or recurse on error listener failures', () => {
107+
for (const errorListener of [
108+
'',
109+
`ee.on('error', () => { throw new Error('error listener failed'); });`,
110+
`ee.on('error', async () => { throw new Error('error listener failed'); });`,
111+
]) {
112+
const result = spawnSync(process.execPath, ['--unhandled-rejections=strict', '-e', `
113+
const { clientEventEmitter: EventEmitter } = require(${JSON.stringify(require.resolve('../../../packages/playwright-core/lib/coreBundle'))});
114+
const ee = new EventEmitter();
115+
${errorListener}
116+
ee.on('event', async () => { throw new Error('listener failed'); });
117+
ee.emit('event');
118+
`], { encoding: 'utf-8', timeout: 10000 });
119+
expect(result.error).toBeUndefined();
120+
expect(result.status).toBe(1);
121+
expect(result.stderr).toContain(errorListener ? 'Error: error listener failed' : 'Error: listener failed');
122+
}
123+
});

‎tests/library/events/remove-all-listeners-wait.spec.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ const { ManualPromise } = iso;
2323

2424
test('EE-032 should not throw with ignoreErrors', async () => {
2525
const ee = new EventEmitter();
26+
ee.on('error', () => { throw new Error('Should ignore listener errors'); });
2627
const releaseHandler = new ManualPromise();
2728
ee.on('console', async () => {
2829
await releaseHandler;
@@ -70,6 +71,7 @@ test('EE-034 should wait all', async () => {
7071

7172
test('EE-035 wait should throw', async () => {
7273
const ee = new EventEmitter();
74+
ee.on('error', () => { throw new Error('Should return listener errors to the caller'); });
7375
const releaseHandler = new ManualPromise();
7476
ee.on('console', async () => {
7577
await releaseHandler;

‎tests/mcp/run-code.spec.ts‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ import fs from 'fs';
1818

1919
import { test, expect, parseResponse, consoleEntries } from './fixtures';
2020

21-
test('browser_run_code_unsafe', async ({ client, server }) => {
21+
test('browser_run_code_unsafe', {
22+
annotation: { type: 'issue', description: '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/microsoft/playwright-mcp/issues/1803' },
23+
}, async ({ client, server }) => {
2224
server.setContent('/', `
2325
<button onclick="console.log('Submit')">Submit</button>
2426
`, 'text/html');
@@ -36,6 +38,56 @@ test('browser_run_code_unsafe', async ({ client, server }) => {
3638
}));
3739
const content = await consoleEntries(response);
3840
expect(content).toContain('[LOG] Submit');
41+
42+
await client.callTool({
43+
name: 'browser_run_code_unsafe',
44+
arguments: {
45+
code: `(page) => {
46+
page.once('requestfinished', () => { throw new TypeError('page listener failed'); });
47+
page.context().once('requestfinished', () => { throw new Error('context listener failed'); });
48+
page.once('requestfinished', async () => { throw new TypeError('async page listener failed'); });
49+
page.context().once('requestfinished', async () => { throw new Error('async context listener failed'); });
50+
}`,
51+
},
52+
});
53+
54+
const listenerResponse = parseResponse(await client.callTool({
55+
name: 'browser_run_code_unsafe',
56+
arguments: {
57+
code: `async (page) => {
58+
await Promise.all([
59+
page.waitForEvent('requestfinished'),
60+
page.evaluate(() => fetch('/empty.html').then(response => response.text())),
61+
]);
62+
}`,
63+
},
64+
}));
65+
const listenerErrors = await consoleEntries(listenerResponse);
66+
expect(listenerErrors).toContain('TypeError: page listener failed');
67+
expect(listenerErrors).toContain('Error: context listener failed');
68+
expect(listenerErrors).toContain('TypeError: async page listener failed');
69+
expect(listenerErrors).toContain('Error: async context listener failed');
70+
71+
expect(await client.callTool({ name: 'browser_console_messages', arguments: { level: 'error' } })).toHaveResponse({
72+
result: expect.stringContaining('Total messages: 5 (Errors: 4, Warnings: 0)'),
73+
});
74+
const consoleResponse = parseResponse(await client.callTool({ name: 'browser_console_messages' }));
75+
expect(consoleResponse.result).toContain('TypeError: page listener failed');
76+
expect(consoleResponse.result).toContain('Error: context listener failed');
77+
expect(consoleResponse.result).toContain('TypeError: async page listener failed');
78+
expect(consoleResponse.result).toContain('Error: async context listener failed');
79+
80+
server.setContent('/next', '<!DOCTYPE html><title>Next</title>', 'text/html');
81+
await client.callTool({ name: 'browser_navigate', arguments: { url: server.PREFIX + '/next' } });
82+
const afterNavigation = parseResponse(await client.callTool({ name: 'browser_console_messages' }));
83+
expect(afterNavigation.result).toContain('Total messages: 4 (Errors: 4, Warnings: 0)');
84+
expect(afterNavigation.result).toContain('TypeError: page listener failed');
85+
expect(afterNavigation.result).toContain('Error: context listener failed');
86+
expect(afterNavigation.result).toContain('TypeError: async page listener failed');
87+
expect(afterNavigation.result).toContain('Error: async context listener failed');
88+
expect(await client.callTool({ name: 'browser_console_messages', arguments: { all: true } })).toHaveResponse({
89+
result: expect.stringContaining('Total messages: 5 (Errors: 4, Warnings: 0)'),
90+
});
3991
});
4092

4193
test('browser_run_code_unsafe block', async ({ client, server }) => {

‎tests/registry.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ subsystem, add a row to the Subsystems table. Then update this file:
5959
| `DI` | Dialog | `page/page-dialog` |
6060
| `DO` | Download | `library/{download, downloads-path}` |
6161
| `DV` | Device | `library/{browsercontext-device, browsercontext-dsf, browsercontext-viewport-mobile}` |
62-
| `EE` | Event emitter | `page/page-listeners`<br>`library/events/{add-listeners, check-listener-leaks, events-list, listener-count, listeners-side-effects, listeners, max-listeners, method-names, modify-in-emit, num-args, once, prepend, remove-all-listeners-wait, remove-all-listeners, remove-listeners, set-max-listeners-side-effects, special-event-names, subclass, symbols}` |
62+
| `EE` | Event emitter | `page/page-listeners`<br>`library/events/{add-listeners, check-listener-leaks, events-list, listener-count, listeners-side-effects, listeners, max-listeners, method-names, modify-in-emit, num-args, once, prepend, remove-all-listeners-wait, remove-all-listeners, remove-listeners, set-max-listeners-side-effects, special-event-names, subclass, symbols, listener-errors}` |
6363
| `EF` | Expose function | `page/page-expose-function`<br>`library/browsercontext-expose-function` |
6464
| `EH` | ElementHandle | `page/{elementhandle-bounding-box, elementhandle-click, elementhandle-content-frame, elementhandle-convenience, elementhandle-eval-on-selector, elementhandle-misc, elementhandle-owner-frame, elementhandle-press, elementhandle-query-selector, elementhandle-screenshot, elementhandle-scroll-into-view, elementhandle-select-text, elementhandle-type, elementhandle-wait-for-element-state}` |
6565
| `EM` | Emulation | `page/page-emulate-media`<br>`library/{emulation-focus, emulation-coop}` |
@@ -1840,6 +1840,10 @@ subsystem, add a row to the Subsystems table. Then update this file:
18401840
| `EE-054` | `library/events/subclass.spec.ts` | myee instance |
18411841
| `EE-055` | `library/events/subclass.spec.ts` | MyEE2 instance |
18421842
| `EE-056` | `library/events/symbols.spec.ts` | should support symbols |
1843+
| `EE-057` | `library/events/listener-errors.spec.ts` | should report synchronous listener errors and continue dispatch |
1844+
| `EE-058` | `library/events/listener-errors.spec.ts` | should capture rejections from promises and thenables |
1845+
| `EE-059` | `library/events/listener-errors.spec.ts` | should read then only once and handle errors while inspecting thenables |
1846+
| `EE-060` | `library/events/listener-errors.spec.ts` | should not swallow unhandled rejections or recurse on error listener failures |
18431847

18441848
### EF — Expose function
18451849

0 commit comments

Comments
 (0)