fix(zod): make typing of Bytes field compatible with both Buffer …

…and `Uint8Array` Fixes #1268
zenstackhq · Apr 24, 2024 · 13061aa · 13061aa
1 parent 7c4d86c
commit 13061aa
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 23 deletions.
diff --git a/packages/schema/package.json b/packages/schema/package.json
@@ -59,13 +59,13 @@
         "configuration": {
             "title": "ZenStack",
             "properties": {
-              "zmodel.format.usePrismaStyle": {
-                "type": "boolean",
-                "default": true,
-                "description": "Use Prisma style indentation."
-              }
+                "zmodel.format.usePrismaStyle": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Use Prisma style indentation."
+                }
             }
-          }
+        }
     },
     "activationEvents": [
         "onLanguage:zmodel"
@@ -90,6 +90,7 @@
     },
     "dependencies": {
         "@paralleldrive/cuid2": "^2.2.0",
+        "@types/node": "^20.12.7",
         "@zenstackhq/language": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
         "async-exit-hook": "^2.0.1",

diff --git a/packages/schema/src/plugins/zod/transformer.ts b/packages/schema/src/plugins/zod/transformer.ts
@@ -117,6 +117,8 @@ export default class Transformer {
                 return result;
             }
 
+            // TODO: unify the following with `schema-gen.ts`
+
             if (inputType.type === 'String') {
                 result.push(this.wrapWithZodValidators('z.string()', field, inputType));
             } else if (inputType.type === 'Int' || inputType.type === 'Float') {
@@ -131,7 +133,13 @@ export default class Transformer {
             } else if (inputType.type === 'DateTime') {
                 result.push(this.wrapWithZodValidators(['z.date()', 'z.string().datetime()'], field, inputType));
             } else if (inputType.type === 'Bytes') {
-                result.push(this.wrapWithZodValidators(`z.instanceof(Uint8Array)`, field, inputType));
+                result.push(
+                    this.wrapWithZodValidators(
+                        `z.custom<Buffer | Uint8Array>(data => data instanceof Uint8Array)`,
+                        field,
+                        inputType
+                    )
+                );
             } else if (inputType.type === 'Json') {
                 this.hasJson = true;
                 result.push(this.wrapWithZodValidators('jsonSchema', field, inputType));

diff --git a/packages/schema/src/plugins/zod/utils/schema-gen.ts b/packages/schema/src/plugins/zod/utils/schema-gen.ts
@@ -186,7 +186,7 @@ function makeZodSchema(field: DataModelField) {
                 schema = 'z.coerce.date()';
                 break;
             case 'Bytes':
-                schema = 'z.union([z.string(), z.instanceof(Uint8Array)])';
+                schema = 'z.union([z.string(), z.custom<Buffer | Uint8Array>(data => data instanceof Uint8Array)])';
                 break;
             default:
                 schema = 'z.any()';

diff --git a/packages/testtools/src/schema.ts b/packages/testtools/src/schema.ts
@@ -101,12 +101,12 @@ generator js {
 
 plugin enhancer {
     provider = '@core/enhancer'
-    preserveTsFiles = true
+    ${options.preserveTsFiles ? 'preserveTsFiles = true' : ''}
 }
 
 plugin zod {
     provider = '@core/zod'
-    // preserveTsFiles = true
+    ${options.preserveTsFiles ? 'preserveTsFiles = true' : ''}
     modelOnly = ${!options.fullZod}
 }
 `;
@@ -130,6 +130,7 @@ export type SchemaLoadOptions = {
     enhanceOptions?: Partial<EnhancementOptions>;
     extraSourceFiles?: { name: string; content: string }[];
     projectDir?: string;
+    preserveTsFiles?: boolean;
 };
 
 const defaultOptions: SchemaLoadOptions = {
@@ -140,6 +141,7 @@ const defaultOptions: SchemaLoadOptions = {
     compile: false,
     logPrismaQuery: false,
     provider: 'sqlite',
+    preserveTsFiles: false,
 };
 
 export async function loadSchemaFromFile(schemaFile: string, options?: SchemaLoadOptions) {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/script/test-scaffold.ts b/script/test-scaffold.ts
@@ -19,6 +19,6 @@ function run(cmd: string) {
 }
 
 run('npm init -y');
-run('npm i --no-audit --no-fund typescript prisma @prisma/client zod decimal.js');
+run('npm i --no-audit --no-fund typescript prisma @prisma/client zod decimal.js @types/node');
 
 console.log('Test scaffold setup complete.');
diff --git a/tests/regression/tests/issue-1268.test.ts b/tests/regression/tests/issue-1268.test.ts
@@ -0,0 +1,32 @@
+import { loadSchema } from '@zenstackhq/testtools';
+
+describe('issue 1268', () => {
+    it('regression', async () => {
+        const { zodSchemas } = await loadSchema(
+            `
+            model Model {
+                id String @id @default(uuid())
+                bytes Bytes
+            }
+            `,
+            {
+                fullZod: true,
+                pushDb: false,
+                compile: true,
+                extraSourceFiles: [
+                    {
+                        name: 'test.ts',
+                        content: `
+import { ModelCreateInputObjectSchema } from '.zenstack/zod/objects';
+ModelCreateInputObjectSchema.parse({ bytes: new Uint8Array(0) });
+                        `,
+                    },
+                ],
+            }
+        );
+
+        expect(
+            zodSchemas.objects.ModelCreateInputObjectSchema.safeParse({ bytes: new Uint8Array(0) }).success
+        ).toBeTruthy();
+    });
+});