chore: merge from dev (#1017)

Author: ymc9

.github/workflows/build-test.yml

@@ -90,4 +90,4 @@ jobs:
               run: pnpm install --frozen-lockfile
 
             - name: Test
-              run: pnpm run test-ci
+              run: pnpm run test-scaffold && pnpm run test-ci

.gitignore

@@ -7,3 +7,4 @@ dist
 .npmcache
 coverage
 .build
+.test

CONTRIBUTING.md

@@ -35,6 +35,14 @@ I want to think you first for considering contributing to ZenStack 🙏🏻. It'
     pnpm build
     ```
 
+1. Scaffold the project used for testing
+
+    ```bash
+    pnpm test-scaffold
+    ```
+
+    You only need to run this command once.
+
 1. Run tests
 
     ```bash

jest.config.ts

@@ -3,15 +3,19 @@
  * https://jestjs.io/docs/configuration
  */
 
+import path from 'path';
+
 export default {
     // Automatically clear mock calls, instances, contexts and results before every test
     clearMocks: true,
 
+    globalSetup: path.join(__dirname, './test-setup.ts'),
+
     // Indicates whether the coverage information should be collected while executing the test
     collectCoverage: true,
 
     // The directory where Jest should output its coverage files
-    coverageDirectory: 'tests/coverage',
+    coverageDirectory: path.join(__dirname, '.test/coverage'),
 
     // An array of regexp pattern strings used to skip coverage collection
     coveragePathIgnorePatterns: ['/node_modules/', '/tests/'],

package.json

@@ -5,8 +5,9 @@
     "scripts": {
         "build": "pnpm -r build",
         "lint": "pnpm -r lint",
-        "test": "ZENSTACK_TEST=1 pnpm -r run test --silent --forceExit",
-        "test-ci": "ZENSTACK_TEST=1 pnpm -r run test --silent --forceExit",
+        "test": "ZENSTACK_TEST=1 pnpm -r --parallel run test --silent --forceExit",
+        "test-ci": "ZENSTACK_TEST=1 pnpm -r --parallel run test --silent --forceExit",
+        "test-scaffold": "tsx script/test-scaffold.ts",
         "publish-all": "pnpm --filter \"./packages/**\" -r publish --access public",
         "publish-preview": "pnpm --filter \"./packages/**\" -r publish --force --registry https://preview.registry.zenstack.dev/",
         "unpublish-preview": "pnpm --recursive --shell-mode exec -- npm unpublish -f --registry https://preview.registry.zenstack.dev/ \"\\$PNPM_PACKAGE_NAME\"",
@@ -33,6 +34,7 @@
         "ts-jest": "^29.1.1",
         "ts-node": "^10.9.1",
         "tsup": "^8.0.1",
+        "tsx": "^4.7.1",
         "typescript": "^5.3.2"
     }
 }

packages/ide/jetbrains/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Added support to complex usage of `@@index` attribute like `@@index([content(ops: raw("gin_trgm_ops"))], type: Gin)`.
+### Fixed
+- Fixed several ZModel validation issues related to model inheritance.
 
+## 1.7.0
 ### Added
 - Auto-completion is now supported inside attributes.

packages/plugins/tanstack-query/src/runtime/vue.ts

@@ -61,7 +61,7 @@ export function useModelQuery<TQueryFnData, TData, TError>(
     model: string,
     url: string,
     args?: unknown,
-    options?: UseQueryOptions<TQueryFnData, TError, TData>,
+    options?: Omit<UseQueryOptions<TQueryFnData, TError, TData>, 'queryKey'>,
     fetch?: FetchFn,
     optimisticUpdate = false
 ) {
@@ -87,7 +87,7 @@ export function useInfiniteModelQuery<TQueryFnData, TData, TError>(
     model: string,
     url: string,
     args?: unknown,
-    options?: UseInfiniteQueryOptions<TQueryFnData, TError, TData>,
+    options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData>, 'queryKey'>,
     fetch?: FetchFn
 ) {
     return useInfiniteQuery<TQueryFnData, TError, TData>({

packages/schema/src/cli/actions/repl.ts

@@ -2,7 +2,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import colors from 'colors';
 import path from 'path';
-import prettyRepl from 'pretty-repl';
 import { inspect } from 'util';
 
 // inspired by: https://github.com/Kinjalrk2k/prisma-console
@@ -11,6 +10,13 @@ import { inspect } from 'util';
  * CLI action for starting a REPL session
  */
 export async function repl(projectPath: string, options: { prismaClient?: string; debug?: boolean; table?: boolean }) {
+    if (!process?.stdout?.isTTY && process?.versions?.bun) {
+        console.error('REPL on Bun is only available in a TTY terminal at this time. Please use npm/npx to run the command in this context instead of bun/bunx.');
+        return;
+    }
+
+    const prettyRepl = await import('pretty-repl')
+
     console.log('Welcome to ZenStack REPL. See help with the ".help" command.');
     console.log('Global variables:');
     console.log(`    ${colors.blue('db')} to access enhanced PrismaClient`);

packages/schema/src/language-server/validator/datamodel-validator.ts

@@ -5,6 +5,7 @@ import {
     isDataModel,
     isStringLiteral,
     ReferenceExpr,
+    isEnum,
 } from '@zenstackhq/language/ast';
 import { getLiteral, getModelIdFields, getModelUniqueFields, isDelegateModel } from '@zenstackhq/sdk';
 import { AstNode, DiagnosticInfo, getDocument, ValidationAcceptor } from 'langium';
@@ -61,8 +62,13 @@ export default class DataModelValidator implements AstValidator<DataModel> {
                 if (idField.type.optional) {
                     accept('error', 'Field with @id attribute must not be optional', { node: idField });
                 }
-                if (idField.type.array || !idField.type.type || !SCALAR_TYPES.includes(idField.type.type)) {
-                    accept('error', 'Field with @id attribute must be of scalar type', { node: idField });
+
+                const isArray = idField.type.array;
+                const isScalar = SCALAR_TYPES.includes(idField.type.type as typeof SCALAR_TYPES[number])
+                const isValidType = isScalar || isEnum(idField.type.reference?.ref)
+
+                if (isArray || !isValidType) {
+                    accept('error', 'Field with @id attribute must be of scalar or enum type', { node: idField });
                 }
             });
         }

packages/schema/src/language-server/validator/schema-validator.ts

@@ -52,8 +52,9 @@ export default class SchemaValidator implements AstValidator<Model> {
     private validateImports(model: Model, accept: ValidationAcceptor) {
         model.imports.forEach((imp) => {
             const importedModel = resolveImport(this.documents, imp);
+            const importPath = imp.path.endsWith('.zmodel') ? imp.path : `${imp.path}.zmodel`;
             if (!importedModel) {
-                accept('error', `Cannot find model file ${imp.path}.zmodel`, { node: imp });
+                accept('error', `Cannot find model file ${importPath}`, { node: imp });
             }
         });
     }

packages/schema/src/plugins/prisma/schema-generator.ts

@@ -56,7 +56,7 @@ import { upperCaseFirst } from 'upper-case-first';
 import { name } from '.';
 import { getStringLiteral } from '../../language-server/validator/utils';
 import telemetry from '../../telemetry';
-import { execSync } from '../../utils/exec-utils';
+import { execPackage } from '../../utils/exec-utils';
 import { findPackageJson } from '../../utils/pkg-utils';
 import {
     AttributeArgValue,
@@ -142,7 +142,7 @@ export class PrismaSchemaGenerator {
         if (options.format === true) {
             try {
                 // run 'prisma format'
-                await execSync(`npx prisma format --schema ${outFile}`, { stdio: 'ignore' });
+                await execPackage(`prisma format --schema ${outFile}`, { stdio: 'ignore' });
             } catch {
                 warnings.push(`Failed to format Prisma schema file`);
             }
@@ -151,18 +151,18 @@ export class PrismaSchemaGenerator {
         const generateClient = options.generateClient !== false;
 
         if (generateClient) {
-            let generateCmd = `npx prisma generate --schema "${outFile}"`;
+            let generateCmd = `prisma generate --schema "${outFile}"`;
             if (typeof options.generateArgs === 'string') {
                 generateCmd += ` ${options.generateArgs}`;
             }
             try {
                 // run 'prisma generate'
-                await execSync(generateCmd, { stdio: 'ignore' });
+                await execPackage(generateCmd, { stdio: 'ignore' });
             } catch {
                 await this.trackPrismaSchemaError(outFile);
                 try {
                     // run 'prisma generate' again with output to the console
-                    await execSync(generateCmd);
+                    await execPackage(generateCmd);
                 } catch {
                     // noop
                 }

packages/schema/src/res/stdlib.zmodel

@@ -390,7 +390,7 @@ attribute @updatedAt() @@@targetField([DateTimeField]) @@@prisma
 /**
  * Add full text index (MySQL only).
  */
-attribute @@fulltext(_ fields: FieldReference[]) @@@prisma
+attribute @@fulltext(_ fields: FieldReference[], map: String?) @@@prisma
 
 
 // String type modifiers
@@ -479,7 +479,7 @@ attribute @db.Bytes() @@@targetField([BytesField]) @@@prisma
 attribute @db.ByteA() @@@targetField([BytesField]) @@@prisma
 attribute @db.LongBlob() @@@targetField([BytesField]) @@@prisma
 attribute @db.Binary() @@@targetField([BytesField]) @@@prisma
-attribute @db.VarBinary() @@@targetField([BytesField]) @@@prisma
+attribute @db.VarBinary(_ x: Int?) @@@targetField([BytesField]) @@@prisma
 attribute @db.TinyBlob() @@@targetField([BytesField]) @@@prisma
 attribute @db.Blob() @@@targetField([BytesField]) @@@prisma
 attribute @db.MediumBlob() @@@targetField([BytesField]) @@@prisma

packages/schema/src/utils/exec-utils.ts

@@ -8,3 +8,11 @@ export function execSync(cmd: string, options?: Omit<ExecSyncOptions, 'env'> & {
     const mergedEnv = env ? { ...process.env, ...env } : undefined;
     _exec(cmd, { encoding: 'utf-8', stdio: options?.stdio ?? 'inherit', env: mergedEnv, ...restOptions });
 }
+
+/**
+ * Utility for running package commands through npx/bunx
+ */
+export function execPackage(cmd: string, options?: Omit<ExecSyncOptions, 'env'> & { env?: Record<string, string> }): void {
+    const packageManager = process?.versions?.bun ? 'bunx' : 'npx';
+    execSync(`${packageManager} ${cmd}`, options)
+}

packages/schema/tests/schema/stdlib.test.ts

@@ -24,7 +24,7 @@ describe('Stdlib Tests', () => {
                     }`
                 );
             }
-            throw new SchemaLoadingError(validationErrors.map((e) => e.message));
+            throw new SchemaLoadingError(validationErrors);
         }
     });
 });

packages/schema/tests/schema/validation/attribute-validation.test.ts

@@ -226,6 +226,25 @@ describe('Attribute tests', () => {
             }
         `);
 
+        await loadModel(`
+            ${ prelude }
+            model A {
+                id String @id
+                x String
+                y String
+                z String
+                @@fulltext([x, y, z])
+            }
+
+            model B {
+                id String @id
+                x String
+                y String
+                z String
+                @@fulltext([x, y, z], map: "n")
+            }
+        `);
+
         await loadModel(`
             ${prelude}
             model A {
@@ -352,6 +371,7 @@ describe('Attribute tests', () => {
                 _longBlob Bytes @db.LongBlob
                 _binary Bytes @db.Binary
                 _varBinary Bytes @db.VarBinary
+                _varBinarySized Bytes @db.VarBinary(100)
                 _tinyBlob Bytes @db.TinyBlob
                 _blob Bytes @db.Blob
                 _mediumBlob Bytes @db.MediumBlob