@tsed/bullmq 8.11.0 → 8.11.2-rc.1

package/src/contracts/JobStore.ts

@@ -1,7 +0,0 @@
-import {JobsOptions} from "bullmq";
-
-export interface JobStore {
-  name: string;
-  queue: string;
-  opts: JobsOptions;
-}

package/src/contracts/index.ts

@@ -1,5 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./JobMethods.js";
-export * from "./JobStore.js";

package/src/decorators/InjectQueue.ts

@@ -1,7 +0,0 @@
-import {Inject} from "@tsed/di";
-
-import {getQueueToken} from "../utils/getQueueToken.js";
-
-export function InjectQueue(name: string) {
-  return Inject(getQueueToken(name));
-}

package/src/decorators/InjectWorker.ts

@@ -1,7 +0,0 @@
-import {Inject} from "@tsed/di";
-
-import {getWorkerToken} from "../utils/getWorkerToken.js";
-
-export function InjectWorker(name: string) {
-  return Inject(getWorkerToken(name));
-}

package/src/decorators/JobController.spec.ts

@@ -1,94 +0,0 @@
-import {Store} from "@tsed/core";
-import {GlobalProviders} from "@tsed/di";
-
-import {FallbackJobController, JobController} from "./JobController.js";
-
-describe("JobController", () => {
-  afterEach(() => GlobalProviders.clear());
-
-  it("should set the proper store data", () => {
-    @JobController("testjob")
-    class TestJob {}
-
-    const store = Store.from(TestJob).get("bullmq");
-
-    expect(store.name).toBe("testjob");
-    expect(store.queue).toBe("default");
-    expect(store.opts).toStrictEqual({});
-  });
-
-  it("should allow settings a custom queue", () => {
-    @JobController("testjob", "custom")
-    class CustomQueueJob {}
-
-    const store = Store.from(CustomQueueJob).get("bullmq");
-
-    expect(store.queue).toBe("custom");
-  });
-
-  it("should allow custom options to be set", () => {
-    @JobController("testjob", "default", {
-      backoff: 69,
-      attempts: 42
-    })
-    class CustomOptionsJob {}
-
-    const store = Store.from(CustomOptionsJob).get("bullmq");
-
-    expect(store.opts).toStrictEqual({
-      backoff: 69,
-      attempts: 42
-    });
-  });
-
-  it("should set type for cron jobs", () => {
-    @JobController("testjob", "default", {
-      repeat: {count: 42}
-    })
-    class CustomCronJob {}
-
-    const store = Store.from(CustomCronJob).get("bullmq");
-
-    expect(store).toBeDefined();
-  });
-});
-
-describe("FallbackJobController", () => {
-  afterEach(() => GlobalProviders.clear());
-
-  describe("with queue", () => {
-    it("should set the proper store data", () => {
-      @FallbackJobController("default")
-      class FallbackJob {}
-
-      const store = Store.from(FallbackJob).get("bullmq");
-      expect(store.queue).toBe("default");
-
-      const fallbackControllerForQueue = GlobalProviders.get("bullmq.fallback-job.default");
-      expect(fallbackControllerForQueue).not.toBeUndefined();
-      expect(fallbackControllerForQueue?.type).toEqual("bullmq:fallback-job");
-      expect(fallbackControllerForQueue?.useClass).toEqual(FallbackJob);
-
-      const fallbackController = GlobalProviders.get("bullmq.fallback-job");
-      expect(fallbackController).toBeUndefined();
-    });
-  });
-
-  describe("without queue", () => {
-    it("should set the proper store data", () => {
-      @FallbackJobController()
-      class FallbackJob {}
-
-      const store = Store.from(FallbackJob).get("bullmq");
-      expect(store.queue).toBeUndefined();
-
-      const fallbackController = GlobalProviders.get("bullmq.fallback-job");
-      expect(fallbackController).not.toBeUndefined();
-      expect(fallbackController?.type).toEqual("bullmq:fallback-job");
-      expect(fallbackController?.useClass).toEqual(FallbackJob);
-
-      const fallbackControllerForQueue = GlobalProviders.get("bullmq.fallback-job.default");
-      expect(fallbackControllerForQueue).toBeUndefined();
-    });
-  });
-});

