Repository navigation
fix(orm): enforce field validation attributes and @@validate inside custom types
#2890
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.
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
Open
MaxFreedomPollard
wants to merge
1
commit into
zenstackhq:dev
Choose a base branch
from
MaxFreedomPollard:fix/typed-json-validation
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| import { createTestClient } from '@zenstackhq/testtools'; | ||
| import { describe, expect, it } from 'vitest'; | ||
|
|
||
| // https://github.com/zenstackhq/zenstack/issues/2844 | ||
| describe('Regression for issue 2844', () => { | ||
| const schema = ` | ||
| type Bounds { | ||
| caption String @length(1, 3) | ||
| low Int @gte(0) | ||
| high Int | ||
|
|
||
| @@validate(low <= high, 'low must not exceed high') | ||
| } | ||
|
|
||
| model Example { | ||
| id Int @id | ||
| bounds Bounds @json | ||
| } | ||
| `; | ||
|
|
||
| it('enforces custom type validation rules on create', async () => { | ||
| const db = await createTestClient(schema); | ||
|
|
||
| await expect( | ||
| db.example.create({ data: { id: 1, bounds: { caption: 'too long', low: 0, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['data.bounds.caption']); | ||
| await expect( | ||
| db.example.create({ data: { id: 1, bounds: { caption: 'ok', low: -1, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['data.bounds.low']); | ||
| await expect( | ||
| db.example.create({ data: { id: 1, bounds: { caption: 'ok', low: 5, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['low must not exceed high']); | ||
|
|
||
| await expect( | ||
| db.example.create({ data: { id: 1, bounds: { caption: 'abc', low: 0, high: 0 } } }), | ||
| ).resolves.toMatchObject({ bounds: { caption: 'abc', low: 0, high: 0 } }); | ||
| }); | ||
|
|
||
| it('enforces custom type validation rules on update', async () => { | ||
| const db = await createTestClient(schema); | ||
| await db.example.create({ data: { id: 1, bounds: { caption: 'ok', low: 0, high: 1 } } }); | ||
|
|
||
| await expect( | ||
| db.example.update({ where: { id: 1 }, data: { bounds: { caption: 'too long', low: 0, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['data.bounds.caption']); | ||
| await expect( | ||
| db.example.update({ where: { id: 1 }, data: { bounds: { caption: 'ok', low: -1, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['data.bounds.low']); | ||
| await expect( | ||
| db.example.update({ where: { id: 1 }, data: { bounds: { caption: 'ok', low: 5, high: 1 } } }), | ||
| ).toBeRejectedByValidation(['low must not exceed high']); | ||
|
|
||
| await expect(db.example.findUnique({ where: { id: 1 } })).resolves.toMatchObject({ | ||
| bounds: { caption: 'ok', low: 0, high: 1 }, | ||
| }); | ||
| }); | ||
|
|
||
| it('enforces validation rules of nested custom types and list fields', async () => { | ||
| const db = await createTestClient(` | ||
| type Item { | ||
| name String @length(1, 5) | ||
| } | ||
|
|
||
| type Cart { | ||
| owner String @email | ||
| items Item[] @length(1, 2) | ||
| } | ||
|
|
||
| model Order { | ||
| id Int @id | ||
| cart Cart @json | ||
| } | ||
| `); | ||
|
|
||
| await expect( | ||
| db.order.create({ data: { id: 1, cart: { owner: 'not-an-email', items: [{ name: 'a' }] } } }), | ||
| ).toBeRejectedByValidation(['data.cart.owner']); | ||
| await expect( | ||
| db.order.create({ data: { id: 1, cart: { owner: 'a@b.com', items: [{ name: 'too long' }] } } }), | ||
| ).toBeRejectedByValidation(['data.cart.items[0].name']); | ||
| await expect( | ||
| db.order.create({ data: { id: 1, cart: { owner: 'a@b.com', items: [] } } }), | ||
| ).toBeRejectedByValidation(['data.cart.items']); | ||
| await expect( | ||
| db.order.create({ | ||
| data: { id: 1, cart: { owner: 'a@b.com', items: [{ name: 'a' }, { name: 'b' }, { name: 'c' }] } }, | ||
| }), | ||
| ).toBeRejectedByValidation(['data.cart.items']); | ||
|
|
||
| await expect( | ||
| db.order.create({ data: { id: 1, cart: { owner: 'a@b.com', items: [{ name: 'apple' }] } } }), | ||
| ).resolves.toMatchObject({ cart: { owner: 'a@b.com', items: [{ name: 'apple' }] } }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Apply list
@lengthonly to the list.For
names String[] @length(1, 2),getItemAttributes(def)passes@lengthto the string schema here. Line 497 also applies@lengthto the array. An otherwise valid value such as['long']is rejected because its element has more than two characters. Keep list-length attributes out of the item schema, and add a regression case for a built-in scalar list.🤖 Prompt for AI Agents