feat: update listPages to return extension service workers

Author: nroscino

src/McpContext.ts

@@ -8,6 +8,7 @@ import fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 
+import type {ParsedArguments} from './cli.js';
 import type {TargetUniverse} from './DevtoolsUtils.js';
 import {
   extractUrlLikeFromDevToolsTitle,
@@ -29,6 +30,7 @@ import type {
   ScreenRecorder,
   SerializedAXNode,
   Viewport,
+  Target,
 } from './third_party/index.js';
 import {Locator} from './third_party/index.js';
 import {PredefinedNetworkConditions} from './third_party/index.js';
@@ -50,6 +52,12 @@ export interface TextSnapshotNode extends SerializedAXNode {
   children: TextSnapshotNode[];
 }
 
+export interface ExtensionServiceWorker {
+	url: string;
+	target: Target;
+	id: string;
+}
+
 export interface GeolocationOptions {
   latitude: number;
   longitude: number;
@@ -129,6 +137,8 @@ export class McpContext implements Context {
   #nextIsolatedContextId = 1;
 
   #pages: Page[] = [];
+  #extensionServiceWorkers: ExtensionServiceWorker[] = [];
+
   #pageToDevToolsPage = new Map<Page, Page>();
   #selectedPage?: Page;
   #textSnapshot: TextSnapshot | null = null;
@@ -146,6 +156,9 @@ export class McpContext implements Context {
   #pageIdMap = new WeakMap<Page, number>();
   #nextPageId = 1;
 
+	#extensionServiceWorkerMap = new WeakMap<Target, string>();
+	#nextExtensionServiceWorkerId = 1;
+
   #nextSnapshotId = 1;
   #traceResults: TraceResult[] = [];
 
@@ -185,6 +198,7 @@ export class McpContext implements Context {
 
   async #init() {
     const pages = await this.createPagesSnapshot();
+    await this.createExtensionServiceWorkersSnapshot();
     await this.#networkCollector.init(pages);
     await this.#consoleCollector.init(pages);
     await this.#devtoolsUniverseManager.init(pages);
@@ -494,7 +508,7 @@ export class McpContext implements Context {
     }
     if (page.isClosed()) {
       throw new Error(
-        `The selected page has been closed. Call ${listPages.name} to see open pages.`,
+        `The selected page has been closed. Call ${listPages({} as ParsedArguments).name} to see open pages.`,
       );
     }
     return page;
@@ -584,6 +598,41 @@ export class McpContext implements Context {
     }
   }
 
+	/**
+	 * Creates a snapshot of the extension service workers.
+	 */
+	async createExtensionServiceWorkersSnapshot(): Promise<
+		ExtensionServiceWorker[]
+	> {
+		const allTargets = await this.browser.targets();
+
+		const serviceWorkers = allTargets.filter(target => {
+			return (
+				target.type() === 'service_worker' &&
+				target.url().includes('chrome-extension://')
+			);
+		});
+
+		for (const serviceWorker of serviceWorkers) {
+			if (!this.#extensionServiceWorkerMap.has(serviceWorker)) {
+				this.#extensionServiceWorkerMap.set(
+					serviceWorker,
+					'sw-' + this.#nextExtensionServiceWorkerId++,
+				);
+			}
+		}
+
+		this.#extensionServiceWorkers = serviceWorkers.map(serviceWorker => {
+			return {
+				target: serviceWorker,
+				id: this.#extensionServiceWorkerMap.get(serviceWorker)!,
+				url: serviceWorker.url(),
+			};
+		});
+
+		return this.#extensionServiceWorkers;
+	}
+
   async createPagesSnapshot(): Promise<Page[]> {
     const allPages = await this.#getAllPages();
 
@@ -677,6 +726,16 @@ export class McpContext implements Context {
     }
   }
 
+	getExtensionServiceWorkers(): ExtensionServiceWorker[] {
+		return this.#extensionServiceWorkers;
+	}
+
+	getExtensionServiceWorkerId(
+		extensionServiceWorker: ExtensionServiceWorker,
+	): string | undefined {
+		return this.#extensionServiceWorkerMap.get(extensionServiceWorker.target);
+	}
+
   getPages(): Page[] {
     return this.#pages;
   }

src/McpResponse.ts

@@ -38,6 +38,7 @@ interface TraceInsightData {
 
 export class McpResponse implements Response {
   #includePages = false;
+  #includeExtensionServiceWorkers = false;
   #snapshotParams?: SnapshotParams;
   #attachedNetworkRequestId?: number;
   #attachedNetworkRequestOptions?: {
@@ -88,6 +89,10 @@ export class McpResponse implements Response {
     this.#listExtensions = true;
   }
 
+  setIncludeExtensionServiceWorkers(value: boolean): void {
+    this.#includeExtensionServiceWorkers = value;
+  }
+
   setIncludeNetworkRequests(
     value: boolean,
     options?: PaginationOptions & {
@@ -233,6 +238,10 @@ export class McpResponse implements Response {
       await context.createPagesSnapshot();
     }
 
+    if (this.#includeExtensionServiceWorkers) {
+      await context.createExtensionServiceWorkersSnapshot();
+    }
+
     let snapshot: SnapshotFormatter | string | undefined;
     if (this.#snapshotParams) {
       await context.createTextSnapshot(
@@ -438,6 +447,7 @@ export class McpResponse implements Response {
       };
       pages?: object[];
       pagination?: object;
+      extensionServiceWorkers?: object[];
     } = {};
 
     const response = [`# ${toolName} response`];
@@ -532,6 +542,26 @@ Call ${handleDialog.name} to handle it before continuing.`);
       });
     }
 
+    if (this.#includeExtensionServiceWorkers) {
+      if (!context.getExtensionServiceWorkers().length) {
+        response.push(`## Extension Service Workers`);
+      }
+
+      for (const extensionServiceWorker of context.getExtensionServiceWorkers()) {
+        response.push(
+          `${extensionServiceWorker.id}: ${extensionServiceWorker.url}`,
+        );
+      }
+      structuredContent.extensionServiceWorkers = context
+        .getExtensionServiceWorkers()
+        .map(extensionServiceWorker => {
+          return {
+            id: extensionServiceWorker.id,
+            url: extensionServiceWorker.url,
+          };
+        });
+    }
+
     if (this.#tabId) {
       structuredContent.tabId = this.#tabId;
     }

src/tools/ToolDefinition.ts

@@ -96,6 +96,7 @@ export interface Response {
     insightName: InsightName,
   ): void;
   setListExtensions(): void;
+  setIncludeExtensionServiceWorkers(value: boolean): void;
 }
 
 /**

src/tools/pages.ts

@@ -4,24 +4,30 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import type {ParsedArguments} from '../cli.js';
 import {logger} from '../logger.js';
 import type {Dialog} from '../third_party/index.js';
 import {zod} from '../third_party/index.js';
 
 import {ToolCategory} from './categories.js';
 import {CLOSE_PAGE_ERROR, defineTool, timeoutSchema} from './ToolDefinition.js';
 
-export const listPages = defineTool({
-  name: 'list_pages',
-  description: `Get a list of pages open in the browser.`,
-  annotations: {
-    category: ToolCategory.NAVIGATION,
-    readOnlyHint: true,
-  },
-  schema: {},
-  handler: async (_request, response) => {
-    response.setIncludePages(true);
-  },
+export const listPages = defineTool((args) => {
+  return {
+    name: 'list_pages',
+    description: `Get a list of pages ${args.categoryExtensions ? 'including extension service workers' : ''} open in the browser.`,
+    annotations: {
+      category: ToolCategory.NAVIGATION,
+      readOnlyHint: true,
+    },
+    schema: {},
+    handler: async (_request, response) => {
+      response.setIncludePages(true);
+      if(args.categoryExtensions) {
+        response.setIncludeExtensionServiceWorkers(true);
+      }
+    },
+  };
 });
 
 export const selectPage = defineTool({
@@ -35,7 +41,7 @@ export const selectPage = defineTool({
     pageId: zod
       .number()
       .describe(
-        `The ID of the page to select. Call ${listPages.name} to get available pages.`,
+        `The ID of the page to select. Call ${listPages({} as ParsedArguments).name} to get available pages.`,
       ),
     bringToFront: zod
       .boolean()
@@ -372,7 +378,7 @@ export const getTabId = defineTool({
     pageId: zod
       .number()
       .describe(
-        `The ID of the page to get the tab ID for. Call ${listPages.name} to get available pages.`,
+        `The ID of the page to get the tab ID for. Call ${listPages({} as ParsedArguments).name} to get available pages.`,
       ),
   },
   handler: async (request, response, context) => {

src/tools/tools.ts

@@ -42,8 +42,7 @@ export const createTools = (args: ParsedArguments) => {
   const tools: ToolDefinition[] = [];
   for (const tool of rawTools) {
     if (typeof tool === 'function') {
-      // @ts-expect-error none of the tools for now implement the function type tool has type "never"
-      tools.push(tool(args) as ToolDefinition);
+      tools.push(tool(args));
     } else {
       tools.push(tool as ToolDefinition);
     }

tests/tools/fixtures/extension-sw/manifest.json

@@ -0,0 +1,11 @@
+{
+  "manifest_version": 3,
+  "name": "Test Extension with SW",
+  "version": "1.0",
+  "background": {
+    "service_worker": "sw.js"
+  },
+  "action": {
+    "default_popup": "popup.html"
+  }
+}

tests/tools/fixtures/extension-sw/popup.html

@@ -0,0 +1,6 @@
+<!doctype html>
+<html>
+  <body>
+    <h1>Extension With Service Worker</h1>
+  </body>
+</html>

tests/tools/fixtures/extension-sw/sw.js

@@ -0,0 +1 @@
+console.log('Service worker loaded');

tests/tools/pages.test.ts

@@ -5,11 +5,14 @@
  */
 
 import assert from 'node:assert';
+import path from 'node:path';
 import {afterEach, describe, it} from 'node:test';
 
 import type {Dialog} from 'puppeteer-core';
 import sinon from 'sinon';
 
+import type {ParsedArguments} from '../../src/cli.js';
+import {installExtension} from '../../src/tools/extensions.js';
 import {
   listPages,
   newPage,
@@ -22,6 +25,11 @@ import {
 } from '../../src/tools/pages.js';
 import {html, withMcpContext} from '../utils.js';
 
+const EXTENSION_PATH = path.join(
+  import.meta.dirname,
+  '../../../tests/tools/fixtures/extension-sw',
+);
+
 describe('pages', () => {
   afterEach(() => {
     sinon.restore();
@@ -30,10 +38,57 @@ describe('pages', () => {
   describe('list_pages', () => {
     it('list pages', async () => {
       await withMcpContext(async (response, context) => {
-        await listPages.handler({params: {}}, response, context);
+        await listPages({} as ParsedArguments).handler(
+          {params: {}},
+          response,
+          context,
+        );
         assert.ok(response.includePages);
       });
     });
+    for (const categoryExtensions of [true, false]) {
+      it(`list pages ${categoryExtensions ? 'with' : 'without'} --category-extensions`, async () => {
+        await withMcpContext(async (response, context) => {
+          await installExtension.handler(
+            {params: {path: EXTENSION_PATH}},
+            response,
+            context,
+          );
+
+          const swTarget = await context.browser.waitForTarget(
+            t =>
+              t.type() === 'service_worker' &&
+              t.url().includes('chrome-extension://'),
+          );
+          const swUrl = swTarget.url();
+
+          response.resetResponseLineForTesting();
+
+          const listPageDef = listPages({categoryExtensions} as ParsedArguments);
+          await listPageDef.handler({params: {}}, response, context);
+
+          const result = await response.handle(listPageDef.name, context);
+          const textContent = result.content.find(c => c.type === 'text') as {
+            type: 'text';
+            text: string;
+          };
+          assert.ok(textContent);
+
+          if (categoryExtensions) {
+            assert.ok(textContent.text.includes(swUrl));
+            const structured = result.structuredContent as {
+              extensionServiceWorkers: Array<{url: string}>;
+            };
+            assert.deepStrictEqual(
+              structured.extensionServiceWorkers.map(sw => sw.url),
+              [swUrl],
+            );
+          } else {
+            assert.ok(!textContent.text.includes(swUrl));
+          }
+        });
+      });
+    }
   });
   describe('new_page', () => {
     it('create a page', async () => {