Skip to content

Chrome DevTools for coding agents

chore: move getComments to the bridge and add setAgentAttached (#2790)

Alex Rudenkoc6d1eff41d19
diff --git a/src/McpPage.ts b/src/McpPage.ts
index b2c1a422..578a5de6 100644
--- a/src/McpPage.ts
+++ b/src/McpPage.ts
@@ -380,13 +380,16 @@ export class McpPage implements ContextPage {
return this.#commentBridge;
}
- async ensureDevToolsCommentBridge(devtoolsPage: Page): Promise<void> {
+ async ensureDevToolsCommentBridge(
+ devtoolsPage: Page,
+ ): Promise<DevToolsCommentBridge> {
if (!this.#commentBridge) {
this.#commentBridge = new DevToolsCommentBridge({
onNotification: this.#onNotification,
});
}
await this.#commentBridge.attach(devtoolsPage);
+ return this.#commentBridge;
}
async getDevToolsPage(): Promise<Page | undefined> {
diff --git a/src/devtools/DevToolsCommentBridge.ts b/src/devtools/DevToolsCommentBridge.ts
index 98fd34b7..41e390d6 100644
--- a/src/devtools/DevToolsCommentBridge.ts
+++ b/src/devtools/DevToolsCommentBridge.ts
@@ -5,6 +5,7 @@
*/
import type {Page} from '../third_party/index.js';
+import type {CD4ACommentThread} from '../types.js';
import {logger} from '../utils/logger.js';
export interface DevToolsCommentBridgeOptions {
@@ -59,12 +60,20 @@ export class DevToolsCommentBridge {
'CommentThreadsChanged',
window.__onDevToolsCommentListener,
);
+ window.universe?.cd4aBridge?.setAgentAttached(true);
});
} catch (e) {
logger?.('DevToolsCommentBridge: evaluate failed', e);
}
}
+ async getComments(devtoolsPage: Page): Promise<CD4ACommentThread[]> {
+ return await devtoolsPage.evaluate(() => {
+ window.universe?.cd4aBridge?.setAgentAttached(true);
+ return window.universe?.cd4aBridge?.getCommentThreads() ?? [];
+ });
+ }
+
#handleCommentEvent(): void {
if (this.#commentDebounceTimer) {
clearTimeout(this.#commentDebounceTimer);
@@ -89,6 +98,7 @@ export class DevToolsCommentBridge {
);
delete window.__onDevToolsCommentListener;
}
+ window.universe?.cd4aBridge?.setAgentAttached(false);
});
if (result && typeof result.catch === 'function') {
void result.catch(e => {
diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.ts
index 6bb8f0b2..b5dab361 100644
--- a/src/tools/ToolDefinition.ts
+++ b/src/tools/ToolDefinition.ts
@@ -14,6 +14,7 @@ import type {
HeapQueryOptions,
} from '../processors/HeapSnapshotManager.js';
import type {McpPage} from '../McpPage.js';
+import type {DevToolsCommentBridge} from '../devtools/DevToolsCommentBridge.js';
import type {CssFormatterOptions} from '../formatters/CssFormatter.js';
import {zod} from '../third_party/index.js';
import type {
@@ -406,6 +407,9 @@ export type ContextPage = Readonly<{
waitForTextOnPage(text: string[], timeout?: number): Promise<Element>;
getDevToolsPage(): Promise<Page | undefined>;
openDevTools(): Promise<Page | undefined>;
+ ensureDevToolsCommentBridge(
+ devtoolsPage: Page,
+ ): Promise<DevToolsCommentBridge>;
}>;
export function defineTool<Schema extends zod.ZodRawShape>(
diff --git a/src/tools/comments.ts b/src/tools/comments.ts
index 861046e2..4937add8 100644
--- a/src/tools/comments.ts
+++ b/src/tools/comments.ts
@@ -64,9 +64,8 @@ export const getDevtoolsComments = definePageTool(() => ({
return;
}
- const threads = await devtoolsPage.evaluate(() => {
- return window.universe?.cd4aBridge?.getCommentThreads() ?? [];
- });
+ const bridge = await page.ensureDevToolsCommentBridge(devtoolsPage);
+ const threads = await bridge.getComments(devtoolsPage);
response.setDevToolsComments(threads);
},
diff --git a/src/types.ts b/src/types.ts
index 611318b7..8ded1ee5 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -68,6 +68,7 @@ export enum CD4ABridgeEvents {
export interface CD4ABridge {
dispose?(): void;
+ setAgentAttached(value: boolean): void;
getCommentThreads(): CD4ACommentThread[];
takeComments(): CD4ACommentThread[];
resolveCommentThread(threadId: string, replyText?: string): boolean;
diff --git a/tests/devtools/DevToolsCommentBridge.test.ts b/tests/devtools/DevToolsCommentBridge.test.ts
index 36fa5f26..54bbc812 100644
--- a/tests/devtools/DevToolsCommentBridge.test.ts
+++ b/tests/devtools/DevToolsCommentBridge.test.ts
@@ -119,4 +119,21 @@ describe('DevToolsCommentBridge', () => {
sinon.assert.notCalled(onNotification);
sinon.assert.calledTwice(devtoolsPage.evaluate);
});
+
+ it('retrieves comments via getComments', async () => {
+ const devtoolsPage = createMockPuppeteerPage();
+ const bridge = new DevToolsCommentBridge();
+ const mockThreads = [
+ {
+ id: 'comment-1',
+ text: 'Check alignment',
+ },
+ ];
+ devtoolsPage.evaluate.resolves(mockThreads);
+
+ const threads = await bridge.getComments(devtoolsPage);
+
+ sinon.assert.calledOnce(devtoolsPage.evaluate);
+ assert.deepStrictEqual(threads, mockThreads);
+ });
});
diff --git a/tests/tools/comments.test.ts b/tests/tools/comments.test.ts
index b8350c7f..d0ec362c 100644
--- a/tests/tools/comments.test.ts
+++ b/tests/tools/comments.test.ts
@@ -8,6 +8,7 @@ import {afterEach, describe, it} from 'node:test';
import sinon from 'sinon';
+import {DevToolsCommentBridge} from '../../src/devtools/DevToolsCommentBridge.js';
import type {CommentThreadPayload} from '../../src/tools/comments.js';
import {
getDevtoolsComments,
@@ -56,7 +57,9 @@ describe('comments tools', () => {
it('fetches comments and sets them on response', async () => {
const {page, context, response, args} = createHandlerMocks();
const devtoolsPage = createMockPuppeteerPage();
+ const bridge = sinon.createStubInstance(DevToolsCommentBridge);
page.getDevToolsPage.resolves(devtoolsPage);
+ page.ensureDevToolsCommentBridge.resolves(bridge);
const mockThread: CommentThreadPayload = {
id: 'comment-1',
@@ -69,7 +72,7 @@ describe('comments tools', () => {
},
};
- devtoolsPage.evaluate.resolves([mockThread]);
+ bridge.getComments.resolves([mockThread]);
await getDevtoolsComments(args).handler(
{params: {}, page},
@@ -78,7 +81,11 @@ describe('comments tools', () => {
);
sinon.assert.calledOnce(page.getDevToolsPage);
- sinon.assert.calledOnce(devtoolsPage.evaluate);
+ sinon.assert.calledOnceWithExactly(
+ page.ensureDevToolsCommentBridge,
+ devtoolsPage,
+ );
+ sinon.assert.calledOnceWithExactly(bridge.getComments, devtoolsPage);
sinon.assert.calledOnceWithExactly(response.setDevToolsComments, [
mockThread,
]);
@@ -87,8 +94,10 @@ describe('comments tools', () => {
it('sets empty comments list when no comments are found', async () => {
const {page, context, response, args} = createHandlerMocks();
const devtoolsPage = createMockPuppeteerPage();
+ const bridge = sinon.createStubInstance(DevToolsCommentBridge);
page.getDevToolsPage.resolves(devtoolsPage);
- devtoolsPage.evaluate.resolves([]);
+ page.ensureDevToolsCommentBridge.resolves(bridge);
+ bridge.getComments.resolves([]);
await getDevtoolsComments(args).handler(
{params: {}, page},
@@ -97,7 +106,11 @@ describe('comments tools', () => {
);
sinon.assert.calledOnce(page.getDevToolsPage);
- sinon.assert.calledOnce(devtoolsPage.evaluate);
+ sinon.assert.calledOnceWithExactly(
+ page.ensureDevToolsCommentBridge,
+ devtoolsPage,
+ );
+ sinon.assert.calledOnceWithExactly(bridge.getComments, devtoolsPage);
sinon.assert.calledOnceWithExactly(response.setDevToolsComments, []);
});
});