chore: update build step description to specify module & script (#226)

rivet-gg · Mar 13, 2024 · e8e5989 · e8e5989
1 parent 2c9d6a5
commit e8e5989
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 10 deletions.
diff --git a/src/build/plan/module.ts b/src/build/plan/module.ts
@@ -12,7 +12,7 @@ export async function planModuleBuild(
 ) {
 	buildStep(buildState, {
 		name: "Parse",
-		description: `modules/${module.name}/config.ts`,
+		description: `config.ts`,
 		module,
 		condition: {
 			// TODO: use tjs.getProgramFiles() to get the dependent files?
@@ -41,7 +41,7 @@ export async function planModuleBuild(
 
 	buildStep(buildState, {
 		name: "Generate",
-		description: `modules/${module.name}/_gen/registry.d.ts`,
+		description: `_gen/registry.d.ts`,
 		module,
 		condition: {
 			files: [resolve(module.path, "module.yaml")],
@@ -53,7 +53,7 @@ export async function planModuleBuild(
 
 	buildStep(buildState, {
 		name: "Generate",
-		description: `modules/${module.name}/_gen/mod.ts`,
+		description: `_gen/mod.ts`,
 		module,
 		condition: {
 			files: [resolve(module.path, "module.yaml")],
@@ -65,7 +65,7 @@ export async function planModuleBuild(
 
 	buildStep(buildState, {
 		name: "Generate",
-		description: `modules/${module.name}/_gen/test.ts`,
+		description: `_gen/test.ts`,
 		module,
 		condition: {
 			files: [resolve(module.path, "module.yaml")],

diff --git a/src/build/plan/project.ts b/src/build/plan/project.ts
@@ -27,7 +27,7 @@ export async function planProjectBuild(
 		if (module.db) {
 			buildStep(buildState, {
 				name: "Generate",
-				description: `modules/${module.name}/_gen/prisma/`,
+				description: `_gen/prisma/`,
 				module,
 				condition: {
 					files: [resolve(module.path, "db", "schema.prisma")],
@@ -220,7 +220,8 @@ export async function planProjectBuild(
 
 			const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
 			buildStep(buildState, {
-				name: "Database Deploy",
+				name: "Migrate Database",
+				description: "deploy",
 				condition: {
 					files: migrations,
 				},
@@ -238,7 +239,8 @@ export async function planProjectBuild(
 
 			const migrations = await glob.glob(resolve(module.path, "db", "migrations", "*", "*.sql"));
 			buildStep(buildState, {
-				name: "Database Dev",
+				name: "Migrate Database",
+				description: "develop",
 				condition: {
 					files: [resolve(module.path, "db", "schema.prisma"), ...migrations],
 				},

diff --git a/src/build/plan/script.ts b/src/build/plan/script.ts
@@ -12,7 +12,7 @@ export async function planScriptBuild(
 ) {
 	buildStep(buildState, {
 		name: "Parse",
-		description: `modules/${module.name}/scripts/${script.name}.ts`,
+		description: `${script.name}.ts`,
 		module,
 		script,
 		condition: {
@@ -57,7 +57,7 @@ export async function planScriptBuild(
 
 	buildStep(buildState, {
 		name: "Generate",
-		description: `modules/${module.name}/_gen/scripts/${script.name}.ts`,
+		description: `_gen/scripts/${script.name}.ts`,
 		module,
 		script,
 		condition: {

diff --git a/src/build_state/mod.ts b/src/build_state/mod.ts
@@ -149,7 +149,16 @@ export function buildStep(
 }
 
 function logBuildStepStart(opts: BuildStepOpts) {
-	progress(opts.name, opts.description);
+	let description = opts.description;
+	if (opts.module && opts.script) {
+		if (description) description += ` (${opts.module.name}.${opts.script.name})`;
+		else description = `${opts.module.name}.${opts.script.name}`;
+	} else if (opts.module) {
+		if (description) description += ` (${opts.module.name})`;
+		else description = opts.module.name;
+	}
+
+	progress(opts.name, description);
 }
 
 export async function waitForBuildPromises(buildState: BuildState): Promise<void> {

diff --git a/tests/basic/modules/foo/db/migrations/20240312203025_init/migration.sql b/tests/basic/modules/foo/db/migrations/20240312203025_init/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "DbEntry" ADD COLUMN     "test2" TEXT;
diff --git a/tests/basic/modules/foo/db/schema.prisma b/tests/basic/modules/foo/db/schema.prisma
@@ -5,4 +5,5 @@ datasource db {
 
 model DbEntry {
     id         String     @id @default(uuid()) @db.Uuid
+    test2 String?
 }