@athenna/cron 5.0.0 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/cron",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "Athenna scheduler application. Built on top of node-cron.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -57,7 +57,7 @@
     "node-cron": "^3.0.3"
   },
   "devDependencies": {
-    "@athenna/artisan": "^5.0.0",
+    "@athenna/artisan": "^5.1.0",
     "@athenna/common": "^5.0.0",
     "@athenna/config": "^5.0.0",
     "@athenna/ioc": "^5.0.0",

package/src/cron/CronImpl.d.ts

@@ -51,6 +51,15 @@ export declare class CronImpl {
      * ```
      */
     getTasks(): Map<string, ScheduledTask>;
+    /**
+     * Run a scheduler by its name.
+     *
+     * @example
+     * ```ts
+     * await Cron.runByName('MySchedulerClassName')
+     * ```
+     */
+    runByName(name: string): Promise<void>;
     /**
      * Close all scheduled tasks.
      *

package/src/cron/CronImpl.js

@@ -8,6 +8,7 @@
  */
 import { getTasks, validate } from 'node-cron';
 import { CronBuilder } from '#src/cron/CronBuilder';
+import { NotFoundTaskNameException } from '#src/exceptions/NotFoundTaskNameException';
 export class CronImpl {
     /**
      * Creates a new instance of CronBuilder to register
@@ -60,6 +61,23 @@ export class CronImpl {
     getTasks() {
         return getTasks();
     }
+    /**
+     * Run a scheduler by its name.
+     *
+     * @example
+     * ```ts
+     * await Cron.runByName('MySchedulerClassName')
+     * ```
+     */
+    async runByName(name) {
+        const task = this.getTasks()?.get(name);
+        if (!task) {
+            throw new NotFoundTaskNameException(name);
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        await task._task._execution();
+    }
     /**
      * Close all scheduled tasks.
      *

package/src/exceptions/NotFoundTaskNameException.d.ts

@@ -0,0 +1,4 @@
+import { Exception } from '@athenna/common';
+export declare class NotFoundTaskNameException extends Exception {
+    constructor(name: string);
+}

package/src/exceptions/NotFoundTaskNameException.js

@@ -0,0 +1,10 @@
+import { Exception } from '@athenna/common';
+export class NotFoundTaskNameException extends Exception {
+    constructor(name) {
+        const status = 500;
+        const help = `You need to define a scheduler with name ({yellow} "${name}") in your route file or set the name in your scheduler annotation.`;
+        const code = 'E_NOT_FOUND_TASK';
+        const message = `The scheduler with name ({yellow} "${name}") does not exist.`;
+        super({ code, help, status, message });
+    }
+}

package/src/testing/plugins/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @athenna/cron
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { TestScheduler } from '#src/testing/plugins/scheduler/TestScheduler';
+declare module '@japa/runner/core' {
+    interface TestContext {
+        scheduler: TestScheduler;
+    }
+}
+export * from '#src/testing/plugins/scheduler/TestScheduler';
+/**
+ * Scheduler plugin registers the scheduler macro to the test context.
+ */
+export declare function scheduler(): () => void;

package/src/testing/plugins/index.js

@@ -0,0 +1,19 @@
+/**
+ * @athenna/cron
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { TestContext } from '@japa/runner/core';
+import { TestScheduler } from '#src/testing/plugins/scheduler/TestScheduler';
+export * from '#src/testing/plugins/scheduler/TestScheduler';
+/**
+ * Scheduler plugin registers the scheduler macro to the test context.
+ */
+export function scheduler() {
+    return function () {
+        TestContext.macro('scheduler', new TestScheduler());
+    };
+}

package/src/testing/plugins/scheduler/TestScheduler.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @athenna/cron
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export declare class TestScheduler {
+    /**
+     * Run a specific scheduler by its name.
+     *
+     * @example
+     * ```js
+     * await scheduler.runByName('MySchedulerClassName')
+     * ```
+     */
+    runByName(name: string): Promise<void>;
+}

package/src/testing/plugins/scheduler/TestScheduler.js

@@ -0,0 +1,22 @@
+/**
+ * @athenna/cron
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Cron } from '@athenna/cron';
+export class TestScheduler {
+    /**
+     * Run a specific scheduler by its name.
+     *
+     * @example
+     * ```js
+     * await scheduler.runByName('MySchedulerClassName')
+     * ```
+     */
+    async runByName(name) {
+        await Cron.runByName(name);
+    }
+}