✨ Make TaskSchedules#startFromMenu() return the started instance

Author: skerit

CHANGELOG.md

@@ -4,6 +4,7 @@
 * Add `Model#beforeCommit(document, options)` support
 * Add `castToBigInt` and `convertBigIntForDatasource` to `Datasource` class
 * Add `LocalDateTime`, `LocalDate` and `LocalTime` fields
+* Make `TaskSchedules#startFromMenu()` return the started instance
 
 ## 1.3.19 (2023-10-18)
 

lib/class/task_service.js

@@ -526,12 +526,15 @@ class TaskSchedules {
 	 *
 	 * @author   Jelle De Loecker   <jelle@elevenways.be>
 	 * @since    1.3.17
-	 * @version  1.3.17
+	 * @version  1.3.20
 	 */
-	#startFromMenu(task_record) {
+	async #startFromMenu(task_record) {
 		console.log('Manually starting', task_record.type, 'task:', task_record);
 		let schedule = new TaskSchedule(this, null, task_record.settings, task_record);
-		schedule.startManually();
+		let task_instance = await schedule.startManually();
+		console.log(' -- Started:', task_instance);
+
+		return task_instance;
 	}
 
 	/**
@@ -579,6 +582,7 @@ class TaskSchedule {
 	janeway_menu_item = null;
 
 	#change_counter = 0;
+	#instance_pledge = null;
 
 	/**
 	 * Initialize the instance
@@ -845,18 +849,30 @@ class TaskSchedule {
 	 *
 	 * @author   Jelle De Loecker   <jelle@elevenways.be>
 	 * @since    1.3.17
-	 * @version  1.3.17
+	 * @version  1.3.20
+	 *
+	 * @return   {Task}
 	 */
 	async startManually() {
-		return this.#run(true);
+
+		if (this.is_running) {
+			return false;
+		}
+
+		let pledge = new Pledge();
+		this.#instance_pledge = pledge;
+
+		this.#run(true);
+
+		return pledge;
 	}
 
 	/**
 	 * Actually run the task
 	 *
 	 * @author   Jelle De Loecker   <jelle@elevenways.be>
 	 * @since    1.3.17
-	 * @version  1.3.17
+	 * @version  1.3.20
 	 */
 	async #run(started_manually = false) {
 
@@ -889,6 +905,12 @@ class TaskSchedule {
 			if (started_manually || await this.ownsScheduledTask()) {
 				let instance = this.createInstance();
 				this.task_instance = instance;
+
+				if (this.#instance_pledge) {
+					this.#instance_pledge.resolve(instance);
+					this.#instance_pledge = null;
+				}
+
 				await instance.start();
 			}
 		} catch (err) {