package/src/decorators/JobController.ts

@@ -1,33 +0,0 @@
-import {StoreMerge, useDecorators} from "@tsed/core";
-import {Injectable} from "@tsed/di";
-import {JobsOptions} from "bullmq";
-
-import {BullMQTypes} from "../constants/BullMQTypes.js";
-import {BULLMQ} from "../constants/constants.js";
-import {getFallbackJobToken, getJobToken} from "../utils/getJobToken.js";
-
-export function JobController(name: string, queue: string = "default", opts: JobsOptions = {}) {
-  return useDecorators(
-    StoreMerge(BULLMQ, {
-      name,
-      queue,
-      opts
-    }),
-    Injectable({
-      token: getJobToken(queue, name),
-      type: opts.repeat ? BullMQTypes.CRON : BullMQTypes.JOB
-    })
-  );
-}
-
-export function FallbackJobController(queue?: string) {
-  return useDecorators(
-    StoreMerge(BULLMQ, {
-      queue
-    }),
-    Injectable({
-      token: getFallbackJobToken(queue),
-      type: BullMQTypes.FALLBACK_JOB
-    })
-  );
-}

package/src/decorators/index.ts

@@ -1,6 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./InjectQueue.js";
-export * from "./InjectWorker.js";
-export * from "./JobController.js";

package/src/dispatchers/JobDispatcher.spec.ts

