@outloud/adonis-scheduler 1.0.7 → 1.1.1

package/README.md

@@ -1,19 +1,15 @@
-<div align="center">
-  <h2><b>Adonis Scheduler</b></h2>
-  
-  <p>
+# AdonisJS Scheduler
 
-`@outloud/adonis-scheduler` is a cron job scheduler for [AdonisJS](https://adonisjs.com/).
+Cron job scheduler for [AdonisJS](https://adonisjs.com/) 6/7.
 
-  </p>
-</div>
+<p>
 
+[![typescript-image]][typescript-url]
+[![npm-image]][npm-url]
+[![npm-download-image]][npm-download-url]
+[![license-image]][license-url]
 
-<div align="center">
-
-[![npm-image]][npm-url] [![license-image]][license-url]
-
-</div>
+</p>
 
 ---
 ## Features
@@ -60,9 +56,16 @@ export default class TestTask extends Task {
 ### Register a task
 For task to run it must be registered in the scheduler.
 
-> [!NOTE]
-> By default tasks are auto-discovered using the locations defined in config.
+#### Auto-discovery (recommended)
+By default tasks are auto-discovered using the locations defined in `config/scheduler.ts`.
 
+```ts
+const schedulerConfig = defineConfig({
+  locations: ['./app/**/*.task.js'],
+})
+```
+
+#### Manual registration
 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.
@@ -73,7 +76,7 @@ import scheduler from '@outloud/adonis-scheduler/services/main'
 scheduler.register(() => import('../app/tasks/test.task.js'))
 ```
 
-Or using a provider.
+Or in a any provider's `start` method.
 
 ```ts
 import type { ApplicationService } from '@adonisjs/core/types'
@@ -116,6 +119,71 @@ To run it as part of the **HTTP server**, set following env variable:
 SCHEDULER_HTTP_SERVER=true
 ```
 
+You can also create a custom worker command that runs the scheduler. This is useful if you want to add health checks or run other logic with the scheduler.
+
+```ts [commands/worker.ts]
+import { createServer, type Server as HttpServer } from 'node:http'
+import { BaseCommand } from '@adonisjs/core/ace'
+import type { CommandOptions } from '@adonisjs/core/types/ace'
+import { inject } from '@adonisjs/core'
+import { Scheduler } from '@outloud/adonis-scheduler'
+
+export default class extends BaseCommand {
+  static commandName = 'worker'
+  static description = 'Run a worker process.'
+
+  static options: CommandOptions = {
+    startApp: true,
+    staysAlive: true,
+  }
+
+  private server?: HttpServer
+  private scheduler?: Scheduler
+
+  prepare() {
+    this.app.terminating(() => {
+      this.server?.close()
+    })
+    this.app.terminating(() => this.scheduler?.stop())
+  }
+
+  @inject()
+  async run(scheduler: Scheduler): Promise<void> {
+    this.scheduler = scheduler
+
+    await Promise.all([
+      this.startServer(),
+      this.scheduler.start(true),
+    ])
+  }
+
+  private async startServer() {
+    const server = await this.makeServer()
+    await server.boot()
+
+    const httpServer = createServer(server.handle.bind(server))
+    server.setNodeServer(httpServer)
+    this.server = httpServer
+
+    const host = process.env.HOST || '0.0.0.0'
+    const port = Number(process.env.PORT || 3000)
+
+    httpServer.once('listening', () => this.logger.info(`listening to http server, host: ${host}, port: ${port}`))
+
+    return httpServer.listen(port, host)
+  }
+
+  private async makeServer() {
+    const server = await this.app.container.make('server')
+    const router = server.getRouter()
+    
+    router.get('/health', () => ({ status: 'ok' }))
+
+    return server
+  }
+}
+```
+
 ## Locking
 
 > [!NOTE]
@@ -162,20 +230,37 @@ export default class TestTask extends Task {
 
 It's possible to globally handle errors for all your tasks or define custom error handler for each task.
 
+### Global error handler
+
 To register global error handler, you can use the `onError` method of the scheduler service. You can define it in `start/scheduler.ts` preloaded file.
 This handler will run only if custom error handler is not defined in the task itself.
 
 ```ts
 import logger from '@adonisjs/core/services/logger'
 import scheduler from '@outloud/adonis-scheduler/services/main'
-import { Sentry } from '@rlanz/sentry'
 
 scheduler.onError((error, task) => {
   logger.error(error)
-  Sentry.captureException(error)
 })
 ```
 
+Or you can listen to `scheduler:error` event using emitter.
+
+```ts
+import emitter from '@adonisjs/core/services/emitter'
+import logger from '@adonisjs/core/services/logger'
+
+emitter.on('scheduler:error', ({ error, task }) => {
+  logger.error(error)
+})
+```
+
+> [!WARNING]
+> When you register global error handler, the package will not throw any errors and it's your responsibility to log or handle them in the handler.
+> If you don't register global error handler, the package will throw error and exit.
+
+### Task-level error handler
+
 Custom error handler can be defined in the task itself by implementing `onError` method.
 
 ```ts
@@ -188,8 +273,14 @@ export default class TestTask extends Task {
 }
 ```
 
-[npm-image]: https://img.shields.io/npm/v/@outloud/adonis-scheduler.svg?style=for-the-badge&logo=**npm**
+[npm-image]: https://badgen.net/npm/v/@outloud/adonis-scheduler/latest
 [npm-url]: https://npmjs.org/package/@outloud/adonis-scheduler "npm"
 
-[license-image]: https://img.shields.io/npm/l/@outloud/adonis-scheduler?color=blueviolet&style=for-the-badge
-[license-url]: LICENSE "license"
+[npm-download-image]: https://badgen.net/npm/dm/@outloud/adonis-scheduler
+[npm-download-url]: https://npmcharts.com/compare/@outloud/adonis-scheduler?minimal=true "downloads"
+
+[typescript-image]: https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white
+[typescript-url]: https://www.typescriptlang.org "TypeScript"
+
+[license-image]: https://img.shields.io/npm/l/@outloud/adonis-scheduler.svg?sanitize=true
+[license-url]: LICENSE.md "license"

package/build/_virtual/_@oxc-project_runtime@0.114.0/helpers/decorate.js

@@ -0,0 +1,10 @@
+//#region \0@oxc-project+runtime@0.114.0/helpers/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+//#endregion
+export { __decorate };

package/build/_virtual/_@oxc-project_runtime@0.114.0/helpers/decorateMetadata.js

@@ -0,0 +1,7 @@
+//#region \0@oxc-project+runtime@0.114.0/helpers/decorateMetadata.js
+function __decorateMetadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+
+//#endregion
+export { __decorateMetadata };

package/build/commands/make_task.d.ts

@@ -1,18 +1,19 @@
-import { BaseCommand } from '@adonisjs/core/ace';
-import { CommandOptions } from '@adonisjs/core/types/ace';
+import { BaseCommand } from "@adonisjs/core/ace";
+import { CommandOptions } from "@adonisjs/core/types/ace";
 
+//#region commands/make_task.d.ts
 declare class MakeTask extends BaseCommand {
-    static commandName: string;
-    static description: string;
-    static options: CommandOptions;
-    /**
-     * The name of the job file.
-     */
-    name: string;
-    /**
-     * Execute command
-     */
-    run(): Promise<void>;
+  static commandName: string;
+  static description: string;
+  static options: CommandOptions;
+  /**
+   * The name of the job file.
+   */
+  name: string;
+  /**
+   * Execute command
+   */
+  run(): Promise<void>;
 }
-
-export { MakeTask as default };
+//#endregion
+export { MakeTask as default };

package/build/commands/make_task.js

@@ -1,42 +1,20 @@
-import { __name } from '../chunk-SHUYVCID.js';
-import 'reflect-metadata';
-import { BaseCommand, args } from '@adonisjs/core/ace';
+import { __decorateMetadata } from "../_virtual/_@oxc-project_runtime@0.114.0/helpers/decorateMetadata.js";
+import { __decorate } from "../_virtual/_@oxc-project_runtime@0.114.0/helpers/decorate.js";
+import { BaseCommand, args } from "@adonisjs/core/ace";
 
-function _ts_decorate(decorators, target, key, desc) {
-  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-  return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-__name(_ts_decorate, "_ts_decorate");
-function _ts_metadata(k, v) {
-  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-__name(_ts_metadata, "_ts_metadata");
+//#region commands/make_task.ts
 var MakeTask = class extends BaseCommand {
-  static {
-    __name(this, "MakeTask");
-  }
-  static commandName = "make:task";
-  static description = "Make a new task class";
-  static options = {
-    allowUnknownFlags: true
-  };
-  /**
-  * Execute command
-  */
-  async run() {
-    const codemods = await this.createCodemods();
-    await codemods.makeUsingStub(import.meta.dirname + "/../stubs", "command/task.stub", {
-      entity: this.app.generators.createEntity(this.name)
-    });
-  }
+	static commandName = "make:task";
+	static description = "Make a new task class";
+	static options = { allowUnknownFlags: true };
+	/**
+	* Execute command
+	*/
+	async run() {
+		await (await this.createCodemods()).makeUsingStub(import.meta.dirname + "/../stubs", "command/task.stub", { entity: this.app.generators.createEntity(this.name) });
+	}
 };
-_ts_decorate([
-  args.string({
-    description: "Name of the task"
-  }),
-  _ts_metadata("design:type", String)
-], MakeTask.prototype, "name", void 0);
+__decorate([args.string({ description: "Name of the task" }), __decorateMetadata("design:type", String)], MakeTask.prototype, "name", void 0);
 
-export { MakeTask as default };
+//#endregion
+export { MakeTask as default };

package/build/commands/scheduler_run.d.ts

@@ -1,19 +1,15 @@
-import { BaseCommand } from '@adonisjs/core/ace';
-import { CommandOptions } from '@adonisjs/core/types/ace';
-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';
+import { Scheduler } from "../src/scheduler.js";
+import { BaseCommand } from "@adonisjs/core/ace";
+import { CommandOptions } from "@adonisjs/core/types/ace";
 
+//#region commands/scheduler_run.d.ts
 declare class SchedulerRun extends BaseCommand {
-    static commandName: string;
-    static description: string;
-    static options: CommandOptions;
-    private scheduler?;
-    prepare(): void;
-    run(scheduler: Scheduler): Promise<void>;
+  static commandName: string;
+  static description: string;
+  static options: CommandOptions;
+  private scheduler?;
+  prepare(): void;
+  run(scheduler: Scheduler): Promise<void>;
 }
-
-export { SchedulerRun as default };
+//#endregion
+export { SchedulerRun as default };

package/build/commands/scheduler_run.js

@@ -1,47 +1,33 @@
-import { Scheduler } from '../chunk-6VW5PUDE.js';
-import '../chunk-OIXFFNQU.js';
-import { __name } from '../chunk-SHUYVCID.js';
-import 'reflect-metadata';
-import { inject } from '@adonisjs/core';
-import { BaseCommand } from '@adonisjs/core/ace';
+import { __decorateMetadata } from "../_virtual/_@oxc-project_runtime@0.114.0/helpers/decorateMetadata.js";
+import { __decorate } from "../_virtual/_@oxc-project_runtime@0.114.0/helpers/decorate.js";
+import { Scheduler } from "../src/scheduler.js";
+import { BaseCommand } from "@adonisjs/core/ace";
+import { inject } from "@adonisjs/core";
 
-function _ts_decorate(decorators, target, key, desc) {
-  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-  return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-__name(_ts_decorate, "_ts_decorate");
-function _ts_metadata(k, v) {
-  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-__name(_ts_metadata, "_ts_metadata");
+//#region commands/scheduler_run.ts
+var _ref;
 var SchedulerRun = class extends BaseCommand {
-  static {
-    __name(this, "SchedulerRun");
-  }
-  static commandName = "scheduler:run";
-  static description = "Run a scheduler";
-  static options = {
-    startApp: true,
-    staysAlive: true
-  };
-  scheduler;
-  prepare() {
-    this.app.terminating(() => this.scheduler?.stop());
-  }
-  async run(scheduler) {
-    this.scheduler = scheduler;
-    await this.scheduler.start(true);
-  }
+	static commandName = "scheduler:run";
+	static description = "Run a scheduler";
+	static options = {
+		startApp: true,
+		staysAlive: true
+	};
+	scheduler;
+	prepare() {
+		this.app.terminating(() => this.scheduler?.stop());
+	}
+	async run(scheduler) {
+		this.scheduler = scheduler;
+		await this.scheduler.start(true);
+	}
 };
-_ts_decorate([
-  inject(),
-  _ts_metadata("design:type", Function),
-  _ts_metadata("design:paramtypes", [
-    typeof Scheduler === "undefined" ? Object : Scheduler
-  ]),
-  _ts_metadata("design:returntype", Promise)
+__decorate([
+	inject(),
+	__decorateMetadata("design:type", Function),
+	__decorateMetadata("design:paramtypes", [typeof (_ref = typeof Scheduler !== "undefined" && Scheduler) === "function" ? _ref : Object]),
+	__decorateMetadata("design:returntype", Promise)
 ], SchedulerRun.prototype, "run", null);
 
-export { SchedulerRun as default };
+//#endregion
+export { SchedulerRun as default };

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

@@ -1,26 +1,23 @@
-import { ApplicationService } from '@adonisjs/core/types';
-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';
+import { SchedulerEvents } from "../src/types.js";
+import { Scheduler } from "../src/scheduler.js";
+import { ApplicationService } from "@adonisjs/core/types";
 
+//#region providers/scheduler.provider.d.ts
 declare class SchedulerProvider {
-    protected app: ApplicationService;
-    private scheduler?;
-    constructor(app: ApplicationService);
-    private getConfig;
-    private getLocks;
-    register(): void;
-    ready(): Promise<void>;
-    shutdown(): Promise<void>;
+  protected app: ApplicationService;
+  private scheduler?;
+  constructor(app: ApplicationService);
+  private getConfig;
+  private getLocks;
+  register(): void;
+  ready(): Promise<void>;
+  shutdown(): Promise<void>;
 }
 declare module '@adonisjs/core/types' {
-    interface ContainerBindings {
-        scheduler: Scheduler;
-    }
-    interface EventsList extends SchedulerEvents {
-    }
+  interface ContainerBindings {
+    scheduler: Scheduler;
+  }
+  interface EventsList extends SchedulerEvents {}
 }
-
-export { SchedulerProvider as default };
+//#endregion
+export { SchedulerProvider as default };

package/build/providers/scheduler.provider.js

@@ -1,41 +1,34 @@
-import { Scheduler } from '../chunk-6VW5PUDE.js';
-import '../chunk-OIXFFNQU.js';
-import { __name } from '../chunk-SHUYVCID.js';
+import { Scheduler } from "../src/scheduler.js";
 
-// providers/scheduler.provider.ts
+//#region providers/scheduler.provider.ts
 var SchedulerProvider = class {
-  static {
-    __name(this, "SchedulerProvider");
-  }
-  app;
-  scheduler;
-  constructor(app) {
-    this.app = app;
-  }
-  getConfig() {
-    return this.app.config.get("scheduler", {});
-  }
-  async getLocks() {
-    if (this.app.container.hasBinding("lock.manager")) {
-      return await this.app.container.make("lock.manager");
-    }
-  }
-  register() {
-    this.app.container.singleton(Scheduler, async () => {
-      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);
-  }
-  async ready() {
-    const config = this.getConfig();
-    if (this.app.getEnvironment() === "web" && config.httpServer) {
-      this.scheduler = await this.app.container.make(Scheduler);
-      await this.scheduler.start();
-    }
-  }
-  async shutdown() {
-    await this.scheduler?.stop();
-  }
+	scheduler;
+	constructor(app) {
+		this.app = app;
+	}
+	getConfig() {
+		return this.app.config.get("scheduler", {});
+	}
+	async getLocks() {
+		if (this.app.container.hasBinding("lock.manager")) return await this.app.container.make("lock.manager");
+	}
+	register() {
+		this.app.container.singleton(Scheduler, async () => {
+			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);
+	}
+	async ready() {
+		const config = this.getConfig();
+		if (this.app.getEnvironment() === "web" && config.httpServer) {
+			this.scheduler = await this.app.container.make(Scheduler);
+			await this.scheduler.start();
+		}
+	}
+	async shutdown() {
+		await this.scheduler?.stop();
+	}
 };
 
-export { SchedulerProvider as default };
+//#endregion
+export { SchedulerProvider as default };

package/build/services/main.d.ts

@@ -1,10 +1,6 @@
-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';
+import { Scheduler } from "../src/scheduler.js";
 
+//#region services/main.d.ts
 declare let scheduler: Scheduler;
-
-export { scheduler as default };
+//#endregion
+export { scheduler as default };

package/build/services/main.js

@@ -1,9 +1,10 @@
-import '../chunk-SHUYVCID.js';
-import app from '@adonisjs/core/services/app';
+import app from "@adonisjs/core/services/app";
 
-var scheduler;
+//#region services/main.ts
+let scheduler;
 await app?.booted(async () => {
-  scheduler = await app.container.make("scheduler");
+	scheduler = await app.container.make("scheduler");
 });
 
-export { scheduler as default };
+//#endregion
+export { scheduler as default };

package/build/src/command.task.js

@@ -0,0 +1,18 @@
+import { Task } from "./task.js";
+import ace from "@adonisjs/core/services/ace";
+
+//#region src/command.task.ts
+var CommandTask = class extends Task {
+	static command = [];
+	get name() {
+		return this.constructor.command.join(",");
+	}
+	async run() {
+		const [name, ...args] = this.constructor.command;
+		if (!name) throw new Error("No command name provided.");
+		await ace.exec(name, args);
+	}
+};
+
+//#endregion
+export { CommandTask };

package/build/src/config.d.ts

@@ -0,0 +1,6 @@
+import { SchedulerConfig } from "./types.js";
+
+//#region src/config.d.ts
+declare function defineConfig<T extends SchedulerConfig>(config: T): T;
+//#endregion
+export { defineConfig };

package/build/src/config.js

@@ -0,0 +1,7 @@
+//#region src/config.ts
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+export { defineConfig };

package/build/src/configure.d.ts

@@ -0,0 +1,6 @@
+import Configure from "@adonisjs/core/commands/configure";
+
+//#region src/configure.d.ts
+declare function configure(command: Configure): Promise<void>;
+//#endregion
+export { configure };

package/build/src/configure.js

@@ -0,0 +1,15 @@
+import path from "node:path";
+
+//#region src/configure.ts
+async function configure(command) {
+	const codemods = await command.createCodemods();
+	await codemods.makeUsingStub(path.resolve(import.meta.dirname, "..", "stubs"), "config/scheduler.stub", {});
+	await codemods.defineEnvVariables({ SCHEDULER_HTTP_SERVER: false });
+	await codemods.defineEnvValidations({ variables: { SCHEDULER_HTTP_SERVER: `Env.schema.boolean.optional()` } });
+	await codemods.updateRcFile((rcFile) => {
+		rcFile.addProvider("@outloud/adonis-scheduler/provider").addCommand("@outloud/adonis-scheduler/commands");
+	});
+}
+
+//#endregion
+export { configure };

package/build/src/helpers.js

@@ -0,0 +1,9 @@
+import timers from "node:timers/promises";
+
+//#region src/helpers.ts
+async function waitUntil(callback, interval = 50) {
+	while (!callback()) await timers.setTimeout(interval);
+}
+
+//#endregion
+export { waitUntil };

package/build/src/index.d.ts

@@ -0,0 +1,6 @@
+import { SchedulerConfig, TaskOptions } from "./types.js";
+import { Task } from "./task.js";
+import { Scheduler } from "./scheduler.js";
+import { configure } from "./configure.js";
+import { defineConfig } from "./config.js";
+export { Scheduler, type SchedulerConfig, Task, type TaskOptions, configure, defineConfig };

package/build/src/index.js

@@ -0,0 +1,6 @@
+import { Task } from "./task.js";
+import { Scheduler } from "./scheduler.js";
+import { configure } from "./configure.js";
+import { defineConfig } from "./config.js";
+
+export { Scheduler, Task, configure, defineConfig };