@tsed/agenda 7.73.1 → 7.73.3

package/src/AgendaModule.spec.ts

@@ -1,220 +0,0 @@
-import {PlatformTest} from "@tsed/common";
-import {Inject} from "@tsed/di";
-import {Job} from "agenda";
-import {AgendaModule} from "./AgendaModule.js";
-import {Agenda} from "./decorators/agenda.js";
-import {Define} from "./decorators/define.js";
-import {Every} from "./decorators/every.js";
-
-jest.mock("agenda", () => {
-  return {
-    Agenda: class {
-      close = jest.fn();
-      stop = jest.fn();
-      drain = jest.fn();
-      define = jest.fn();
-      every = jest.fn();
-      schedule = jest.fn();
-      now = jest.fn();
-      create = jest.fn().mockReturnValue({
-        repeatEvery: jest.fn().mockReturnThis(),
-        save: jest.fn()
-      });
-      start = jest.fn();
-    }
-  };
-});
-
-@Agenda({namespace: "test-nsp"})
-class CustomCampaign {
-  @Inject()
-  agenda: AgendaModule;
-
-  job: Job;
-
-  $beforeAgendaStart() {
-    this.job = this.agenda.create("customName2", {
-      locale: "fr-FR"
-    });
-  }
-
-  $afterAgendaStart() {
-    return this.job.repeatEvery("1 week").save();
-  }
-
-  @Every("60 seconds")
-  test(job: Job) {
-    // test
-    return "hello " + job.attrs.name;
-  }
-
-  @Define({name: "customName"})
-  test2(job: Job) {
-    // test
-    return "hello " + job.attrs.name;
-  }
-
-  @Define({name: "customName2"})
-  test3() {
-    // test
-  }
-}
-
-@Agenda({namespace: "test-nsp-2"})
-class CustomCampaign2 {
-  @Define({name: "customName"})
-  test(job: Job) {
-    // test
-    return "hello " + job.attrs.name;
-  }
-}
-
-@Agenda({namespace: "test-nsp-3"})
-class CustomCampaign3 {}
-
-describe("AgendaModule", () => {
-  describe("when agenda is enabled", () => {
-    beforeEach(() =>
-      PlatformTest.create({
-        agenda: {
-          enabled: true
-        }
-      })
-    );
-    afterEach(() => PlatformTest.reset());
-
-    describe("$afterListen()", () => {
-      it("should load all jobs", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-        const campaign = PlatformTest.get<CustomCampaign>(CustomCampaign)!;
-
-        await agendaModule.$afterListen();
-
-        expect(agendaModule.agenda.define).toHaveBeenCalledWith("test-nsp.test", {}, expect.any(Function));
-        expect(agendaModule.agenda.every).toHaveBeenCalledWith("60 seconds", "test-nsp.test", {}, {});
-        expect(agendaModule.agenda.start).toHaveBeenCalledWith();
-        expect(agendaModule.agenda.create).toHaveBeenCalledWith("customName2", {locale: "fr-FR"});
-
-        expect(campaign.job.repeatEvery).toHaveBeenCalledWith("1 week");
-        expect(campaign.job.save).toHaveBeenCalledWith();
-
-        const result = await agendaModule.agenda.define.mock.calls[0][2]({
-          attrs: {
-            name: "test-nsp.test"
-          }
-        });
-
-        expect(result).toEqual("hello test-nsp.test");
-      });
-    });
-    describe("schedule()", () => {
-      it("should schedule a job", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-
-        await agendaModule.schedule("now", "test-nsp.test", {});
-
-        expect(agendaModule.agenda.schedule).toHaveBeenCalledWith("now", "test-nsp.test", {});
-      });
-    });
-
-    describe("now()", () => {
-      it("should schedule a job", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-
-        await agendaModule.now("test-nsp.test", {});
-
-        expect(agendaModule.agenda.now).toHaveBeenCalledWith("test-nsp.test", {});
-      });
-    });
-    describe("$onDestroy()", () => {
-      it("should close agenda", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-
-        await agendaModule.$onDestroy();
-
-        expect(agendaModule.agenda.stop).toHaveBeenCalledWith();
-        expect(agendaModule.agenda.close).toHaveBeenCalledWith({force: true});
-      });
-    });
-  });
-  describe("when agenda is enabled and drainJobsBeforeClose = true", () => {
-    beforeEach(() =>
-      PlatformTest.create({
-        agenda: {
-          enabled: true,
-          drainJobsBeforeClose: true
-        }
-      })
-    );
-    afterEach(() => PlatformTest.reset());
-    describe("$onDestroy()", () => {
-      it("should close agenda", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-
-        await agendaModule.$onDestroy();
-
-        expect(agendaModule.agenda.drain).toHaveBeenCalledWith();
-        expect(agendaModule.agenda.close).toHaveBeenCalledWith({force: true});
-      });
-    });
-  });
-  describe("when agenda is enabled but disableJobProcessing = true", () => {
-    beforeEach(() =>
-      PlatformTest.create({
-        agenda: {
-          enabled: true,
-          disableJobProcessing: true
-        }
-      })
-    );
-    afterEach(() => PlatformTest.reset());
-
-    describe("$afterListen()", () => {
-      it("should load all jobs", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-        const campaign = PlatformTest.get<CustomCampaign>(CustomCampaign)!;
-
-        await agendaModule.$afterListen();
-
-        expect(agendaModule.agenda.define).not.toHaveBeenCalled();
-        expect(agendaModule.agenda.every).not.toHaveBeenCalled();
-        expect(agendaModule.agenda.start).toHaveBeenCalledWith();
-        expect(agendaModule.agenda.create).not.toHaveBeenCalled();
-
-        expect(campaign.job).toBeUndefined();
-      });
-    });
-  });
-
-  describe("when agenda is disabled", () => {
-    beforeEach(() =>
-      PlatformTest.create({
-        agenda: {
-          enabled: false
-        }
-      })
-    );
-    afterEach(() => PlatformTest.reset());
-
-    describe("$afterListen()", () => {
-      it("should load all jobs", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-        const campaign = PlatformTest.get<CustomCampaign>(CustomCampaign)!;
-
-        await agendaModule.$afterListen();
-
-        expect(agendaModule.agenda.define).toBeUndefined();
-
-        expect(campaign.job).toBeUndefined();
-      });
-    });
-
-    describe("$onDestroy()", () => {
-      it("should do nothing", async () => {
-        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
-
-        await agendaModule.$onDestroy();
-      });
-    });
-  });
-});

