Chrome DevTools for coding agents
fix(lighthouse): explain unsupported URL schemes in navigation mode (#3144)
nancyc6ad84a23b4d
diff --git a/src/tools/lighthouse.ts b/src/tools/lighthouse.tsindex 1cc57923..f022d18f 100644--- a/src/tools/lighthouse.ts+++ b/src/tools/lighthouse.ts@@ -44,6 +44,13 @@ const isRecord = (value: unknown): value is Record<string, unknown> => {return typeof value === 'object' && value !== null;};+// Lighthouse's navigation mode only accepts the URL schemes in+// `allowedProtocols` (core/lib/url-utils.js) and throws a bare `INVALID_URL`+// for anything else, such as file:// or about:blank.+const isInvalidUrlError = (error: unknown): boolean => {+ return isRecord(error) && error.code === 'INVALID_URL';+};+const getString = (value: unknown): string | undefined => {return typeof value === 'string' ? value : undefined;};@@ -233,13 +240,20 @@ export const lighthouseAudit = definePageTool((args: ParsedArguments) => ({let result: RunnerResult | undefined;try {if (mode === 'navigation') {- result = await lighthouseRunner.navigation(- page.pptrPage,- page.pptrPage.url(),- {+ const url = page.pptrPage.url();+ try {+ result = await lighthouseRunner.navigation(page.pptrPage, url, {flags,- },- );+ });+ } catch (error) {+ if (isInvalidUrlError(error)) {+ throw new Error(+ `Lighthouse "navigation" mode cannot audit ${url}: it only supports http:, https:, chrome: and chrome-extension: URLs. Use mode "snapshot" to audit the page in its current state.`,+ {cause: error},+ );+ }+ throw error;+ }} else {result = await lighthouseRunner.snapshot(page.pptrPage, {flags,diff --git a/tests/tools/lighthouse.test.ts b/tests/tools/lighthouse.test.tsindex 4de5a50c..376deee9 100644--- a/tests/tools/lighthouse.test.ts+++ b/tests/tools/lighthouse.test.ts@@ -60,6 +60,58 @@ describe('lighthouse', () => {});});+ it('explains which URLs navigation mode can audit', async () => {+ const {page, context, response, args} = createHandlerMocks();+ page.pptrPage.url.returns('file:///tmp/page.html');+ const invalidUrl = Object.assign(new Error('INVALID_URL'), {+ code: 'INVALID_URL',+ });+ sinon.stub(lighthouseRunner, 'navigation').rejects(invalidUrl);++ await assert.rejects(+ () =>+ lighthouseAudit(args).handler(+ {+ params: {+ mode: 'navigation',+ device: 'desktop',+ },+ page,+ },+ response,+ context,+ ),+ {+ message:+ 'Lighthouse "navigation" mode cannot audit file:///tmp/page.html: it only supports http:, https:, chrome: and chrome-extension: URLs. Use mode "snapshot" to audit the page in its current state.',+ cause: invalidUrl,+ },+ );+ });++ it('passes other navigation errors through unchanged', async () => {+ const {page, context, response, args} = createHandlerMocks();+ sinon+ .stub(lighthouseRunner, 'navigation')+ .rejects(new Error('PROTOCOL_TIMEOUT'));++ await assert.rejects(+ () =>+ lighthouseAudit(args).handler(+ {+ params: {+ mode: 'navigation',+ device: 'desktop',+ },+ page,+ },+ response,+ context,+ ),+ {message: 'PROTOCOL_TIMEOUT'},+ );+ });+it('restores emulation', async () => {const {page, context, response, args} = createHandlerMocks();context.saveTemporaryFile.resolves({filepath: 'report.json'});