Merge pull request #565 from zenstackhq/fix/issue-558

fix(orm): preserve zod validation errors when validating custom json types

Author: ymc9

packages/orm/src/client/crud/validator/index.ts

@@ -382,9 +382,13 @@ export class InputValidator<Schema extends SchemaDef> {
         // zod doesn't preserve object field order after parsing, here we use a
         // validation-only custom schema and use the original data if parsing
         // is successful
-        const finalSchema = z.custom((v) => {
-            return schema.safeParse(v).success;
+        const finalSchema = z.any().superRefine((value, ctx) => {
+            const parseResult = schema.safeParse(value);
+            if (!parseResult.success) {
+                parseResult.error.issues.forEach((issue) => ctx.addIssue(issue as any));
+            }
         });
+
         this.setSchemaCache(key!, finalSchema);
         return finalSchema;
     }
@@ -495,7 +499,7 @@ export class InputValidator<Schema extends SchemaDef> {
         }
 
         // expression builder
-        fields['$expr'] = z.custom((v) => typeof v === 'function').optional();
+        fields['$expr'] = z.custom((v) => typeof v === 'function', { error: '"$expr" must be a function' }).optional();
 
         // logical operators
         fields['AND'] = this.orArray(

tests/e2e/orm/client-api/typed-json-fields.test.ts

@@ -121,7 +121,7 @@ model User {
                     },
                 },
             }),
-        ).rejects.toThrow(/invalid/i);
+        ).rejects.toThrow('data.identity.providers[0].id');
     });
 
     it('works with find', async () => {

tests/regression/test/issue-558.test.ts

@@ -0,0 +1,19 @@
+import { createTestClient } from '@zenstackhq/testtools';
+import { describe, expect, it } from 'vitest';
+
+describe('Regression for issue #558', () => {
+    it('verifies issue 558', async () => {
+        const db = await createTestClient(`
+type Foo {
+    x Int
+}
+
+model Model {
+    id String @id @default(cuid())
+    foo Foo @json
+}
+        `);
+
+        await expect(db.model.create({ data: { foo: { x: 'hello' } } })).rejects.toThrow('data.foo.x');
+    });
+});