Skip to content

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

chore(webkit): prepare for the next roll (#38710)

Yury Semikhatsky684cd81070fc
diff --git a/packages/playwright-core/src/server/webkit/wkConnection.ts b/packages/playwright-core/src/server/webkit/wkConnection.ts
index 5b0163a7cf..eb48e564fa 100644
--- a/packages/playwright-core/src/server/webkit/wkConnection.ts
+++ b/packages/playwright-core/src/server/webkit/wkConnection.ts
@@ -165,7 +165,7 @@ export class WKSession extends EventEmitter<Protocol.EventMap & { [kPageProxyMes
}
} else if (object.id && !object.error) {
// Response might come after session has been disposed and rejected all callbacks.
- assert(this.isDisposed());
+ assert(this.isDisposed(), JSON.stringify(object));
} else {
Promise.resolve().then(() => this.emit(object.method, object.params));
}
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
index 23505467c5..6220d32518 100644
--- a/packages/playwright-core/src/server/webkit/wkPage.ts
+++ b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -46,12 +46,15 @@ import type * as types from '../types';
const UTILITY_WORLD_NAME = '__playwright_utility_world__';
+const enableFrameSessions = !!process.env.WK_ENABLE_FRAME_SESSIONS;
+
export class WKPage implements PageDelegate {
readonly rawMouse: RawMouseImpl;
readonly rawKeyboard: RawKeyboardImpl;
readonly rawTouchscreen: RawTouchscreenImpl;
_session: WKSession;
private _provisionalPage: WKProvisionalPage | null = null;
+ private _targetIdToFrameSession = new Map<string, WKFrame>();
readonly _page: Page;
private readonly _pageProxySession: WKSession;
readonly _opener: WKPage | null;
@@ -162,10 +165,13 @@ export class WKPage implements PageDelegate {
// Resource tree should be received before first execution context.
session.send('Runtime.enable'),
session.send('Page.createUserWorld', { name: UTILITY_WORLD_NAME }).catch(_ => {}), // Worlds are per-process
- session.send('Console.enable'),
session.send('Network.enable'),
this._workers.initializeSession(session)
];
+ if (enableFrameSessions)
+ this._initializeFrameSessions(frameTree.frameTree, promises);
+ else
+ promises.push(session.send('Console.enable'));
if (this._page.browserContext.needsPlaywrightBinding())
promises.push(session.send('Runtime.addBinding', { name: PageBinding.kBindingName }));
if (this._page.needsRequestInterception()) {
@@ -218,6 +224,14 @@ export class WKPage implements PageDelegate {
await Promise.all(promises);
}
+ private _initializeFrameSessions(frame: Protocol.Page.FrameResourceTree, promises: Promise<any>[]) {
+ const session = this._targetIdToFrameSession.get(`frame-${frame.frame.id}`);
+ if (session)
+ promises.push(session.initialize());
+ for (const childFrame of frame.childFrames || [])
+ this._initializeFrameSessions(childFrame, promises);
+ }
+
private _onDidCommitProvisionalTarget(event: Protocol.Target.didCommitProvisionalTargetPayload) {
const { oldTargetId, newTargetId } = event;
assert(this._provisionalPage);
@@ -244,6 +258,9 @@ export class WKPage implements PageDelegate {
this._session.markAsCrashed();
this._page._didCrash();
}
+ } else if (this._targetIdToFrameSession.has(targetId)) {
+ this._targetIdToFrameSession.get(targetId)!.dispose();
+ this._targetIdToFrameSession.delete(targetId);
}
}
@@ -292,9 +309,15 @@ export class WKPage implements PageDelegate {
session.dispatchMessage({ id: message.id, error: { message: e.message } });
});
});
- // TODO: support OOPIFs.
- if (targetInfo.type === 'frame' as any)
+ if (targetInfo.type === 'frame') {
+ if (enableFrameSessions) {
+ const wkFrame = new WKFrame(this, session);
+ this._targetIdToFrameSession.set(targetInfo.targetId, wkFrame);
+ // TODO: this is racy, we should pause the child frames until their frame agents are initialized.
+ await wkFrame.initialize().catch(e => {});
+ }
return;
+ }
assert(targetInfo.type === 'page', 'Only page targets are expected in WebKit, received: ' + targetInfo.type);
if (!targetInfo.isProvisional) {
@@ -342,6 +365,8 @@ export class WKPage implements PageDelegate {
this._provisionalPage._session.dispatchMessage(JSON.parse(message));
else if (this._session.sessionId === targetId)
this._session.dispatchMessage(JSON.parse(message));
+ else if (this._targetIdToFrameSession.has(targetId))
+ this._targetIdToFrameSession.get(targetId)!._session.dispatchMessage(JSON.parse(message));
else
throw new Error('Unknown target: ' + targetId);
}
@@ -499,7 +524,7 @@ export class WKPage implements PageDelegate {
return { newDocumentId: result.loaderId };
}
- private _onConsoleMessage(event: Protocol.Console.messageAddedPayload) {
+ _onConsoleMessage(event: Protocol.Console.messageAddedPayload) {
// Note: do no introduce await in this function, otherwise we lose the ordering.
// For example, frame.setContent relies on this.
const { type, level, text, parameters, url, line: lineNumber, column: columnNumber, source } = event.message;
@@ -1205,6 +1230,40 @@ export class WKPage implements PageDelegate {
}
}
+class WKFrame {
+ readonly _page: WKPage;
+ readonly _session: WKSession;
+ private _sessionListeners: RegisteredListener[] = [];
+ private _initializePromise: Promise<void> | null = null;
+
+ constructor(page: WKPage, session: WKSession) {
+ this._page = page;
+ this._session = session;
+ }
+
+ async initialize() {
+ if (this._initializePromise)
+ return this._initializePromise;
+ this._initializePromise = this._initializeImpl();
+ return this._initializePromise;
+ }
+
+ private async _initializeImpl() {
+ this._sessionListeners = [
+ eventsHelper.addEventListener(this._session, 'Console.messageAdded', event => this._page._onConsoleMessage(event)),
+ eventsHelper.addEventListener(this._session, 'Console.messageRepeatCountUpdated', event => this._page._onConsoleRepeatCountUpdated(event)),
+ ];
+ // Child frames will actually inherit the console agent state from the main frame,
+ // but we keep the logic uniform as we don't know if we are a main frame or not.
+ await this._session.send('Console.enable');
+ }
+
+ dispose() {
+ eventsHelper.removeEventListeners(this._sessionListeners);
+ this._session.dispose();
+ }
+}
+
/**
* WebKit Remote Addresses look like:
*