fix(webdriver): throw an error on pipe provided for Firefox (#12934)

puppeteer · Aug 12, 2024 · bec089c · bec089c
1 parent 14717a7
commit bec089c
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/docs/api/puppeteer.launchoptions.md b/docs/api/puppeteer.launchoptions.md
@@ -253,7 +253,7 @@ boolean
 
 </td><td>
 
-Connect to a browser over a pipe instead of a WebSocket.
+Connect to a browser over a pipe instead of a WebSocket. Only supported with Chrome.
 
 </td><td>
 

diff --git a/packages/puppeteer-core/src/node/BrowserLauncher.ts b/packages/puppeteer-core/src/node/BrowserLauncher.ts
@@ -128,6 +128,16 @@ export abstract class BrowserLauncher {
       );
     }
 
+    if (
+      this.#browser === 'firefox' &&
+      protocol === 'webDriverBiDi' &&
+      usePipe
+    ) {
+      throw new Error(
+        'Pipe connections are not supported wtih Firefox and WebDriver BiDi'
+      );
+    }
+
     const browserProcess = launch({
       executablePath: launchArgs.executablePath,
       args: launchArgs.args,

diff --git a/packages/puppeteer-core/src/node/LaunchOptions.ts b/packages/puppeteer-core/src/node/LaunchOptions.ts
@@ -114,7 +114,9 @@ export interface LaunchOptions {
    */
   env?: Record<string, string | undefined>;
   /**
-   * Connect to a browser over a pipe instead of a WebSocket.
+   * Connect to a browser over a pipe instead of a WebSocket. Only supported
+   * with Chrome.
+   *
    * @defaultValue `false`
    */
   pipe?: boolean;