package/src/AgendaModule.ts

@@ -1,150 +0,0 @@
-import {AfterListen, DIContext, Logger, OnDestroy, runInContext} from "@tsed/common";
-import {Constant, Inject, InjectorService, Module, Provider} from "@tsed/di";
-import {Job, Processor} from "agenda";
-import {v4 as uuid} from "uuid";
-import {PROVIDER_TYPE_AGENDA} from "./constants/constants.js";
-import {AgendaStore} from "./interfaces/AgendaStore.js";
-import {AgendaService} from "./services/AgendaFactory.js";
-
-@Module()
-export class AgendaModule implements OnDestroy, AfterListen {
-  @Inject()
-  protected logger: Logger;
-
-  @Inject()
-  protected injector: InjectorService;
-
-  @Inject()
-  protected agenda: AgendaService;
-
-  @Constant("agenda.enabled", false)
-  private enabled: boolean;
-
-  @Constant("agenda.drainJobsBeforeClose", false)
-  private drainJobsBeforeClose: boolean;
-
-  @Constant("agenda.disableJobProcessing", false)
-  private disableJobProcessing: boolean;
-
-  async $afterListen(): Promise<any> {
-    if (this.enabled) {
-      const providers = this.getProviders();
-
-      if (!this.disableJobProcessing) {
-        this.logger.info({
-          event: "AGENDA_ADD_DEFINITIONS",
-          message: "Agenda add definitions"
-        });
-        providers.forEach((provider) => this.addAgendaDefinitionsForProvider(provider));
-
-        await this.injector.emit("$beforeAgendaStart");
-      }
-
-      await this.agenda.start();
-
-      if (!this.disableJobProcessing) {
-        this.logger.info({
-          event: "AGENDA_ADD_JOBS",
-          message: "Agenda add scheduled jobs"
-        });
-        await Promise.all(providers.map((provider) => this.scheduleJobsForProvider(provider)));
-
-        await this.injector.emit("$afterAgendaStart");
-      }
-    }
-  }
-
-  async $onDestroy(): Promise<any> {
-    if (this.enabled) {
-      if (this.drainJobsBeforeClose && "drain" in this.agenda) {
-        this.logger.info({
-          event: "AGENDA_DRAIN",
-          message: "Agenda is draining all jobs before close"
-        });
-        await this.agenda.drain();
-      } else {
-        this.logger.info({
-          event: "AGENDA_STOP",
-          message: "Agenda is stopping"
-        });
-        await this.agenda.stop();
-      }
-
-      await this.agenda.close({force: true});
-
-      this.logger.info({event: "AGENDA_STOP", message: "Agenda stopped"});
-    }
-  }
-
-  define(name: string, options?: any, processor?: any) {
-    return this.agenda.define(name, options, (job: Job) => {
-      const $ctx = new DIContext({
-        injector: this.injector,
-        id: uuid(),
-        logger: this.injector.logger
-      });
-
-      $ctx.set("job", job);
-
-      return runInContext($ctx, () => processor(job));
-    });
-  }
-
-  every(interval: string, name: string, data?: any, options?: any) {
-    return this.agenda.every(interval, name, data, options);
-  }
-
-  schedule(when: Date | string, name: string, data?: any) {
-    return this.agenda.schedule(when, name, data);
-  }
-
-  now(name: string, data?: any) {
-    return this.agenda.now(name, data);
-  }
-
-  create(name: string, data?: any) {
-    return this.agenda.create(name, data);
-  }
-
-  protected getProviders(): Provider<any>[] {
-    return this.injector.getProviders(PROVIDER_TYPE_AGENDA);
-  }
-
-  protected addAgendaDefinitionsForProvider(provider: Provider): void {
-    const store = provider.store.get<AgendaStore>("agenda", {});
-
-    if (!store.define) {
-      return;
-    }
-
-    Object.entries(store.define).forEach(([propertyKey, {name, ...options}]) => {
-      const instance = this.injector.get(provider.token);
-
-      const jobProcessor: Processor<unknown> = instance[propertyKey].bind(instance) as Processor<unknown>;
-      const jobName = this.getNameForJob(propertyKey, store.namespace, name);
-
-      this.define(jobName, options, jobProcessor);
-    });
-  }
-
-  protected async scheduleJobsForProvider(provider: Provider<any>): Promise<void> {
-    const store = provider.store.get<AgendaStore>("agenda", {});
-
-    if (!store.every) {
-      return;
-    }
-
-    const promises = Object.entries(store.every).map(([propertyKey, {interval, name, ...options}]) => {
-      const jobName = this.getNameForJob(propertyKey, store.namespace, name);
-
-      return this.every(interval, jobName, {}, options);
-    });
-
-    await Promise.all(promises);
-  }
-
-  protected getNameForJob(propertyKey: string, namespace?: string, customName?: string): string {
-    const name = customName || propertyKey;
-    return namespace ? `${namespace}.${name}` : name;
-  }
-}

