Skip to content

fix: add a few missing zmodel validation checks #101

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 7 commits into from
Jul 18, 2025
Merged

fix: add a few missing zmodel validation checks #101

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
51b3656
chore: add CLAUDE.md
ymc9 Jul 17, 2025
aa1b5bf
fix: add a few missing zmodel validation checks
ymc9 Jul 17, 2025
b5def9f
update
ymc9 Jul 17, 2025
bff4ce6
Merge remote-tracking branch 'origin/dev' into chore/claude-md
ymc9 Jul 17, 2025
4efba44
update
ymc9 Jul 17, 2025
08a065a
Merge remote-tracking branch 'origin/dev' into chore/claude-md
ymc9 Jul 18, 2025
fcb5be1
update
ymc9 Jul 18, 2025
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
3 changes: 3 additions & 0 deletions TODO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
- [x] migrate
- [x] info
- [x] init
- [ ] validate
- [ ] format
- [ ] db seed
- [ ] ORM
- [x] Create
- [x] Input validation
Expand Down
9 changes: 7 additions & 2 deletions packages/language/res/stdlib.zmodel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ attribute @@@prisma()
*/
attribute @@@completionHint(_ values: String[])

/**
* Indicates that the attribute can only be applied once to a declaration.
*/
attribute @@@once()

