Merge pull request #157 from AthennaIO/develop

feat(task): add addPromise method to Task

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/artisan",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "description": "The Athenna CLI application. Built on top of commander and inspired in @adonisjs/ace.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",

src/helpers/Task.ts

@@ -47,6 +47,39 @@ export class Task {
     return this
   }
 
+  /**
+   * Same as add but automatically handle the callback
+   * depending on the promise result.
+   *
+   * @example
+   * ```ts
+   * await this.logger
+   *    .task()
+   *    .addPromise('hello', async () => {
+   *      await Exec.sleep(1000)
+   *    })
+   *    .run()
+   * ```
+   * Output:
+   * ```bash
+   * → hello 1005ms
+   * ```
+   */
+  public addPromise(title: string, cb: () => Promise<any>): Task {
+    this.tasks.push({
+      title,
+      cb: async task =>
+        await cb()
+          .then(() => task.complete())
+          .catch(error => {
+            task.fail()
+            throw error
+          })
+    })
+
+    return this
+  }
+
   /**
    * Run all the tasks added.
    *

tests/unit/helpers/TaskTest.ts

@@ -10,6 +10,7 @@
 import { Task } from '#src/helpers/Task'
 import { Test, BeforeEach, type Context } from '@athenna/test'
 import { RunningTaskException } from '#src/exceptions/RunningTaskException'
+import { Exec } from '@athenna/common'
 
 export default class TaskTest {
   @BeforeEach()
@@ -43,6 +44,45 @@ export default class TaskTest {
     assert.equal(value, 'hello')
   }
 
+  @Test()
+  public async shouldBeAbleToCreateTasksRunnerUsingPromises({ assert }: Context) {
+    let value = 'hello'
+    Config.set('logging.channels.console.driver', 'null')
+
+    await new Task()
+      .addPromise('Testing 1', async () => {
+        await Exec.sleep(100)
+      })
+      .addPromise('Testing 2', async () => {
+        await Exec.sleep(100)
+      })
+      .addPromise('Testing 3', async () => {
+        value = null
+        await Exec.sleep(100)
+      })
+      .run()
+
+    assert.equal(value, null)
+  }
+
+  @Test()
+  public async shouldThrowIfPromiseDoesNotResolveWhenUsingAddPromise({ assert }: Context) {
+    Config.set('logging.channels.console.driver', 'null')
+
+    const task = new Task()
+      .addPromise('Testing 1', async () => {
+        await Exec.sleep(100)
+      })
+      .addPromise('Testing 2', async () => {
+        await Exec.sleep(100)
+      })
+      .addPromise('Testing 3', async () => {
+        throw new Error('Error')
+      })
+
+    await assert.rejects(() => task.run(), Error)
+  }
+
   @Test()
   public async shouldThrowRunningTaskExceptionIfExecutingCallbackAfterEndingTheTaskWithFail({ assert }: Context) {
     Config.set('logging.channels.console.driver', 'null')