[FEATURE] TaskUtil: Add 'force' flag to cleanup task callback (#677)

JIRA: CPOUI5FOUNDATION-751 \@ui5/builder PR that depends on this change: SAP/ui5-builder#953 When cleaning up after tasks run, it can happen in couple cases: - When the project is build - When there's a SIGTERM signal - (Maybe) on some error We need to be able to distinguish between those cases as in some places we rely on graceful termination and cleanup. Especially, after the project has been build successfully. On the other hand when the user presses `Ctrl + C`, for example, we need to enforce the termination. This cahnge provides this context. --------- Co-authored-by: Merlin Beutlberger <[email protected]> Co-authored-by: Günter Klatt <[email protected]>
SAP · Nov 15, 2023 · a0a21b7 · a0a21b7
1 parent 7824bef
commit a0a21b7
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 10 deletions.
diff --git a/lib/build/ProjectBuilder.js b/lib/build/ProjectBuilder.js
@@ -388,17 +388,18 @@ class ProjectBuilder {
 		}));
 	}
 
-	async _executeCleanupTasks() {
+	async _executeCleanupTasks(force) {
 		this.#log.info("Executing cleanup tasks...");
-		await this._buildContext.executeCleanupTasks();
+
+		await this._buildContext.executeCleanupTasks(force);
 	}
 
 	_registerCleanupSigHooks() {
 		const that = this;
 		function createListener(exitCode) {
 			return function() {
 				// Asynchronously cleanup resources, then exit
-				that._executeCleanupTasks().then(() => {
+				that._executeCleanupTasks(true).then(() => {
 					process.exit(exitCode);
 				});
 			};

diff --git a/lib/build/helpers/BuildContext.js b/lib/build/helpers/BuildContext.js
@@ -80,9 +80,9 @@ class BuildContext {
 		return projectBuildContext;
 	}
 
-	async executeCleanupTasks() {
+	async executeCleanupTasks(force = false) {
 		await Promise.all(this._projectBuildContexts.map((ctx) => {
-			return ctx.executeCleanupTasks();
+			return ctx.executeCleanupTasks(force);
 		}));
 	}
 }

diff --git a/lib/build/helpers/ProjectBuildContext.js b/lib/build/helpers/ProjectBuildContext.js
@@ -47,9 +47,9 @@ class ProjectBuildContext {
 		this._queues.cleanup.push(callback);
 	}
 
-	async executeCleanupTasks() {
+	async executeCleanupTasks(force) {
 		await Promise.all(this._queues.cleanup.map((callback) => {
-			return callback();
+			return callback(force);
 		}));
 	}
 

diff --git a/lib/build/helpers/TaskUtil.js b/lib/build/helpers/TaskUtil.js
@@ -163,6 +163,16 @@ class TaskUtil {
 		return this._projectBuildContext.getOption(key);
 	}
 
+	/**
+	 * Callback that is executed once the build has finished
+	 *
+	 * @public
+	 * @callback @ui5/project/build/helpers/TaskUtil~cleanupTaskCallback
+	 * @param {boolean} force Whether the cleanup callback should
+	 * 							gracefully wait for certain jobs to be completed (<code>false</code>)
+	 * 							or enforce immediate termination (<code>true</code>)
+	 */
+
 	/**
 	 * Register a function that must be executed once the build is finished. This can be used to, for example,
 	 * clean up files temporarily created on the file system. If the callback returns a Promise, it will be waited for.
@@ -172,7 +182,8 @@ class TaskUtil {
 	 * This method is only available to custom task extensions defining
 	 * <b>Specification Version 2.2 and above</b>.
 	 *
-	 * @param {Function} callback Callback to register. If it returns a Promise, it will be waited for
+	 * @param {@ui5/project/build/helpers/TaskUtil~cleanupTaskCallback} callback Callback to
+	 * 									register; it will be waited for if it returns a Promise
 	 * @public
 	 */
 	registerCleanupTask(callback) {

diff --git a/test/lib/build/ProjectBuilder.js b/test/lib/build/ProjectBuilder.js
@@ -727,8 +727,16 @@ test("_executeCleanupTasks", async (t) => {
 	const executeCleanupTasksStub = sinon.stub(builder._buildContext, "executeCleanupTasks");
 	await builder._executeCleanupTasks();
 	t.is(executeCleanupTasksStub.callCount, 1, "BuildContext#executeCleanupTasks got called once");
-	t.deepEqual(executeCleanupTasksStub.getCall(0).args, [],
-		"BuildContext#executeCleanupTasks got called with no arguments");
+	t.deepEqual(executeCleanupTasksStub.getCall(0).args, [undefined],
+		"BuildContext#executeCleanupTasks got called with correct arguments");
+
+	// reset stub
+	executeCleanupTasksStub.reset();
+	// Call with enforcement flag
+	await builder._executeCleanupTasks(true);
+	t.is(executeCleanupTasksStub.callCount, 1, "BuildContext#executeCleanupTasks got called once");
+	t.deepEqual(executeCleanupTasksStub.getCall(0).args, [true],
+		"BuildContext#executeCleanupTasks got called with correct arguments");
 });
 
 test("instantiate new logger for every ProjectBuilder", async (t) => {

diff --git a/test/lib/build/helpers/BuildContext.js b/test/lib/build/helpers/BuildContext.js
@@ -203,4 +203,15 @@ test("executeCleanupTasks", async (t) => {
 
 	t.is(executeCleanupTasks.callCount, 2,
 		"Project context executeCleanupTasks got called twice");
+	t.is(executeCleanupTasks.getCall(0).firstArg, false,
+		"Project context executeCleanupTasks got called with expected arguments");
+
+
+	executeCleanupTasks.reset();
+	await buildContext.executeCleanupTasks(true);
+
+	t.is(executeCleanupTasks.callCount, 2,
+		"Project context executeCleanupTasks got called twice");
+	t.is(executeCleanupTasks.getCall(0).firstArg, true,
+		"Project context executeCleanupTasks got called with expected arguments");
 });