Skip to content

Chrome DevTools for coding agents

refactor: store the last 3 navigations in PageCollector (#411)

Nikolay Vitkovb8738221d8cf
diff --git a/src/McpContext.ts b/src/McpContext.ts
index 771da7dc..90b67b02 100644
--- a/src/McpContext.ts
+++ b/src/McpContext.ts
@@ -95,13 +95,7 @@ export class McpContext implements Context {
this.browser = browser;
this.logger = logger;
- this.#networkCollector = new NetworkCollector(this.browser, collect => {
- return {
- request: request => {
- collect(request);
- },
- } as ListenerMap;
- });
+ this.#networkCollector = new NetworkCollector(this.browser);
this.#consoleCollector = new PageCollector(this.browser, collect => {
return {
diff --git a/src/PageCollector.ts b/src/PageCollector.ts
index 69615c50..b6b3d679 100644
--- a/src/PageCollector.ts
+++ b/src/PageCollector.ts
@@ -38,12 +38,14 @@ export class PageCollector<T> {
collector: (item: T) => void,
) => ListenerMap<PageEvents>;
#listeners = new WeakMap<Page, ListenerMap>();
+ #maxNavigationSaved = 3;
+
/**
- * The Array in this map should only be set once
- * As we use the reference to it.
- * Use methods that manipulate the array in place.
+ * This maps a Page to a list of navigations with a sub-list
+ * of all collected resources.
+ * The newer navigations come first.
*/
- protected storage = new WeakMap<Page, Array<WithSymbolId<T>>>();
+ protected storage = new WeakMap<Page, Array<Array<WithSymbolId<T>>>>();
constructor(
browser: Browser,
@@ -85,20 +87,23 @@ export class PageCollector<T> {
}
const idGenerator = createIdGenerator();
- const stored: Array<WithSymbolId<T>> = [];
- this.storage.set(page, stored);
+ const storedLists: Array<Array<WithSymbolId<T>>> = [[]];
+ this.storage.set(page, storedLists);
const listeners = this.#listenersInitializer(value => {
const withId = value as WithSymbolId<T>;
withId[stableIdSymbol] = idGenerator();
- stored.push(withId);
+
+ const navigations = this.storage.get(page) ?? [[]];
+ navigations[0].push(withId);
});
+
listeners['framenavigated'] = (frame: Frame) => {
- // Only reset the storage on main frame navigation
+ // Only split the storage on main frame navigation
if (frame !== page.mainFrame()) {
return;
}
- this.cleanupAfterNavigation(page);
+ this.splitAfterNavigation(page);
};
for (const [name, listener] of Object.entries(listeners)) {
@@ -108,12 +113,14 @@ export class PageCollector<T> {
this.#listeners.set(page, listeners);
}
- protected cleanupAfterNavigation(page: Page) {
- const collection = this.storage.get(page);
- if (collection) {
- // Keep the reference alive
- collection.length = 0;
+ protected splitAfterNavigation(page: Page) {
+ const navigations = this.storage.get(page);
+ if (!navigations) {
+ return;
}
+ // Add the latest navigation first
+ navigations.unshift([]);
+ navigations.splice(this.#maxNavigationSaved);
}
#cleanupPageDestroyed(page: Page) {
@@ -127,7 +134,11 @@ export class PageCollector<T> {
}
getData(page: Page): T[] {
- return this.storage.get(page) ?? [];
+ const navigations = this.storage.get(page);
+ if (!navigations) {
+ return [];
+ }
+ return navigations[0];
}
getIdForResource(resource: WithSymbolId<T>): number {
@@ -135,14 +146,16 @@ export class PageCollector<T> {
}
getById(page: Page, stableId: number): T {
- const data = this.storage.get(page);
- if (!data || !data.length) {
+ const navigations = this.storage.get(page);
+ if (!navigations) {
throw new Error('No requests found for selected page');
}
- for (const collected of data) {
- if (collected[stableIdSymbol] === stableId) {
- return collected;
+ for (const navigation of navigations) {
+ for (const collected of navigation) {
+ if (collected[stableIdSymbol] === stableId) {
+ return collected;
+ }
}
}
@@ -151,19 +164,37 @@ export class PageCollector<T> {
}
export class NetworkCollector extends PageCollector<HTTPRequest> {
- override cleanupAfterNavigation(page: Page) {
- const requests = this.storage.get(page) ?? [];
- if (!requests) {
+ constructor(browser: Browser) {
+ super(browser, collect => {
+ return {
+ request: req => {
+ collect(req);
+ },
+ } as ListenerMap;
+ });
+ }
+ override splitAfterNavigation(page: Page) {
+ const navigations = this.storage.get(page) ?? [];
+ if (!navigations) {
return;
}
+
+ const requests = navigations[0];
+
const lastRequestIdx = requests.findLastIndex(request => {
return request.frame() === page.mainFrame()
? request.isNavigationRequest()
: false;
});
+
// Keep all requests since the last navigation request including that
// navigation request itself.
// Keep the reference
- requests.splice(0, Math.max(lastRequestIdx, 0));
+ if (lastRequestIdx) {
+ const fromCurrentNavigation = requests.splice(lastRequestIdx);
+ navigations.unshift(fromCurrentNavigation);
+ } else {
+ navigations.unshift([]);
+ }
}
}
diff --git a/tests/PageCollector.test.ts b/tests/PageCollector.test.ts
index 431687aa..a916fdc2 100644
--- a/tests/PageCollector.test.ts
+++ b/tests/PageCollector.test.ts
@@ -9,7 +9,7 @@ import {describe, it} from 'node:test';
import type {Browser, Frame, HTTPRequest, Page, Target} from 'puppeteer-core';
import type {ListenerMap} from '../src/PageCollector.js';
-import {PageCollector} from '../src/PageCollector.js';
+import {NetworkCollector, PageCollector} from '../src/PageCollector.js';
import {getMockRequest} from './utils.js';
@@ -220,3 +220,34 @@ describe('PageCollector', () => {
assert.equal(collector.getIdForResource(request2), 2);
});
});
+
+describe('NetworkCollector', () => {
+ it('correctly picks up navigation requests to latest navigation', async () => {
+ const browser = getMockBrowser();
+ const page = (await browser.pages())[0];
+ const mainFrame = page.mainFrame();
+ const request = getMockRequest();
+ const navRequest = getMockRequest({
+ navigationRequest: true,
+ frame: page.mainFrame(),
+ });
+ const request2 = getMockRequest();
+ const collector = new NetworkCollector(browser);
+ await collector.init();
+ page.emit('request', request);
+ page.emit('request', navRequest);
+
+ assert.equal(collector.getData(page)[0], request);
+ assert.equal(collector.getData(page)[1], navRequest);
+ page.emit('framenavigated', mainFrame);
+
+ assert.equal(collector.getData(page).length, 1);
+ assert.equal(collector.getData(page)[0], navRequest);
+
+ page.emit('request', request2);
+
+ assert.equal(collector.getData(page).length, 2);
+ assert.equal(collector.getData(page)[0], navRequest);
+ assert.equal(collector.getData(page)[1], request2);
+ });
+});
diff --git a/tests/utils.ts b/tests/utils.ts
index 48cd6b77..6c8744fb 100644
--- a/tests/utils.ts
+++ b/tests/utils.ts
@@ -6,7 +6,7 @@
import logger from 'debug';
import type {Browser} from 'puppeteer';
import puppeteer from 'puppeteer';
-import type {HTTPRequest, HTTPResponse} from 'puppeteer-core';
+import type {Frame, HTTPRequest, HTTPResponse} from 'puppeteer-core';
import {McpContext} from '../src/McpContext.js';
import {McpResponse} from '../src/McpResponse.js';
@@ -51,6 +51,8 @@ export function getMockRequest(
postData?: string;
fetchPostData?: Promise<string>;
stableId?: number;
+ navigationRequest?: boolean;
+ frame?: Frame;
} = {},
): HTTPRequest {
return {
@@ -86,6 +88,12 @@ export function getMockRequest(
redirectChain(): HTTPRequest[] {
return [];
},
+ isNavigationRequest() {
+ return options.navigationRequest ?? false;
+ },
+ frame() {
+ return options.frame ?? ({} as Frame);
+ },
[stableIdSymbol]: options.stableId ?? 1,
} as unknown as HTTPRequest;
}