package/src/constants/constants.ts

@@ -1 +0,0 @@
-export const PROVIDER_TYPE_AGENDA = "PROVIDER_TYPE_AGENDA";

package/src/decorators/agenda.spec.ts

@@ -1,21 +0,0 @@
-import {Store} from "@tsed/core";
-import {Agenda} from "./agenda.js";
-
-describe("@Agenda()", () => {
-  it("should set empty metadata", () => {
-    @Agenda()
-    class Test {}
-
-    const store = Store.from(Test);
-    expect(store.get("agenda")).toEqual(undefined);
-  });
-  it("should set namespace metadata", () => {
-    @Agenda({namespace: "nsp1"})
-    class Test {}
-
-    const store = Store.from(Test);
-    expect(store.get("agenda")).toEqual({
-      namespace: "nsp1"
-    });
-  });
-});

package/src/decorators/agenda.ts

@@ -1,16 +0,0 @@
-import {StoreMerge, useDecorators} from "@tsed/core";
-import {Injectable} from "@tsed/di";
-import {PROVIDER_TYPE_AGENDA} from "../constants/constants.js";
-
-interface AgendaOptions {
-  namespace?: string;
-}
-
-export function Agenda(options?: AgendaOptions): ClassDecorator {
-  return useDecorators(
-    options?.namespace && StoreMerge("agenda", options),
-    Injectable({
-      type: PROVIDER_TYPE_AGENDA
-    })
-  );
-}

