Skip to content

add path arg to @@validate and implement gencode #1641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2024
Merged

add path arg to @@validate and implement gencode #1641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions packages/schema/src/plugins/zod/utils/schema-gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getAttributeArg,
getAttributeArgLiteral,
getLiteral,
getLiteralArray,
isDataModelFieldReference,
isFromStdlib,
} from '@zenstackhq/sdk';
Expand All @@ -14,6 +15,7 @@ import {
DataModelField,
DataModelFieldAttribute,
isDataModel,
isArrayExpr,
isEnum,
isInvocationExpr,
isNumberLiteral,
Expand Down Expand Up @@ -221,7 +223,12 @@ export function makeValidationRefinements(model: DataModel) {
}

const messageArg = getAttributeArgLiteral<string>(attr, 'message');
const message = messageArg ? `, { message: ${JSON.stringify(messageArg)} }` : '';
const message = messageArg ? `message: ${JSON.stringify(messageArg)},` : '';

const pathArg = getAttributeArg(attr, 'path');
const path = pathArg && isArrayExpr(pathArg) ? `path: ['${getLiteralArray<string>(pathArg)?.join(`', '`)}'],` : '';

const options = `, { ${message} ${path} }`;

try {
let expr = new TypeScriptExpressionTransformer({
Expand All @@ -235,7 +242,7 @@ export function makeValidationRefinements(model: DataModel) {
expr = `${expr} ?? true`;
}

return `.refine((value: any) => ${expr}${message})`;
return `.refine((value: any) => ${expr}${options})`;

Check warning

Code scanning / CodeQL

Improper code sanitization

Code construction depends on an [improperly sanitized value](1).
} catch (err) {
if (err instanceof TypeScriptExpressionTransformerError) {
throw new PluginError(name, err.message);
Expand Down
2 changes: 1 addition & 1 deletion packages/schema/src/res/stdlib.zmodel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ attribute @lte(_ value: Int, _ message: String?) @@@targetField([IntField, Float
/**
* Validates the entity with a complex condition.
*/
attribute @@validate(_ value: Boolean, _ message: String?) @@@validation
attribute @@validate(_ value: Boolean, _ message: String?, _ path: String[]?) @@@validation

/**
* Validates length of a string field.
Expand Down
8 changes: 4 additions & 4 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 41 additions & 0 deletions tests/integration/tests/plugins/zod.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,47 @@ describe('Zod plugin tests', () => {
expect(schema.safeParse({ arr: [1, 2, 3] }).success).toBeTruthy();
});

it('refinement with path', async () => {
const model = `
datasource db {
provider = 'postgresql'
url = env('DATABASE_URL')
}

generator js {
provider = 'prisma-client-js'
}

plugin zod {
provider = "@core/zod"
}

model M {
id Int @id @default(autoincrement())
arr Int[]

@@validate(!isEmpty(arr), 'condition1', ['array'])
@@validate(has(arr, 1), 'condition2', ['arr'])
@@validate(hasEvery(arr, [1, 2]), 'condition3', ['arr', 'every'])
@@validate(hasSome(arr, [1, 2]), 'condition4', ['arr', 'some'])
}
`;

const { zodSchemas } = await loadSchema(model, { addPrelude: false, pushDb: false });

const schema = zodSchemas.models.MCreateSchema;
expect(schema.safeParse({}).error.issues[0].path).toEqual(['array']);
expect(schema.safeParse({ arr: [] }).error.issues[0].path).toEqual(['array']);
expect(schema.safeParse({ arr: [3] }).error.issues[0].path).toEqual(['arr']);
expect(schema.safeParse({ arr: [3] }).error.issues[1].path).toEqual(['arr', 'every']);
expect(schema.safeParse({ arr: [3] }).error.issues[2].path).toEqual(['arr', 'some']);
expect(schema.safeParse({ arr: [1] }).error.issues[0].path).toEqual(['arr', 'every']);
expect(schema.safeParse({ arr: [4] }).error.issues[0].path).toEqual(['arr']);
expect(schema.safeParse({ arr: [4] }).error.issues[1].path).toEqual(['arr', 'every']);
expect(schema.safeParse({ arr: [4] }).error.issues[2].path).toEqual(['arr', 'some']);
expect(schema.safeParse({ arr: [1, 2, 3] }).success).toBeTruthy();
})

it('full-text search', async () => {
const model = `
datasource db {
Expand Down