Skip to content

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

chore(protocol): replace EventTarget interface with __waitInfo__ message (#40718)

Dmitry Gozmana26b3614d61b
diff --git a/packages/isomorphic/protocolMetainfo.ts b/packages/isomorphic/protocolMetainfo.ts
index 8a0dcb4ab1..686f1451fc 100644
--- a/packages/isomorphic/protocolMetainfo.ts
+++ b/packages/isomorphic/protocolMetainfo.ts
@@ -112,14 +112,6 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['BrowserType.connectOverCDP', { title: 'Connect over CDP', }],
['BrowserType.connectToWorker', { title: 'Connect to worker', }],
['Disposable.dispose', { internal: true, }],
- ['EventTarget.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['AndroidDevice.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['BrowserContext.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['ElectronApplication.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['WebSocket.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Page.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Debugger.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Worker.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['Electron.launch', { title: 'Launch electron', }],
['ElectronApplication.browserWindow', { internal: true, }],
['ElectronApplication.evaluateExpression', { title: 'Evaluate', }],
diff --git a/packages/playwright-core/src/client/connection.ts b/packages/playwright-core/src/client/connection.ts
index f54c07948c..4e72253fb1 100644
--- a/packages/playwright-core/src/client/connection.ts
+++ b/packages/playwright-core/src/client/connection.ts
@@ -172,6 +172,10 @@ export class Connection extends EventEmitter {
}
async sendMessageToServer(object: ChannelOwner, method: string, params: any, options: { apiName?: string, title?: string, internal?: boolean, frames?: channels.StackFrame[], stepId?: string }): Promise<any> {
+ // Fire-and-forget: server intentionally never replies to __waitInfo__,
+ // so silently drop it after the connection is closed or the object was collected.
+ if (method === '__waitInfo__' && (this._closedError || object._wasCollected))
+ return;
if (this._closedError)
throw this._closedError;
if (object._wasCollected)
@@ -192,6 +196,9 @@ export class Connection extends EventEmitter {
// We need to exit zones before calling into the server, otherwise
// when we receive events from the server, we would be in an API zone.
this._platform.zones.empty.run(() => this.onmessage({ ...message, metadata }));
+ // Fire-and-forget: server intentionally never replies to __waitInfo__.
+ if (method === '__waitInfo__')
+ return;
return await new Promise((resolve, reject) => this._callbacks.set(id, { resolve, reject, title: options.title, type, method }));
}
diff --git a/packages/playwright-core/src/client/waiter.ts b/packages/playwright-core/src/client/waiter.ts
index 61c3172f90..e2b63c8900 100644
--- a/packages/playwright-core/src/client/waiter.ts
+++ b/packages/playwright-core/src/client/waiter.ts
@@ -27,28 +27,47 @@ export class Waiter {
private _failures: Promise<any>[] = [];
private _immediateError?: Error;
private _logs: string[] = [];
- private _channelOwner: ChannelOwner<channels.EventTargetChannel>;
+ private _channelOwner: ChannelOwner;
private _waitId: string;
private _error: string | undefined;
private _savedZone: Zone;
- constructor(channelOwner: ChannelOwner<channels.EventTargetChannel>, event: string) {
+ constructor(channelOwner: ChannelOwner, event: string) {
this._waitId = channelOwner._platform.createGuid();
this._channelOwner = channelOwner;
this._savedZone = channelOwner._platform.zones.current().pop();
- this._channelOwner._channel.waitForEventInfo({ info: { waitId: this._waitId, phase: 'before', event } }).catch(() => {});
+ const title = `Wait for event "${event}"`;
+ this._sendWaitInfo({ waitId: this._waitId, phase: 'before', event }, { title });
this._dispose = [
- () => this._channelOwner._wrapApiCall(async () => {
- await this._channelOwner._channel.waitForEventInfo({ info: { waitId: this._waitId, phase: 'after', error: this._error } });
- }, { internal: true }).catch(() => {}),
+ () => this._sendWaitInfo({ waitId: this._waitId, phase: 'after', error: this._error }, { internal: true }),
];
}
- static createForEvent(channelOwner: ChannelOwner<channels.EventTargetChannel>, event: string) {
+ static createForEvent(channelOwner: ChannelOwner, event: string) {
return new Waiter(channelOwner, event);
}
+ private _sendWaitInfo(info: channels.WaitInfo, options: { title?: string, internal?: boolean }): void {
+ // Fire-and-forget: server intentionally never replies, and we never throw to the caller.
+ const owner = this._channelOwner;
+ owner._wrapApiCall(async apiZone => {
+ if (apiZone.internal || apiZone.reported) {
+ void owner._connection.sendMessageToServer(owner, '__waitInfo__', info, { internal: true });
+ return;
+ }
+ apiZone.reported = true;
+ // An outer `_wrapApiCall` may have set its own title (e.g. "Wait for navigation");
+ // fall back to ours only when the outer zone left it blank. The title is read both by
+ // `onApiCallBegin` (drives the test runner step title) and by `sendMessageToServer`
+ // (drives the trace viewer action title), so set it on the zone itself.
+ if (!apiZone.title)
+ apiZone.title = options.title;
+ owner._instrumentation.onApiCallBegin(apiZone, { type: owner._type, method: '__waitInfo__', params: info });
+ void owner._connection.sendMessageToServer(owner, '__waitInfo__', info, apiZone);
+ }, options).catch(() => {});
+ }
+
async waitForEvent<T = void>(emitter: EventEmitter, event: string, predicate?: (arg: T) => boolean | Promise<boolean>): Promise<T> {
const { promise, dispose } = waitForEvent(emitter, event, this._savedZone, predicate);
return await this.waitForPromise(promise, dispose);
@@ -95,9 +114,7 @@ export class Waiter {
log(s: string) {
this._logs.push(s);
- this._channelOwner._wrapApiCall(async () => {
- await this._channelOwner._channel.waitForEventInfo({ info: { waitId: this._waitId, phase: 'log', message: s } });
- }, { internal: true }).catch(() => {});
+ this._sendWaitInfo({ waitId: this._waitId, phase: 'log', message: s }, { internal: true });
}
private _rejectOn(promise: Promise<any>, dispose?: () => void) {
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index b73bea2193..fd6ee27b4f 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -18,7 +18,7 @@
import { scheme, tOptional, tObject, tBoolean, tInt, tFloat, tString, tAny, tEnum, tArray, tBinary, tChannel, tType } from './validatorPrimitives';
export type { Validator, ValidatorContext } from './validatorPrimitives';
-export { ValidationError, findValidator, maybeFindValidator, createMetadataValidator } from './validatorPrimitives';
+export { ValidationError, findValidator, maybeFindValidator, createMetadataValidator, createWaitInfoValidator } from './validatorPrimitives';
scheme.AndroidInitializer = tOptional(tObject({}));
scheme.AndroidDevicesParams = tObject({
@@ -1089,31 +1089,13 @@ scheme.SDKLanguage = tEnum(['javascript', 'python', 'java', 'csharp']);
scheme.DisposableInitializer = tOptional(tObject({}));
scheme.DisposableDisposeParams = tOptional(tObject({}));
scheme.DisposableDisposeResult = tOptional(tObject({}));
-scheme.EventTargetInitializer = tOptional(tObject({}));
-scheme.EventTargetWaitForEventInfoParams = tObject({
- info: tObject({
- waitId: tString,
- phase: tEnum(['before', 'after', 'log']),
- event: tOptional(tString),
- message: tOptional(tString),
- error: tOptional(tString),
- }),
+scheme.WaitInfo = tObject({
+ waitId: tString,
+ phase: tEnum(['before', 'after', 'log']),
+ event: tOptional(tString),
+ message: tOptional(tString),
+ error: tOptional(tString),
});
-scheme.AndroidDeviceWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.BrowserContextWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.ElectronApplicationWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.WebSocketWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.PageWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.DebuggerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.WorkerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.EventTargetWaitForEventInfoResult = tOptional(tObject({}));
-scheme.AndroidDeviceWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.BrowserContextWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.ElectronApplicationWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.WebSocketWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.PageWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.DebuggerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.WorkerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
scheme.ElectronInitializer = tOptional(tObject({}));
scheme.ElectronLaunchParams = tObject({
executablePath: tOptional(tString),
diff --git a/packages/playwright-core/src/protocol/validatorPrimitives.ts b/packages/playwright-core/src/protocol/validatorPrimitives.ts
index d722439572..ba15b856d8 100644
--- a/packages/playwright-core/src/protocol/validatorPrimitives.ts
+++ b/packages/playwright-core/src/protocol/validatorPrimitives.ts
@@ -36,6 +36,9 @@ export function maybeFindValidator(type: string, method: string, kind: 'Initiali
export function createMetadataValidator(): Validator {
return tOptional(scheme['Metadata']);
}
+export function createWaitInfoValidator(): Validator {
+ return scheme['WaitInfo'];
+}
export const tFloat: Validator = (arg: any, path: string, context: ValidatorContext) => {
if (arg instanceof Number)
diff --git a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
index 1b2d7a1587..dc554d8466 100644
--- a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
@@ -44,7 +44,6 @@ export class AndroidDispatcher extends Dispatcher<Android, channels.AndroidChann
}
export class AndroidDeviceDispatcher extends Dispatcher<AndroidDevice, channels.AndroidDeviceChannel, AndroidDispatcher> implements channels.AndroidDeviceChannel {
- _type_EventTarget = true;
_type_AndroidDevice = true;
static from(scope: AndroidDispatcher, device: AndroidDevice): AndroidDeviceDispatcher {
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 3170e5e7d0..fb03e1713f 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -51,7 +51,6 @@ import type { Progress } from '@protocol/progress';
import type { URLMatch } from '@isomorphic/urlMatch';
export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channels.BrowserContextChannel, DispatcherScope> implements channels.BrowserContextChannel {
- _type_EventTarget = true;
_type_BrowserContext = true;
private _context: BrowserContext;
private _subscriptions = new Set<channels.BrowserContextUpdateSubscriptionParams['event']>();
diff --git a/packages/playwright-core/src/server/dispatchers/debuggerDispatcher.ts b/packages/playwright-core/src/server/dispatchers/debuggerDispatcher.ts
index f33978684b..6dcd7ef7ec 100644
--- a/packages/playwright-core/src/server/dispatchers/debuggerDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/debuggerDispatcher.ts
@@ -23,7 +23,6 @@ import type * as channels from '@protocol/channels';
import type { Progress } from '@protocol/progress';
export class DebuggerDispatcher extends Dispatcher<Debugger, channels.DebuggerChannel, BrowserContextDispatcher> implements channels.DebuggerChannel {
- _type_EventTarget = true;
_type_Debugger = true;
static from(scope: BrowserContextDispatcher, debugger_: Debugger): DebuggerDispatcher {
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 48feced737..e065137eeb 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -22,7 +22,7 @@ import { isUnderTest } from '@utils/debug';
import { assert } from '@isomorphic/assert';
import { monotonicTime } from '@isomorphic/time';
import { rewriteErrorMessage } from '@isomorphic/stackTrace';
-import { ValidationError, createMetadataValidator, findValidator } from '../../protocol/validator';
+import { ValidationError, createMetadataValidator, createWaitInfoValidator, findValidator } from '../../protocol/validator';
import { TargetClosedError, isTargetClosedError, serializeError } from '../errors';
import { createRootSdkObject, SdkObject } from '../instrumentation';
import { isProtocolError } from '../protocolError';
@@ -36,6 +36,7 @@ import type { ValidatorContext } from '../../protocol/validator';
import type * as channels from '@protocol/channels';
const metadataValidator = createMetadataValidator();
+const waitInfoValidator = createWaitInfoValidator();
let maxDispatchersOverride: number | undefined;
export function setMaxDispatchersForTest(value: number | undefined) {
@@ -170,10 +171,6 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
objects: Array.from(this._dispatchers.values()).map(o => o._debugScopeState()),
};
}
-
- async waitForEventInfo(): Promise<void> {
- // Instrumentation takes care of this.
- }
}
export type DispatcherScope = Dispatcher<SdkObject, any, any>;
@@ -301,6 +298,12 @@ export class DispatcherConnection {
async dispatch(message: object) {
const { id, guid, method, params, metadata } = message as any;
const dispatcher = this._dispatcherByGuid.get(guid);
+ if (method === '__waitInfo__') {
+ // Fire-and-forget: silently drop if the target is gone.
+ if (dispatcher)
+ await this._dispatchWaitInfo(id, dispatcher, params, metadata);
+ return;
+ }
if (!dispatcher) {
this.onmessage({ id, error: serializeError(new TargetClosedError(undefined)) });
return;
@@ -345,33 +348,6 @@ export class DispatcherConnection {
log: [],
};
- if (params?.info?.waitId) {
- // Process logs for waitForNavigation/waitForLoadState/etc.
- const info = params.info;
- switch (info.phase) {
- case 'before': {
- this._waitOperations.set(info.waitId, callMetadata);
- await sdkObject.instrumentation.onBeforeCall(sdkObject, callMetadata);
- this.onmessage({ id });
- return;
- } case 'log': {
- const originalMetadata = this._waitOperations.get(info.waitId)!;
- originalMetadata.log.push(info.message);
- sdkObject.instrumentation.onCallLog(sdkObject, originalMetadata, 'api', info.message);
- this.onmessage({ id });
- return;
- } case 'after': {
- const originalMetadata = this._waitOperations.get(info.waitId)!;
- originalMetadata.endTime = monotonicTime();
- originalMetadata.error = info.error ? { error: { name: 'Error', message: info.error } } : undefined;
- this._waitOperations.delete(info.waitId);
- await sdkObject.instrumentation.onAfterCall(sdkObject, originalMetadata);
- this.onmessage({ id });
- return;
- }
- }
- }
-
await sdkObject.instrumentation.onBeforeCall(sdkObject, callMetadata);
const response: any = { id };
try {
@@ -413,4 +389,55 @@ export class DispatcherConnection {
if (slowMo)
await new Promise(f => setTimeout(f, slowMo));
}
+
+ private async _dispatchWaitInfo(id: number, dispatcher: DispatcherScope, params: any, metadata: any) {
+ // Fire-and-forget notification: never reply, never throw to the caller.
+ let info: channels.WaitInfo;
+ let validMetadata: channels.Metadata;
+ try {
+ const validatorContext = this._validatorFromWireContext();
+ info = waitInfoValidator(params, '', validatorContext);
+ validMetadata = metadataValidator(metadata, '', validatorContext);
+ } catch {
+ return;
+ }
+
+ const sdkObject = dispatcher._object;
+ if (info.phase === 'before') {
+ const callMetadata: CallMetadata = {
+ id: `call@${id}`,
+ location: validMetadata.location,
+ title: validMetadata.title,
+ internal: validMetadata.internal,
+ stepId: validMetadata.stepId,
+ objectId: sdkObject.guid,
+ pageId: sdkObject.attribution?.page?.guid,
+ frameId: sdkObject.attribution?.frame?.guid,
+ startTime: monotonicTime(),
+ endTime: 0,
+ type: dispatcher._type,
+ method: '__waitInfo__',
+ params: params || {},
+ log: [],
+ };
+ this._waitOperations.set(info.waitId, callMetadata);
+ await sdkObject.instrumentation.onBeforeCall(sdkObject, callMetadata).catch(() => {});
+ return;
+ }
+
+ const originalMetadata = this._waitOperations.get(info.waitId);
+ if (!originalMetadata)
+ return;
+ if (info.phase === 'log' && info.message) {
+ originalMetadata.log.push(info.message);
+ sdkObject.instrumentation.onCallLog(sdkObject, originalMetadata, 'api', info.message);
+ return;
+ }
+ if (info.phase === 'after') {
+ originalMetadata.endTime = monotonicTime();
+ originalMetadata.error = info.error ? { error: { name: 'Error', message: info.error } } : undefined;
+ this._waitOperations.delete(info.waitId);
+ await sdkObject.instrumentation.onAfterCall(sdkObject, originalMetadata).catch(() => {});
+ }
+ }
}
diff --git a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts b/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
index ce51ffec96..12cb35cbf8 100644
--- a/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
+++ b/packages/playwright-core/src/server/dispatchers/networkDispatchers.ts
@@ -175,7 +175,6 @@ export class RouteDispatcher extends Dispatcher<Route, channels.RouteChannel, Re
}
export class WebSocketDispatcher extends Dispatcher<WebSocket, channels.WebSocketChannel, PageDispatcher> implements channels.WebSocketChannel {
- _type_EventTarget = true;
_type_WebSocket = true;
constructor(scope: PageDispatcher, webSocket: WebSocket) {
diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
index 56dc88c2ce..d393fac2d1 100644
--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
@@ -52,7 +52,6 @@ import type { ScreencastFrame } from '../types';
import type { ScreencastClient } from '../screencast';
export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, BrowserContextDispatcher> implements channels.PageChannel {
- _type_EventTarget = true;
_type_Page = true;
private _page: Page;
_subscriptions = new Set<channels.PageUpdateSubscriptionParams['event']>();
@@ -490,7 +489,6 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
export class WorkerDispatcher extends Dispatcher<Worker, channels.WorkerChannel, PageDispatcher | BrowserContextDispatcher | BrowserTypeDispatcher> implements channels.WorkerChannel {
_type_Worker = true;
- _type_EventTarget = true;
readonly _subscriptions = new Set<channels.WorkerUpdateSubscriptionParams['event']>();
diff --git a/packages/protocol/spec/android.yml b/packages/protocol/spec/android.yml
index 9846f184b6..5c627b675d 100644
--- a/packages/protocol/spec/android.yml
+++ b/packages/protocol/spec/android.yml
@@ -49,8 +49,6 @@ AndroidSocket:
AndroidDevice:
type: interface
- extends: EventTarget
-
initializer:
model: string
serial: string
diff --git a/packages/protocol/spec/browserContext.yml b/packages/protocol/spec/browserContext.yml
index dc3679ebe5..411459d519 100644
--- a/packages/protocol/spec/browserContext.yml
+++ b/packages/protocol/spec/browserContext.yml
@@ -15,8 +15,6 @@
BrowserContext:
type: interface
- extends: EventTarget
-
initializer:
debugger: Debugger
requestContext: APIRequestContext
diff --git a/packages/protocol/spec/core.yml b/packages/protocol/spec/core.yml
index f320692acb..b97078ea76 100644
--- a/packages/protocol/spec/core.yml
+++ b/packages/protocol/spec/core.yml
@@ -50,25 +50,16 @@ Disposable:
dispose:
internal: true
-EventTarget:
- type: interface
-
- commands:
- waitForEventInfo:
- title: Wait for event "{info.event}"
- parameters:
- info:
- type: object
- properties:
- waitId: string
- phase:
- type: enum
- literals:
- - before
- - after
- - log
- event: string?
- message: string?
- error: string?
- flags:
- snapshot: true
+WaitInfo:
+ type: object
+ properties:
+ waitId: string
+ phase:
+ type: enum
+ literals:
+ - before
+ - after
+ - log
+ event: string?
+ message: string?
+ error: string?
diff --git a/packages/protocol/spec/network.yml b/packages/protocol/spec/network.yml
index ade023e50f..7c2eca411d 100644
--- a/packages/protocol/spec/network.yml
+++ b/packages/protocol/spec/network.yml
@@ -283,8 +283,6 @@ RemoteAddr:
WebSocket:
type: interface
- extends: EventTarget
-
initializer:
url: string
diff --git a/packages/protocol/spec/page.yml b/packages/protocol/spec/page.yml
index a5e6e16488..8cb3a7fe75 100644
--- a/packages/protocol/spec/page.yml
+++ b/packages/protocol/spec/page.yml
@@ -15,8 +15,6 @@
Page:
type: interface
- extends: EventTarget
-
initializer:
mainFrame: Frame
viewportSize:
diff --git a/packages/protocol/spec/playwright.yml b/packages/protocol/spec/playwright.yml
index bec45a11f5..287f3714d4 100644
--- a/packages/protocol/spec/playwright.yml
+++ b/packages/protocol/spec/playwright.yml
@@ -431,8 +431,6 @@ BindingCall:
Debugger:
type: interface
- extends: EventTarget
-
commands:
requestPause:
diff --git a/packages/protocol/spec/worker.yml b/packages/protocol/spec/worker.yml
index 3588726308..55dda2f7bf 100644
--- a/packages/protocol/spec/worker.yml
+++ b/packages/protocol/spec/worker.yml
@@ -15,8 +15,6 @@
Worker:
type: interface
- extends: EventTarget
-
initializer:
url: string
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 645d3f441a..a2005ec27f 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -26,25 +26,20 @@ export interface Channel {
// ----------- Initializer Traits -----------
export type InitializerTraits<T> =
- T extends AndroidDeviceChannel ? AndroidDeviceInitializer :
- T extends BrowserContextChannel ? BrowserContextInitializer :
- T extends ElectronApplicationChannel ? ElectronApplicationInitializer :
T extends ElementHandleChannel ? ElementHandleInitializer :
- T extends WebSocketChannel ? WebSocketInitializer :
- T extends PageChannel ? PageInitializer :
- T extends DebuggerChannel ? DebuggerInitializer :
- T extends WorkerChannel ? WorkerInitializer :
T extends AndroidChannel ? AndroidInitializer :
T extends AndroidSocketChannel ? AndroidSocketInitializer :
+ T extends AndroidDeviceChannel ? AndroidDeviceInitializer :
T extends APIRequestContextChannel ? APIRequestContextInitializer :
T extends ArtifactChannel ? ArtifactInitializer :
T extends StreamChannel ? StreamInitializer :
T extends WritableStreamChannel ? WritableStreamInitializer :
T extends BrowserChannel ? BrowserInitializer :
+ T extends BrowserContextChannel ? BrowserContextInitializer :
T extends BrowserTypeChannel ? BrowserTypeInitializer :
T extends DisposableChannel ? DisposableInitializer :
- T extends EventTargetChannel ? EventTargetInitializer :
T extends ElectronChannel ? ElectronInitializer :
+ T extends ElectronApplicationChannel ? ElectronApplicationInitializer :
T extends FrameChannel ? FrameInitializer :
T extends JSHandleChannel ? JSHandleInitializer :
T extends LocalUtilsChannel ? LocalUtilsInitializer :
@@ -52,6 +47,8 @@ export type InitializerTraits<T> =
T extends RouteChannel ? RouteInitializer :
T extends WebSocketRouteChannel ? WebSocketRouteInitializer :
T extends ResponseChannel ? ResponseInitializer :
+ T extends WebSocketChannel ? WebSocketInitializer :
+ T extends PageChannel ? PageInitializer :
T extends RootChannel ? RootInitializer :
T extends PlaywrightChannel ? PlaywrightInitializer :
T extends DebugControllerChannel ? DebugControllerInitializer :
@@ -59,31 +56,28 @@ export type InitializerTraits<T> =
T extends JsonPipeChannel ? JsonPipeInitializer :
T extends CDPSessionChannel ? CDPSessionInitializer :
T extends BindingCallChannel ? BindingCallInitializer :
+ T extends DebuggerChannel ? DebuggerInitializer :
T extends DialogChannel ? DialogInitializer :
T extends TracingChannel ? TracingInitializer :
+ T extends WorkerChannel ? WorkerInitializer :
object;
// ----------- Event Traits -----------
export type EventsTraits<T> =
- T extends AndroidDeviceChannel ? AndroidDeviceEvents :
- T extends BrowserContextChannel ? BrowserContextEvents :
- T extends ElectronApplicationChannel ? ElectronApplicationEvents :
T extends ElementHandleChannel ? ElementHandleEvents :
- T extends WebSocketChannel ? WebSocketEvents :
- T extends PageChannel ? PageEvents :
- T extends DebuggerChannel ? DebuggerEvents :
- T extends WorkerChannel ? WorkerEvents :
T extends AndroidChannel ? AndroidEvents :
T extends AndroidSocketChannel ? AndroidSocketEvents :
+ T extends AndroidDeviceChannel ? AndroidDeviceEvents :
T extends APIRequestContextChannel ? APIRequestContextEvents :
T extends ArtifactChannel ? ArtifactEvents :
T extends StreamChannel ? StreamEvents :
T extends WritableStreamChannel ? WritableStreamEvents :
T extends BrowserChannel ? BrowserEvents :
+ T extends BrowserContextChannel ? BrowserContextEvents :
T extends BrowserTypeChannel ? BrowserTypeEvents :
T extends DisposableChannel ? DisposableEvents :
- T extends EventTargetChannel ? EventTargetEvents :
T extends ElectronChannel ? ElectronEvents :
+ T extends ElectronApplicationChannel ? ElectronApplicationEvents :
T extends FrameChannel ? FrameEvents :
T extends JSHandleChannel ? JSHandleEvents :
T extends LocalUtilsChannel ? LocalUtilsEvents :
@@ -91,6 +85,8 @@ export type EventsTraits<T> =
T extends RouteChannel ? RouteEvents :
T extends WebSocketRouteChannel ? WebSocketRouteEvents :
T extends ResponseChannel ? ResponseEvents :
+ T extends WebSocketChannel ? WebSocketEvents :
+ T extends PageChannel ? PageEvents :
T extends RootChannel ? RootEvents :
T extends PlaywrightChannel ? PlaywrightEvents :
T extends DebugControllerChannel ? DebugControllerEvents :
@@ -98,31 +94,28 @@ export type EventsTraits<T> =
T extends JsonPipeChannel ? JsonPipeEvents :
T extends CDPSessionChannel ? CDPSessionEvents :
T extends BindingCallChannel ? BindingCallEvents :
+ T extends DebuggerChannel ? DebuggerEvents :
T extends DialogChannel ? DialogEvents :
T extends TracingChannel ? TracingEvents :
+ T extends WorkerChannel ? WorkerEvents :
undefined;
// ----------- EventTarget Traits -----------
export type EventTargetTraits<T> =
- T extends AndroidDeviceChannel ? AndroidDeviceEventTarget :
- T extends BrowserContextChannel ? BrowserContextEventTarget :
- T extends ElectronApplicationChannel ? ElectronApplicationEventTarget :
T extends ElementHandleChannel ? ElementHandleEventTarget :
- T extends WebSocketChannel ? WebSocketEventTarget :
- T extends PageChannel ? PageEventTarget :
- T extends DebuggerChannel ? DebuggerEventTarget :
- T extends WorkerChannel ? WorkerEventTarget :
T extends AndroidChannel ? AndroidEventTarget :
T extends AndroidSocketChannel ? AndroidSocketEventTarget :
+ T extends AndroidDeviceChannel ? AndroidDeviceEventTarget :
T extends APIRequestContextChannel ? APIRequestContextEventTarget :
T extends ArtifactChannel ? ArtifactEventTarget :
T extends StreamChannel ? StreamEventTarget :
T extends WritableStreamChannel ? WritableStreamEventTarget :
T extends BrowserChannel ? BrowserEventTarget :
+ T extends BrowserContextChannel ? BrowserContextEventTarget :
T extends BrowserTypeChannel ? BrowserTypeEventTarget :
T extends DisposableChannel ? DisposableEventTarget :
- T extends EventTargetChannel ? EventTargetEventTarget :
T extends ElectronChannel ? ElectronEventTarget :
+ T extends ElectronApplicationChannel ? ElectronApplicationEventTarget :
T extends FrameChannel ? FrameEventTarget :
T extends JSHandleChannel ? JSHandleEventTarget :
T extends LocalUtilsChannel ? LocalUtilsEventTarget :
@@ -130,6 +123,8 @@ export type EventTargetTraits<T> =
T extends RouteChannel ? RouteEventTarget :
T extends WebSocketRouteChannel ? WebSocketRouteEventTarget :
T extends ResponseChannel ? ResponseEventTarget :
+ T extends WebSocketChannel ? WebSocketEventTarget :
+ T extends PageChannel ? PageEventTarget :
T extends RootChannel ? RootEventTarget :
T extends PlaywrightChannel ? PlaywrightEventTarget :
T extends DebugControllerChannel ? DebugControllerEventTarget :
@@ -137,8 +132,10 @@ export type EventTargetTraits<T> =
T extends JsonPipeChannel ? JsonPipeEventTarget :
T extends CDPSessionChannel ? CDPSessionEventTarget :
T extends BindingCallChannel ? BindingCallEventTarget :
+ T extends DebuggerChannel ? DebuggerEventTarget :
T extends DialogChannel ? DialogEventTarget :
T extends TracingChannel ? TracingEventTarget :
+ T extends WorkerChannel ? WorkerEventTarget :
undefined;
// ----------- Android -----------
@@ -207,7 +204,7 @@ export interface AndroidDeviceEventTarget {
on(event: 'webViewAdded', callback: (params: AndroidDeviceWebViewAddedEvent) => void): this;
on(event: 'webViewRemoved', callback: (params: AndroidDeviceWebViewRemovedEvent) => void): this;
}
-export interface AndroidDeviceChannel extends AndroidDeviceEventTarget, EventTargetChannel {
+export interface AndroidDeviceChannel extends AndroidDeviceEventTarget, Channel {
_type_AndroidDevice: boolean;
wait(params: AndroidDeviceWaitParams, progress?: Progress): Promise<AndroidDeviceWaitResult>;
fill(params: AndroidDeviceFillParams, progress?: Progress): Promise<AndroidDeviceFillResult>;
@@ -1321,7 +1318,7 @@ export interface BrowserContextEventTarget {
on(event: 'response', callback: (params: BrowserContextResponseEvent) => void): this;
on(event: 'recorderEvent', callback: (params: BrowserContextRecorderEventEvent) => void): this;
}
-export interface BrowserContextChannel extends BrowserContextEventTarget, EventTargetChannel {
+export interface BrowserContextChannel extends BrowserContextEventTarget, Channel {
_type_BrowserContext: boolean;
addCookies(params: BrowserContextAddCookiesParams, progress?: Progress): Promise<BrowserContextAddCookiesResult>;
addInitScript(params: BrowserContextAddInitScriptParams, progress?: Progress): Promise<BrowserContextAddInitScriptResult>;
@@ -2065,30 +2062,13 @@ export type DisposableDisposeResult = void;
export interface DisposableEvents {
}
-// ----------- EventTarget -----------
-export type EventTargetInitializer = {};
-export interface EventTargetEventTarget {
-}
-export interface EventTargetChannel extends EventTargetEventTarget, Channel {
- _type_EventTarget: boolean;
- waitForEventInfo(params: EventTargetWaitForEventInfoParams, progress?: Progress): Promise<EventTargetWaitForEventInfoResult>;
-}
-export type EventTargetWaitForEventInfoParams = {
- info: {
- waitId: string,
- phase: 'before' | 'after' | 'log',
- event?: string,
- message?: string,
- error?: string,
- },
-};
-export type EventTargetWaitForEventInfoOptions = {
-
+export type WaitInfo = {
+ waitId: string,
+ phase: 'before' | 'after' | 'log',
+ event?: string,
+ message?: string,
+ error?: string,
};
-export type EventTargetWaitForEventInfoResult = void;
-
-export interface EventTargetEvents {
-}
// ----------- Electron -----------
export type ElectronInitializer = {};
@@ -3945,7 +3925,7 @@ export interface WebSocketEventTarget {
on(event: 'socketError', callback: (params: WebSocketSocketErrorEvent) => void): this;
on(event: 'close', callback: (params: WebSocketCloseEvent) => void): this;
}
-export interface WebSocketChannel extends WebSocketEventTarget, EventTargetChannel {
+export interface WebSocketChannel extends WebSocketEventTarget, Channel {
_type_WebSocket: boolean;
}
export type WebSocketOpenEvent = {};
@@ -3997,7 +3977,7 @@ export interface PageEventTarget {
on(event: 'webSocket', callback: (params: PageWebSocketEvent) => void): this;
on(event: 'worker', callback: (params: PageWorkerEvent) => void): this;
}
-export interface PageChannel extends PageEventTarget, EventTargetChannel {
+export interface PageChannel extends PageEventTarget, Channel {
_type_Page: boolean;
addInitScript(params: PageAddInitScriptParams, progress?: Progress): Promise<PageAddInitScriptResult>;
close(params: PageCloseParams, progress?: Progress): Promise<PageCloseResult>;
@@ -5139,7 +5119,7 @@ export type DebuggerInitializer = {};
export interface DebuggerEventTarget {
on(event: 'pausedStateChanged', callback: (params: DebuggerPausedStateChangedEvent) => void): this;
}
-export interface DebuggerChannel extends DebuggerEventTarget, EventTargetChannel {
+export interface DebuggerChannel extends DebuggerEventTarget, Channel {
_type_Debugger: boolean;
requestPause(params?: DebuggerRequestPauseParams, progress?: Progress): Promise<DebuggerRequestPauseResult>;
resume(params?: DebuggerResumeParams, progress?: Progress): Promise<DebuggerResumeResult>;
@@ -5394,7 +5374,7 @@ export interface WorkerEventTarget {
on(event: 'console', callback: (params: WorkerConsoleEvent) => void): this;
on(event: 'close', callback: (params: WorkerCloseEvent) => void): this;
}
-export interface WorkerChannel extends WorkerEventTarget, EventTargetChannel {
+export interface WorkerChannel extends WorkerEventTarget, Channel {
_type_Worker: boolean;
disconnect(params: WorkerDisconnectParams, progress?: Progress): Promise<WorkerDisconnectResult>;
evaluateExpression(params: WorkerEvaluateExpressionParams, progress?: Progress): Promise<WorkerEvaluateExpressionResult>;
diff --git a/tests/library/tracing.spec.ts b/tests/library/tracing.spec.ts
index b1232072f9..bd077ed4d5 100644
--- a/tests/library/tracing.spec.ts
+++ b/tests/library/tracing.spec.ts
@@ -829,6 +829,7 @@ test('should not emit after w/o before', async ({ browserType, mode }, testInfo)
{
type: 'before',
callId: expect.any(Number),
+ title: 'Wait for event "console"',
},
{
type: 'after',
diff --git a/utils/generate_channels.js b/utils/generate_channels.js
index 2ce95efb6f..3d03cb4857 100755
--- a/utils/generate_channels.js
+++ b/utils/generate_channels.js
@@ -158,7 +158,7 @@ const validator_ts = [
import { scheme, tOptional, tObject, tBoolean, tInt, tFloat, tString, tAny, tEnum, tArray, tBinary, tChannel, tType } from './validatorPrimitives';
export type { Validator, ValidatorContext } from './validatorPrimitives';
-export { ValidationError, findValidator, maybeFindValidator, createMetadataValidator } from './validatorPrimitives';
+export { ValidationError, findValidator, maybeFindValidator, createMetadataValidator, createWaitInfoValidator } from './validatorPrimitives';
`];
const metainfo_ts = [