feat: add CLI config file support (#328)

Author: ymc9

packages/schema/package.json

@@ -92,6 +92,7 @@
         "colors": "1.4.0",
         "commander": "^8.3.0",
         "cuid": "^2.1.8",
+        "get-latest-version": "^5.0.1",
         "langium": "1.1.0",
         "mixpanel": "^0.17.0",
         "node-machine-id": "^1.1.12",
@@ -108,7 +109,7 @@
         "vscode-languageserver-textdocument": "^1.0.7",
         "vscode-uri": "^3.0.6",
         "zod": "^3.19.1",
-        "get-latest-version": "^5.0.1"
+        "zod-validation-error": "^0.2.1"
     },
     "devDependencies": {
         "@types/async-exit-hook": "^2.0.0",

packages/schema/src/cli/config.ts

@@ -0,0 +1,40 @@
+import { GUARD_FIELD_NAME, TRANSACTION_FIELD_NAME } from '@zenstackhq/sdk';
+import fs from 'fs';
+import z from 'zod';
+import { fromZodError } from 'zod-validation-error';
+import { CliError } from './cli-error';
+
+const schema = z
+    .object({
+        guardFieldName: z.string().default(GUARD_FIELD_NAME),
+        transactionFieldName: z.string().default(TRANSACTION_FIELD_NAME),
+    })
+    .strict();
+
+export type ConfigType = z.infer<typeof schema>;
+
+export let config: ConfigType = schema.parse({});
+
+/**
+ * Loads and validates CLI configuration file.
+ * @returns
+ */
+export function loadConfig(filename: string) {
+    if (!fs.existsSync(filename)) {
+        return;
+    }
+
+    let content: unknown;
+    try {
+        content = JSON.parse(fs.readFileSync(filename, 'utf-8'));
+    } catch {
+        throw new CliError(`Config is not a valid JSON file: ${filename}`);
+    }
+
+    const parsed = schema.safeParse(content);
+    if (!parsed.success) {
+        throw new CliError(`Config file ${filename} is not valid: ${fromZodError(parsed.error)}`);
+    }
+
+    config = parsed.data;
+}

packages/schema/src/cli/index.ts

@@ -2,16 +2,20 @@
 import { ZModelLanguageMetaData } from '@zenstackhq/language/module';
 import colors from 'colors';
 import { Command, Option } from 'commander';
+import fs from 'fs';
 import * as semver from 'semver';
 import telemetry from '../telemetry';
 import { PackageManagers } from '../utils/pkg-utils';
 import { getVersion } from '../utils/version-utils';
 import { CliError } from './cli-error';
 import { dumpInfo, initProject, runPlugins } from './cli-util';
+import { loadConfig } from './config';
 
 // required minimal version of Prisma
 export const requiredPrismaVersion = '4.0.0';
 
+const DEFAULT_CONFIG_FILE = 'zenstack.config.json';
+
 export const initAction = async (
     projectPath: string,
     options: {
@@ -97,6 +101,8 @@ export function createProgram() {
         './schema.zmodel'
     );
 
+    const configOption = new Option('-c, --config [file]', 'config file');
+
     const pmOption = new Option('-p, --package-manager <pm>', 'package manager to use').choices([
         'npm',
         'yarn',
@@ -114,6 +120,7 @@ export function createProgram() {
     program
         .command('init')
         .description('Initialize an existing project for ZenStack.')
+        .addOption(configOption)
         .addOption(pmOption)
         .addOption(new Option('--prisma <file>', 'location of Prisma schema file to bootstrap from'))
         .addOption(new Option('--tag [tag]', 'the NPM package tag to use when installing dependencies'))
@@ -124,9 +131,27 @@ export function createProgram() {
         .command('generate')
         .description('Run code generation.')
         .addOption(schemaOption)
+        .addOption(configOption)
         .addOption(pmOption)
         .addOption(noDependencyCheck)
         .action(generateAction);
+
+    // make sure config is loaded before actions run
+    program.hook('preAction', async (_, actionCommand) => {
+        let configFile: string | undefined = actionCommand.opts().config;
+        if (!configFile && fs.existsSync(DEFAULT_CONFIG_FILE)) {
+            configFile = DEFAULT_CONFIG_FILE;
+        }
+
+        if (configFile) {
+            if (fs.existsSync(configFile)) {
+                loadConfig(configFile);
+            } else {
+                throw new CliError(`Config file ${configFile} not found`);
+            }
+        }
+    });
+
     return program;
 }
 

packages/schema/src/cli/plugin-runner.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { DMMF } from '@prisma/generator-helper';
+import type { DMMF } from '@prisma/generator-helper';
 import { getDMMF } from '@prisma/internals';
 import { isPlugin, Plugin } from '@zenstackhq/language/ast';
 import { getLiteral, getLiteralArray, PluginError, PluginFunction, PluginOptions } from '@zenstackhq/sdk';
@@ -8,7 +8,8 @@ import fs from 'fs';
 import ora from 'ora';
 import path from 'path';
 import telemetry from '../telemetry';
-import { Context } from '../types';
+import type { Context } from '../types';
+import { config } from './config';
 
 /**
  * ZenStack code generator
@@ -133,7 +134,7 @@ export class PluginRunner {
                     plugin: name,
                 },
                 async () => {
-                    let result = run(context.schema, options, dmmf);
+                    let result = run(context.schema, options, dmmf, config);
                     if (result instanceof Promise) {
                         result = await result;
                     }

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

@@ -1,9 +1,15 @@
+import type { DMMF } from '@prisma/generator-helper';
 import { Model } from '@zenstackhq/language/ast';
 import { PluginOptions } from '@zenstackhq/sdk';
 import PrismaSchemaGenerator from './schema-generator';
 
 export const name = 'Prisma';
 
-export default async function run(model: Model, options: PluginOptions) {
-    return new PrismaSchemaGenerator().generate(model, options);
+export default async function run(
+    model: Model,
+    options: PluginOptions,
+    _dmmf?: DMMF.Document,
+    config?: Record<string, string>
+) {
+    return new PrismaSchemaGenerator().generate(model, options, config);
 }

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

@@ -69,7 +69,7 @@ export default class PrismaSchemaGenerator {
 
 `;
 
-    async generate(model: Model, options: PluginOptions) {
+    async generate(model: Model, options: PluginOptions, config?: Record<string, string>) {
         const prisma = new PrismaModel();
 
         for (const decl of model.declarations) {
@@ -83,7 +83,7 @@ export default class PrismaSchemaGenerator {
                     break;
 
                 case DataModel:
-                    this.generateModel(prisma, decl as DataModel);
+                    this.generateModel(prisma, decl as DataModel, config);
                     break;
 
                 case GeneratorDecl:
@@ -191,26 +191,33 @@ export default class PrismaSchemaGenerator {
         );
     }
 
-    private generateModel(prisma: PrismaModel, decl: DataModel) {
+    private generateModel(prisma: PrismaModel, decl: DataModel, config?: Record<string, string>) {
         const model = prisma.addModel(decl.name);
         for (const field of decl.fields) {
             this.generateModelField(model, field);
         }
 
         // add an "zenstack_guard" field for dealing with boolean conditions
-        model.addField(GUARD_FIELD_NAME, 'Boolean', [
+        const guardField = model.addField(GUARD_FIELD_NAME, 'Boolean', [
             new PrismaFieldAttribute('@default', [
                 new PrismaAttributeArg(undefined, new PrismaAttributeArgValue('Boolean', true)),
             ]),
         ]);
 
+        if (config?.guardFieldName && config?.guardFieldName !== GUARD_FIELD_NAME) {
+            // generate a @map to rename field in the database
+            guardField.addAttribute('@map', [
+                new PrismaAttributeArg(undefined, new PrismaAttributeArgValue('String', config.guardFieldName)),
+            ]);
+        }
+
         const { allowAll, denyAll, hasFieldValidation } = analyzePolicies(decl);
 
         if ((!allowAll && !denyAll) || hasFieldValidation) {
             // generate auxiliary fields for policy check
 
             // add an "zenstack_transaction" field for tracking records created/updated with nested writes
-            model.addField(TRANSACTION_FIELD_NAME, 'String?');
+            const transactionField = model.addField(TRANSACTION_FIELD_NAME, 'String?');
 
             // create an index for "zenstack_transaction" field
             model.addAttribute('@@index', [
@@ -221,6 +228,16 @@ export default class PrismaSchemaGenerator {
                     ])
                 ),
             ]);
+
+            if (config?.transactionFieldName && config?.transactionFieldName !== TRANSACTION_FIELD_NAME) {
+                // generate a @map to rename field in the database
+                transactionField.addAttribute('@map', [
+                    new PrismaAttributeArg(
+                        undefined,
+                        new PrismaAttributeArgValue('String', config.transactionFieldName)
+                    ),
+                ]);
+            }
         }
 
         for (const attr of decl.attributes.filter((attr) => this.isPrismaAttribute(attr))) {

packages/schema/tests/cli/cli.test.ts renamed to packages/schema/tests/cli/command.test.ts

@@ -8,7 +8,7 @@ import * as tmp from 'tmp';
 import { createProgram } from '../../src/cli';
 import { execSync } from '../../src/utils/exec-utils';
 
-describe('CLI Tests', () => {
+describe('CLI Command Tests', () => {
     let projDir: string;
     let origDir: string;
 
@@ -37,7 +37,7 @@ describe('CLI Tests', () => {
         createNpmrc();
 
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest'], { from: 'user' });
 
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toEqual(fs.readFileSync('prisma/schema.prisma', 'utf-8'));
 
@@ -53,7 +53,7 @@ describe('CLI Tests', () => {
         createNpmrc();
 
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest'], { from: 'user' });
 
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toEqual(fs.readFileSync('prisma/schema.prisma', 'utf-8'));
 
@@ -69,7 +69,7 @@ describe('CLI Tests', () => {
         createNpmrc();
 
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest'], { from: 'user' });
 
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toEqual(fs.readFileSync('prisma/schema.prisma', 'utf-8'));
 
@@ -86,7 +86,7 @@ describe('CLI Tests', () => {
         fs.renameSync('prisma/schema.prisma', 'prisma/my.prisma');
 
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest', '--prisma', 'prisma/my.prisma'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest', '--prisma', 'prisma/my.prisma'], { from: 'user' });
 
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toEqual(fs.readFileSync('prisma/my.prisma', 'utf-8'));
     });
@@ -96,7 +96,7 @@ describe('CLI Tests', () => {
         fs.writeFileSync('package.json', JSON.stringify({ name: 'my app', version: '1.0.0' }));
         createNpmrc();
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest'], { from: 'user' });
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toBeTruthy();
     });
 
@@ -111,7 +111,7 @@ describe('CLI Tests', () => {
         fs.writeFileSync('schema.zmodel', origZModelContent);
         createNpmrc();
         const program = createProgram();
-        program.parse(['init', '--tag', 'latest'], { from: 'user' });
+        await program.parseAsync(['init', '--tag', 'latest'], { from: 'user' });
         expect(fs.readFileSync('schema.zmodel', 'utf-8')).toEqual(origZModelContent);
     });
 });