feat: allow toggling force deploy migrations

.github/workflows/opengb.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Run Tests
         env:
           VERBOSE: true
-        run: cd tests/basic/ && opengb test || docker ps
+        run: cd tests/basic/ && opengb test --strict-schemas --force-deploy-migrations || docker ps
 
       # Inspect containers running after tests finish
       - name: docker ps

src/build/mod.ts

@@ -35,9 +35,15 @@ export interface BuildOpts {
 	format: Format;
 	runtime: Runtime;
 	dbDriver: DbDriver;
-	autoMigrate: boolean;
+	/** If true, parse TypeScript to generate JSON schemas to be validated at runtime. */
 	strictSchemas: boolean;
+	/** If true, don't run `deno check` on the generated code. */
 	skipDenoCheck: boolean;
+	/** If exists, run database migrations. */
+	migrate?: {
+		/** If true, run migrations automatically without dev mode. */
+		forceDeploy: boolean;
+	};
 	signal?: AbortSignal;
 }
 

src/build/plan/project.ts

@@ -213,50 +213,50 @@ export async function planProjectBuild(
 
 	await waitForBuildPromises(buildState);
 
-	if (opts.autoMigrate) {
+	if (opts.migrate) {
 		// Deploy external migrations in parallel
 		for (const module of project.modules.values()) {
-			if (!module.db || !module.registry.isExternal) continue;
-
-			const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
-			buildStep(buildState, {
-				name: "Migrate Database",
-				module,
-				description: "deploy",
-				condition: {
-					files: migrations,
-				},
-				async build({ signal }) {
-					await migrateDeploy(project, [module], signal);
-				},
-			});
+			if (module.db && (opts.migrate.forceDeploy || module.registry.isExternal)) {
+				const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
+				buildStep(buildState, {
+					name: "Migrate Database",
+					module,
+					description: "deploy",
+					condition: {
+						files: migrations,
+					},
+					async build({ signal }) {
+						await migrateDeploy(project, [module], signal);
+					},
+				});
+			}
 		}
 
 		await waitForBuildPromises(buildState);
 
 		// Deploy dev migrations one at a time
 		for (const module of project.modules.values()) {
-			if (!module.db || module.registry.isExternal) continue;
-
-			const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
-			buildStep(buildState, {
-				name: "Migrate Database",
-				module,
-				description: "develop",
-				condition: {
-					files: [resolve(module.path, "db", "schema.prisma"), ...migrations],
-				},
-				async build({ signal }) {
-					await migrateDev(project, [module], {
-						createOnly: false,
-						// HACK: Disable lock since running this command in watch does not clear the lock correctly
-						disableSchemaLock: true,
-						signal,
-					});
-				},
-			});
+			if (module.db && !opts.migrate.forceDeploy && !module.registry.isExternal) {
+				const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
+				buildStep(buildState, {
+					name: "Migrate Database",
+					module,
+					description: "develop",
+					condition: {
+						files: [resolve(module.path, "db", "schema.prisma"), ...migrations],
+					},
+					async build({ signal }) {
+						await migrateDev(project, [module], {
+							createOnly: false,
+							// HACK: Disable lock since running this command in watch does not clear the lock correctly
+							disableSchemaLock: true,
+							signal,
+						});
+					},
+				});
 
-			await waitForBuildPromises(buildState);
+				await waitForBuildPromises(buildState);
+			}
 		}
 	}
 }

src/cli/commands/build.ts

@@ -66,6 +66,7 @@ export const buildCommand = new Command<GlobalOpts>()
 		"Automatically migrate the database",
 		{ default: false },
 	)
+	.option("--force-deploy-migrations", "Auto deploy migrations without using development prompt", { default: false })
 	.option(
 		"--no-strict-schemas",
 		"Disable strict schema validation",
@@ -111,9 +112,13 @@ export const buildCommand = new Command<GlobalOpts>()
 					format: opts.outputFormat!,
 					runtime: opts.runtime,
 					dbDriver: opts.dbDriver!,
-					autoMigrate: opts.autoMigrate,
 					strictSchemas: opts.strictSchemas,
 					skipDenoCheck: false,
+					migrate: opts.autoMigrate
+						? {
+							forceDeploy: opts.forceDeployMigrations,
+						}
+						: undefined,
 					signal,
 				});
 			},

src/cli/commands/dev.ts

@@ -28,12 +28,12 @@ export const devCommand = new Command<GlobalOpts>()
 							runtime: Runtime.Deno,
 							format: Format.Native,
 							dbDriver: DbDriver.NodePostgres,
-							autoMigrate: true,
 							strictSchemas: opts.strictSchemas,
-
 							// This gets ran on `deno run`
 							skipDenoCheck: true,
-
+							migrate: {
+								forceDeploy: false,
+							},
 							signal,
 						});
 					}

src/cli/commands/test.ts

@@ -14,6 +14,7 @@ export const testCommand = new Command<GlobalOpts>()
 	.option("--no-build", "Don't build source files")
 	.option("--no-check", "Don't check source files before running")
 	.option("--strict-schemas", "Strictly validate schemas", { default: false })
+	.option("--force-deploy-migrations", "Auto deploy migrations without using development prompt", { default: false })
 	.option("--watch", "Automatically rerun tests on changes")
 	.action(
 		async (opts, ...modulesFilter: string[]) => {
@@ -30,12 +31,12 @@ export const testCommand = new Command<GlobalOpts>()
 							runtime: Runtime.Deno,
 							format: Format.Native,
 							dbDriver: DbDriver.NodePostgres,
-							autoMigrate: true,
 							strictSchemas: opts.strictSchemas,
-
 							// This gets ran on `deno test`
 							skipDenoCheck: true,
-
+							migrate: {
+								forceDeploy: opts.forceDeployMigrations,
+							},
 							signal,
 						});
 					}

src/template/template_test.ts

@@ -39,9 +39,8 @@ Deno.test({
 			format: Format.Native,
 			runtime: Runtime.Deno,
 			dbDriver: DbDriver.NodePostgres,
-			autoMigrate: false,
-			skipDenoCheck: false,
 			strictSchemas: true,
+			skipDenoCheck: false,
 		});
 	},
 });