Skip to content

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

fix(chromium): replay execution contexts when connecting to Android WebView (#42447)

Pavel Feldmaneca9e03e049f
diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.ts
index 444c315e30..37c691c78c 100644
--- a/packages/playwright-core/src/client/browserType.ts
+++ b/packages/playwright-core/src/client/browserType.ts
@@ -168,6 +168,7 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple
slowMo: params.slowMo,
isLocal: params.isLocal,
noDefaults: params.noDefaults,
+ isWebView: (params as any).isWebView,
artifactsDir: params.artifactsDir,
}, new TimeoutSettings().timeout(params));
return await this._browserFromConnectResult(result);
diff --git a/packages/playwright-core/src/client/channels.d.ts b/packages/playwright-core/src/client/channels.d.ts
index 1f53bd0e12..84080820cc 100644
--- a/packages/playwright-core/src/client/channels.d.ts
+++ b/packages/playwright-core/src/client/channels.d.ts
@@ -1941,6 +1941,7 @@ export type BrowserTypeConnectOverCDPParams = {
slowMo?: number,
isLocal?: boolean,
noDefaults?: boolean,
+ isWebView?: boolean,
artifactsDir?: string,
transport?: Binary,
};
@@ -1950,6 +1951,7 @@ export type BrowserTypeConnectOverCDPOptions = {
slowMo?: number,
isLocal?: boolean,
noDefaults?: boolean,
+ isWebView?: boolean,
artifactsDir?: string,
transport?: Binary,
};
diff --git a/packages/playwright-core/src/server/android/android.ts b/packages/playwright-core/src/server/android/android.ts
index 04d9e89857..623a76a0fa 100644
--- a/packages/playwright-core/src/server/android/android.ts
+++ b/packages/playwright-core/src/server/android/android.ts
@@ -329,10 +329,10 @@ export class AndroidDevice extends SdkObject {
const webView = this._webViews.get(socketName);
if (!webView)
throw new Error('WebView has been closed');
- return await this._connectToBrowser(progress, socketName);
+ return await this._connectToBrowser(progress, socketName, {}, /* isWebView */ true);
}
- private async _connectToBrowser(progress: Progress, socketName: string, options: types.BrowserContextOptions = {}): Promise<BrowserContext> {
+ private async _connectToBrowser(progress: Progress, socketName: string, options: types.BrowserContextOptions = {}, isWebView?: boolean): Promise<BrowserContext> {
const socket = await this._waitForLocalAbstract(progress, socketName);
try {
const androidBrowser = new AndroidBrowser(this, socket);
@@ -363,6 +363,7 @@ export class AndroidDevice extends SdkObject {
protocolLogger: helper.debugProtocolLogger(),
browserLogsCollector: new RecentLogsCollector(),
originalLaunchOptions: {},
+ isWebView,
};
validateBrowserContextOptions(options, browserOptions);
diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.ts
index 608fdab72c..53f6363221 100644
--- a/packages/playwright-core/src/server/browser.ts
+++ b/packages/playwright-core/src/server/browser.ts
@@ -65,6 +65,7 @@ export type BrowserOptions = {
originalLaunchOptions: types.LaunchOptions;
userDataDir?: string;
noDefaults?: boolean;
+ isWebView?: boolean;
};
export abstract class Browser extends SdkObject {
diff --git a/packages/playwright-core/src/server/channels.d.ts b/packages/playwright-core/src/server/channels.d.ts
index 4fea33fe8d..8e4d1a42dd 100644
--- a/packages/playwright-core/src/server/channels.d.ts
+++ b/packages/playwright-core/src/server/channels.d.ts
@@ -1942,6 +1942,7 @@ export type BrowserTypeConnectOverCDPParams = {
slowMo?: number,
isLocal?: boolean,
noDefaults?: boolean,
+ isWebView?: boolean,
artifactsDir?: string,
transport?: Binary,
};
@@ -1951,6 +1952,7 @@ export type BrowserTypeConnectOverCDPOptions = {
slowMo?: number,
isLocal?: boolean,
noDefaults?: boolean,
+ isWebView?: boolean,
artifactsDir?: string,
transport?: Binary,
};
diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.ts
index fca1112b91..222fb073f6 100644
--- a/packages/playwright-core/src/server/chromium/chromium.ts
+++ b/packages/playwright-core/src/server/chromium/chromium.ts
@@ -87,7 +87,7 @@ export class Chromium extends BrowserType {
return await this._connectOverCDPInternal(progress, params.endpointURL!, params);
}
- async _connectOverCDPInternal(progress: Progress, endpointURL: string, options: types.LaunchOptions & { headers?: types.HeadersArray, isLocal?: boolean, noDefaults?: boolean, artifactsDir?: string }, onClose?: () => Promise<void>) {
+ async _connectOverCDPInternal(progress: Progress, endpointURL: string, options: types.LaunchOptions & { headers?: types.HeadersArray, isLocal?: boolean, noDefaults?: boolean, isWebView?: boolean, artifactsDir?: string }, onClose?: () => Promise<void>) {
let headersMap: { [key: string]: string; } | undefined;
if (options.headers)
headersMap = headersArrayToObject(options.headers, false);
@@ -115,7 +115,7 @@ export class Chromium extends BrowserType {
return this._connectOverCDPImpl(progress, chromeTransport, closeAndWait, options, onClose);
}
- private async _connectOverCDPImpl(progress: Progress, transport: ConnectionTransport, closeAndWait: () => Promise<void>, options: types.LaunchOptions & { isLocal?: boolean, noDefaults?: boolean, artifactsDir?: string }, onClose?: () => Promise<void>) {
+ private async _connectOverCDPImpl(progress: Progress, transport: ConnectionTransport, closeAndWait: () => Promise<void>, options: types.LaunchOptions & { isLocal?: boolean, noDefaults?: boolean, isWebView?: boolean, artifactsDir?: string }, onClose?: () => Promise<void>) {
let artifactsDir: string;
const tempDirectories: string[] = [];
if (options.artifactsDir) {
@@ -155,6 +155,7 @@ export class Chromium extends BrowserType {
tracesDir: options.tracesDir || artifactsDir,
originalLaunchOptions: {},
noDefaults: options.noDefaults,
+ isWebView: options.isWebView,
};
validateBrowserContextOptions(persistent, browserOptions);
const browser = await progress.race(CRBrowser.connect(this.attribution.playwright, transport, browserOptions));
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index f53e0ecec6..0c2bcc08b0 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -464,6 +464,7 @@ class FrameSession {
}
async _initialize(hasUIWindow: boolean) {
+ const browserOptions = this._crPage._browserContext._browser.options;
if (!this._page.isStorageStatePage && hasUIWindow &&
!this._crPage._browserContext._browser.isClank() &&
!this._crPage._browserContext._options.noDefaultViewport) {
@@ -539,7 +540,7 @@ class FrameSession {
this._client.send('Target.setAutoAttach', { autoAttach: true, waitForDebuggerOnStart: true, flatten: true }),
];
if (!this._page.isStorageStatePage) {
- const skipDefaultOverrides = this._crPage._browserContext._browser.options.noDefaults &&
+ const skipDefaultOverrides = browserOptions.noDefaults &&
this._crPage._browserContext === this._crPage._browserContext._browser._defaultContext;
if (this._crPage._browserContext.needsPlaywrightBinding())
promises.push(this.exposePlaywrightBinding());
@@ -562,7 +563,7 @@ class FrameSession {
promises.push(emulateLocale(this._client, options.locale));
if (options.timezoneId)
promises.push(emulateTimezone(this._client, options.timezoneId));
- if (!this._crPage._browserContext._browser.options.headful)
+ if (!browserOptions.headful)
promises.push(this._setDefaultFontFamilies(this._client));
promises.push(this._updateGeolocation(true));
if (!skipDefaultOverrides)
@@ -574,6 +575,19 @@ class FrameSession {
promises.push(this._client.send('Runtime.runIfWaitingForDebugger'));
promises.push(this._firstNonInitialNavigationCommittedPromise);
await Promise.all(promises);
+
+ if (browserOptions.isWebView) {
+ // Android WebView's devtools endpoint sometimes acknowledges Runtime.enable
+ // without replaying the pre-existing execution contexts. Cycle
+ // Runtime.disable/enable until the default context is reported.
+ for (let attempt = 0; attempt < 10; ++attempt) {
+ if ([...this._contextIdToContext.values()].some(context => context.world === 'main'))
+ break;
+ await this._client._sendMayFail('Runtime.disable');
+ await this._client._sendMayFail('Runtime.enable');
+ await new Promise(f => setTimeout(f, 250));
+ }
+ }
}
dispose() {
diff --git a/packages/protocol/spec/browserType.yml b/packages/protocol/spec/browserType.yml
index a50d1d2001..2b73d99dcc 100644
--- a/packages/protocol/spec/browserType.yml
+++ b/packages/protocol/spec/browserType.yml
@@ -50,6 +50,7 @@ BrowserType:
slowMo: float?
isLocal: boolean?
noDefaults: boolean?
+ isWebView: boolean?
artifactsDir: string?
transport: binary?
returns:
diff --git a/packages/protocol/src/validator.ts b/packages/protocol/src/validator.ts
index 9e662d18e6..46baf155da 100644
--- a/packages/protocol/src/validator.ts
+++ b/packages/protocol/src/validator.ts
@@ -1057,6 +1057,7 @@ scheme.BrowserTypeConnectOverCDPParams = tObject({
slowMo: tOptional(tFloat),
isLocal: tOptional(tBoolean),
noDefaults: tOptional(tBoolean),
+ isWebView: tOptional(tBoolean),
artifactsDir: tOptional(tString),
transport: tOptional(tBinary),
});