/**
* Defines a single-field ID on the model.
*
Expand All @@ -232,7 +237,7 @@ attribute @@@completionHint(_ values: String[])
* @param sort: Allows you to specify in what order the entries of the ID are stored in the database. The available options are Asc and Desc.
* @param clustered: Defines whether the ID is clustered or non-clustered. Defaults to true.
*/
attribute @id(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@supportTypeDef
attribute @id(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@supportTypeDef @@@once

/**
* Defines a default value for a field.
Expand All @@ -247,7 +252,7 @@ attribute @default(_ value: ContextType, map: String?) @@@prisma @@@supportTypeD
* @param sort: Allows you to specify in what order the entries of the constraint are stored in the database. The available options are Asc and Desc.
* @param clustered: Boolean Defines whether the constraint is clustered or non-clustered. Defaults to false.
*/
attribute @unique(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma
attribute @unique(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@once

/**
* Defines a multi-field ID (composite ID) on the model.
Expand Down
22 changes: 22 additions & 0 deletions packages/language/src/validators/attribute-application-validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ export default class AttributeApplicationValidator implements AstValidator<Attri
accept('error', `attribute "${decl.name}" cannot be used on type declarations`, { node: attr });
}

this.checkDuplicatedAttributes(attr, accept);

const filledParams = new Set<AttributeParam>();

for (const arg of attr.args) {
Expand Down Expand Up @@ -131,6 +133,18 @@ export default class AttributeApplicationValidator implements AstValidator<Attri
}
}

private checkDuplicatedAttributes(attr: AttributeApplication, accept: ValidationAcceptor) {
const attrDecl = attr.decl.ref;
if (!attrDecl?.attributes.some((a) => a.decl.ref?.name === '@@@once')) {
return;
}

const duplicates = attr.$container.attributes.filter((a) => a.decl.ref === attrDecl && a !== attr);
if (duplicates.length > 0) {
accept('error', `Attribute "${attrDecl.name}" can only be applied once`, { node: attr });
}
}

@check('@@allow')
@check('@@deny')
// @ts-expect-error
Expand Down Expand Up @@ -197,13 +211,21 @@ export default class AttributeApplicationValidator implements AstValidator<Attri
}

@check('@@unique')
@check('@@id')
// @ts-expect-error
private _checkUnique(attr: AttributeApplication, accept: ValidationAcceptor) {
const fields = attr.args[0]?.value;
if (!fields) {
accept('error', `expects an array of field references`, {
node: attr.args[0]!,
});
return;
}
if (isArrayExpr(fields)) {
if (fields.items.length === 0) {
accept('error', `\`@@unique\` expects at least one field reference`, { node: fields });
return;
}
fields.items.forEach((item) => {
if (!isReferenceExpr(item)) {
accept('error', `Expecting a field reference`, {
Expand Down
157 changes: 92 additions & 65 deletions packages/language/src/validators/datamodel-validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,11 +259,20 @@ export default class DataModelValidator implements AstValidator<DataModel> {
return;
}

if (this.isSelfRelation(field)) {
if (!thisRelation.name) {
accept('error', 'Self-relation field must have a name in @relation attribute', {
node: field,
});
return;
}
}

const oppositeModel = field.type.reference!.ref! as DataModel;

// Use name because the current document might be updated
let oppositeFields = getModelFieldsWithBases(oppositeModel, false).filter(
(f) => f.type.reference?.ref?.name === contextModel.name,
(f) => f !== field && f.type.reference?.ref?.name === contextModel.name,
);
oppositeFields = oppositeFields.filter((f) => {
const fieldRel = this.parseRelation(f);
Expand Down Expand Up @@ -322,27 +331,41 @@ export default class DataModelValidator implements AstValidator<DataModel> {

let relationOwner: DataModelField;

if (thisRelation?.references?.length && thisRelation.fields?.length) {
if (oppositeRelation?.references || oppositeRelation?.fields) {
accept('error', '"fields" and "references" must be provided only on one side of relation field', {
node: oppositeField,
});
return;
} else {
relationOwner = oppositeField;
}
} else if (oppositeRelation?.references?.length && oppositeRelation.fields?.length) {
if (thisRelation?.references || thisRelation?.fields) {
accept('error', '"fields" and "references" must be provided only on one side of relation field', {
node: field,
});
return;
} else {
relationOwner = field;
if (field.type.array && oppositeField.type.array) {
// if both the field is array, then it's an implicit many-to-many relation,
// neither side should have fields/references
for (const r of [thisRelation, oppositeRelation]) {
if (r.fields?.length || r.references?.length) {
accept(
'error',
'Implicit many-to-many relation cannot have "fields" or "references" in @relation attribute',
{
node: r === thisRelation ? field : oppositeField,
},
);
}
}
} else {
// if both the field is array, then it's an implicit many-to-many relation
if (!(field.type.array && oppositeField.type.array)) {
if (thisRelation?.references?.length && thisRelation.fields?.length) {
if (oppositeRelation?.references || oppositeRelation?.fields) {
accept('error', '"fields" and "references" must be provided only on one side of relation field', {
node: oppositeField,
});
return;
} else {
relationOwner = oppositeField;
}
} else if (oppositeRelation?.references?.length && oppositeRelation.fields?.length) {
if (thisRelation?.references || thisRelation?.fields) {
accept('error', '"fields" and "references" must be provided only on one side of relation field', {
node: field,
});
return;
} else {
relationOwner = field;
}
} else {
// for non-M2M relations, one side must have fields/references
[field, oppositeField].forEach((f) => {
if (!this.isSelfRelation(f)) {
accept(
Expand All @@ -352,56 +375,60 @@ export default class DataModelValidator implements AstValidator<DataModel> {
);
}
});
return;
}
return;
}

if (!relationOwner.type.array && !relationOwner.type.optional) {
accept('error', 'Relation field needs to be list or optional', {
node: relationOwner,
});
return;
}

if (relationOwner !== field && !relationOwner.type.array) {
// one-to-one relation requires defining side's reference field to be @unique
// e.g.:
// model User {
// id String @id @default(cuid())
// data UserData?
// }
// model UserData {
// id String @id @default(cuid())
// user User @relation(fields: [userId], references: [id])
// userId String
// }
//
// UserData.userId field needs to be @unique

const containingModel = field.$container as DataModel;
const uniqueFieldList = getUniqueFields(containingModel);

// field is defined in the abstract base model
if (containingModel !== contextModel) {
uniqueFieldList.push(...getUniqueFields(contextModel));
if (!relationOwner.type.array && !relationOwner.type.optional) {
accept('error', 'Relation field needs to be list or optional', {
node: relationOwner,
});
return;
}

thisRelation.fields?.forEach((ref) => {
const refField = ref.target.ref as DataModelField;
if (refField) {
if (refField.attributes.find((a) => a.decl.ref?.name === '@id' || a.decl.ref?.name === '@unique')) {
return;
}
if (uniqueFieldList.some((list) => list.includes(refField))) {
return;
}
accept(
'error',
`Field "${refField.name}" on model "${containingModel.name}" is part of a one-to-one relation and must be marked as @unique or be part of a model-level @@unique attribute`,
{ node: refField },
);
if (relationOwner !== field && !relationOwner.type.array) {
// one-to-one relation requires defining side's reference field to be @unique
// e.g.:
// model User {
// id String @id @default(cuid())
// data UserData?
// }
// model UserData {
// id String @id @default(cuid())
// user User @relation(fields: [userId], references: [id])
// userId String
// }
//
// UserData.userId field needs to be @unique

const containingModel = field.$container as DataModel;
const uniqueFieldList = getUniqueFields(containingModel);

// field is defined in the abstract base model
if (containingModel !== contextModel) {
uniqueFieldList.push(...getUniqueFields(contextModel));
}
});

thisRelation.fields?.forEach((ref) => {
const refField = ref.target.ref as DataModelField;
if (refField) {
if (
refField.attributes.find(
(a) => a.decl.ref?.name === '@id' || a.decl.ref?.name === '@unique',
)
) {
return;
}
if (uniqueFieldList.some((list) => list.includes(refField))) {
return;
}
accept(
'error',
`Field "${refField.name}" on model "${containingModel.name}" is part of a one-to-one relation and must be marked as @unique or be part of a model-level @@unique attribute`,
{ node: refField },
);
}
});
}
}
}

Expand Down
4 changes: 4 additions & 0 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.

3 changes: 3 additions & 0 deletions tests/e2e/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@
},
"dependencies": {
"@zenstackhq/testtools": "workspace:*"
},
"devDependencies": {
"@zenstackhq/cli": "workspace:*"
}
}
Loading