@outloud/adonis-scheduler 1.0.5 → 1.0.7

package/README.md

@@ -23,6 +23,7 @@
 - Cancellation support for long-running tasks.
 - Graceful shutdown.
 - Global and task-level error handling.
+- Auto-discovery of tasks.
 
 ## Getting Started
 
@@ -57,8 +58,12 @@ export default class TestTask extends Task {
 ```
 
 ### Register a task
+For task to run it must be registered in the scheduler.
 
-For task to run it must be registered in the scheduler. You can register tasks in two ways: using the `start/scheduler.ts` preloaded file or in a provider's `start` method.
+> [!NOTE]
+> By default tasks are auto-discovered using the locations defined in config.
+
+If you want to register tasks manually, you can register tasks in two ways: using the `start/scheduler.ts` preloaded file or in a provider's `start` method.
 
 Using `start/scheduler.ts` file.
 

package/build/{chunk-BBI2I5B5.js → chunk-6VW5PUDE.js}

@@ -1,4 +1,7 @@
+import { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
+import { glob } from 'fs/promises';
+import { resolve } from 'path';
 import { Cron } from 'croner';
 import timers from 'timers/promises';
 
@@ -17,14 +20,16 @@ var Scheduler = class {
   config;
   resolver;
   logger;
+  emitter;
   locks;
   definitions = [];
   state = "created";
   errorHandler;
-  constructor(config, resolver, logger, locks) {
+  constructor(config, resolver, logger, emitter, locks) {
     this.config = config;
     this.resolver = resolver;
     this.logger = logger;
+    this.emitter = emitter;
     this.locks = locks;
   }
   register(options) {
@@ -38,15 +43,18 @@ var Scheduler = class {
         options.command
       ];
       Object.assign(definition, options);
-      definition.loader = () => import('./command.task-GUNK3QFY.js').then((module) => {
+      definition.loader = () => import('./command.task-GALKWNLQ.js').then((module) => {
         return class extends module.CommandTask {
           static command = command;
         };
       });
+    } else if (Task.isTask(options)) {
+      definition.task = options;
+      Object.assign(definition, options.options ?? {});
     } else {
       definition.loader = options;
     }
-    if (!definition.loader) {
+    if (!definition.task && !definition.loader) {
       throw new Error("Task definition must have either a command or a task defined.");
     }
     this.definitions.push(definition);
@@ -67,6 +75,9 @@ var Scheduler = class {
       return;
     }
     this.setState("starting");
+    if (this.config.locations) {
+      await Promise.all(this.config.locations.map((location) => this.registerFromGlob(location)));
+    }
     await Promise.all(this.definitions.map((definition) => this.schedule(definition)));
     if (!this.definitions.length) {
       this.logger.warn("No tasks registered, scheduler will not run any jobs.");
@@ -92,6 +103,20 @@ var Scheduler = class {
     this.errorHandler = callback;
     return this;
   }
+  async registerFromGlob(pattern) {
+    const normalizedPattern = pattern.replace(/\.(?:js|ts)$/, ".{js,ts}");
+    for await (const file of glob(normalizedPattern)) {
+      try {
+        const absolutePath = resolve(file);
+        const module = await import(`file://${absolutePath}`);
+        if (Task.isTask(module.default)) {
+          this.register(module.default);
+        }
+      } catch (error) {
+        console.warn(`Failed to load task from ${file}:`, error);
+      }
+    }
+  }
   async load(definition) {
     if (definition.loader) {
       const module = await definition.loader();
@@ -145,15 +170,15 @@ var Scheduler = class {
     this.logger.info(`Scheduler: ${state}`);
   }
   async handleError(error, _, task) {
-    if (task && task.onError) {
-      await task.onError(error);
-      return;
-    }
-    if (this.errorHandler) {
-      await this.errorHandler(error, task);
-      return;
+    await task.onError?.(error);
+    this.emitter.emit("scheduler:error", {
+      error,
+      task
+    });
+    await this.errorHandler?.(error, task);
+    if (!this.emitter.hasListeners("scheduler:error") && !this.errorHandler) {
+      throw error;
     }
-    throw error;
   }
   async cancel(job) {
     await job.$cancel();

package/build/{chunk-7P6J5U6O.js → chunk-OIXFFNQU.js}

@@ -1,13 +1,16 @@
 import { __name } from './chunk-SHUYVCID.js';
 
 // src/task.ts
-var Task = class {
+var Task = class _Task {
   static {
     __name(this, "Task");
   }
   isCanceled = false;
   promise;
   static options;
+  static isTask(obj) {
+    return typeof obj === "function" && obj.prototype instanceof _Task;
+  }
   // eslint-disable-next-line @typescript-eslint/no-useless-constructor
   constructor(..._) {
   }

package/build/{command.task-GUNK3QFY.js → command.task-GALKWNLQ.js}

@@ -1,4 +1,4 @@
-import { Task } from './chunk-7P6J5U6O.js';
+import { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
 import ace from '@adonisjs/core/services/ace';
 

package/build/commands/scheduler_run.d.ts

@@ -1,10 +1,11 @@
 import { BaseCommand } from '@adonisjs/core/ace';
 import { CommandOptions } from '@adonisjs/core/types/ace';
-import { a as Scheduler } from '../scheduler-BWT0Iqko.js';
+import { a as Scheduler } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';
 import '@adonisjs/lock/types';
 import '@adonisjs/core/logger';
+import '@adonisjs/core/events';
 
 declare class SchedulerRun extends BaseCommand {
     static commandName: string;

package/build/commands/scheduler_run.js

@@ -1,4 +1,5 @@
-import { Scheduler } from '../chunk-BBI2I5B5.js';
+import { Scheduler } from '../chunk-6VW5PUDE.js';
+import '../chunk-OIXFFNQU.js';
 import { __name } from '../chunk-SHUYVCID.js';
 import 'reflect-metadata';
 import { inject } from '@adonisjs/core';

package/build/index.d.ts

@@ -1,10 +1,11 @@
-import { S as SchedulerConfig } from './scheduler-BWT0Iqko.js';
-export { a as Scheduler, T as Task, b as TaskOptions } from './scheduler-BWT0Iqko.js';
+import { S as SchedulerConfig } from './scheduler-vBDqaysB.js';
+export { a as Scheduler, T as Task, b as TaskOptions } from './scheduler-vBDqaysB.js';
 import Configure from '@adonisjs/core/commands/configure';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';
 import '@adonisjs/lock/types';
 import '@adonisjs/core/logger';
+import '@adonisjs/core/events';
 
 declare function configure(command: Configure): Promise<void>;
 

package/build/index.js

@@ -1,5 +1,5 @@
-export { Scheduler } from './chunk-BBI2I5B5.js';
-export { Task } from './chunk-7P6J5U6O.js';
+export { Scheduler } from './chunk-6VW5PUDE.js';
+export { Task } from './chunk-OIXFFNQU.js';
 import { __name } from './chunk-SHUYVCID.js';
 
 // configure.ts

package/build/providers/scheduler.provider.d.ts

@@ -1,8 +1,9 @@
 import { ApplicationService } from '@adonisjs/core/types';
-import { a as Scheduler } from '../scheduler-BWT0Iqko.js';
+import { a as Scheduler, c as SchedulerEvents } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/lock/types';
 import '@adonisjs/core/logger';
+import '@adonisjs/core/events';
 
 declare class SchedulerProvider {
     protected app: ApplicationService;
@@ -18,6 +19,8 @@ declare module '@adonisjs/core/types' {
     interface ContainerBindings {
         scheduler: Scheduler;
     }
+    interface EventsList extends SchedulerEvents {
+    }
 }
 
 export { SchedulerProvider as default };

package/build/providers/scheduler.provider.js

@@ -1,4 +1,5 @@
-import { Scheduler } from '../chunk-BBI2I5B5.js';
+import { Scheduler } from '../chunk-6VW5PUDE.js';
+import '../chunk-OIXFFNQU.js';
 import { __name } from '../chunk-SHUYVCID.js';
 
 // providers/scheduler.provider.ts
@@ -21,7 +22,7 @@ var SchedulerProvider = class {
   }
   register() {
     this.app.container.singleton(Scheduler, async () => {
-      return new Scheduler(this.getConfig(), this.app.container.createResolver(), await this.app.container.make("logger"), await this.getLocks());
+      return new Scheduler(this.getConfig(), this.app.container.createResolver(), await this.app.container.make("logger"), await this.app.container.make("emitter"), await this.getLocks());
     });
     this.app.container.alias("scheduler", Scheduler);
   }

package/build/{scheduler-BWT0Iqko.d.ts → scheduler-vBDqaysB.d.ts}

@@ -2,6 +2,7 @@ import { ContainerResolver } from '@adonisjs/core/container';
 import { ContainerBindings } from '@adonisjs/core/types';
 import { LockService } from '@adonisjs/lock/types';
 import { Logger } from '@adonisjs/core/logger';
+import { Emitter } from '@adonisjs/core/events';
 
 interface SchedulerConfig {
     /**
@@ -16,6 +17,8 @@ interface SchedulerConfig {
      * The default ttl for the lock.
      */
     lockDuration: number | string;
+    /** Locations for task auto-discovery */
+    locations?: string[];
 }
 interface TaskOptions {
     /**
@@ -45,6 +48,12 @@ interface TaskRegisterOptions extends TaskOptions {
     command: string | string[];
 }
 type ErrorHandler = (error: Error, task: Task) => (void | Promise<void>);
+interface SchedulerEvents {
+    'scheduler:error': {
+        error: Error;
+        task: Task;
+    };
+}
 type MaybePromise<T> = T | Promise<T>;
 type Factory<T> = () => MaybePromise<{
     default: T;
@@ -54,6 +63,7 @@ declare abstract class Task {
     isCanceled: boolean;
     promise?: Promise<any>;
     static options: TaskOptions;
+    static isTask(obj: unknown): obj is typeof Task;
     constructor(..._: any[]);
     get name(): string;
     abstract run(...args: any[]): Promise<void>;
@@ -68,15 +78,17 @@ declare class Scheduler {
     private config;
     private resolver;
     private logger;
+    private emitter;
     private locks?;
     private definitions;
     private state;
     private errorHandler?;
-    constructor(config: SchedulerConfig, resolver: ContainerResolver<ContainerBindings>, logger: Logger, locks?: LockService | undefined);
-    register(options: TaskRegisterOptions | Factory<typeof Task>): this;
+    constructor(config: SchedulerConfig, resolver: ContainerResolver<ContainerBindings>, logger: Logger, emitter: Emitter<any>, locks?: LockService | undefined);
+    register(options: TaskRegisterOptions | typeof Task | Factory<typeof Task>): this;
     start(wait?: boolean): Promise<void>;
     stop(): Promise<void>;
     onError(callback: ErrorHandler): this;
+    private registerFromGlob;
     private load;
     private make;
     private run;
@@ -88,4 +100,4 @@ declare class Scheduler {
     private schedule;
 }
 
-export { type SchedulerConfig as S, Task as T, Scheduler as a, type TaskOptions as b };
+export { type SchedulerConfig as S, Task as T, Scheduler as a, type TaskOptions as b, type SchedulerEvents as c };

package/build/services/main.d.ts

@@ -1,8 +1,9 @@
-import { a as Scheduler } from '../scheduler-BWT0Iqko.js';
+import { a as Scheduler } from '../scheduler-vBDqaysB.js';
 import '@adonisjs/core/container';
 import '@adonisjs/core/types';
 import '@adonisjs/lock/types';
 import '@adonisjs/core/logger';
+import '@adonisjs/core/events';
 
 declare let scheduler: Scheduler;
 

package/build/stubs/config/scheduler.stub

@@ -9,6 +9,7 @@ const schedulerConfig = defineConfig({
   httpServer: env.get('SCHEDULER_HTTP_SERVER', false),
   warnWhenLocked: false,
   lockDuration: '10m',
+  locations: ['./app/**/*.task.js'],
 })
 
 export default schedulerConfig

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outloud/adonis-scheduler",
   "type": "module",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Schedule cron jobs in AdonisJS.",
   "author": "Outloud <hello@outloud.co>",
   "contributors": [
@@ -66,7 +66,6 @@
     "postcompile": "pnpm run copy:templates && pnpm run index:commands",
     "build": "rm -rf build && pnpm run compile",
     "release": "release-it",
-    "index:commands": "adonis-kit index build/commands",
-    "version": "pnpm run build"
+    "index:commands": "adonis-kit index build/commands"
   }
 }