Chrome DevTools for coding agents
fix: capture thrown transform errors as Zod validation issues (#3242)
Nikolay Vitkov0f95c21b028e
diff --git a/src/tools/ToolDefinition.ts b/src/tools/ToolDefinition.tsindex aff12143..4b3b9f0d 100644--- a/src/tools/ToolDefinition.ts+++ b/src/tools/ToolDefinition.ts@@ -608,13 +608,31 @@ export const pageIdSchema = {pageId: zod.number().describe('Targets a specific page by ID.'),};+export function zodTransform<Input, Output>(+ transform: (arg: Input) => Output,+): (arg: Input, ctx: zod.RefinementCtx) => Output {+ return (arg: Input, ctx: zod.RefinementCtx): Output => {+ try {+ return transform(arg);+ } catch (error) {+ ctx.addIssue({+ code: 'custom',+ message: error instanceof Error ? error.message : String(error),+ });+ return zod.NEVER;+ }+ };+}+export const timeoutSchema = {timeout: zod.number().int()- .transform(value => {- return value <= 0 ? undefined : value;- })+ .transform(+ zodTransform(value => {+ return value <= 0 ? undefined : value;+ }),+ ).optional().describe(`Maximum wait time in milliseconds. If set to 0, the default timeout will be used.`,diff --git a/src/tools/emulation.ts b/src/tools/emulation.tsindex 06c53b77..9a54a058 100644--- a/src/tools/emulation.ts+++ b/src/tools/emulation.ts@@ -17,6 +17,7 @@ import {definePageTool,geolocationTransform,viewportTransform,+ zodTransform,} from './ToolDefinition.js';function headerStringTransform(@@ -72,7 +73,7 @@ export const emulate = definePageTool(() => ({),geolocation: zod.string()- .transform(geolocationTransform)+ .transform(zodTransform(geolocationTransform)).optional().describe('Geolocation (`<latitude>,<longitude>`) to emulate. Latitude between -90 and 90. Longitude between -180 and 180. Omit to clear the geolocation override.',@@ -109,14 +110,14 @@ export const emulate = definePageTool(() => ({),viewport: zod.string()- .transform(viewportTransform)+ .transform(zodTransform(viewportTransform)).optional().describe(`Emulate device viewports '<width>x<height>x<devicePixelRatio>[,mobile][,touch][,landscape]'. 'touch' and 'mobile' to emulate mobile devices. 'landscape' to emulate landscape mode. Omit to clear the viewport override.`,),extraHttpHeaders: zod.string()- .transform(headerStringTransform)+ .transform(zodTransform(headerStringTransform)).optional().describe('Extra HTTP headers as a JSON string object, e.g. {"X-Custom": "value", "Authorization": "Bearer token"}. Headers are included into every HTTP request originating from the page and persist across navigations until cleared. Pass an empty string to clear all extra headers.',diff --git a/src/utils/bytes.ts b/src/utils/bytes.tsindex 5a194e54..97281892 100644--- a/src/utils/bytes.ts+++ b/src/utils/bytes.ts@@ -5,6 +5,7 @@*/import {zod} from '../third_party/index.js';+import {zodTransform} from '../tools/ToolDefinition.js';const BYTE_UNITS: Readonly<Record<string, number>> = {b: 1,@@ -120,17 +121,6 @@ export function byteSizeRangeSchema(): zod.ZodType<ByteSizeRange> {return zod.string()- .transform((value, context) => {- try {- return parseByteSizeRange(value);- } catch (error) {- context.addIssue({- code: zod.ZodIssueCode.custom,- message:- error instanceof Error ? error.message : 'Invalid byte size range',- });- return zod.NEVER;- }- })+ .transform(zodTransform(parseByteSizeRange)).describe(description);}diff --git a/tests/McpServer.test.ts b/tests/McpServer.test.tsindex 2d8239e2..f7499a9a 100644--- a/tests/McpServer.test.ts+++ b/tests/McpServer.test.ts@@ -88,6 +88,35 @@ describe('McpServer', () => {sinon.assert.notCalled(browserManager.ensureBrowser);});+ it('returns a validation error when transform validation fails', async () => {+ const {server, browserManager} = await createTestServer();+ const cases: Array<[Record<string, unknown>, RegExp]> = [+ [+ {pageId: 1, geolocation: '0x0'},+ /^Input validation error: Invalid arguments for tool emulate: geolocation: Invalid geolocation "0x0"\. Expected '<latitude>,<longitude>'\.$/,+ ],+ [+ {pageId: 1, viewport: '0x0'},+ /^Input validation error: Invalid arguments for tool emulate: viewport: Invalid viewport width "0"\./,+ ],+ [+ {pageId: 1, extraHttpHeaders: 'notjson'},+ /^Input validation error: Invalid arguments for tool emulate: extraHttpHeaders: Invalid JSON for headers:/,+ ],+ ];++ for (const [args, expectedPattern] of cases) {+ const result = await server.callTool('emulate', args);++ assert.strictEqual(result.isError, true);+ assert.strictEqual(result.content.length, 1);+ const firstBlock = result.content[0];+ assert.strictEqual(firstBlock.type, 'text');+ assert.match(firstBlock.text, expectedPattern);+ }+ sinon.assert.notCalled(browserManager.ensureBrowser);+ });+it('executes the tool handler when arguments are valid', async () => {const {server, context} = await createTestServer();diff --git a/tests/tools/emulation.test.ts b/tests/tools/emulation.test.tsindex 5cfa94de..f6faa47a 100644--- a/tests/tools/emulation.test.ts+++ b/tests/tools/emulation.test.ts@@ -514,6 +514,76 @@ describe('emulation', () => {extraHttpHeaders: {'X-Page': 'one'},});});++ it('parses valid extraHttpHeaders JSON and empty string in schema', () => {+ const {args} = createHandlerMocks();+ const schema = zod.object(emulate(args).schema);+ assert.deepStrictEqual(+ schema.safeParse({+ pageId: 1,+ extraHttpHeaders: '{"X-Custom": "value"}',+ }),+ {+ success: true,+ data: {+ pageId: 1,+ extraHttpHeaders: {'X-Custom': 'value'},+ },+ },+ );+ assert.deepStrictEqual(+ schema.safeParse({+ pageId: 1,+ extraHttpHeaders: '',+ }),+ {+ success: true,+ data: {+ pageId: 1,+ extraHttpHeaders: {},+ },+ },+ );+ });++ it('reports validation issues instead of throwing for invalid transform inputs', () => {+ const {args} = createHandlerMocks();+ const schema = zod.object(emulate(args).schema);++ const geoResult = schema.safeParse({pageId: 1, geolocation: '0x0'});+ assert.strictEqual(geoResult.success, false);+ assert.strictEqual(+ geoResult.error.issues[0].message,+ 'Invalid geolocation "0x0". Expected \'<latitude>,<longitude>\'.',+ );++ const viewportResult = schema.safeParse({pageId: 1, viewport: '0x0'});+ assert.strictEqual(viewportResult.success, false);+ assert.strictEqual(+ viewportResult.error.issues[0].message,+ 'Invalid viewport width "0". Expected format \'<width>x<height>x<devicePixelRatio>[,mobile][,touch][,landscape]\' with a positive width.',+ );++ const invalidJsonResult = schema.safeParse({+ pageId: 1,+ extraHttpHeaders: 'notjson',+ });+ assert.strictEqual(invalidJsonResult.success, false);+ assert.match(+ invalidJsonResult.error.issues[0].message,+ /^Invalid JSON for headers:/,+ );++ const nonObjectHeadersResult = schema.safeParse({+ pageId: 1,+ extraHttpHeaders: '[]',+ });+ assert.strictEqual(nonObjectHeadersResult.success, false);+ assert.strictEqual(+ nonObjectHeadersResult.error.issues[0].message,+ 'Invalid JSON for headers: Headers must be a JSON object',+ );+ });});describe('colorScheme', () => {