chore: experimental includeAllPages option (#517)

Author: OrKoN

src/McpContext.ts

@@ -45,6 +45,8 @@ export interface TextSnapshot {
 interface McpContextOptions {
   // Whether the DevTools windows are exposed as pages for debugging of DevTools.
   experimentalDevToolsDebugging: boolean;
+  // Whether all page-like targets are exposed as pages.
+  experimentalIncludeAllPages?: boolean;
 }
 
 const DEFAULT_TIMEOUT = 5_000;
@@ -114,24 +116,32 @@ export class McpContext implements Context {
     this.#locatorClass = locatorClass;
     this.#options = options;
 
-    this.#networkCollector = new NetworkCollector(this.browser);
+    this.#networkCollector = new NetworkCollector(
+      this.browser,
+      undefined,
+      this.#options.experimentalIncludeAllPages,
+    );
 
-    this.#consoleCollector = new PageCollector(this.browser, collect => {
-      return {
-        console: event => {
-          collect(event);
-        },
-        pageerror: event => {
-          if (event instanceof Error) {
+    this.#consoleCollector = new PageCollector(
+      this.browser,
+      collect => {
+        return {
+          console: event => {
             collect(event);
-          } else {
-            const error = new Error(`${event}`);
-            error.stack = undefined;
-            collect(error);
-          }
-        },
-      } as ListenerMap;
-    });
+          },
+          pageerror: event => {
+            if (event instanceof Error) {
+              collect(event);
+            } else {
+              const error = new Error(`${event}`);
+              error.stack = undefined;
+              collect(error);
+            }
+          },
+        } as ListenerMap;
+      },
+      this.#options.experimentalIncludeAllPages,
+    );
   }
 
   async #init() {
@@ -364,7 +374,9 @@ export class McpContext implements Context {
    * Creates a snapshot of the pages.
    */
   async createPagesSnapshot(): Promise<Page[]> {
-    const allPages = await this.browser.pages();
+    const allPages = await this.browser.pages(
+      this.#options.experimentalIncludeAllPages,
+    );
 
     this.#pages = allPages.filter(page => {
       // If we allow debugging DevTools windows, return all pages.
@@ -382,7 +394,9 @@ export class McpContext implements Context {
 
   async detectOpenDevToolsWindows() {
     this.logger('Detecting open DevTools windows');
-    const pages = await this.browser.pages();
+    const pages = await this.browser.pages(
+      this.#options.experimentalIncludeAllPages,
+    );
     this.#pageToDevToolsPage = new Map<Page, Page>();
     for (const devToolsPage of pages) {
       if (devToolsPage.url().startsWith('devtools://')) {

src/PageCollector.ts

@@ -39,6 +39,7 @@ export class PageCollector<T> {
   ) => ListenerMap<PageEvents>;
   #listeners = new WeakMap<Page, ListenerMap>();
   #maxNavigationSaved = 3;
+  #includeAllPages?: boolean;
 
   /**
    * This maps a Page to a list of navigations with a sub-list
@@ -50,13 +51,15 @@ export class PageCollector<T> {
   constructor(
     browser: Browser,
     listeners: (collector: (item: T) => void) => ListenerMap<PageEvents>,
+    includeAllPages?: boolean,
   ) {
     this.#browser = browser;
     this.#listenersInitializer = listeners;
+    this.#includeAllPages = includeAllPages;
   }
 
   async init() {
-    const pages = await this.#browser.pages();
+    const pages = await this.#browser.pages(this.#includeAllPages);
     for (const page of pages) {
       this.#initializePage(page);
     }
@@ -203,8 +206,9 @@ export class NetworkCollector extends PageCollector<HTTPRequest> {
         },
       } as ListenerMap;
     },
+    includeAllPages?: boolean,
   ) {
-    super(browser, listeners);
+    super(browser, listeners, includeAllPages);
   }
   override splitAfterNavigation(page: Page) {
     const navigations = this.storage.get(page) ?? [];

src/cli.ts

@@ -134,6 +134,12 @@ export const cliOptions = {
     describe: 'Whether to enable automation over DevTools targets',
     hidden: true,
   },
+  experimentalIncludeAllPages: {
+    type: 'boolean',
+    describe:
+      'Whether to include all kinds of pages such as webviews or background pages as pages.',
+    hidden: true,
+  },
   chromeArg: {
     type: 'array',
     describe:

src/main.ts

@@ -83,6 +83,7 @@ async function getContext(): Promise<McpContext> {
   if (context?.browser !== browser) {
     context = await McpContext.from(browser, logger, {
       experimentalDevToolsDebugging: devtools,
+      experimentalIncludeAllPages: args.experimentalIncludeAllPages,
     });
   }
   return context;