Skip to content

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

chore(bidi): support workers with console events (#37331)

Alex Rudenko5d48e77aa088
diff --git a/packages/playwright-core/src/server/bidi/bidiConnection.ts b/packages/playwright-core/src/server/bidi/bidiConnection.ts
index 0882836c38..cd7357b256 100644
--- a/packages/playwright-core/src/server/bidi/bidiConnection.ts
+++ b/packages/playwright-core/src/server/bidi/bidiConnection.ts
@@ -40,6 +40,9 @@ export class BidiConnection {
private _closed = false;
readonly browserSession: BidiSession;
readonly _browsingContextToSession = new Map<string, BidiSession>();
+ readonly _realmToBrowsingContext = new Map<string, string>();
+ // TODO: shared/service workers might have multiple owner realms.
+ readonly _realmToOwnerRealm = new Map<string, string>();
constructor(transport: ConnectionTransport, onDisconnect: () => void, protocolLogger: ProtocolLogger, browserLogsCollector: RecentLogsCollector) {
this._transport = transport;
@@ -69,12 +72,35 @@ export class BidiConnection {
// Bidi messages do not have a common session identifier, so we
// route them based on BrowsingContext.
if (object.type === 'event') {
+ // Track realms to context as well as realm ownership to later resolve
+ // non-window realms to a browsing context.
+ if (object.method === 'script.realmCreated') {
+ if ('context' in object.params)
+ this._realmToBrowsingContext.set(object.params.realm, object.params.context);
+ if (object.params.type === 'dedicated-worker')
+ this._realmToOwnerRealm.set(object.params.realm, object.params.owners[0]);
+ } else if (object.method === 'script.realmDestroyed') {
+ this._realmToBrowsingContext.delete(object.params.realm);
+ this._realmToOwnerRealm.delete(object.params.realm);
+ }
// Route page events to the right session.
let context;
- if ('context' in object.params)
+ let realm;
+ if ('context' in object.params) {
context = object.params.context;
- else if (object.method === 'log.entryAdded' || object.method === 'script.message')
+ } else if (object.method === 'log.entryAdded' || object.method === 'script.message') {
context = object.params.source?.context;
+ realm = object.params.source?.realm;
+ } else if (object.method === 'script.realmCreated' && object.params.type === 'dedicated-worker') {
+ realm = object.params.owners[0];
+ }
+ if (!context && realm) {
+ // Find parent realm and its browing context if it is a window realm.
+ while (this._realmToOwnerRealm.get(realm))
+ realm = this._realmToOwnerRealm.get(realm)!;
+ context = this._realmToBrowsingContext.get(realm);
+ }
+
if (context) {
const session = this._browsingContextToSession.get(context);
if (session) {
diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.ts
index 94c91e53b4..5b508bce38 100644
--- a/packages/playwright-core/src/server/bidi/bidiPage.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts
@@ -17,8 +17,9 @@
import { eventsHelper } from '../utils/eventsHelper';
import * as dialog from '../dialog';
import * as dom from '../dom';
-import { Page } from '../page';
+import * as js from '../javascript';
import { BidiBrowserContext, getScreenOrientation } from './bidiBrowser';
+import { Page, Worker } from '../page';
import { BidiExecutionContext, createHandle } from './bidiExecutionContext';
import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './bidiInput';
import { BidiNetworkManager } from './bidiNetworkManager';
@@ -45,6 +46,7 @@ export class BidiPage implements PageDelegate {
readonly _session: BidiSession;
readonly _opener: BidiPage | null;
readonly _realmToContext: Map<string, dom.FrameExecutionContext>;
+ private _realmToWorkerContext = new Map<string, js.ExecutionContext>();
private _sessionListeners: RegisteredListener[] = [];
readonly _browserContext: BidiBrowserContext;
readonly _networkManager: BidiNetworkManager;
@@ -120,6 +122,13 @@ export class BidiPage implements PageDelegate {
}
private _onRealmCreated(realmInfo: bidi.Script.RealmInfo) {
+ if (realmInfo.type === 'dedicated-worker') {
+ const delegate = new BidiExecutionContext(this._session, realmInfo);
+ const worker = new Worker(this._page, realmInfo.origin);
+ this._realmToWorkerContext.set(realmInfo.realm, worker.createExecutionContext(delegate));
+ this._page.addWorker(realmInfo.realm, worker);
+ return;
+ }
if (this._realmToContext.has(realmInfo.realm))
return;
if (realmInfo.type !== 'window')
@@ -161,11 +170,17 @@ export class BidiPage implements PageDelegate {
_onRealmDestroyed(params: bidi.Script.RealmDestroyedParameters): boolean {
const context = this._realmToContext.get(params.realm);
- if (!context)
- return false;
- this._realmToContext.delete(params.realm);
- context.frame._contextDestroyed(context);
- return true;
+ if (context) {
+ this._realmToContext.delete(params.realm);
+ context.frame._contextDestroyed(context);
+ return true;
+ }
+ const existed = this._realmToWorkerContext.delete(params.realm);
+ if (existed) {
+ this._page.removeWorker(params.realm);
+ return true;
+ }
+ return false;
}
// TODO: route the message directly to the browser
@@ -262,9 +277,10 @@ export class BidiPage implements PageDelegate {
if (params.type !== 'console')
return;
const entry: bidi.Log.ConsoleLogEntry = params as bidi.Log.ConsoleLogEntry;
- const context = this._realmToContext.get(params.source.realm);
+ const context = this._realmToContext.get(params.source.realm) ?? this._realmToWorkerContext.get(params.source.realm);
if (!context)
return;
+
const callFrame = params.stackTrace?.callFrames[0];
const location = callFrame ?? { url: '', lineNumber: 1, columnNumber: 1 };
this._page.addConsoleMessage(entry.method, entry.args.map(arg => createHandle(context, arg)), location, params.text || undefined);