refactor(project): Use cleanup hooks in update builds

Author: RandomByte

packages/project/lib/build/ProjectBuilder.js

@@ -181,7 +181,6 @@ class ProjectBuilder {
 		}
 
 		const projectBuildContexts = await this._createRequiredBuildContexts(requestedProjects);
-		const cleanupSigHooks = this._registerCleanupSigHooks();
 		let fsTarget;
 		if (destPath) {
 			fsTarget = resourceFactory.createAdapter({
@@ -191,7 +190,6 @@ class ProjectBuilder {
 		}
 
 		const queue = [];
-		const alreadyBuilt = [];
 
 		// Create build queue based on graph depth-first search to ensure correct build order
 		await this._graph.traverseDepthFirst(async ({project}) => {
@@ -202,15 +200,38 @@ class ProjectBuilder {
 				//	=> This project needs to be built or, in case it has already
 				//		been built, it's build result needs to be written out (if requested)
 				queue.push(projectBuildContext);
-				if (!await projectBuildContext.requiresBuild()) {
-					alreadyBuilt.push(projectName);
-				}
 			}
 		});
 
+		if (destPath && cleanDest) {
+			this.#log.info(`Cleaning target directory...`);
+			await rmrf(destPath);
+		}
+
+		await this.#build(queue, projectBuildContexts, requestedProjects, fsTarget);
+
+		if (watch) {
+			const relevantProjects = queue.map((projectBuildContext) => {
+				return projectBuildContext.getProject();
+			});
+			return this._buildContext.initWatchHandler(relevantProjects, async () => {
+				await this.#updateBuild(projectBuildContexts, requestedProjects, fsTarget);
+			});
+		}
+	}
+
+	async #build(queue, projectBuildContexts, requestedProjects, fsTarget) {
 		this.#log.setProjects(queue.map((projectBuildContext) => {
 			return projectBuildContext.getProject().getName();
 		}));
+
+		const alreadyBuilt = [];
+		for (const projectBuildContext of queue) {
+			if (!await projectBuildContext.requiresBuild()) {
+				const projectName = projectBuildContext.getProject().getName();
+				alreadyBuilt.push(projectName);
+			}
+		}
 		if (queue.length > 1) { // Do not log if only the root project is being built
 			this.#log.info(`Processing ${queue.length} projects`);
 			if (alreadyBuilt.length) {
@@ -240,13 +261,9 @@ class ProjectBuilder {
 					.join("\n    ")}`);
 			}
 		}
-
-		if (destPath && cleanDest) {
-			this.#log.info(`Cleaning target directory...`);
-			await rmrf(destPath);
-		}
-		const startTime = process.hrtime();
+		const cleanupSigHooks = this._registerCleanupSigHooks();
 		try {
+			const startTime = process.hrtime();
 			const pWrites = [];
 			for (const projectBuildContext of queue) {
 				const project = projectBuildContext.getProject();
@@ -285,21 +302,26 @@ class ProjectBuilder {
 			await Promise.all(pWrites);
 			this.#log.info(`Build succeeded in ${this._getElapsedTime(startTime)}`);
 		} catch (err) {
-			this.#log.error(`Build failed in ${this._getElapsedTime(startTime)}`);
+			this.#log.error(`Build failed`);
 			throw err;
 		} finally {
 			this._deregisterCleanupSigHooks(cleanupSigHooks);
 			await this._executeCleanupTasks();
 		}
+	}
 
-		if (watch) {
-			const relevantProjects = queue.map((projectBuildContext) => {
-				return projectBuildContext.getProject();
-			});
-			const watchHandler = this._buildContext.initWatchHandler(relevantProjects, async () => {
-				await this.#update(projectBuildContexts, requestedProjects, fsTarget);
-			});
-			return watchHandler;
+	async #updateBuild(projectBuildContexts, requestedProjects, fsTarget) {
+		const cleanupSigHooks = this._registerCleanupSigHooks();
+		try {
+			const startTime = process.hrtime();
+			await this.#update(projectBuildContexts, requestedProjects, fsTarget);
+			this.#log.info(`Update succeeded in ${this._getElapsedTime(startTime)}`);
+		} catch (err) {
+			this.#log.error(`Update failed`);
+			this.#log.error(err);
+		} finally {
+			this._deregisterCleanupSigHooks(cleanupSigHooks);
+			await this._executeCleanupTasks();
 		}
 	}
 

packages/project/lib/build/TaskRunner.js

@@ -205,8 +205,9 @@ class TaskRunner {
 				}
 				const usingCache = supportsDifferentialUpdates && cacheInfo;
 
-				this._log.info(
-					`Executing task ${taskName} for project ${this._project.getName()}`);
+				this._log.verbose(
+					`Executing task ${taskName} for project ${this._project.getName()}` +
+						(usingCache ? ` (using differential update)` : ""));
 				const workspace = createMonitor(this._project.getWorkspace());
 				const params = {
 					workspace,
@@ -220,9 +221,6 @@ class TaskRunner {
 					params.dependencies = dependencies;
 				}
 				if (usingCache) {
-					this._log.info(
-						`Using differential update for task ${taskName} of project ${this._project.getName()}`);
-					// workspace =
 					params.changedProjectResourcePaths = Array.from(cacheInfo.changedProjectResourcePaths);
 					if (requiresDependencies) {
 						params.changedDependencyResourcePaths = Array.from(cacheInfo.changedDependencyResourcePaths);

packages/project/lib/build/cache/CacheManager.js

@@ -129,7 +129,10 @@ export default class CacheManager {
 				// Cache miss
 				return null;
 			}
-			throw err;
+			throw new Error(`Failed to read build manifest for ` +
+				`${projectId} / ${buildSignature}: ${err.message}`, {
+				cause: err,
+			});
 		}
 	}
 
@@ -183,7 +186,10 @@ export default class CacheManager {
 				// Cache miss
 				return null;
 			}
-			throw err;
+			throw new Error(`Failed to read resource index cache for ` +
+				`${projectId} / ${buildSignature}: ${err.message}`, {
+				cause: err,
+			});
 		}
 	}
 
@@ -243,7 +249,10 @@ export default class CacheManager {
 				// Cache miss
 				return null;
 			}
-			throw err;
+			throw new Error(`Failed to read stage metadata from cache for ` +
+				`${projectId} / ${buildSignature} / ${stageId} / ${stageSignature}: ${err.message}`, {
+				cause: err,
+			});
 		}
 	}
 
@@ -302,7 +311,10 @@ export default class CacheManager {
 				// Cache miss
 				return null;
 			}
-			throw err;
+			throw new Error(`Failed to read task metadata from cache for ` +
+				`${projectId} / ${buildSignature} / ${taskName}: ${err.message}`, {
+				cause: err,
+			});
 		}
 	}