chore: identify largest gaps in Bidi API (#32434)

This pull request introduces initial support for the WebDriver BiDi
protocol in Playwright. The primary goal of this PR is not to fully
implement BiDi but to experiment with the current state of the
specification and its implementation. We aim to identify the biggest
gaps and challenges that need to be addressed before considering BiDi as
the main protocol for Playwright.

package.json

@@ -24,6 +24,7 @@
     "webview2test": "playwright test --config=tests/webview2/playwright.config.ts",
     "itest": "playwright test --config=tests/installation/playwright.config.ts",
     "stest": "playwright test --config=tests/stress/playwright.config.ts",
+    "biditest": "playwright test --config=tests/bidi/playwright.config.ts",
     "test-html-reporter": "playwright test --config=packages/html-reporter",
     "test-web": "playwright test --config=packages/web",
     "ttest": "node ./tests/playwright-test/stable-test-runner/node_modules/@playwright/test/cli test --config=tests/playwright-test/playwright.config.ts",

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

@@ -26,6 +26,7 @@ import { Selectors, SelectorsOwner } from './selectors';
 export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
   readonly _android: Android;
   readonly _electron: Electron;
+  readonly _experimentalBidi: BrowserType;
   readonly chromium: BrowserType;
   readonly firefox: BrowserType;
   readonly webkit: BrowserType;
@@ -45,6 +46,8 @@ export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
     this.webkit._playwright = this;
     this._android = Android.from(initializer.android);
     this._electron = Electron.from(initializer.electron);
+    this._experimentalBidi = BrowserType.from(initializer.bidi);
+    this._experimentalBidi._playwright = this;
     this.devices = this._connection.localUtils()?.devices ?? {};
     this.selectors = new Selectors();
     this.errors = { TimeoutError };

packages/playwright-core/src/protocol/validator.ts

@@ -321,6 +321,7 @@ scheme.RootInitializeResult = tObject({
 });
 scheme.PlaywrightInitializer = tObject({
   chromium: tChannel(['BrowserType']),
+  bidi: tChannel(['BrowserType']),
   firefox: tChannel(['BrowserType']),
   webkit: tChannel(['BrowserType']),
   android: tChannel(['Android']),

packages/playwright-core/src/server/DEPS.list

@@ -16,6 +16,7 @@
 
 [playwright.ts]
 ./android/
+./bidi/
 ./chromium/
 ./electron/
 ./firefox/

packages/playwright-core/src/server/bidi/DEPS.list

@@ -0,0 +1,5 @@
+[*]
+../../utils/
+../
+../isomorphic/
+./third_party/

packages/playwright-core/src/server/bidi/bidiBrowser.ts

@@ -0,0 +1,332 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type * as channels from '@protocol/channels';
+import type { RegisteredListener } from '../../utils/eventsHelper';
+import { eventsHelper } from '../../utils/eventsHelper';
+import type { BrowserOptions } from '../browser';
+import { Browser } from '../browser';
+import { assertBrowserContextIsNotOwned, BrowserContext } from '../browserContext';
+import type { SdkObject } from '../instrumentation';
+import * as network from '../network';
+import type { InitScript, Page, PageDelegate } from '../page';
+import type { ConnectionTransport } from '../transport';
+import type * as types from '../types';
+import type { BidiSession } from './bidiConnection';
+import { BidiConnection } from './bidiConnection';
+import { bidiBytesValueToString } from './bidiNetworkManager';
+import { BidiPage } from './bidiPage';
+import * as bidi from './third_party/bidiProtocol';
+
+export class BidiBrowser extends Browser {
+  private readonly _connection: BidiConnection;
+  readonly _browserSession: BidiSession;
+  private _bidiSessionInfo!: bidi.Session.NewResult;
+  readonly _contexts = new Map<string, BidiBrowserContext>();
+  readonly _bidiPages = new Map<bidi.BrowsingContext.BrowsingContext, BidiPage>();
+  private readonly _eventListeners: RegisteredListener[];
+
+  static async connect(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {
+    const browser = new BidiBrowser(parent, transport, options);
+    if ((options as any).__testHookOnConnectToBrowser)
+      await (options as any).__testHookOnConnectToBrowser();
+    const sessionStatus = await browser._browserSession.send('session.status', {});
+    if (!sessionStatus.ready)
+      throw new Error('Bidi session is not ready. ' + sessionStatus.message);
+
+    let proxy: bidi.Session.ManualProxyConfiguration | undefined;
+    if (options.proxy) {
+      proxy = {
+        proxyType: 'manual',
+      };
+      const url = new URL(options.proxy.server);  // Validate proxy server.
+      switch (url.protocol) {
+        case 'http:':
+          proxy.httpProxy = url.host;
+          break;
+        case 'https:':
+          proxy.httpsProxy = url.host;
+          break;
+        case 'socks4:':
+          proxy.socksProxy = url.host;
+          proxy.socksVersion = 4;
+          break;
+        case 'socks5:':
+          proxy.socksProxy = url.host;
+          proxy.socksVersion = 5;
+          break;
+        default:
+          throw new Error('Invalid proxy server protocol: ' + options.proxy.server);
+      }
+      if (options.proxy.bypass)
+        proxy.noProxy = options.proxy.bypass.split(',');
+      // TODO: support authentication.
+    }
+
+    browser._bidiSessionInfo = await browser._browserSession.send('session.new', {
+      capabilities: {
+        alwaysMatch: {
+          acceptInsecureCerts: false,
+          proxy,
+          unhandledPromptBehavior: {
+            default: bidi.Session.UserPromptHandlerType.Ignore,
+          },
+          webSocketUrl: true
+        },
+      }
+    });
+
+    await browser._browserSession.send('session.subscribe', {
+      events: [
+        'browsingContext',
+        'network',
+        'log',
+        'script',
+      ],
+    });
+    return browser;
+  }
+
+  constructor(parent: SdkObject, transport: ConnectionTransport, options: BrowserOptions) {
+    super(parent, options);
+    this._connection = new BidiConnection(transport, this._onDisconnect.bind(this), options.protocolLogger, options.browserLogsCollector);
+    this._browserSession = this._connection.browserSession;
+    this._eventListeners = [
+      eventsHelper.addEventListener(this._browserSession, 'browsingContext.contextCreated', this._onBrowsingContextCreated.bind(this)),
+      eventsHelper.addEventListener(this._browserSession, 'script.realmDestroyed', this._onScriptRealmDestroyed.bind(this)),
+    ];
+  }
+
+  _onDisconnect() {
+    this._didClose();
+  }
+
+  async doCreateNewContext(options: channels.BrowserNewContextParams): Promise<BrowserContext> {
+    const { userContext } = await this._browserSession.send('browser.createUserContext', {});
+    const context = new BidiBrowserContext(this, userContext, options);
+    await context._initialize();
+    this._contexts.set(userContext, context);
+    return context;
+  }
+
+  contexts(): BrowserContext[] {
+    return Array.from(this._contexts.values());
+  }
+
+  version(): string {
+    return this._bidiSessionInfo.capabilities.browserVersion;
+  }
+
+  userAgent(): string {
+    return this._bidiSessionInfo.capabilities.userAgent;
+  }
+
+  isConnected(): boolean {
+    return !this._connection.isClosed();
+  }
+
+  private _onBrowsingContextCreated(event: bidi.BrowsingContext.Info) {
+    if (event.parent) {
+      const parentFrameId = event.parent;
+      for (const page of this._bidiPages.values()) {
+        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        if (!parentFrame)
+          continue;
+        page._session.addFrameBrowsingContext(event.context);
+        page._page._frameManager.frameAttached(event.context, parentFrameId);
+        return;
+      }
+      return;
+    }
+    let context = this._contexts.get(event.userContext);
+    if (!context)
+      context = this._defaultContext as BidiBrowserContext;
+    if (!context)
+      return;
+    const session = this._connection.createMainFrameBrowsingContextSession(event.context);
+    const opener = event.originalOpener && this._bidiPages.get(event.originalOpener);
+    const page = new BidiPage(context, session, opener || null);
+    this._bidiPages.set(event.context, page);
+  }
+
+  _onBrowsingContextDestroyed(event: bidi.BrowsingContext.Info) {
+    if (event.parent) {
+      this._browserSession.removeFrameBrowsingContext(event.context);
+      const parentFrameId = event.parent;
+      for (const page of this._bidiPages.values()) {
+        const parentFrame = page._page._frameManager.frame(parentFrameId);
+        if (!parentFrame)
+          continue;
+        page._page._frameManager.frameDetached(event.context);
+        return;
+      }
+      return;
+    }
+    const bidiPage = this._bidiPages.get(event.context);
+    if (!bidiPage)
+      return;
+    bidiPage.didClose();
+    this._bidiPages.delete(event.context);
+  }
+
+  private _onScriptRealmDestroyed(event: bidi.Script.RealmDestroyedParameters) {
+    for (const page of this._bidiPages.values()) {
+      if (page._onRealmDestroyed(event))
+        return;
+    }
+  }
+}
+
+export class BidiBrowserContext extends BrowserContext {
+  declare readonly _browser: BidiBrowser;
+
+  constructor(browser: BidiBrowser, browserContextId: string | undefined, options: channels.BrowserNewContextParams) {
+    super(browser, options, browserContextId);
+    this._authenticateProxyViaHeader();
+  }
+
+  pages(): Page[] {
+    return [];
+  }
+
+  async newPageDelegate(): Promise<PageDelegate> {
+    assertBrowserContextIsNotOwned(this);
+    const { context } = await this._browser._browserSession.send('browsingContext.create', {
+      type: bidi.BrowsingContext.CreateType.Window,
+      userContext: this._browserContextId,
+    });
+    return this._browser._bidiPages.get(context)!;
+  }
+
+  async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
+    const { cookies } = await this._browser._browserSession.send('storage.getCookies',
+        { partition: { type: 'storageKey', userContext: this._browserContextId } });
+    return network.filterCookies(cookies.map((c: bidi.Network.Cookie) => {
+      const copy: channels.NetworkCookie = {
+        name: c.name,
+        value: bidiBytesValueToString(c.value),
+        domain: c.domain,
+        path: c.path,
+        httpOnly: c.httpOnly,
+        secure: c.secure,
+        expires: c.expiry ?? -1,
+        sameSite: c.sameSite ? fromBidiSameSite(c.sameSite) : 'None',
+      };
+      return copy;
+    }), urls);
+  }
+
+  async addCookies(cookies: channels.SetNetworkCookie[]) {
+    cookies = network.rewriteCookies(cookies);
+    const promises = cookies.map((c: channels.SetNetworkCookie) => {
+      const cookie: bidi.Storage.PartialCookie = {
+        name: c.name,
+        value: { type: 'string', value: c.value },
+        domain: c.domain!,
+        path: c.path,
+        httpOnly: c.httpOnly,
+        secure: c.secure,
+        sameSite: c.sameSite && toBidiSameSite(c.sameSite),
+        expiry: (c.expires === -1 || c.expires === undefined) ? undefined : Math.round(c.expires),
+      };
+      return this._browser._browserSession.send('storage.setCookie',
+          { cookie, partition: { type: 'storageKey', userContext: this._browserContextId } });
+    });
+    await Promise.all(promises);
+  }
+
+  async doClearCookies() {
+    await this._browser._browserSession.send('storage.deleteCookies',
+        { partition: { type: 'storageKey', userContext: this._browserContextId } });
+  }
+
+  async doGrantPermissions(origin: string, permissions: string[]) {
+  }
+
+  async doClearPermissions() {
+  }
+
+  async setGeolocation(geolocation?: types.Geolocation): Promise<void> {
+  }
+
+  async setExtraHTTPHeaders(headers: types.HeadersArray): Promise<void> {
+  }
+
+  async setUserAgent(userAgent: string | undefined): Promise<void> {
+  }
+
+  async setOffline(offline: boolean): Promise<void> {
+  }
+
+  async doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise<void> {
+  }
+
+  async doAddInitScript(initScript: InitScript) {
+    // for (const page of this.pages())
+    //   await (page._delegate as WKPage)._updateBootstrapScript();
+  }
+
+  async doRemoveNonInternalInitScripts() {
+  }
+
+  async doUpdateRequestInterception(): Promise<void> {
+  }
+
+  onClosePersistent() {}
+
+  override async clearCache(): Promise<void> {
+  }
+
+  async doClose(reason: string | undefined) {
+    // TODO: implement for persistent context
+    if (!this._browserContextId)
+      return;
+
+    await this._browser._browserSession.send('browser.removeUserContext', {
+      userContext: this._browserContextId
+    });
+    this._browser._contexts.delete(this._browserContextId);
+  }
+
+  async cancelDownload(uuid: string) {
+  }
+}
+
+function fromBidiSameSite(sameSite: bidi.Network.SameSite): channels.NetworkCookie['sameSite'] {
+  switch (sameSite) {
+    case 'strict': return 'Strict';
+    case 'lax': return 'Lax';
+    case 'none': return 'None';
+  }
+  return 'None';
+}
+
+function toBidiSameSite(sameSite: channels.SetNetworkCookie['sameSite']): bidi.Network.SameSite {
+  switch (sameSite) {
+    case 'Strict': return bidi.Network.SameSite.Strict;
+    case 'Lax': return bidi.Network.SameSite.Lax;
+    case 'None': return bidi.Network.SameSite.None;
+  }
+  return bidi.Network.SameSite.None;
+}
+
+export namespace Network {
+  export const enum SameSite {
+    Strict = 'strict',
+    Lax = 'lax',
+    None = 'none',
+  }
+}