@@ -1,169 +0,0 @@
-import {catchAsyncError} from "@tsed/core";
-import {DITest, inject, injectable, injector} from "@tsed/di";
-import {beforeEach} from "vitest";
-
-import {JobMethods} from "../contracts/index.js";
-import {JobController} from "../decorators/index.js";
-import {JobDispatcher} from "./JobDispatcher.js";
-
-@JobController("example-job-with-custom-id-from-job-methods")
-class ExampleJobWithCustomJobIdFromJobMethods implements JobMethods {
-  handle(payload: string) {}
-
-  jobId(payload: string): string {
-    return payload.toUpperCase();
-  }
-}
-
-@JobController("example-job", "default", {
-  backoff: 69
-})
-class ExampleTestJob implements JobMethods {
-  handle(payload: {msg: string}) {}
-}
-
-@JobController("queue-not-configured", "not-configured")
-class NotConfiguredQueueTestJob implements JobMethods {
-  handle() {}
-}
-
-function getFixture() {
-  const dispatcher = inject(JobDispatcher);
-  const queue = {
-    name: "default",
-    add: vi.fn()
-  };
-
-  const specialQueue = {
-    name: "special",
-    add: vi.fn()
-  };
-
-  injectable("bullmq.queue.default").value(queue);
-  injectable("bullmq.queue.special").value(specialQueue);
-  injectable("bullmq.job.default.example-job").value(new ExampleTestJob());
-  injectable("bullmq.job.default.example-job-with-custom-id-from-job-methods").value(new ExampleJobWithCustomJobIdFromJobMethods());
-
-  vi.spyOn(injector(), "resolve");
-
-  return {
-    dispatcher,
-    queue,
-    specialQueue,
-    job: inject<ExampleJobWithCustomJobIdFromJobMethods>("bullmq.job.default.example-job-with-custom-id-from-job-methods")
-  };
-}
-
-describe("JobDispatcher", () => {
-  beforeEach(() => DITest.create());
-  afterEach(() => DITest.reset());
-
-  it("should throw an exception when a queue is not configured", async () => {
-    const {dispatcher} = getFixture();
-
-    const error = await catchAsyncError(() => dispatcher.dispatch(NotConfiguredQueueTestJob));
-
-    await expect(error).toEqual(new Error("Queue(not-configured) not defined"));
-
-    expect(injector().resolve).toHaveBeenCalledWith("bullmq.queue.not-configured", expect.anything());
-  });
-  it("should dispatch job as type", async () => {
-    const {dispatcher, queue} = getFixture();
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"});
-
-    expect(queue.add).toHaveBeenCalledOnce();
-    expect(queue.add).toHaveBeenCalledWith(
-      "example-job",
-      expect.objectContaining({msg: "hello test"}),
-      expect.objectContaining({backoff: 69})
-    );
-  });
-  it("should dispatch job as options", async () => {
-    const {dispatcher, specialQueue} = getFixture();
-
-    await dispatcher.dispatch(
-      {
-        queue: "special",
-        name: "some-name"
-      },
-      {msg: "hello test"}
-    );
-
-    expect(specialQueue.add).toHaveBeenCalledOnce();
-    expect(specialQueue.add).toHaveBeenCalledWith("some-name", expect.objectContaining({msg: "hello test"}), expect.anything());
-  });
-  it("should dispatch job as string", async () => {
-    const {dispatcher, queue} = getFixture();
-
-    await dispatcher.dispatch("some-name", {msg: "hello test"});
-
-    expect(queue.add).toHaveBeenCalledOnce();
-    expect(queue.add).toHaveBeenCalledWith("some-name", expect.objectContaining({msg: "hello test"}), expect.anything());
-  });
-  it("should overwrite job options defined by the job", async () => {
-    const {dispatcher, queue} = getFixture();
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {backoff: 42, jobId: "ffeeaa"});
-
-    expect(queue.add).toHaveBeenCalledOnce();
-    expect(queue.add).toHaveBeenCalledWith(
-      "example-job",
-      expect.objectContaining({msg: "hello test"}),
-      expect.objectContaining({backoff: 42, jobId: "ffeeaa"})
-    );
-  });
-  it("should keep existing options and add new ones", async () => {
-    const {dispatcher, queue} = getFixture();
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {jobId: "ffeeaa"});
-
-    expect(queue.add).toHaveBeenCalledOnce();
-    expect(queue.add).toHaveBeenCalledWith(
-      "example-job",
-      expect.objectContaining({msg: "hello test"}),
-      expect.objectContaining({backoff: 69, jobId: "ffeeaa"})
-    );
-  });
-  describe("custom jobId", () => {
-    it("should allow setting the job id from within the job", async () => {
-      const {dispatcher, queue} = getFixture();
-
-      await dispatcher.dispatch(ExampleJobWithCustomJobIdFromJobMethods, "hello world");
-
-      expect(queue.add).toHaveBeenCalledOnce();
-      expect(queue.add).toHaveBeenCalledWith("example-job-with-custom-id-from-job-methods", "hello world", expect.anything());
-
-      const [, , opts] = queue.add.mock.calls.at(-1)!;
-
-      expect(opts).toMatchObject({
-        jobId: "HELLO WORLD"
-      });
-    });
-
-    it("should pass the payload to the jobId method", async () => {
-      const {dispatcher, job} = getFixture();
-
-      vi.spyOn(job, "jobId");
-
-      await dispatcher.dispatch(ExampleJobWithCustomJobIdFromJobMethods, "hello world");
-
-      expect(job.jobId).toHaveBeenCalledOnce();
-      expect(job.jobId).toHaveBeenCalledWith("hello world");
-    });
-
-    it("should choose the jobId provided to the dispatcher even when the method is implemented", async () => {
-      const {dispatcher, queue} = getFixture();
-
-      await dispatcher.dispatch(ExampleJobWithCustomJobIdFromJobMethods, "hello world", {
-        jobId: "I don't think so"
-      });
-
-      const [, , opts] = queue.add.mock.calls.at(-1)!;
-
-      expect(opts).toMatchObject({
-        jobId: "I don't think so"
-      });
-    });
-  });
-});

package/src/dispatchers/JobDispatcher.ts

