chore: support bidi connection to chromium (#32474)

package.json

@@ -77,6 +77,7 @@
     "@vitejs/plugin-react": "^4.2.1",
     "@zip.js/zip.js": "^2.7.29",
     "chokidar": "^3.5.3",
+    "chromium-bidi": "^0.6.4",
     "colors": "^1.4.0",
     "concurrently": "^6.2.1",
     "cross-env": "^7.0.3",

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

@@ -3,3 +3,9 @@
 ../
 ../isomorphic/
 ./third_party/
+
+[bidiOverCdp.ts]
+***
+
+[bidiBrowserType.ts]
+../chromium/chromiumSwitches.ts

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

@@ -43,9 +43,6 @@ export class BidiBrowser extends Browser {
     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) {

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

@@ -0,0 +1,206 @@
+/**
+ * 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 os from 'os';
+import path from 'path';
+import { assert, wrapInASCIIBox } from '../../utils';
+import type { Env } from '../../utils/processLauncher';
+import type { BrowserOptions } from '../browser';
+import { BrowserReadyState } from '../browserType';
+import { BrowserType, kNoXServerRunningError } from '../browserType';
+import type { SdkObject } from '../instrumentation';
+import type { ProtocolError } from '../protocolError';
+import type { ConnectionTransport } from '../transport';
+import type * as types from '../types';
+import { BidiBrowser } from './bidiBrowser';
+import { kBrowserCloseMessageId } from './bidiConnection';
+import { chromiumSwitches } from '../chromium/chromiumSwitches';
+
+export class BidiBrowserType extends BrowserType {
+  constructor(parent: SdkObject) {
+    super(parent, 'bidi');
+    this._useBidi = true;
+  }
+
+  override async connectToTransport(transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {
+    if (options.channel?.includes('chrome')) {
+      // Chrome doesn't support Bidi, we create Bidi over CDP which is used by Chrome driver.
+      // bidiOverCdp depends on chromium-bidi which we only have in devDependencies, so
+      // we load bidiOverCdp dynamically.
+      const bidiTransport = await require('./bidiOverCdp').connectBidiOverCdp(transport);
+      (transport as any)[kBidiOverCdpWrapper] = bidiTransport;
+      transport = bidiTransport;
+    }
+    return BidiBrowser.connect(this.attribution.playwright, transport, options);
+  }
+
+  override doRewriteStartupLog(error: ProtocolError): ProtocolError {
+    if (!error.logs)
+      return error;
+    // https://github.com/microsoft/playwright/issues/6500
+    if (error.logs.includes(`as root in a regular user's session is not supported.`))
+      error.logs = '\n' + wrapInASCIIBox(`Firefox is unable to launch if the $HOME folder isn't owned by the current user.\nWorkaround: Set the HOME=/root environment variable${process.env.GITHUB_ACTION ? ' in your GitHub Actions workflow file' : ''} when running Playwright.`, 1);
+    if (error.logs.includes('no DISPLAY environment variable specified'))
+      error.logs = '\n' + wrapInASCIIBox(kNoXServerRunningError, 1);
+    return error;
+  }
+
+  override amendEnvironment(env: Env, userDataDir: string, executable: string, browserArguments: string[]): Env {
+    if (!path.isAbsolute(os.homedir()))
+      throw new Error(`Cannot launch Firefox with relative home directory. Did you set ${os.platform() === 'win32' ? 'USERPROFILE' : 'HOME'} to a relative path?`);
+    if (os.platform() === 'linux') {
+      // Always remove SNAP_NAME and SNAP_INSTANCE_NAME env variables since they
+      // confuse Firefox: in our case, builds never come from SNAP.
+      // See https://github.com/microsoft/playwright/issues/20555
+      return { ...env, SNAP_NAME: undefined, SNAP_INSTANCE_NAME: undefined };
+    }
+    return env;
+  }
+
+  override attemptToGracefullyCloseBrowser(transport: ConnectionTransport): void {
+    const bidiTransport = (transport as any)[kBidiOverCdpWrapper];
+    if (bidiTransport)
+      transport = bidiTransport;
+    transport.send({ method: 'browser.close', params: {}, id: kBrowserCloseMessageId });
+  }
+
+  override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
+    if (options.channel === 'bidi-firefox-stable')
+      return this._defaultFirefoxArgs(options, isPersistent, userDataDir);
+    else if (options.channel === 'bidi-chrome-canary')
+      return this._defaultChromiumArgs(options, isPersistent, userDataDir);
+    throw new Error(`Unknown Bidi channel "${options.channel}"`);
+  }
+
+  override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {
+    assert(options.useWebSocket);
+    if (options.channel?.includes('firefox'))
+      return new FirefoxReadyState();
+    if (options.channel?.includes('chrome'))
+      return new ChromiumReadyState();
+    return undefined;
+  }
+
+  private _defaultFirefoxArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
+    const { args = [], headless } = options;
+    const userDataDirArg = args.find(arg => arg.startsWith('-profile') || arg.startsWith('--profile'));
+    if (userDataDirArg)
+      throw this._createUserDataDirArgMisuseError('--profile');
+    const firefoxArguments = ['--remote-debugging-port=0'];
+    if (headless)
+      firefoxArguments.push('--headless');
+    else
+      firefoxArguments.push('--foreground');
+    firefoxArguments.push(`--profile`, userDataDir);
+    firefoxArguments.push(...args);
+    // TODO: make ephemeral context work without this argument.
+    firefoxArguments.push('about:blank');
+    // if (isPersistent)
+    //   firefoxArguments.push('about:blank');
+    // else
+    //   firefoxArguments.push('-silent');
+    return firefoxArguments;
+  }
+
+  private _defaultChromiumArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {
+    const chromeArguments = this._innerDefaultArgs(options);
+    chromeArguments.push(`--user-data-dir=${userDataDir}`);
+    chromeArguments.push('--remote-debugging-port=0');
+    if (isPersistent)
+      chromeArguments.push('about:blank');
+    else
+      chromeArguments.push('--no-startup-window');
+    return chromeArguments;
+  }
+
+  private _innerDefaultArgs(options: types.LaunchOptions): string[] {
+    const { args = [], proxy } = options;
+    const userDataDirArg = args.find(arg => arg.startsWith('--user-data-dir'));
+    if (userDataDirArg)
+      throw this._createUserDataDirArgMisuseError('--user-data-dir');
+    if (args.find(arg => arg.startsWith('--remote-debugging-pipe')))
+      throw new Error('Playwright manages remote debugging connection itself.');
+    if (args.find(arg => !arg.startsWith('-')))
+      throw new Error('Arguments can not specify page to be opened');
+    const chromeArguments = [...chromiumSwitches];
+
+    if (os.platform() === 'darwin') {
+      // See https://github.com/microsoft/playwright/issues/7362
+      chromeArguments.push('--enable-use-zoom-for-dsf=false');
+      // See https://bugs.chromium.org/p/chromium/issues/detail?id=1407025.
+      if (options.headless)
+        chromeArguments.push('--use-angle');
+    }
+
+    if (options.devtools)
+      chromeArguments.push('--auto-open-devtools-for-tabs');
+    if (options.headless) {
+      if (process.env.PLAYWRIGHT_CHROMIUM_USE_HEADLESS_NEW)
+        chromeArguments.push('--headless=new');
+      else
+        chromeArguments.push('--headless=old');
+
+      chromeArguments.push(
+          '--hide-scrollbars',
+          '--mute-audio',
+          '--blink-settings=primaryHoverType=2,availableHoverTypes=2,primaryPointerType=4,availablePointerTypes=4',
+      );
+    }
+    if (options.chromiumSandbox !== true)
+      chromeArguments.push('--no-sandbox');
+    if (proxy) {
+      const proxyURL = new URL(proxy.server);
+      const isSocks = proxyURL.protocol === 'socks5:';
+      // https://www.chromium.org/developers/design-documents/network-settings
+      if (isSocks && !this.attribution.playwright.options.socksProxyPort) {
+        // https://www.chromium.org/developers/design-documents/network-stack/socks-proxy
+        chromeArguments.push(`--host-resolver-rules="MAP * ~NOTFOUND , EXCLUDE ${proxyURL.hostname}"`);
+      }
+      chromeArguments.push(`--proxy-server=${proxy.server}`);
+      const proxyBypassRules = [];
+      // https://source.chromium.org/chromium/chromium/src/+/master:net/docs/proxy.md;l=548;drc=71698e610121078e0d1a811054dcf9fd89b49578
+      if (this.attribution.playwright.options.socksProxyPort)
+        proxyBypassRules.push('<-loopback>');
+      if (proxy.bypass)
+        proxyBypassRules.push(...proxy.bypass.split(',').map(t => t.trim()).map(t => t.startsWith('.') ? '*' + t : t));
+      if (!process.env.PLAYWRIGHT_DISABLE_FORCED_CHROMIUM_PROXIED_LOOPBACK && !proxyBypassRules.includes('<-loopback>'))
+        proxyBypassRules.push('<-loopback>');
+      if (proxyBypassRules.length > 0)
+        chromeArguments.push(`--proxy-bypass-list=${proxyBypassRules.join(';')}`);
+    }
+    chromeArguments.push(...args);
+    return chromeArguments;
+  }
+}
+
+class FirefoxReadyState extends BrowserReadyState {
+  override onBrowserOutput(message: string): void {
+    // Bidi WebSocket in Firefox.
+    const match = message.match(/WebDriver BiDi listening on (ws:\/\/.*)$/);
+    if (match)
+      this._wsEndpoint.resolve(match[1] + '/session');
+  }
+}
+
+class ChromiumReadyState extends BrowserReadyState {
+  override onBrowserOutput(message: string): void {
+    const match = message.match(/DevTools listening on (.*)/);
+    if (match)
+      this._wsEndpoint.resolve(match[1]);
+  }
+}
+
+const kBidiOverCdpWrapper = Symbol('kBidiConnectionWrapper');