Chrome DevTools for coding agents
fix: do not enable the DevTools frontend Audits subscription (#2625)
Matt Van Hornd1e73ffd7e73
diff --git a/src/devtools/DevtoolsUtils.ts b/src/devtools/DevtoolsUtils.tsindex 5b4ac445..60af36c8 100644--- a/src/devtools/DevtoolsUtils.ts+++ b/src/devtools/DevtoolsUtils.ts@@ -36,6 +36,12 @@ export function overrideDevToolsGlobals({// DevTools CDP errors can get noisy.DevTools.ProtocolClient.InspectorBackend.test.suppressRequestErrors = true;+ const noopAgentCommand = () => {+ return Promise.resolve({+ getError: () => undefined,+ });+ };+// Stub out Network emulation commands on the DevTools Agent prototype globally.// This prevents the DevTools Frontend from ever resetting/clearing Puppeteer's// active network blocking/throttling rules during target setup or session lifetime.@@ -63,42 +69,42 @@ export function overrideDevToolsGlobals({networkAgentPrototype,'invoke_overrideNetworkState',{- value: () => {- return Promise.resolve({- getError: () => undefined,- });- },+ value: noopAgentCommand,writable: true,configurable: true,enumerable: true,},);Object.defineProperty(networkAgentPrototype, 'invoke_enable', {- value: () => {- return Promise.resolve({- getError: () => undefined,- });- },+ value: noopAgentCommand,writable: true,configurable: true,enumerable: true,});Object.defineProperty(networkAgentPrototype, 'invoke_disable', {- value: () => {- return Promise.resolve({- getError: () => undefined,- });- },+ value: noopAgentCommand,writable: true,configurable: true,enumerable: true,});Object.defineProperty(networkAgentPrototype, 'invoke_setBlockedURLs', {- value: () => {- return Promise.resolve({- getError: () => undefined,- });- },+ value: noopAgentCommand,+ writable: true,+ configurable: true,+ enumerable: true,+ });+ }++ // Puppeteer already collects issues from its own Audits subscription. Avoid+ // enabling the DevTools Frontend's redundant subscription, which can replay+ // a large retained issue backlog and delay unrelated page work.+ const auditsAgentPrototype =+ DevTools.ProtocolClient.InspectorBackend.inspectorBackend.agentPrototypes.get(+ 'Audits',+ );+ if (auditsAgentPrototype) {+ Object.defineProperty(auditsAgentPrototype, 'invoke_enable', {+ value: noopAgentCommand,writable: true,configurable: true,enumerable: true,diff --git a/tests/devtools/DevtoolsUtils.test.ts b/tests/devtools/DevtoolsUtils.test.tsindex 4be3f42e..9ff88a53 100644--- a/tests/devtools/DevtoolsUtils.test.ts+++ b/tests/devtools/DevtoolsUtils.test.ts@@ -100,6 +100,58 @@ describe('createTargetUniverse', () => {sinon.assert.notCalled(requestStartedSpy);});});++ it('does not replay retained Audits issues', async () => {+ server.addHtmlRoute('/audits', html`<div>Audits</div>`);++ await withBrowser(async (browser, page) => {+ await page.goto(server.getRoute('/audits'));++ const auditsSession = await page.createCDPSession();+ await auditsSession.send('Audits.enable');++ const backlogCreated = Promise.withResolvers<void>();+ let performanceIssueCount = 0;+ auditsSession.on('Audits.issueAdded', event => {+ if (+ event.issue.code === 'PerformanceIssue' &&+ event.issue.details.performanceIssueDetails?.performanceIssueType ===+ 'DocumentCookie'+ ) {+ performanceIssueCount++;+ if (performanceIssueCount === 500) {+ backlogCreated.resolve();+ }+ }+ });++ await page.evaluate(() => {+ document.cookie = 'test=value';+ for (let i = 0; i < 500; i++) {+ void document.cookie;+ }+ });++ await backlogCreated.promise;+ assert.strictEqual(performanceIssueCount, 500);+ await auditsSession.detach();++ const warnStub = sinon.stub(console, 'warn');+ const targetUniverse = await createTargetUniverse(+ await page.createCDPSession(),+ );++ assert.ok(targetUniverse.target.model(DevTools.DebuggerModel));+ assert.strictEqual(await page.evaluate('1 + 1'), 2);+ await targetUniverse.session.send('Runtime.evaluate', {+ expression: '1 + 1',+ });+ sinon.assert.neverCalledWithMatch(+ warnStub,+ 'No handler registered for issue code PerformanceIssue',+ );+ });+ });});describe('SymbolizedError', () => {