@tsed/agenda 8.29.0 → 8.30.0

package/lib/esm/decorators/{agenda.js → jobController.js}

@@ -6,7 +6,3 @@ export function JobsController(options) {
         type: PROVIDER_TYPE_AGENDA
     }));
 }
-/**
- * @deprecated Use `JobsController` instead.
- */
-export const Agenda = JobsController;

package/lib/esm/index.js

@@ -2,9 +2,9 @@
  * @file Automatically generated by @tsed/barrels.
  */
 export * from "./constants/constants.js";
-export * from "./decorators/agenda.js";
 export * from "./decorators/define.js";
 export * from "./decorators/every.js";
+export * from "./decorators/jobController.js";
 export * from "./interfaces/AgendaStore.js";
 export * from "./interfaces/interfaces.js";
 export * from "./services/AgendaService.js";

package/lib/esm/services/AgendaService.js

@@ -4,7 +4,11 @@ import { Agenda } from "agenda";
 import { v4 as uuid } from "uuid";
 import { PROVIDER_TYPE_AGENDA } from "../constants/constants.js";
 function getOpts() {
-    return constant("agenda", { enabled: false });
+    return constant("agenda", false);
+}
+function getEnabledAgendaOptions(settings) {
+    const { enabled, disableJobProcessing, drainJobsBeforeClose, ...agendaOptions } = settings;
+    return agendaOptions;
 }
 function addAgendaDefinitionsForProvider(agenda, provider) {
     const store = provider.store.get("agenda", {});
@@ -13,9 +17,11 @@ function addAgendaDefinitionsForProvider(agenda, provider) {
     }
     Object.entries(store.define).forEach(([propertyKey, { name, ...options }]) => {
         const instance = injector().get(provider.token);
-        const jobProcessor = instance[propertyKey].bind(instance);
+        const jobProcessor = async (job) => {
+            return Promise.resolve(instance[propertyKey].call(instance, job));
+        };
         const jobName = getNameForJob(propertyKey, store.namespace, name);
-        agenda.define(jobName, options, jobProcessor);
+        agenda.define(jobName, jobProcessor, options);
     });
 }
 async function scheduleJobsForProvider(agenda, provider) {
@@ -35,7 +41,7 @@ function getNameForJob(propertyKey, namespace, customName) {
 }
 async function afterListen(agenda) {
     const opts = getOpts();
-    if (opts.enabled) {
+    if (opts && opts.enabled) {
         const providers = injector().getProviders(PROVIDER_TYPE_AGENDA);
         if (!opts.disableJobProcessing) {
             logger().info({
@@ -58,7 +64,7 @@ async function afterListen(agenda) {
 }
 async function onDestroy(agenda) {
     const opts = getOpts();
-    if (opts.enabled) {
+    if (opts && opts.enabled) {
         if (opts.drainJobsBeforeClose && "drain" in agenda) {
             logger().info({
                 event: "AGENDA_DRAIN",
@@ -73,15 +79,14 @@ async function onDestroy(agenda) {
             });
             await agenda.stop();
         }
-        await agenda.close({ force: true });
         logger().info({ event: "AGENDA_STOP", message: "Agenda stopped" });
     }
 }
 export const AgendaService = injectable(Agenda)
     .factory(() => {
     const opts = getOpts();
-    if (opts.enabled) {
-        const agenda = new Agenda(opts);
+    if (opts && opts.enabled) {
+        const agenda = new Agenda(getEnabledAgendaOptions(opts));
         return new Proxy(agenda, {
             set(target, prop, value) {
                 return Reflect.set(target, prop, value);
@@ -94,14 +99,14 @@ export const AgendaService = injectable(Agenda)
                     return Reflect.get(target, "define", target);
                 }
                 if (prop === "define") {
-                    return (name, options, processor) => {
-                        return target["define"](name, options, (job) => {
+                    return (name, processor, options) => {
+                        return target["define"](name, async (job) => {
                             const $ctx = new DIContext({
                                 id: uuid()
                             });
                             $ctx.set("job", job);
-                            return runInContext($ctx, () => processor(job));
-                        });
+                            return Promise.resolve(runInContext($ctx, () => processor(job)));
+                        }, options);
                     };
                 }
                 return Reflect.get(target, prop, target);
@@ -115,7 +120,3 @@ export const AgendaService = injectable(Agenda)
     $onDestroy: onDestroy
 })
     .token();
-/**
- * @deprecated Use `Agenda` from `agenda` instead.
- */
-export const AgendaModule = Agenda;

package/lib/types/decorators/{agenda.d.ts → jobController.d.ts}

@@ -2,8 +2,4 @@ interface AgendaOptions {
     namespace?: string;
 }
 export declare function JobsController(options?: AgendaOptions): any;
-/**
- * @deprecated Use `JobsController` instead.
- */
-export declare const Agenda: typeof JobsController;
 export {};

package/lib/types/index.d.ts

@@ -2,9 +2,9 @@
  * @file Automatically generated by @tsed/barrels.
  */
 export * from "./constants/constants.js";
-export * from "./decorators/agenda.js";
 export * from "./decorators/define.js";
 export * from "./decorators/every.js";
+export * from "./decorators/jobController.js";
 export * from "./interfaces/AgendaStore.js";
 export * from "./interfaces/interfaces.js";
 export * from "./services/AgendaService.js";

package/lib/types/interfaces/AgendaStore.d.ts

@@ -1,8 +1,16 @@
-import { DefineOptions as AgendaDefineOptions, JobOptions } from "agenda";
-export interface DefineOptions extends AgendaDefineOptions {
+import { type JobDefinition } from "agenda";
+type AgendaJobOptions = {
+    timezone?: string;
+    skipImmediate?: boolean;
+    forkMode?: boolean;
+    startDate?: Date | string;
+    endDate?: Date | string;
+    skipDays?: number[];
+};
+export interface DefineOptions extends Partial<Pick<JobDefinition, "lockLimit" | "lockLifetime" | "concurrency" | "backoff" | "removeOnComplete" | "logging" | "priority">> {
     name?: string;
 }
-export type EveryOptions = JobOptions & DefineOptions;
+export type EveryOptions = AgendaJobOptions & DefineOptions;
 export interface AgendaStore {
     namespace?: string;
     define?: {
@@ -14,3 +22,4 @@ export interface AgendaStore {
         };
     };
 }
+export {};

package/lib/types/interfaces/interfaces.d.ts

@@ -1,9 +1,13 @@
-import { AgendaConfig } from "agenda";
-export type AgendaSettings = AgendaConfig & {
-    enabled?: boolean;
+import { type AgendaOptions } from "agenda";
+type CommonSettings = {
     disableJobProcessing?: boolean;
     drainJobsBeforeClose?: boolean;
-};
+} & AgendaOptions;
+export type AgendaSettings = ({
+    enabled: false;
+} & Partial<CommonSettings>) | ({
+    enabled?: true;
+} & CommonSettings);
 declare global {
     namespace TsED {
         interface Configuration {
@@ -11,3 +15,4 @@ declare global {
         }
     }
 }
+export {};

package/lib/types/services/AgendaService.d.ts

@@ -6,8 +6,3 @@ export declare const AgendaService: {
  * @deprecated Use `Agenda` from `agenda` instead.
  */
 export type AgendaService = Agenda;
-/**
- * @deprecated Use `Agenda` from `agenda` instead.
- */
-export declare const AgendaModule: typeof Agenda;
-export type AgendaModule = Agenda;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/agenda",
   "description": "Agenda package for Ts.ED framework",
   "type": "module",
-  "version": "8.29.0",
+  "version": "8.30.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -26,18 +26,21 @@
     "tslib": ">=2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.29.0",
-    "@tsed/core": "8.29.0",
-    "@tsed/di": "8.29.0",
-    "@tsed/platform-http": "8.29.0",
-    "@tsed/typescript": "8.29.0",
-    "agenda": "^5.0.0",
+    "@agendajs/mongo-backend": "^4.0.2",
+    "@tsed/barrels": "8.30.0",
+    "@tsed/core": "8.30.0",
+    "@tsed/di": "8.30.0",
+    "@tsed/platform-http": "8.30.0",
+    "@tsed/testcontainers-mongo": "8.30.0",
+    "@tsed/typescript": "8.30.0",
+    "agenda": "^6.2.5",
     "eslint": "9.12.0",
+    "mongodb": "^6.21.0",
     "typescript": "6.0.2",
     "vitest": "4.1.4"
   },
   "peerDependencies": {
-    "agenda": ">=4"
+    "agenda": "^6.2.5"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/readme.md

@@ -32,7 +32,7 @@ A package of Ts.ED framework. See website: https://tsed.dev
 
 ## Feature
 
-Currently, `@tsed/agenda` allows you to decorate classes with `@Agenda` and
+Currently, `@tsed/agenda` allows you to decorate classes with `@JobsController` and
 corresponding methods to have them picked up by the Agenda library to be
 scheduled automatically (`@Every`) or programmatically (`@Define`) via the AgendaService.
 
@@ -43,8 +43,37 @@ For more information about Agenda look at the documentation [here](https://githu
 To begin, install the Agenda module for Ts.ED:
 
 ```bash
-npm install --save @tsed/agenda
-npm install --save agenda
+npm install --save @tsed/agenda agenda @agendajs/mongo-backend
+```
+
+## Migration note
+
+`@tsed/agenda` now targets Agenda v6.
+
+- `agenda.backend` is required when the module is enabled
+- top-level `db`, `mongo`, and `repository` configuration are no longer supported
+- `ensureIndex` and `sort` move into `new MongoBackend(...)`
+- sort directions use `"asc"` / `"desc"` instead of `1` / `-1`
+- `@Agenda()` has been removed in favor of `@JobsController()`
+- `AgendaModule` has been removed; inject `Agenda` from `agenda`
+
+```diff
+ import {Configuration} from "@tsed/di";
+ import "@tsed/agenda";
++import {MongoBackend} from "@agendajs/mongo-backend";
+
+ @Configuration({
+   agenda: {
+     enabled: true,
+-    db: {
+-      address: mongoConnectionString
+-    }
++    backend: new MongoBackend({
++      address: mongoConnectionString
++    })
+   }
+ })
+ export class Server {}
 ```
 
 ## Configure your server
@@ -54,18 +83,23 @@ Import `@tsed/agenda` in your Server:
 ```typescript
 import {Configuration} from "@tsed/di";
 import "@tsed/agenda"; // import agenda ts.ed module
+import {MongoBackend} from "@agendajs/mongo-backend";
 
 const mongoConnectionString = "mongodb://127.0.0.1/agenda";
 
 @Configuration({
   agenda: {
     enabled: true, // Enable Agenda jobs for this instance.
-    // drainJobsBeforeStop: true, // Wait for jobs to finish before stopping the agenda process.
+    // drainJobsBeforeClose: true, // Wait for jobs to finish before stopping the agenda process.
     // disableJobProcessing: true, // Prevents jobs from being processed.
-    // pass any options that you would normally pass to new Agenda(), e.g.
-    db: {
-      address: mongoConnectionString
-    }
+    backend: new MongoBackend({
+      address: mongoConnectionString,
+      ensureIndex: true,
+      sort: {
+        nextRunAt: "asc",
+        priority: "desc"
+      }
+    })
   }
 })
 export class Server {}
@@ -73,7 +107,7 @@ export class Server {}
 
 ## Create a new Service
 
-Decorate the class with `@Agenda`. The `namespace` option is optional and will
+Decorate the class with `@JobsController`. The `namespace` option is optional and will
 prefix the job name with `namespace.`
 
 Use the `@Every` decorator to define a cron-like job that gets automatically
@@ -83,6 +117,22 @@ method name is used as job name.
 Use the `@Define` decorator on methods that you would like to schedule
 programmatically via the AgendaService and Agenda instance access.
 
+### Migration note for decorators and injection
+
+```diff
+-import {Agenda, AgendaModule, Define, Every} from "@tsed/agenda";
++import {Define, Every, JobsController} from "@tsed/agenda";
++import {Agenda} from "agenda";
+
+-@Agenda({namespace: "email"})
++@JobsController({namespace: "email"})
+ export class EmailJobService {
+   @Inject()
+-  agenda: AgendaModule;
++  agenda: Agenda;
+ }
+```
+
 ```ts
 import {Every, Define, JobsController} from "@tsed/agenda";
 import {Job} from "agenda";
@@ -114,8 +164,8 @@ export class EmailJobService {
 
 ## Define a job processor manually
 
-Since Ts.ED 7.53.0, AgendaModule exposes methods to manually define a job processor. It can be useful to define a job
-processor when you need to fetch data beforehand and dynamically build job name / options.
+Inject `Agenda` from `agenda` to manually define a job processor. It can be useful when you need to fetch data
+beforehand and dynamically build job name / options.
 
 ```typescript
 import {Define, JobsController} from "@tsed/agenda";
@@ -162,12 +212,11 @@ export class EmailJobService {
 
 ## Inject Agenda
 
-Inject the AgendaService instance to interact with it directly, e.g. to schedule
+Inject the Agenda instance to interact with it directly, e.g. to schedule
 a job manually.
 
 ```ts
 import {Service} from "@tsed/di";
-import {AfterRoutesInit} from "@tsed/platform-params";
 import {Agenda} from "agenda";
 
 @Service()
@@ -200,7 +249,7 @@ This is an optional feature and is not required to use agenda.
 Install the additional dependency.
 
 ```shell
-npm install --save agendash
+npm install --save agendash agenda @agendajs/mongo-backend
 ```
 
 Afterward create the module `agendash.module.ts` in src/modules so that the dashboard can be exposed using middleware.
@@ -209,7 +258,7 @@ Afterward create the module `agendash.module.ts` in src/modules so that the dash
 import {AfterRoutesInit, PlatformApplication} from "@tsed/platform-http";
 import {Configuration, Inject, Module} from "@tsed/di";
 import {Agenda} from "agenda";
-import Agendash from "agendash";
+import {expressMiddleware} from "agendash";
 
 @Module()
 export class AgendashModule implements AfterRoutesInit {
@@ -224,7 +273,7 @@ export class AgendashModule implements AfterRoutesInit {
 
   $afterRoutesInit() {
     if (this.config.agenda?.enabled) {
-      this.app.use("/agendash", Agendash(this.agenda));
+      this.app.use("/agendash", expressMiddleware(this.agenda));
     }
   }
 }
@@ -249,7 +298,7 @@ website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
 
 The MIT License (MIT)
 
-Copyright (c) 2016 - 2021 Romain Lenzotti
+Copyright (c) 2016 - Today Romain Lenzotti
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation the