fix: regenerate Prisma schema on related cli commands

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "0.2.10",
+    "version": "0.2.11",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",

packages/internal/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/internal",
-    "version": "0.2.10",
+    "version": "0.2.11",
     "displayName": "ZenStack Internal Library",
     "description": "ZenStack internal runtime library. This package is for supporting runtime functionality of ZenStack and not supposed to be used directly.",
     "repository": {
@@ -42,6 +42,7 @@
         "@types/jest": "^29.0.3",
         "@types/node": "^14.18.29",
         "@types/uuid": "^8.3.4",
+        "eslint": "^8.27.0",
         "jest": "^29.0.3",
         "ts-jest": "^29.0.1",
         "ts-node": "^10.9.1",

packages/runtime/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/runtime",
     "displayName": "ZenStack Runtime Library",
-    "version": "0.2.10",
+    "version": "0.2.11",
     "description": "This package contains runtime library for consuming client and server side code generated by ZenStack.",
     "repository": {
         "type": "git",

packages/schema/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack Language Tools",
     "description": "ZenStack is a toolkit that simplifies full-stack development",
-    "version": "0.2.10",
+    "version": "0.2.11",
     "author": {
         "name": "ZenStack Team"
     },

packages/schema/src/cli/cli-util.ts

@@ -1,10 +1,15 @@
 import { STD_LIB_MODULE_NAME } from '@lang/constants';
 import { Model } from '@lang/generated/ast';
+import { createZModelServices } from '@lang/zmodel-module';
 import colors from 'colors';
 import fs from 'fs';
 import { LangiumServices } from 'langium';
+import { NodeFileSystem } from 'langium/node';
 import path from 'path';
+import { ZenStackGenerator } from '../generator';
 import { URI } from 'vscode-uri';
+import { GENERATED_CODE_PATH } from '../generator/constants';
+import { Context, GeneratorError } from '../generator/types';
 
 /**
  * Loads a zmodel document from a file.
@@ -69,3 +74,32 @@ export async function loadDocument(
 
     return document.parseResult.value as Model;
 }
+
+export async function runGenerator(
+    options: { schema: string },
+    includedGenerators?: string[],
+    clearOutput = true
+) {
+    const services = createZModelServices(NodeFileSystem).ZModel;
+    const model = await loadDocument(options.schema, services);
+
+    const context: Context = {
+        schema: model,
+        outDir: path.dirname(options.schema),
+        // TODO: make this configurable
+        generatedCodeDir: GENERATED_CODE_PATH,
+    };
+
+    try {
+        await new ZenStackGenerator().generate(
+            context,
+            includedGenerators,
+            clearOutput
+        );
+    } catch (err) {
+        if (err instanceof GeneratorError) {
+            console.error(colors.red(err.message));
+            process.exit(1);
+        }
+    }
+}

packages/schema/src/cli/index.ts

@@ -1,38 +1,16 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Command, Option } from 'commander';
-import { NodeFileSystem } from 'langium/node';
 import { ZModelLanguageMetaData } from '../language-server/generated/module';
-import { createZModelServices } from '../language-server/zmodel-module';
-import { Context, GeneratorError } from '../generator/types';
-import { ZenStackGenerator } from '../generator';
-import { GENERATED_CODE_PATH } from '../generator/constants';
 import colors from 'colors';
 import { execSync } from '../utils/exec-utils';
 import { paramCase } from 'change-case';
 import path from 'path';
-import { loadDocument } from './cli-util';
+import { runGenerator } from './cli-util';
 
 export const generateAction = async (options: {
     schema: string;
 }): Promise<void> => {
-    const services = createZModelServices(NodeFileSystem).ZModel;
-    const model = await loadDocument(options.schema, services);
-
-    const context: Context = {
-        schema: model,
-        outDir: path.dirname(options.schema),
-        // TODO: make this configurable
-        generatedCodeDir: GENERATED_CODE_PATH,
-    };
-
-    try {
-        await new ZenStackGenerator().generate(context);
-    } catch (err) {
-        if (err instanceof GeneratorError) {
-            console.error(colors.red(err.message));
-            process.exit(1);
-        }
-    }
+    await runGenerator(options);
 };
 
 function prismaAction(prismaCmd: string): (...args: any[]) => Promise<void> {
@@ -50,6 +28,10 @@ function prismaAction(prismaCmd: string): (...args: any[]) => Promise<void> {
                 );
             })
             .join(' ');
+
+        // regenerate prisma schema first
+        await runGenerator(options, ['prisma'], false);
+
         const prismaExec = `npx prisma ${prismaCmd} ${command.name()} ${optStr}`;
         console.log(prismaExec);
         try {

packages/schema/src/generator/index.ts

@@ -1,13 +1,12 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { Context, GeneratorError } from './types';
+import { Context } from './types';
 import * as fs from 'fs';
 import colors from 'colors';
 import PrismaGenerator from './prisma';
 import ServiceGenerator from './service';
 import ReactHooksGenerator from './react-hooks';
 import NextAuthGenerator from './next-auth';
-import path from 'path';
-import { execSync } from '../utils/exec-utils';
+import { TypescriptCompilation } from './tsc';
 
 /**
  * ZenStack code generator
@@ -16,20 +15,26 @@ export class ZenStackGenerator {
     /**
      * Runs a series of nested generators
      */
-    async generate(context: Context): Promise<void> {
-        // folder that stores generated prisma schema and migrations
+    async generate(
+        context: Context,
+        includeGenerators?: string[],
+        clearOutput = true
+    ): Promise<void> {
+        // ensure folder that stores generated prisma schema and migrations
         if (!fs.existsSync(context.outDir)) {
             fs.mkdirSync(context.outDir);
         }
 
-        // folder that stores generated zenstack code
-        if (fs.existsSync(context.generatedCodeDir)) {
-            fs.rmSync(context.generatedCodeDir, {
-                force: true,
-                recursive: true,
-            });
+        if (clearOutput) {
+            // recreate folder that stores generated zenstack code
+            if (fs.existsSync(context.generatedCodeDir)) {
+                fs.rmSync(context.generatedCodeDir, {
+                    force: true,
+                    recursive: true,
+                });
+            }
+            fs.mkdirSync(context.generatedCodeDir);
         }
-        fs.mkdirSync(context.generatedCodeDir);
 
         const version = require('../../package.json').version;
         console.log(colors.bold(`⌛️ Running ZenStack generator v${version}`));
@@ -40,49 +45,19 @@ export class ZenStackGenerator {
             new ServiceGenerator(),
             new ReactHooksGenerator(),
             new NextAuthGenerator(),
+            new TypescriptCompilation(),
         ];
 
         for (const generator of generators) {
+            if (
+                includeGenerators &&
+                !includeGenerators.includes(generator.name)
+            ) {
+                continue;
+            }
             await generator.generate(context);
         }
 
-        // generate package.json
-        const packageJson = require(path.join(
-            __dirname,
-            '../res',
-            'package.template.json'
-        ));
-        fs.writeFileSync(
-            path.join(context.generatedCodeDir, 'package.json'),
-            JSON.stringify(packageJson, undefined, 4)
-        );
-
-        // compile ts sources
-        const tsConfig = require(path.join(
-            __dirname,
-            '../res',
-            'tsconfig.template.json'
-        ));
-        fs.writeFileSync(
-            path.join(context.generatedCodeDir, 'tsconfig.json'),
-            JSON.stringify(tsConfig, undefined, 4)
-        );
-
-        try {
-            execSync(
-                `npx tsc -p "${path.join(
-                    context.generatedCodeDir,
-                    'tsconfig.json'
-                )}"`
-            );
-        } catch {
-            throw new GeneratorError(
-                'Something went wrong, generated runtime code failed to compile...\nPlease check errors above.'
-            );
-        }
-
-        console.log(colors.blue('  ✔️ Typescript source files transpiled'));
-
         console.log(
             colors.green(
                 colors.bold('👻 All generators completed successfully!')

packages/schema/src/generator/next-auth/index.ts

@@ -9,6 +9,10 @@ import { execSync } from 'child_process';
  * Generates NextAuth adaptor code
  */
 export default class NextAuthGenerator implements Generator {
+    get name() {
+        return 'next-auth';
+    }
+
     private findModel(schema: Model, name: string) {
         return schema.declarations.find(
             (d) => isDataModel(d) && d.name === name

packages/schema/src/generator/prisma/index.ts

@@ -8,6 +8,10 @@ import QueryGuardGenerator from './query-guard-generator';
  * Generates Prisma schema and db client
  */
 export default class PrismaGenerator implements Generator {
+    get name() {
+        return 'prisma';
+    }
+
     async generate(context: Context): Promise<void> {
         // generate prisma schema
         const schemaFile = await new PrismaSchemaGenerator(context).generate();

packages/schema/src/generator/react-hooks/index.ts

@@ -11,6 +11,10 @@ import { API_ROUTE_NAME, INTERNAL_PACKAGE } from '../constants';
  * Generate react data query hooks code
  */
 export default class ReactHooksGenerator implements Generator {
+    get name() {
+        return 'react-hooks';
+    }
+
     async generate(context: Context): Promise<void> {
         const project = new Project();
 

packages/schema/src/generator/service/index.ts

@@ -8,6 +8,10 @@ import { INTERNAL_PACKAGE } from '../constants';
  * Generates ZenStack service code
  */
 export default class ServiceGenerator implements Generator {
+    get name() {
+        return 'service';
+    }
+
     async generate(context: Context): Promise<void> {
         const project = new Project();
         const sf = project.createSourceFile(

packages/schema/src/generator/tsc/index.ts

@@ -0,0 +1,52 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+import colors from 'colors';
+import * as fs from 'fs';
+import path from 'path';
+import { execSync } from '../../utils/exec-utils';
+import { Context, Generator, GeneratorError } from '../types';
+
+export class TypescriptCompilation implements Generator {
+    get name(): string {
+        return 'tsc';
+    }
+
+    async generate(context: Context) {
+        // generate package.json
+        const packageJson = require(path.join(
+            __dirname,
+            '../res',
+            'package.template.json'
+        ));
+
+        fs.writeFileSync(
+            path.join(context.generatedCodeDir, 'package.json'),
+            JSON.stringify(packageJson, undefined, 4)
+        );
+
+        // compile ts sources
+        const tsConfig = require(path.join(
+            __dirname,
+            '../res',
+            'tsconfig.template.json'
+        ));
+        fs.writeFileSync(
+            path.join(context.generatedCodeDir, 'tsconfig.json'),
+            JSON.stringify(tsConfig, undefined, 4)
+        );
+
+        try {
+            execSync(
+                `npx tsc -p "${path.join(
+                    context.generatedCodeDir,
+                    'tsconfig.json'
+                )}"`
+            );
+        } catch {
+            throw new GeneratorError(
+                'Something went wrong, generated runtime code failed to compile...\nPlease check errors above.'
+            );
+        }
+
+        console.log(colors.blue('  ✔️ Typescript source files transpiled'));
+    }
+}

packages/schema/src/generator/types.ts

@@ -7,6 +7,7 @@ export interface Context {
 }
 
 export interface Generator {
+    get name(): string;
     generate(context: Context): Promise<void>;
 }