@tsed/bullmq 7.50.0 → 7.51.1

package/src/decorators/JobController.spec.ts

@@ -1,93 +0,0 @@
-import {FallbackJobController, JobController} from "./JobController";
-import {Store} from "@tsed/core";
-import {GlobalProviders} from "@tsed/di";
-
-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);
-  });
-});
-
-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,29 +0,0 @@
-import {StoreMerge, useDecorators} from "@tsed/core";
-import {Injectable} from "@tsed/di";
-import {JobsOptions} from "bullmq";
-
-export function JobController(name: string, queue: string = "default", opts: JobsOptions = {}) {
-  return useDecorators(
-    StoreMerge("bullmq", {
-      name,
-      queue,
-      opts
-    }),
-    Injectable({
-      provide: `bullmq.job.${queue}.${name}`,
-      type: opts.repeat ? "bullmq:cron" : "bullmq:job"
-    })
-  );
-}
-
-export function FallbackJobController(queue?: string) {
-  return useDecorators(
-    StoreMerge("bullmq", {
-      queue
-    }),
-    Injectable({
-      provide: "bullmq.fallback-job" + (queue ? `.${queue}` : ""),
-      type: "bullmq:fallback-job"
-    })
-  );
-}

package/src/decorators/index.ts

@@ -1,5 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from "./JobController";

package/src/dispatchers/JobDispatcher.spec.ts

@@ -1,132 +0,0 @@
-import {InjectorService} from "@tsed/di";
-import {JobDispatcher} from "./JobDispatcher";
-import {JobMethods} from "../contracts";
-import {JobController} from "../decorators";
-import {Queue} from "bullmq";
-import {instance, mock, verify, when, objectContaining} from "ts-mockito";
-
-@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() {}
-}
-
-describe("JobDispatcher", () => {
-  it("should throw an exception when a queue is not configured", () => {
-    const injector = mock(InjectorService);
-    when(injector.get("bullmq.queue.not-configured")).thenReturn();
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    expect(dispatcher.dispatch(NotConfiguredQueueTestJob)).rejects.toThrow(new Error("Queue(not-configured) not defined"));
-    verify(injector.get("bullmq.queue.not-configured")).once();
-  });
-
-  it("should dispatch job as type", async () => {
-    const injector = mock(InjectorService);
-    const queue = mock(Queue);
-    when(queue.name).thenReturn("default");
-
-    when(injector.get("bullmq.queue.default")).thenReturn(instance(queue));
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"});
-
-    verify(
-      queue.add(
-        "example-job",
-        objectContaining({msg: "hello test"}),
-        objectContaining({
-          backoff: 69
-        })
-      )
-    ).once();
-  });
-
-  it("should dispatch job as options", async () => {
-    const injector = mock(InjectorService);
-    const queue = mock(Queue);
-    when(queue.name).thenReturn("special");
-
-    when(injector.get("bullmq.queue.special")).thenReturn(instance(queue));
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    await dispatcher.dispatch(
-      {
-        queue: "special",
-        name: "some-name"
-      },
-      {msg: "hello test"}
-    );
-
-    verify(queue.add("some-name", objectContaining({msg: "hello test"}), objectContaining({}))).once();
-  });
-
-  it("should dispatch job as string", async () => {
-    const injector = mock(InjectorService);
-    const queue = mock(Queue);
-    when(queue.name).thenReturn("default");
-
-    when(injector.get("bullmq.queue.default")).thenReturn(instance(queue));
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    await dispatcher.dispatch("some-name", {msg: "hello test"});
-
-    verify(queue.add("some-name", objectContaining({msg: "hello test"}), objectContaining({}))).once();
-  });
-
-  it("should overwrite job options defined by the job", async () => {
-    const injector = mock(InjectorService);
-    const queue = mock(Queue);
-    when(queue.name).thenReturn("default");
-
-    when(injector.get("bullmq.queue.default")).thenReturn(instance(queue));
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {backoff: 42, jobId: "ffeeaa"});
-
-    verify(
-      queue.add(
-        "example-job",
-        objectContaining({msg: "hello test"}),
-        objectContaining({
-          backoff: 42,
-          jobId: "ffeeaa"
-        })
-      )
-    ).once();
-  });
-
-  it("should keep existing options and add new ones", async () => {
-    const injector = mock(InjectorService);
-    const queue = mock(Queue);
-    when(queue.name).thenReturn("default");
-
-    when(injector.get("bullmq.queue.default")).thenReturn(instance(queue));
-
-    const dispatcher = new JobDispatcher(instance(injector));
-
-    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {jobId: "ffeeaa"});
-
-    verify(
-      queue.add(
-        "example-job",
-        objectContaining({msg: "hello test"}),
-        objectContaining({
-          backoff: 69,
-          jobId: "ffeeaa"
-        })
-      )
-    ).once();
-  });
-});

package/src/dispatchers/JobDispatcher.ts

@@ -1,61 +0,0 @@
-/* eslint-disable require-await */
-import {InjectorService, Service} from "@tsed/di";
-import {JobMethods, type JobStore} from "../contracts";
-import {Store, Type} from "@tsed/core";
-import {Job as BullMQJob, JobsOptions, Queue} from "bullmq";
-import type {JobDispatcherOptions} from "./JobDispatcherOptions";
-
-@Service()
-export class JobDispatcher {
-  constructor(private readonly injector: InjectorService) {}
-
-  public async dispatch<T extends JobMethods>(
-    job: Type<T>,
-    payload?: Parameters<T["handle"]>[0],
-    options?: JobsOptions
-  ): Promise<BullMQJob>;
-  public async dispatch<T = any>(job: JobDispatcherOptions, payload?: T, options?: JobsOptions): Promise<BullMQJob>;
-  public async dispatch<T = any>(job: string, payload?: T, options?: JobsOptions): Promise<BullMQJob>;
-  public async dispatch(job: Type | JobDispatcherOptions | string, payload: any, options: JobsOptions = {}): Promise<BullMQJob> {
-    const {queueName, jobName, defaultJobOptions} = this.resolveDispatchArgs(job);
-
-    const queue = this.injector.get<Queue>(`bullmq.queue.${queueName}`);
-
-    if (!queue) {
-      throw new Error(`Queue(${queueName}) not defined`);
-    }
-
-    return queue.add(jobName, payload, {
-      ...defaultJobOptions,
-      ...options
-    });
-  }
-
-  private resolveDispatchArgs(job: Type | JobDispatcherOptions | string) {
-    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 = store.opts;
-    } 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
-    };
-  }
-}

package/src/dispatchers/JobDispatcherOptions.ts

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

package/src/dispatchers/index.ts

@@ -1,6 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from "./JobDispatcher";
-export * from "./JobDispatcherOptions";

package/src/index.ts

@@ -1,11 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-
-export * from "./BullMQModule";
-export * from "./config/config";
-export * from "./contracts/JobMethods";
-export * from "./contracts/JobStore";
-export * from "./decorators/JobController";
-export * from "./dispatchers/JobDispatcher";
-export * from "./dispatchers/JobDispatcherOptions";

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"
-    }
-  ]
-}