Chrome DevTools for coding agents
feat: report pages opened by input actions (#2679)
lisa031428fb230dde70
diff --git a/src/McpResponse.ts b/src/McpResponse.tsindex 66048814..26a2e17d 100644--- a/src/McpResponse.ts+++ b/src/McpResponse.ts@@ -776,6 +776,10 @@ export class McpResponse implements Response {content: Array<TextContent | ImageContent>;structuredContent: object;}> {+ if (this.#attachedWaitForResult?.openedPages && !this.#includePages) {+ await context.createPagesSnapshot();+ }+const [snapshot,detailedNetworkRequest,@@ -895,6 +899,7 @@ export class McpResponse implements Response {defaultValue?: string;};pages?: object[];+ openedPages?: object[];pagination?: object;heapSnapshot?: {stats?: object;@@ -971,6 +976,28 @@ export class McpResponse implements Response {structuredContent.navigatedToUrl =this.#attachedWaitForResult.navigatedToUrl;}+ if (this.#attachedWaitForResult.openedPages) {+ const openedPages = this.#attachedWaitForResult.openedPages;+ const openedMcpPages = context+ .getPages()+ .filter(mcpPage => openedPages.has(mcpPage.target));++ if (openedMcpPages.length) {+ const targetInfos = await context.getTargetInfos();+ response.push('## Opened pages');+ const structuredPages = [];+ for (const mcpPage of openedMcpPages) {+ const page = formatPage(+ mcpPage,+ context,+ targetInfos.get(mcpPage.targetId),+ );+ response.push(page.text);+ structuredPages.push(page.structured);+ }+ structuredContent.openedPages = structuredPages;+ }+ }}const page = this.#page;@@ -1094,14 +1121,15 @@ Call ${handleDialog(this.#args).name} to handle it before continuing.`);const contextLabel = isolatedContextName? ` isolatedContext=${isolatedContextName}`: '';- const title = mcpPage.getTitle(targetInfos.get(mcpPage.targetId));- const pageLabel = title- ? `${truncateTitle(title)} (${mcpPage.url()})`- : mcpPage.url();+ const page = formatPage(+ mcpPage,+ context,+ targetInfos.get(mcpPage.targetId),+ );parts.push(- `${mcpPage.id}: ${pageLabel}${context.isPageSelected(mcpPage) ? ' [selected]' : ''}${contextLabel}`,+ `${page.text}${context.isPageSelected(mcpPage) ? ' [selected]' : ''}${contextLabel}`,);- structuredPages.push(createStructuredPage(mcpPage, context, title));+ structuredPages.push(page.structured);}response.push(...parts);structuredContent.pages = structuredPages;@@ -1116,16 +1144,15 @@ Call ${handleDialog(this.#args).name} to handle it before continuing.`);const contextLabel = isolatedContextName? ` isolatedContext=${isolatedContextName}`: '';- const title = mcpPage.getTitle(targetInfos.get(mcpPage.targetId));- const pageLabel = title- ? `${truncateTitle(title)} (${mcpPage.url()})`- : mcpPage.url();- response.push(- `${mcpPage.id}: ${pageLabel}${context.isPageSelected(mcpPage) ? ' [selected]' : ''}${contextLabel}`,+ const page = formatPage(+ mcpPage,+ context,+ targetInfos.get(mcpPage.targetId),);- structuredExtensionPages.push(- createStructuredPage(mcpPage, context, title),+ response.push(+ `${page.text}${context.isPageSelected(mcpPage) ? ' [selected]' : ''}${contextLabel}`,);+ structuredExtensionPages.push(page.structured);}structuredContent.extensionPages = structuredExtensionPages;}@@ -1789,6 +1816,19 @@ const collapseWhitespace = (value: string): string => {return value.replace(/\s+/g, ' ').trim();};+function formatPage(+ mcpPage: McpPage,+ context: McpContext,+ targetInfo: Protocol.Target.TargetInfo | undefined,+): {text: string; structured: ReturnType<typeof createStructuredPage>} {+ const title = mcpPage.getTitle(targetInfo);+ const url = mcpPage.url();+ const pageLabel = title ? `${truncateTitle(title)} (${url})` : url;+ return {+ text: `${mcpPage.id}: ${pageLabel}`,+ structured: createStructuredPage(mcpPage, context, title),+ };+}function createStructuredPage(mcpPage: McpPage,context: McpContext,diff --git a/src/utils/WaitForHelper.ts b/src/utils/WaitForHelper.tsindex 03a1821d..3a092938 100644--- a/src/utils/WaitForHelper.ts+++ b/src/utils/WaitForHelper.ts@@ -5,6 +5,7 @@*/import type {+ Target,Page,Protocol,CdpPage,@@ -18,6 +19,7 @@ export type DialogAction = 'accept' | 'dismiss' | string;export class WaitForHelper {#abortController = new AbortController();#page: CdpPage;+ #publicPage: Page;#stableDomTimeout: number;#stableDomFor: number;#expectNavigationIn: number;@@ -27,6 +29,7 @@ export class WaitForHelper {/** Track all dialogs as they pause the renderer. */#dialogDetected = false;#initialUrl: string;+ #openedPages = new Set<Target>();constructor(page: Page,@@ -38,6 +41,7 @@ export class WaitForHelper {this.#expectNavigationIn = 100 * cpuTimeoutMultiplier;this.#navigationTimeout = 3000 * networkTimeoutMultiplier;this.#page = page as unknown as CdpPage;+ this.#publicPage = page;this.#initialUrl = page.url();}@@ -163,6 +167,16 @@ export class WaitForHelper {this.#page.off('dialog', dialogHandler);});+ const popupHandler = (page: Page | null): void => {+ if (page) {+ this.#openedPages.add(page.target());+ }+ };+ this.#publicPage.on('popup', popupHandler);+ this.#abortController.signal.addEventListener('abort', () => {+ this.#publicPage.off('popup', popupHandler);+ });+// A scoped AbortController used to clean up navigation probe listeners.// When aborted (either after navigation detection finishes or if this.#abortController// aborts), it removes CDP navigation probe listeners and automatically@@ -292,6 +306,7 @@ export class WaitForHelper {? {navigatedToUrl: urlAfterAction}: {}),dialogHandled: this.#dialogHandled,+ ...(this.#openedPages.size ? {openedPages: this.#openedPages} : {}),};}}@@ -306,6 +321,7 @@ export interface WaitForEventsResult {* Whether a dialog was automatically handled during the action.*/dialogHandled?: boolean;+ openedPages?: Set<Target>;}export function getNetworkMultiplierFromString(diff --git a/tests/McpResponse.test.ts b/tests/McpResponse.test.tsindex 41a79604..6dd9b9eb 100644--- a/tests/McpResponse.test.ts+++ b/tests/McpResponse.test.ts@@ -7,7 +7,7 @@import assert from 'node:assert';import {readFile} from 'node:fs/promises';import {join} from 'node:path';-import {describe, it} from 'node:test';+import {afterEach, describe, it} from 'node:test';import sinon from 'sinon';@@ -53,6 +53,7 @@ import {createMockMcpWorker,createMockObjectInfo,createMockParsedArguments,+ createMockPuppeteerTarget,} from './mocks.js';import {createTempDir,@@ -68,6 +69,58 @@ import {} from './utils.js';describe('McpResponse', () => {+ afterEach(() => {+ sinon.restore();+ });++ it('reports only pages opened by the attached action', async () => {+ const openedTarget = createMockPuppeteerTarget({+ url: 'https://example.com/opened',+ title: 'Opened page',+ });+ const openedPage = createMockMcpPage({target: openedTarget});+ const unrelatedPage = createMockMcpPage();+ Object.defineProperty(openedPage, 'id', {value: 2});+ openedPage.url.returns('https://example.com/opened');+ openedPage.getTitle.returns('Opened page');+ Object.defineProperty(unrelatedPage, 'id', {value: 3});+ unrelatedPage.url.returns('https://example.com/unrelated');+ unrelatedPage.getTitle.returns('Unrelated page');++ const context = createMockMcpContext();+ const targetInfo = openedTarget._getTargetInfo();+ context.getTargetInfos.resolves(+ new Map([[targetInfo.targetId, targetInfo]]),+ );+ context.getPages.returns([openedPage, unrelatedPage]);+ context.isPageSelected.returns(false);+ const response = new McpResponse(createMockParsedArguments());+ response.attachWaitForResult({+ openedPages: new Set([openedPage.target]),+ });++ const result = await response.handle(context);++ sinon.assert.calledOnceWithExactly(context.createPagesSnapshot);+ sinon.assert.calledOnceWithExactly(context.getTargetInfos);+ sinon.assert.calledOnceWithExactly(openedPage.getTitle, targetInfo);+ assert.match(+ getTextContent(result.content[0]),+ /## Opened pages\n2: Opened page \(https:\/\/example\.com\/opened\)/,+ );+ assert.ok(!getTextContent(result.content[0]).includes('Unrelated page'));+ assert.deepStrictEqual(result.structuredContent, {+ openedPages: [+ {+ id: 2,+ url: 'https://example.com/opened',+ title: 'Opened page',+ selected: false,+ },+ ],+ });+ });+it('list pages', async t => {await withMcpContext(async (response, context) => {response.setIncludePages(true);diff --git a/tests/mocks.ts b/tests/mocks.tsindex cd911f52..c82cfd28 100644--- a/tests/mocks.ts+++ b/tests/mocks.ts@@ -133,6 +133,9 @@ export function mockListener() {listener(data);}},+ listenerCount(eventName: string | symbol | number) {+ return listeners[eventName]?.length ?? 0;+ },};}@@ -178,6 +181,7 @@ export function createMockPuppeteerPage(): sinon.SinonStubbedInstance<Page> & {CdpPage,) as unknown as sinon.SinonStubbedInstance<Page>;const pageListener = mockListener();+ page.listenerCount.callsFake(pageListener.listenerCount);page.on.callsFake((eventName, handler) => {pageListener.on(eventName, handler);return page;diff --git a/tests/utils/WaitForHelper.test.ts b/tests/utils/WaitForHelper.test.tsindex b2612f2f..fd40a6eb 100644--- a/tests/utils/WaitForHelper.test.ts+++ b/tests/utils/WaitForHelper.test.ts@@ -10,7 +10,11 @@ import {afterEach, describe, it} from 'node:test';import sinon from 'sinon';import {WaitForHelper} from '../../src/utils/WaitForHelper.js';-import {createMockDialog, createMockPuppeteerPage} from '../mocks.js';+import {+ createMockDialog,+ createMockPuppeteerPage,+ createMockPuppeteerTarget,+} from '../mocks.js';import {serverHooks} from '../server.js';import {html, withMcpContext} from '../utils.js';@@ -202,4 +206,24 @@ describe('WaitForHelper', () => {assert.strictEqual(result.navigatedToUrl, targetUrl);});});++ it('captures popup targets opened by the action', async () => {+ const pptrPage = createMockPuppeteerPage();+ pptrPage.url.returns('https://example.com');+ pptrPage.waitForNavigation.returns(Promise.withResolvers<null>().promise);+ const popupPage = createMockPuppeteerPage();+ const popupTarget = createMockPuppeteerTarget({page: popupPage});+ const helper = new WaitForHelper(pptrPage, 1, 1);++ const result = await helper.waitForEventsAfterAction(+ async () => {+ assert.strictEqual(pptrPage.listenerCount('popup'), 1);+ pptrPage.emit('popup', popupPage);+ },+ {waitForStableDom: false, expectNavigationIn: 0},+ );++ assert.strictEqual(result.openedPages?.has(popupTarget), true);+ assert.strictEqual(pptrPage.listenerCount('popup'), 0);+ });});