Merge pull request #174 from zenstackhq/dev

merge dev to main (v3.0.0-alpha.25)

Author: ymc9

README.md

@@ -109,7 +109,7 @@ npm install -D @types/better-sqlite3
 For Postgres:
 
 ```bash
-npm install pg pg-connection-string
+npm install pg
 npm install -D @types/pg
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-v3",
-    "version": "3.0.0-alpha.24",
+    "version": "3.0.0-alpha.25",
     "description": "ZenStack",
     "packageManager": "[email protected]",
     "scripts": {

packages/cli/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-alpha.24",
+    "version": "3.0.0-alpha.25",
     "type": "module",
     "author": {
         "name": "ZenStack Team"
@@ -22,7 +22,7 @@
         "zenstack": "bin/cli"
     },
     "scripts": {
-        "build": "tsup-node",
+        "build": "tsc --noEmit && tsup-node",
         "watch": "tsup-node --watch",
         "lint": "eslint src --ext ts",
         "test": "vitest run",

packages/cli/src/actions/migrate.ts

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import { CliError } from '../cli-error';
 import { execPackage } from '../utils/exec-utils';
 import { generateTempPrismaSchema, getSchemaFile } from './action-utils';
 
@@ -21,6 +22,11 @@ type DeployOptions = CommonOptions;
 
 type StatusOptions = CommonOptions;
 
+type ResolveOptions = CommonOptions & {
+    applied?: string;
+    rolledBack?: string;
+};
+
 /**
  * CLI action for migration-related commands
  */
@@ -46,6 +52,10 @@ export async function run(command: string, options: CommonOptions) {
             case 'status':
                 await runStatus(prismaSchemaFile, options as StatusOptions);
                 break;
+
+            case 'resolve':
+                await runResolve(prismaSchemaFile, options as ResolveOptions);
+                break;
         }
     } finally {
         if (fs.existsSync(prismaSchemaFile)) {
@@ -100,6 +110,25 @@ async function runStatus(prismaSchemaFile: string, _options: StatusOptions) {
     }
 }
 
+async function runResolve(prismaSchemaFile: string, options: ResolveOptions) {
+    if (!options.applied && !options.rolledBack) {
+        throw new CliError('Either --applied or --rolled-back option must be provided');
+    }
+
+    try {
+        const cmd = [
+            'prisma migrate resolve',
+            ` --schema "${prismaSchemaFile}"`,
+            options.applied ? ` --applied ${options.applied}` : '',
+            options.rolledBack ? ` --rolled-back ${options.rolledBack}` : '',
+        ].join('');
+
+        await execPackage(cmd);
+    } catch (err) {
+        handleSubProcessError(err);
+    }
+}
+
 function handleSubProcessError(err: unknown) {
     if (err instanceof Error && 'status' in err && typeof err.status === 'number') {
         process.exit(err.status);

packages/cli/src/index.ts

@@ -95,9 +95,18 @@ export function createProgram() {
         .command('status')
         .addOption(schemaOption)
         .addOption(migrationsOption)
-        .description('check the status of your database migrations.')
+        .description('Check the status of your database migrations.')
         .action((options) => migrateAction('status', options));
 
+    migrateCommand
+        .command('resolve')
+        .addOption(schemaOption)
+        .addOption(migrationsOption)
+        .addOption(new Option('--applied <migration>', 'record a specific migration as applied'))
+        .addOption(new Option('--rolled-back <migration>', 'record a specific migration as rolled back'))
+        .description('Resolve issues with database migrations in deployment databases')
+        .action((options) => migrateAction('resolve', options));
+
     const dbCommand = program.command('db').description('Manage your database schema during development.');
 
     dbCommand

packages/cli/test/migrate.test.ts

@@ -38,4 +38,35 @@ describe('CLI migrate commands test', () => {
         runCli('migrate dev --name init', workDir);
         runCli('migrate status', workDir);
     });
+
+    it('supports migrate resolve', () => {
+        const workDir = createProject(model);
+        runCli('migrate dev --name init', workDir);
+
+        // find the migration record "timestamp_init"
+        const migrationRecords = fs.readdirSync(path.join(workDir, 'zenstack/migrations'));
+        const migration = migrationRecords.find((f) => f.endsWith('_init'));
+
+        // force a migration failure
+        fs.writeFileSync(path.join(workDir, 'zenstack/migrations', migration!, 'migration.sql'), 'invalid content');
+
+        // redeploy the migration, which will fail
+        fs.rmSync(path.join(workDir, 'zenstack/dev.db'), { force: true });
+        try {
+            runCli('migrate deploy', workDir);
+        } catch {
+            // noop
+        }
+
+        // --rolled-back
+        runCli(`migrate resolve --rolled-back ${migration}`, workDir);
+
+        // --applied
+        runCli(`migrate resolve --applied ${migration}`, workDir);
+    });
+
+    it('should throw error when neither applied nor rolled-back is provided', () => {
+        const workDir = createProject(model);
+        expect(() => runCli('migrate resolve', workDir)).toThrow();
+    });
 });

packages/cli/tsconfig.json

@@ -1,7 +1,7 @@
 {
     "extends": "@zenstackhq/typescript-config/base.json",
     "compilerOptions": {
-        "outDir": "dist"
+        "baseUrl": "."
     },
     "include": ["src/**/*.ts"]
 }

packages/common-helpers/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@zenstackhq/common-helpers",
-    "version": "3.0.0-alpha.24",
+    "version": "3.0.0-alpha.25",
     "description": "ZenStack Common Helpers",
     "type": "module",
     "scripts": {
-        "build": "tsup-node",
+        "build": "tsc --noEmit && tsup-node",
         "watch": "tsup-node --watch",
         "lint": "eslint src --ext ts",
         "pack": "pnpm pack"

packages/common-helpers/tsconfig.json

@@ -1,7 +1,7 @@
 {
     "extends": "@zenstackhq/typescript-config/base.json",
     "compilerOptions": {
-        "outDir": "dist"
+        "baseUrl": "."
     },
     "include": ["src/**/*.ts"]
 }

packages/create-zenstack/package.json

@@ -1,10 +1,10 @@
 {
     "name": "create-zenstack",
-    "version": "3.0.0-alpha.24",
+    "version": "3.0.0-alpha.25",
     "description": "Create a new ZenStack project",
     "type": "module",
     "scripts": {
-        "build": "tsup-node",
+        "build": "tsc --noEmit && tsup-node",
         "lint": "eslint src --ext ts",
         "pack": "pnpm pack"
     },