package/src/decorators/define.spec.ts

@@ -1,48 +0,0 @@
-import {Store} from "@tsed/core";
-import {Agenda} from "./agenda.js";
-import {Define} from "./define.js";
-
-describe("@Define()", () => {
-  it("should set empty metadata", () => {
-    @Agenda()
-    class Test {
-      @Define()
-      testDefineDecorator() {
-        // test
-      }
-
-      @Define()
-      testDefineDecorator2() {
-        // test 2
-      }
-    }
-
-    const store = Store.from(Test);
-
-    expect(store.get("agenda").define).toEqual({
-      testDefineDecorator: {},
-      testDefineDecorator2: {}
-    });
-  });
-
-  it("should set options metadata", () => {
-    @Agenda()
-    class Test {
-      @Define({
-        name: "testDefineDecoratorCustomName",
-        priority: 20
-      })
-      test() {
-        // test
-      }
-    }
-
-    const store = Store.from(Test);
-    expect(store.get("agenda").define).toEqual({
-      test: {
-        name: "testDefineDecoratorCustomName",
-        priority: 20
-      }
-    });
-  });
-});

package/src/decorators/define.ts

@@ -1,14 +0,0 @@
-import {Store} from "@tsed/core";
-import {AgendaStore, DefineOptions} from "../interfaces/AgendaStore.js";
-
-export function Define(options: DefineOptions = {}): MethodDecorator {
-  return (target: any, propertyKey: string) => {
-    const store: AgendaStore = {
-      define: {
-        [propertyKey]: options
-      }
-    };
-
-    Store.from(target).merge("agenda", store);
-  };
-}

package/src/decorators/every.spec.ts

@@ -1,36 +0,0 @@
-import {descriptorOf, Store} from "@tsed/core";
-import {Agenda} from "./agenda.js";
-import {Every} from "./every.js";
-
-describe("@Every()", () => {
-  it("should set metadata", () => {
-    @Agenda()
-    class Test {
-      @Every("60 seconds")
-      testEveryDecorator() {
-        // test
-      }
-
-      @Every("* * * * *")
-      testEveryDecorator2() {
-        // test 2
-      }
-    }
-
-    const store = Store.from(Test);
-
-    expect(store.get("agenda").define).toEqual({
-      testEveryDecorator: {},
-      testEveryDecorator2: {}
-    });
-
-    expect(store.get("agenda").every).toEqual({
-      testEveryDecorator: {
-        interval: "60 seconds"
-      },
-      testEveryDecorator2: {
-        interval: "* * * * *"
-      }
-    });
-  });
-});

package/src/decorators/every.ts

