feat: make zod errors better (#97)

cjquines · web-flow · commit 5995e883a7c8 · 2025-09-09T15:45:16.000-04:00
* feat: make zod errors better

* address
diff --git a/demo/package.json b/demo/package.json
@@ -47,7 +47,7 @@
     "react-virtualized-auto-sizer": "^1.0.20",
     "react-window": "^1.8.10",
     "stainless": "workspace:*",
-    "zod": "^3.22.4",
+    "zod": "^3.25.76",
     "zustand": "^4.4.7"
   },
   "devDependencies": {
diff --git a/packages/hono/src/honoPlugin.test.ts b/packages/hono/src/honoPlugin.test.ts
@@ -125,11 +125,41 @@ describe("basic routing", () => {
             "expected": "object",
             "message": "Required",
             "path": [
-              "<stainless request body>",
+              "<body>",
             ],
             "received": "undefined",
           },
         ],
+        "message": "Required at "<body>"",
+      }
+    `);
+  });
+
+  test("update posts, missing param", async () => {
+    const response = await app.request("/api/posts/5", {
+      method: "POST",
+      headers: {
+        "content-type": "application/json",
+      },
+      body: JSON.stringify({}),
+    });
+    expect(response).toHaveProperty("status", 400);
+    expect(await response.json()).toMatchInlineSnapshot(`
+      {
+        "error": "bad request",
+        "issues": [
+          {
+            "code": "invalid_type",
+            "expected": "string",
+            "message": "Required",
+            "path": [
+              "<body>",
+              "content",
+            ],
+            "received": "undefined",
+          },
+        ],
+        "message": "Validation error: Required at "<body>.content"",
       }
     `);
   });
diff --git a/packages/prisma/package.json b/packages/prisma/package.json
@@ -32,7 +32,7 @@
   "dependencies": {
     "lodash": "^4.17.21",
     "stainless": "workspace:*",
-    "zod": "^3.22.4"
+    "zod": "^3.25.76"
   },
   "peerDependencies": {
     "prisma": "^4.0.0"
diff --git a/packages/stainless/package.json b/packages/stainless/package.json
@@ -50,7 +50,8 @@
     "lodash": "^4.17.21",
     "qs": "^6.11.2",
     "ts-node": "^10.9.1",
-    "zod": "^3.22.4",
-    "zod-openapi": "github:stainless-api/zod-openapi#2.8.0"
+    "zod": "^3.25.76",
+    "zod-openapi": "github:stainless-api/zod-openapi#2.8.0",
+    "zod-validation-error": "^4.0.1"
   }
 }
diff --git a/packages/stainless/src/stl.ts b/packages/stainless/src/stl.ts
@@ -1,6 +1,7 @@
 import * as z from "./z";
 import { openapiSpec } from "./openapiSpec";
 import type { OpenAPIObject } from "zod-openapi/lib-types/openapi3-ts/dist/oas31";
+import { fromZodError } from "zod-validation-error/v3";
 import coerceParams from "./coerceParams";
 export { openapiSpec };
 export { type SelectTree, parseSelect } from "./parseSelect";
@@ -778,20 +779,27 @@ export class Stl<Plugins extends AnyPlugins> {
         context.endpoint[coercedQuery] ??= coerceParams(context.endpoint.query);
         context.parsedParams.query = await context.endpoint[coercedQuery]
           .parseAsync(params.query, parseParams)
-          .catch(prependZodPath("<stainless request query>"));
+          .catch(prependZodPath("<query>"));
       }
       if (context.endpoint.path) {
         context.endpoint[coercedPath] ??= coerceParams(context.endpoint.path);
         context.parsedParams.path = await context.endpoint[coercedPath]
           .parseAsync(params.path, parseParams)
-          .catch(prependZodPath("<stainless request path>"));
+          .catch(prependZodPath("<path>"));
       }
       context.parsedParams.body = await context.endpoint.body
         ?.parseAsync(params.body, parseParams)
-        .catch(prependZodPath("<stainless request body>"));
+        .catch(prependZodPath("<body>"));
     } catch (error) {
       if (error instanceof z.ZodError) {
-        throw new BadRequestError({ issues: error.issues });
+        let validationError = fromZodError(error).message;
+        if (validationError.startsWith("Validation error: ")) {
+          validationError = validationError.slice("Validation error: ".length);
+        }
+        throw new BadRequestError({
+          message: validationError,
+          issues: error.issues,
+        });
       }
       throw error;
     }
diff --git a/packages/ts-to-zod/package.json b/packages/ts-to-zod/package.json
@@ -34,6 +34,6 @@
     "lodash": "^4.17.21",
     "pkg-up": "~3.1.0",
     "ts-morph": "^19.0.0",
-    "zod": "^3.22.4"
+    "zod": "^3.25.76"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@`
`50`	`50`	`"lodash": "^4.17.21",`
`51`	`51`	`"qs": "^6.11.2",`
`52`	`52`	`"ts-node": "^10.9.1",`
`53`		`- "zod": "^3.22.4",`
`54`		`- "zod-openapi": "github:stainless-api/zod-openapi#2.8.0"`
	`53`	`+ "zod": "^3.25.76",`
	`54`	`+ "zod-openapi": "github:stainless-api/zod-openapi#2.8.0",`
	`55`	`+ "zod-validation-error": "^4.0.1"`
`55`	`56`	`}`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,6 @@`
`34`	`34`	`"lodash": "^4.17.21",`
`35`	`35`	`"pkg-up": "~3.1.0",`
`36`	`36`	`"ts-morph": "^19.0.0",`
`37`		`- "zod": "^3.22.4"`
	`37`	`+ "zod": "^3.25.76"`
`38`	`38`	`}`
`39`	`39`	`}`