feat!: default to WebDriver BiDi for Firefox (#12732)

Co-authored-by: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> Co-authored-by: Nikolay Vitkov <nvitkov@chromium.org>
puppeteer · Aug 1, 2024 · 6422dc2 · 6422dc2
1 parent 3aacc1c
commit 6422dc2
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/docs/api/puppeteer.browserconnectoptions.md b/docs/api/puppeteer.browserconnectoptions.md
@@ -93,7 +93,13 @@ Whether to ignore HTTPS errors during navigation.
 
 </td><td>
 
-'cdp'
+Determined at run time:
+
+- Launching Chrome - 'cdp'.
+
+- Launching Firefox - 'webDriverBiDi'.
+
+- Connecting to a browser - 'cdp'.
 
 </td></tr>
 <tr><td>

diff --git a/packages/puppeteer-core/src/common/ConnectOptions.ts b/packages/puppeteer-core/src/common/ConnectOptions.ts
@@ -49,7 +49,14 @@ export interface BrowserConnectOptions {
   _isPageTarget?: IsPageTargetCallback;
 
   /**
-   * @defaultValue 'cdp'
+   * @defaultValue Determined at run time:
+   *
+   * - Launching Chrome - 'cdp'.
+   *
+   * - Launching Firefox - 'webDriverBiDi'.
+   *
+   * - Connecting to a browser - 'cdp'.
+   *
    * @public
    */
   protocol?: ProtocolType;

diff --git a/packages/puppeteer-core/src/node/ProductLauncher.ts b/packages/puppeteer-core/src/node/ProductLauncher.ts
@@ -93,9 +93,15 @@ export abstract class ProductLauncher {
       timeout = 30000,
       waitForInitialPage = true,
       protocolTimeout,
-      protocol,
     } = options;
 
+    let {protocol} = options;
+
+    // Default to 'webDriverBiDi' for Firefox.
+    if (this.#product === 'firefox' && protocol === undefined) {
+      protocol = 'webDriverBiDi';
+    }
+
     const launchArgs = await this.computeLaunchArguments(options);
 
     if (!existsSync(launchArgs.executablePath)) {