@@ -1,78 +0,0 @@
-import {isClass, Store, Type} from "@tsed/core";
-import {inject, injectable} from "@tsed/di";
-import {Job as BullMQJob, JobsOptions, Queue} from "bullmq";
-
-import {BULLMQ} from "../constants/constants.js";
-import {JobMethods, type JobStore} from "../contracts/index.js";
-import {getJobToken} from "../utils/getJobToken.js";
-import {getQueueToken} from "../utils/getQueueToken.js";
-import type {JobDispatcherOptions} from "./JobDispatcherOptions.js";
-
-export class JobDispatcher {
-  public async dispatch<T extends JobMethods>(
-    job: Type<T>,
-    payload?: Parameters<T["handle"]>[0],
-    options?: JobsOptions
-  ): Promise<BullMQJob>;
-  public async dispatch<P = unknown>(job: JobDispatcherOptions, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
-  public async dispatch<P = unknown>(job: string, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
-  public async dispatch(job: Type | JobDispatcherOptions | string, payload: unknown, options: JobsOptions = {}): Promise<BullMQJob> {
-    const {queueName, jobName, defaultJobOptions} = await this.resolveDispatchArgs(job, payload);
-
-    const queue = inject<Queue>(getQueueToken(queueName));
-
-    if (!queue) {
-      throw new Error(`Queue(${queueName}) not defined`);
-    }
-
-    return queue.add(jobName, payload, {
-      ...defaultJobOptions,
-      ...options
-    });
-  }
-
-  private async resolveDispatchArgs(job: Type | JobDispatcherOptions | string, payload: unknown) {
-    let queueName: string;
-    let jobName: string;
-    let defaultJobOptions: JobsOptions | undefined;
-
-    if (typeof job === "function") {
-      // job is passed as a Type
-      const store = Store.from(job).get<JobStore>(BULLMQ);
-      queueName = store.queue;
-      jobName = store.name;
-
-      defaultJobOptions = await this.retrieveJobOptionsFromClassBasedJob(store, payload);
-    } else if (typeof job === "object") {
-      // job is passed as JobDispatcherOptions
-      queueName = job.queue;
-      jobName = job.name;
-    } else {
-      // job is passed as a string
-      queueName = "default";
-      jobName = job;
-    }
-
-    return {
-      queueName,
-      jobName,
-      defaultJobOptions
-    };
-  }
-
-  private async retrieveJobOptionsFromClassBasedJob(store: JobStore, payload: unknown): Promise<JobsOptions> {
-    const job = inject<JobMethods>(getJobToken(store.queue, store.name));
-    const jobId = await job.jobId?.(payload);
-
-    if (jobId === undefined) {
-      return store.opts;
-    }
-
-    return {
-      ...store.opts,
-      jobId
-    };
-  }
-}
-
-injectable(JobDispatcher);

package/src/dispatchers/JobDispatcherOptions.ts

@@ -1,4 +0,0 @@
-export interface JobDispatcherOptions {
-  queue: string;
-  name: string;
-}

package/src/dispatchers/index.ts

@@ -1,5 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./JobDispatcher.js";
-export * from "./JobDispatcherOptions.js";

package/src/index.ts

@@ -1,24 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./BullMQModule.js";
-export * from "./config/config.js";
-export * from "./constants/BullMQTypes.js";
-export * from "./constants/constants.js";
-export * from "./contracts/index.js";
-export * from "./contracts/JobMethods.js";
-export * from "./contracts/JobStore.js";
-export * from "./decorators/index.js";
-export * from "./decorators/InjectQueue.js";
-export * from "./decorators/InjectWorker.js";
-export * from "./decorators/JobController.js";
-export * from "./dispatchers/index.js";
-export * from "./dispatchers/JobDispatcher.js";
-export * from "./dispatchers/JobDispatcherOptions.js";
-export * from "./utils/createQueueProvider.js";
-export * from "./utils/createWorkerProvider.js";
-export * from "./utils/getJobToken.js";
-export * from "./utils/getQueueToken.js";
-export * from "./utils/getWorkerToken.js";
-export * from "./utils/mapQueueOptions.js";
-export * from "./utils/mapWorkerOptions.js";

package/src/utils/createQueueProvider.ts

@@ -1,16 +0,0 @@
-import {inject, injectable} from "@tsed/di";
-import {Queue, QueueOptions} from "bullmq";
-
-import {getQueueToken} from "./getQueueToken.js";
-
-export function createQueueProvider(queue: string, opts: QueueOptions) {
-  const token = getQueueToken(queue);
-
-  injectable(token)
-    .factory(() => new Queue(queue, opts))
-    .hooks({
-      $onDestroy: (queue: Queue) => queue.close()
-    });
-
-  return inject<Queue>(token);
-}

package/src/utils/createWorkerProvider.ts

@@ -1,18 +0,0 @@
-import {inject, injectable} from "@tsed/di";
-import {Job, Worker, WorkerOptions} from "bullmq";
-
-import {BullMQTypes} from "../constants/BullMQTypes.js";
-import {getWorkerToken} from "./getWorkerToken.js";
-
-export function createWorkerProvider(worker: string, process: (job: Job) => any, opts: WorkerOptions) {
-  const token = getWorkerToken(worker);
-
-  injectable(token)
-    .type(BullMQTypes.WORKER)
-    .value(new Worker(worker, process, opts))
-    .hooks({
-      $onDestroy: (worker: Worker) => worker.close()
-    });
-
-  return inject<Worker>(token);
-}

package/src/utils/getJobToken.ts

@@ -1,7 +0,0 @@
-export function getJobToken(queue: string, name: string) {
-  return `bullmq.job.${queue}.${name}`;
-}
-
-export function getFallbackJobToken(queue?: string) {
-  return ["bullmq.fallback-job", queue].filter(Boolean).join(".");
-}

package/src/utils/getQueueToken.ts

@@ -1,3 +0,0 @@
-export function getQueueToken(queue: string) {
-  return `bullmq.queue.${queue}`;
-}

package/src/utils/getWorkerToken.ts

@@ -1,3 +0,0 @@
-export function getWorkerToken(worker: string) {
-  return `bullmq.worker.${worker}`;
-}

package/src/utils/mapQueueOptions.ts

@@ -1,14 +0,0 @@
-import {deepMerge} from "@tsed/core";
-import type {QueueOptions} from "bullmq";
-
-import {BullMQConfig} from "../config/config.js";
-
-export function mapQueueOptions(queue: string, bullMQConfig: BullMQConfig): QueueOptions {
-  return deepMerge<QueueOptions, QueueOptions>(
-    {
-      connection: bullMQConfig.connection,
-      ...bullMQConfig.defaultQueueOptions
-    },
-    bullMQConfig.queueOptions?.[queue]
-  )!;
-}

package/src/utils/mapWorkerOptions.ts

@@ -1,14 +0,0 @@
-import {deepMerge} from "@tsed/core";
-import type {WorkerOptions} from "bullmq";
-
-import {BullMQConfig} from "../config/config.js";
-
-export function mapWorkerOptions(queue: string, bullMQConfig: BullMQConfig): WorkerOptions {
-  return deepMerge<WorkerOptions, WorkerOptions>(
-    {
-      connection: bullMQConfig.connection,
-      ...bullMQConfig.defaultWorkerOptions
-    },
-    bullMQConfig.workerOptions?.[queue]
-  )!;
-}

package/vitest.config.mts

@@ -1,26 +0,0 @@
-// @ts-ignore
-import {presets} from "@tsed/vitest/presets";
-import {defineConfig} from "vitest/config";
-
-export default defineConfig(
-  {
-    ...presets,
-    test: {
-      ...presets.test,
-      coverage: {
-        ...presets.test.coverage,
-        exclude: [
-          ...presets.test.coverage.exclude,
-          "**/contracts/**/*",
-          "**/config/**/*"
-        ],
-        thresholds: {
-          statements: 0,
-          branches: 0,
-          functions: 0,
-          lines: 0
-        }
-      }
-    }
-  }
-);