Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "zenstack-v3",
"displayName": "ZenStack",
"description": "ZenStack",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/auth-adapters/better-auth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/better-auth",
"displayName": "ZenStack Better Auth Adapter",
"description": "ZenStack Better Auth Adapter. This adapter is modified from better-auth's Prisma adapter.",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/cli",
"displayName": "ZenStack CLI",
"description": "FullStack database toolkit with built-in access control and automatic API generation.",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
49 changes: 49 additions & 0 deletions packages/cli/test/prisma-schema-gen.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { loadSchema } from '@zenstackhq/testtools';
import { describe, expect, it } from 'vitest';
import { PrismaSchemaGenerator } from '@zenstackhq/sdk';

describe('Prisma schema generation tests', () => {
it('strips format args from id functions', async () => {
const model = await loadSchema(`
model User {
id Int @id @default(autoincrement())

cuid String @default(cuid())
cuid1 String @default(cuid(1, 'cuid1_%s'))
cuid2 String @default(cuid(2, 'cuid2_%s'))

uuid String @default(uuid())
uuid4 String @default(uuid(4, 'uuid4_%s'))
uuid7 String @default(uuid(7, 'uuid7_%s'))

ulid String @default(ulid())
ulid1 String @default(ulid('ulid_%s'))

nanoid String @default(nanoid())
nanoid12 String @default(nanoid(12, 'nanoid12_%s'))
}
`);

const generator = new PrismaSchemaGenerator(model);
const prismaSchemaText = await generator.generate();

expect(prismaSchemaText.includes('cuid()')).toBe(true);
expect(prismaSchemaText.includes('cuid(1)')).toBe(true);
expect(prismaSchemaText.includes('cuid(2)')).toBe(true);
expect(prismaSchemaText.includes('cuid1_%s')).toBe(false);
expect(prismaSchemaText.includes('cuid2_%s')).toBe(false);

expect(prismaSchemaText.includes('uuid()')).toBe(true);
expect(prismaSchemaText.includes('uuid(4)')).toBe(true);
expect(prismaSchemaText.includes('uuid(7)')).toBe(true);
expect(prismaSchemaText.includes('uuid4_%s')).toBe(false);
expect(prismaSchemaText.includes('uuid7_%s')).toBe(false);

expect(prismaSchemaText.match(/ulid\(\)/g)).toHaveLength(2);
expect(prismaSchemaText.includes('ulid_%s')).toBe(false);

expect(prismaSchemaText.includes('nanoid()')).toBe(true);
expect(prismaSchemaText.includes('nanoid(12)')).toBe(true);
expect(prismaSchemaText.includes('nanoid12_%s')).toBe(false);
});
});
2 changes: 1 addition & 1 deletion packages/clients/client-helpers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/client-helpers",
"displayName": "ZenStack Client Helpers",
"description": "Helpers for implementing clients that consume ZenStack's CRUD service",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/fetch-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/fetch-client",
"displayName": "ZenStack Fetch Client",
"description": "Simple fetch-based client for consuming ZenStack's RPC-style CRUD API",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/clients/tanstack-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/tanstack-query",
"displayName": "ZenStack TanStack Query Integration",
"description": "TanStack Query Client for consuming ZenStack v3's CRUD service",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/common-helpers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/common-helpers",
"displayName": "ZenStack Common Helpers",
"description": "ZenStack Common Helpers",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/config/eslint-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@zenstackhq/eslint-config",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"private": true,
"license": "MIT"
Expand Down
2 changes: 1 addition & 1 deletion packages/config/tsdown-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@zenstackhq/tsdown-config",
"version": "3.7.0",
"version": "3.7.1",
"private": true,
"type": "module",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion packages/config/typescript-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@zenstackhq/typescript-config",
"version": "3.7.0",
"version": "3.7.1",
"private": true,
"license": "MIT"
}
2 changes: 1 addition & 1 deletion packages/config/vitest-config/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@zenstackhq/vitest-config",
"type": "module",
"version": "3.7.0",
"version": "3.7.1",
"private": true,
"license": "MIT",
"exports": {
Expand Down
2 changes: 1 addition & 1 deletion packages/create-zenstack/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "create-zenstack",
"displayName": "Create ZenStack",
"description": "Create a new ZenStack project",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
2 changes: 1 addition & 1 deletion packages/ide/vscode/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "zenstack-v3",
"publisher": "zenstack",
"version": "3.7.0",
"version": "3.7.1",
"displayName": "ZenStack V3 Language Tools",
"description": "VSCode extension for ZenStack (v3) ZModel language",
"private": true,
Expand Down
2 changes: 1 addition & 1 deletion packages/language/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@zenstackhq/language",
"displayName": "ZenStack Language Tooling",
"description": "ZenStack ZModel language specification",
"version": "3.7.0",
"version": "3.7.1",
"type": "module",
"author": {
"name": "ZenStack Team",
Expand Down
7 changes: 7 additions & 0 deletions packages/language/res/stdlib.zmodel
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,13 @@ attribute @@prisma.passthrough(_ text: String)
*/
attribute @@delegate(_ discriminator: FieldReference)

/**
* Maps a delegate sub-model to a specific discriminator value. If not set the sub-model name is used as the discriminator value by default.
*
* @param value: A string literal or enum member used as the discriminator.
*/
attribute @@delegateMap(_ value: Any)

/**
* Used for specifying operator classes for GIN index.
*/
Expand Down
113 changes: 113 additions & 0 deletions packages/language/src/validators/datamodel-validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,27 @@ import {
ArrayExpr,
DataField,
DataModel,
DataModelAttribute,
ReferenceExpr,
TypeDef,
isDataField,
isDataModel,
isEnum,
isReferenceExpr,
isStringLiteral,
isTypeDef,
} from '../generated/ast';
import {
getAllAttributes,
getAllFields,
getAttribute,
getAttributeArg,
getModelIdFields,
getModelUniqueFields,
getUniqueFields,
hasAttribute,
isDelegateModel,
isEnumFieldReference,
} from '../utils';
import { validateAttributeApplication } from './attribute-application-validator';
import { validateDuplicatedDeclarations, type AstValidator } from './common';
Expand All @@ -36,6 +42,7 @@ export default class DataModelValidator implements AstValidator<DataModel> {
this.validateMixins(dm, accept);
}
this.validateInherits(dm, accept);
this.validateDelegateMap(dm, accept);
}

private validateFields(dm: DataModel, accept: ValidationAcceptor) {
Expand Down Expand Up @@ -489,6 +496,112 @@ export default class DataModelValidator implements AstValidator<DataModel> {
todo.push(...current.mixins.map((mixin) => mixin.ref!));
}
}

private validateDelegateMap(dm: DataModel, accept: ValidationAcceptor) {
const delegateMapAttrs = dm.attributes.filter((attr) => attr.decl.$refText === '@@delegateMap');
if (delegateMapAttrs.length > 1) {
accept('error', 'Model can include at most one @@delegateMap attribute', {
node: delegateMapAttrs[1]!,
});
}

const delegateMapAttr = delegateMapAttrs[0];
if (delegateMapAttr) {
if (!dm.baseModel) {
accept('error', '`@@delegateMap` can only be used on models that extend a delegate base model', {
node: delegateMapAttr,
});
} else if (dm.baseModel.ref) {
this.validateDelegateMapValue(dm.baseModel.ref, delegateMapAttr, accept);
}
}

if (!hasAttribute(dm, '@@delegate')) {
return;
}

const subModels = dm.$container.declarations.filter(isDataModel).filter((model) => model.baseModel?.ref === dm);

if (subModels.length === 0) {
return;
}

const seen = new Map<string, DataModel>();
subModels.forEach((model) => {
const value = this.getDelegateMapRawValue(model) ?? model.name;
const existing = seen.get(value);
if (existing) {
accept(
'error',
`Duplicate @@delegateMap value "${value}" on models "${existing.name}" and "${model.name}"`,
{ node: model },
);
} else {
seen.set(value, model);
}
});
Comment on lines +529 to +542
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Validate enum compatibility for unmapped delegate sub-models

Line 531 falls back to model.name when @@delegateMap is absent, but enum membership is never validated for that fallback. This allows invalid enum discriminator values to pass validation.

Suggested fix
         const subModels = dm.$container.declarations.filter(isDataModel).filter((model) => model.baseModel?.ref === dm);
+        const delegateAttr = getAttribute(dm, '@@delegate');
+        const discriminatorArg = delegateAttr && getAttributeArg(delegateAttr, 'discriminator');
+        const discriminatorRef = discriminatorArg && isReferenceExpr(discriminatorArg) ? discriminatorArg.target.ref : undefined;
+        const discriminatorEnum = isDataField(discriminatorRef) ? discriminatorRef.type.reference?.ref : undefined;
 
         if (subModels.length === 0) {
             return;
         }
 
         const seen = new Map<string, DataModel>();
         subModels.forEach((model) => {
-            const value = this.getDelegateMapRawValue(model) ?? model.name;
+            const mappedValue = this.getDelegateMapRawValue(model);
+            if (mappedValue === undefined && isEnum(discriminatorEnum)) {
+                const validFallback = discriminatorEnum.fields.some((f) => f.name === model.name);
+                if (!validFallback) {
+                    accept(
+                        'error',
+                        `Model "${model.name}" must specify @@delegateMap(...) because "${model.name}" is not a value of enum "${discriminatorEnum.name}"`,
+                        { node: model },
+                    );
+                    return;
+                }
+            }
+            const value = mappedValue ?? model.name;
             const existing = seen.get(value);
             if (existing) {
                 accept(
                     'error',
                     `Duplicate @@delegateMap value "${value}" on models "${existing.name}" and "${model.name}"`,
                     { node: model },
                 );
             } else {
                 seen.set(value, model);
             }
         });
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/language/src/validators/datamodel-validator.ts` around lines 529 -
542, The current loop in subModels.forEach uses getDelegateMapRawValue(model) ??
model.name to derive a value but skips enum membership validation when falling
back to model.name, allowing invalid discriminator values; update the logic in
the loop (the block using seen, getDelegateMapRawValue, and accept) to always
validate the computed value against the delegate enum members for the parent
DataModel (reuse the existing enum membership check or helper used elsewhere in
datamodel-validator.ts), and if the value is not a valid enum member emit an
accept('error', ...) referencing the model and the invalid value before
checking/recording duplicates in seen.

}

private getDelegateMapRawValue(dm: DataModel): string | undefined {
const delegateMapAttr = dm.attributes.find((attr) => attr.decl.$refText === '@@delegateMap');
const valueExpr = delegateMapAttr?.args[0]?.value;
if (!valueExpr) {
return undefined;
}
if (isStringLiteral(valueExpr)) {
return valueExpr.value;
}
if (isEnumFieldReference(valueExpr)) {
return valueExpr.target.ref?.name;
}
return undefined;
}

private validateDelegateMapValue(baseModel: DataModel, attr: DataModelAttribute, accept: ValidationAcceptor) {
const delegateMapValueExpr = attr.args[0]?.value;
if (!delegateMapValueExpr) {
accept('error', '`@@delegateMap` expects a value', { node: attr });
return;
}

const delegateAttr = getAttribute(baseModel, '@@delegate');
const discriminatorArg = delegateAttr && getAttributeArg(delegateAttr, 'discriminator');
const discriminatorRef = discriminatorArg && isReferenceExpr(discriminatorArg) ? discriminatorArg.target.ref : undefined;

if (!discriminatorRef || !isDataField(discriminatorRef)) {
return;
}

const discriminatorType = discriminatorRef.type;
const discriminatorEnum = discriminatorType.reference?.ref;

if (isEnumFieldReference(delegateMapValueExpr)) {
if (!isEnum(discriminatorEnum)) {
accept('error', '`@@delegateMap` enum value cannot be used when the discriminator field is String', {
node: delegateMapValueExpr,
});
return;
}

if (delegateMapValueExpr.target.ref?.$container !== discriminatorEnum) {
accept('error', '`@@delegateMap` enum value must come from the discriminator enum type', {
node: delegateMapValueExpr,
});
}
return;
}

if (isStringLiteral(delegateMapValueExpr)) {
if (discriminatorType.type !== 'String') {
accept('error', '`@@delegateMap` string value must match a String discriminator field', {
node: delegateMapValueExpr,
});
}
return;
}

accept('error', '`@@delegateMap` expects a string literal or enum value', { node: delegateMapValueExpr });
}
}

export interface MissingOppositeRelationData {
Expand Down
Loading
Loading