fix: use targetFilter in puppeteer.launch (#8774)

Drive-by: adds Symbol.toStringTag to Target to simplify debugging. Closes #8772
puppeteer · Aug 11, 2022 · ee2540b · ee2540b
1 parent b417602
commit ee2540b
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/src/common/Target.ts b/src/common/Target.ts
@@ -135,6 +135,13 @@ export class Target {
     return this.#sessionFactory();
   }
 
+  /**
+   * @internal
+   */
+  get [Symbol.toStringTag](): string {
+    return JSON.stringify(this.#targetInfo, null, 2);
+  }
+
   /**
    * @internal
    */

diff --git a/src/node/ChromeLauncher.ts b/src/node/ChromeLauncher.ts
@@ -161,7 +161,8 @@ export class ChromeLauncher implements ProductLauncher {
         ignoreHTTPSErrors,
         defaultViewport,
         runner.proc,
-        runner.close.bind(runner)
+        runner.close.bind(runner),
+        options.targetFilter
       );
     } catch (error) {
       runner.kill();

diff --git a/src/node/FirefoxLauncher.ts b/src/node/FirefoxLauncher.ts
@@ -158,7 +158,8 @@ export class FirefoxLauncher implements ProductLauncher {
         ignoreHTTPSErrors,
         defaultViewport,
         runner.proc,
-        runner.close.bind(runner)
+        runner.close.bind(runner),
+        options.targetFilter
       );
     } catch (error) {
       runner.kill();

diff --git a/test/src/launcher.spec.ts b/test/src/launcher.spec.ts
@@ -753,6 +753,29 @@ describe('Launcher specs', function () {
         await page.close();
         await browser.close();
       });
+
+      it('should support targetFilter option in puppeteer.launch', async () => {
+        const {puppeteer, defaultBrowserOptions} = getTestState();
+        const browser = await puppeteer.launch({
+          ...defaultBrowserOptions,
+          targetFilter: target => {
+            return target.type !== 'page';
+          },
+          waitForInitialPage: false,
+        });
+        try {
+          const targets = browser.targets();
+          expect(targets.length).toEqual(1);
+          expect(
+            targets.find(target => {
+              return target.type() === 'page';
+            })
+          ).toBeUndefined();
+        } finally {
+          await browser.close();
+        }
+      });
+
       // @see https://github.com/puppeteer/puppeteer/issues/4197
       itFailsFirefox('should support targetFilter option', async () => {
         const {server, puppeteer, defaultBrowserOptions} = getTestState();