@@ -1,14 +0,0 @@
-import {Store, useDecorators} from "@tsed/core";
-import {Define} from "./define.js";
-import {AgendaStore, EveryOptions} from "../interfaces/AgendaStore.js";
-
-export function Every(interval: string, options: EveryOptions = {}): MethodDecorator {
-  return useDecorators(Define(options), (target: any, propertyKey: string) => {
-    const store: AgendaStore = {
-      every: {
-        [propertyKey]: {...options, interval}
-      }
-    };
-    Store.from(target).merge("agenda", store);
-  });
-}

package/src/index.ts

@@ -1,11 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./AgendaModule.js";
-export * from "./constants/constants.js";
-export * from "./decorators/agenda.js";
-export * from "./decorators/define.js";
-export * from "./decorators/every.js";
-export * from "./interfaces/AgendaStore.js";
-export * from "./interfaces/interfaces.js";
-export * from "./services/AgendaFactory.js";

package/src/interfaces/AgendaStore.ts

@@ -1,13 +0,0 @@
-import {DefineOptions as AgendaDefineOptions, JobOptions} from "agenda";
-
-export interface DefineOptions extends AgendaDefineOptions {
-  name?: string;
-}
-
-export type EveryOptions = JobOptions & DefineOptions;
-
-export interface AgendaStore {
-  namespace?: string;
-  define?: {[propertyKey: string]: DefineOptions};
-  every?: {[propertyKey: string]: EveryOptions & {interval: string}};
-}

package/src/interfaces/interfaces.ts

@@ -1,16 +0,0 @@
-import {AgendaConfig} from "agenda";
-
-declare global {
-  namespace TsED {
-    interface Configuration {
-      agenda?: {
-        /**
-         * Enable Agenda jobs. Default false.
-         */
-        enabled?: boolean;
-        disableJobProcessing?: boolean;
-        drainJobsBeforeClose?: boolean;
-      } & AgendaConfig;
-    }
-  }
-}

package/src/services/AgendaFactory.ts

@@ -1,15 +0,0 @@
-import {Configuration, registerProvider} from "@tsed/di";
-import {Agenda, AgendaConfig} from "agenda";
-
-// create Alias to avoid confusing import between Agenda from "agenda" and Agenda decorator
-export const AgendaService = Agenda;
-export type AgendaService = Agenda;
-
-registerProvider({
-  provide: Agenda,
-  deps: [Configuration],
-  useFactory(settings: Configuration) {
-    const opts = settings.get<AgendaConfig & {enabled: boolean}>("agenda", {enabled: false});
-    return opts.enabled ? new Agenda(opts) : {};
-  }
-});

package/tsconfig.esm.json

@@ -1,39 +0,0 @@
-{
-  "extends": "@tsed/typescript/tsconfig.node.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "ES2020",
-    "rootDir": "src",
-    "outDir": "./lib/esm",
-    "declaration": true,
-    "declarationDir": "./lib/types",
-    "composite": true,
-    "noEmit": false
-  },
-  "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js",
-    "**/__mock__/**",
-    "webpack.config.js"
-  ],
-  "references": [
-    {
-      "path": "../../platform/common"
-    },
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    }
-  ]
-}

package/tsconfig.json

@@ -1,39 +0,0 @@
-{
-  "extends": "@tsed/typescript/tsconfig.node.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "commonjs",
-    "rootDir": "src",
-    "outDir": "./lib/cjs",
-    "declaration": true,
-    "declarationDir": "./lib/types",
-    "composite": true,
-    "noEmit": false
-  },
-  "include": ["src", "src/**/*.json"],
-  "exclude": [
-    "node_modules",
-    "test",
-    "lib",
-    "benchmark",
-    "coverage",
-    "spec",
-    "**/*.benchmark.ts",
-    "**/*.spec.ts",
-    "keys",
-    "jest.config.js",
-    "**/__mock__/**",
-    "webpack.config.js"
-  ],
-  "references": [
-    {
-      "path": "../../platform/common"
-    },
-    {
-      "path": "../../core"
-    },
-    {
-      "path": "../../di"
-    }
-  ]
-}