@tsed/bullmq 7.47.1 → 7.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +116 -11
- package/jest.config.js +1 -1
- package/lib/cjs/BullMQModule.js +24 -9
- package/lib/cjs/BullMQModule.js.map +1 -1
- package/lib/cjs/decorators/JobController.js +10 -1
- package/lib/cjs/decorators/JobController.js.map +1 -1
- package/lib/cjs/dispatchers/JobDispatcher.js +35 -8
- package/lib/cjs/dispatchers/JobDispatcher.js.map +1 -1
- package/lib/cjs/dispatchers/JobDispatcherOptions.js +3 -0
- package/lib/cjs/dispatchers/JobDispatcherOptions.js.map +1 -0
- package/lib/cjs/dispatchers/index.js +1 -0
- package/lib/cjs/dispatchers/index.js.map +1 -1
- package/lib/cjs/index.js +1 -0
- package/lib/cjs/index.js.map +1 -1
- package/lib/esm/BullMQModule.js +24 -9
- package/lib/esm/BullMQModule.js.map +1 -1
- package/lib/esm/decorators/JobController.js +8 -0
- package/lib/esm/decorators/JobController.js.map +1 -1
- package/lib/esm/dispatchers/JobDispatcher.js +35 -8
- package/lib/esm/dispatchers/JobDispatcher.js.map +1 -1
- package/lib/esm/dispatchers/JobDispatcherOptions.js +2 -0
- package/lib/esm/dispatchers/JobDispatcherOptions.js.map +1 -0
- package/lib/esm/dispatchers/index.js +1 -0
- package/lib/esm/dispatchers/index.js.map +1 -1
- package/lib/esm/index.js +1 -0
- package/lib/esm/index.js.map +1 -1
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/lib/types/config/config.d.ts +40 -1
- package/lib/types/contracts/JobMethods.d.ts +3 -2
- package/lib/types/decorators/JobController.d.ts +1 -0
- package/lib/types/dispatchers/JobDispatcher.d.ts +4 -0
- package/lib/types/dispatchers/JobDispatcherOptions.d.ts +4 -0
- package/lib/types/dispatchers/index.d.ts +1 -0
- package/lib/types/index.d.ts +1 -0
- package/package.json +5 -5
- package/src/BullMQModule.spec.ts +295 -118
- package/src/BullMQModule.ts +35 -10
- package/src/config/config.ts +48 -3
- package/src/contracts/JobMethods.ts +4 -2
- package/src/decorators/JobController.spec.ts +44 -1
- package/src/decorators/JobController.ts +12 -0
- package/src/dispatchers/JobDispatcher.spec.ts +48 -14
- package/src/dispatchers/JobDispatcher.ts +44 -8
- package/src/dispatchers/JobDispatcherOptions.ts +4 -0
- package/src/dispatchers/index.ts +1 -0
- package/src/index.ts +1 -0
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ A package of Ts.ED framework. See website: https://tsed.io
|
|
|
33
33
|
|
|
34
34
|
## Feature
|
|
35
35
|
|
|
36
|
-
The `@tsed/bullmq` package allows you to define jobs using the `@
|
|
36
|
+
The `@tsed/bullmq` package allows you to define jobs using the `@JobController` decorator and the `JobMethods` interface and have them picked up by the `BullMQ` worker.
|
|
37
37
|
|
|
38
38
|
## Installation
|
|
39
39
|
|
|
@@ -53,16 +53,35 @@ import "@tsed/bullmq"; // import bullmq ts.ed module
|
|
|
53
53
|
|
|
54
54
|
@Configuration({
|
|
55
55
|
bullmq: {
|
|
56
|
-
|
|
56
|
+
// Specify queue name's to create
|
|
57
|
+
queues: ["default", "special"],
|
|
57
58
|
connection: {
|
|
58
59
|
// redisio connection options
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
60
|
+
},
|
|
61
|
+
defaultQueueOptions: {
|
|
62
|
+
// Default queue options which are applied to every queue
|
|
63
|
+
// Can be extended/overridden by `queueOptions`
|
|
64
|
+
},
|
|
65
|
+
queueOptions: {
|
|
66
|
+
special: {
|
|
67
|
+
// Specify additional queue options by queue name
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
// Disable the creation of any worker.
|
|
71
|
+
// All other worker configuration will be ignored
|
|
72
|
+
disableWorker: true,
|
|
73
|
+
// Specify for which queues to start a worker for.
|
|
74
|
+
// When undefined falls back to all queues specified.
|
|
75
|
+
workerQueues: ["default"],
|
|
76
|
+
defaultWorkerOptions: {
|
|
77
|
+
// Default worker options which are applied to every worker
|
|
78
|
+
// Can be extended/overridden by `workerOptions`
|
|
79
|
+
},
|
|
80
|
+
workerOptions: {
|
|
81
|
+
special: {
|
|
82
|
+
// Specify additional worker options by queue name
|
|
83
|
+
}
|
|
84
|
+
}
|
|
66
85
|
}
|
|
67
86
|
})
|
|
68
87
|
export class Server {}
|
|
@@ -70,7 +89,7 @@ export class Server {}
|
|
|
70
89
|
|
|
71
90
|
## Define a Job
|
|
72
91
|
|
|
73
|
-
A job is defined as a class decorated with the `@
|
|
92
|
+
A job is defined as a class decorated with the `@JobController` decorator and implementing the `JobMethods` interface of the `@tsed/bullmq` package
|
|
74
93
|
|
|
75
94
|
```ts
|
|
76
95
|
import {JobController, JobMethods} from "@tsed/bullmq";
|
|
@@ -100,7 +119,8 @@ class OtherExampleJob implements JobMethods {
|
|
|
100
119
|
|
|
101
120
|
## Defining a repeating job
|
|
102
121
|
|
|
103
|
-
Jobs that should be run regularly on a schedule can also easily defined using the `@
|
|
122
|
+
Jobs that should be run regularly on a schedule can also easily defined using the `@JobController` decorator.
|
|
123
|
+
Doing so will automatically dispatch it without any data
|
|
104
124
|
|
|
105
125
|
```ts
|
|
106
126
|
import {JobController, JobMethods} from "@tsed/bullmq";
|
|
@@ -130,6 +150,42 @@ import "./jobs/MyCronJob";
|
|
|
130
150
|
export class Server {}
|
|
131
151
|
```
|
|
132
152
|
|
|
153
|
+
## Defining a fallback job
|
|
154
|
+
|
|
155
|
+
Because the `@JobController` requires a name, you can not use it in case you have dynamic job names.
|
|
156
|
+
For this use case there is a `@FallbackJobController`, which allows you to define a fallback method globally or per queue:
|
|
157
|
+
|
|
158
|
+
```ts
|
|
159
|
+
import {FallbackJobController, JobMethods} from "@tsed/bullmq";
|
|
160
|
+
|
|
161
|
+
@FallbackJobController("foo")
|
|
162
|
+
class FooFallbackController implements JobMethods {
|
|
163
|
+
public handle() {
|
|
164
|
+
console.info(`I run for every job within the "foo" queue, which doesn't has it's own JobController`);
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
@FallbackJobController()
|
|
169
|
+
class GlobalFallbackController implements JobMethods {
|
|
170
|
+
public handle() {
|
|
171
|
+
console.info(`I run for every job in every other queue, which doesn't has it's own JobController`);
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
You also have to register the fallback job in the server:
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import {Configuration} from "@tsed/common";
|
|
180
|
+
import "@tsed/bullmq"; // import bullmq ts.ed module
|
|
181
|
+
|
|
182
|
+
import "./jobs/MyFallbackJobs";
|
|
183
|
+
|
|
184
|
+
@Configuration()
|
|
185
|
+
// server configuration
|
|
186
|
+
export class Server {}
|
|
187
|
+
```
|
|
188
|
+
|
|
133
189
|
## Dispatching jobs
|
|
134
190
|
|
|
135
191
|
Dispatching jobs is done via the `JobDispatcher` service that takes the job to be dispatched and its payload.
|
|
@@ -151,6 +207,55 @@ class MyService {
|
|
|
151
207
|
}
|
|
152
208
|
```
|
|
153
209
|
|
|
210
|
+
In addition to statically defined job options when declaring the job, custom job options can also be set when dispatching the job.
|
|
211
|
+
This allows to for example delay the job from when it has originally been dispatched.
|
|
212
|
+
|
|
213
|
+
```ts
|
|
214
|
+
import {Service} from "@tsed/di";
|
|
215
|
+
import {JobDispatcher} from "@tsed/bullmq";
|
|
216
|
+
import {ExampleJob} from "./jobs/ExampleJob";
|
|
217
|
+
|
|
218
|
+
@Service()
|
|
219
|
+
class MyService {
|
|
220
|
+
constructor(private readonly dispatcher: JobDispatcher) {}
|
|
221
|
+
|
|
222
|
+
public async doingSomething() {
|
|
223
|
+
await this.dispatcher.dispatch(
|
|
224
|
+
ExampleJob,
|
|
225
|
+
{msg: "this message is part of the payload for the job"},
|
|
226
|
+
{
|
|
227
|
+
delay: 600_000 // 10 minutes in milliseconds
|
|
228
|
+
}
|
|
229
|
+
);
|
|
230
|
+
|
|
231
|
+
console.info("I just dispatched a job!");
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
In case you want to be more flexible, you can also dispatch a job via a name or a queue/name combination.
|
|
237
|
+
|
|
238
|
+
**Note**: This normally only make sense when you have a [Fallback Job](#defining-a-fallback-job) configured.
|
|
239
|
+
|
|
240
|
+
```ts
|
|
241
|
+
import {Service} from "@tsed/di";
|
|
242
|
+
import {JobDispatcher} from "@tsed/bullmq";
|
|
243
|
+
import {ExampleJob} from "./jobs/ExampleJob";
|
|
244
|
+
|
|
245
|
+
@Service()
|
|
246
|
+
class MyService {
|
|
247
|
+
constructor(private readonly dispatcher: JobDispatcher) {}
|
|
248
|
+
|
|
249
|
+
public async doingSomething() {
|
|
250
|
+
// When passing only a name, the job will be dispatched in a queue named "default"
|
|
251
|
+
await this.dispatcher.dispatch("some-name", {msg: "this message is part of the payload for the job"});
|
|
252
|
+
|
|
253
|
+
// You can also specifiy which queue to use
|
|
254
|
+
await this.dispatcher.dispatch({queue: "some-queue", name: "some-name"}, {msg: "this message is part of the payload for the job"});
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
```
|
|
258
|
+
|
|
154
259
|
## Contributors
|
|
155
260
|
|
|
156
261
|
Please read [contributing guidelines here](https://tsed.io/contributing.html)
|
package/jest.config.js
CHANGED
package/lib/cjs/BullMQModule.js
CHANGED
|
@@ -4,6 +4,7 @@ exports.BullMQModule = void 0;
|
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
5
|
const common_1 = require("@tsed/common");
|
|
6
6
|
const di_1 = require("@tsed/di");
|
|
7
|
+
const core_1 = require("@tsed/core");
|
|
7
8
|
const schema_1 = require("@tsed/schema");
|
|
8
9
|
const bullmq_1 = require("bullmq");
|
|
9
10
|
const uuid_1 = require("uuid");
|
|
@@ -20,19 +21,23 @@ let BullMQModule = class BullMQModule {
|
|
|
20
21
|
if (!this.bullmq) {
|
|
21
22
|
return;
|
|
22
23
|
}
|
|
23
|
-
this.
|
|
24
|
+
if (!this.bullmq.disableWorker) {
|
|
25
|
+
this.buildWorkers();
|
|
26
|
+
}
|
|
24
27
|
this.buildQueues();
|
|
25
28
|
this.injector.getMany("bullmq:cron").map((job) => this.dispatcher.dispatch((0, schema_1.getComputedType)(job)));
|
|
26
29
|
}
|
|
27
30
|
buildQueues() {
|
|
28
31
|
this.bullmq.queues.forEach((queue) => {
|
|
32
|
+
const ops = (0, core_1.deepMerge)({
|
|
33
|
+
connection: this.bullmq.connection,
|
|
34
|
+
defaultJobOptions: this.bullmq.defaultJobOptions,
|
|
35
|
+
...this.bullmq.defaultQueueOptions
|
|
36
|
+
}, this.bullmq.queueOptions?.[queue]);
|
|
29
37
|
this.injector
|
|
30
38
|
.add(`bullmq.queue.${queue}`, {
|
|
31
39
|
type: "bullmq:queue",
|
|
32
|
-
useValue: new bullmq_1.Queue(queue,
|
|
33
|
-
connection: this.bullmq.connection,
|
|
34
|
-
defaultJobOptions: this.bullmq.defaultJobOptions
|
|
35
|
-
}),
|
|
40
|
+
useValue: new bullmq_1.Queue(queue, ops),
|
|
36
41
|
hooks: {
|
|
37
42
|
$onDestroy: (queue) => queue.close()
|
|
38
43
|
}
|
|
@@ -42,12 +47,14 @@ let BullMQModule = class BullMQModule {
|
|
|
42
47
|
}
|
|
43
48
|
buildWorkers() {
|
|
44
49
|
(this.bullmq.workerQueues ?? this.bullmq.queues).forEach((queue) => {
|
|
50
|
+
const ops = (0, core_1.deepMerge)({
|
|
51
|
+
connection: this.bullmq.connection,
|
|
52
|
+
...this.bullmq.defaultWorkerOptions
|
|
53
|
+
}, this.bullmq.workerOptions?.[queue]);
|
|
45
54
|
this.injector
|
|
46
55
|
.add(`bullmq.worker.${queue}`, {
|
|
47
56
|
type: "bullmq:worker",
|
|
48
|
-
useValue: new bullmq_1.Worker(queue, this.onProcess.bind(this),
|
|
49
|
-
connection: this.bullmq.connection
|
|
50
|
-
}),
|
|
57
|
+
useValue: new bullmq_1.Worker(queue, this.onProcess.bind(this), ops),
|
|
51
58
|
hooks: {
|
|
52
59
|
$onDestroy: (worker) => worker.close()
|
|
53
60
|
}
|
|
@@ -56,7 +63,15 @@ let BullMQModule = class BullMQModule {
|
|
|
56
63
|
});
|
|
57
64
|
}
|
|
58
65
|
getJob(name, queueName) {
|
|
59
|
-
|
|
66
|
+
const job = this.injector.get(`bullmq.job.${queueName}.${name}`);
|
|
67
|
+
if (job) {
|
|
68
|
+
return job;
|
|
69
|
+
}
|
|
70
|
+
const fallbackJobForQueue = this.injector.get(`bullmq.fallback-job.${queueName}`);
|
|
71
|
+
if (fallbackJobForQueue) {
|
|
72
|
+
return fallbackJobForQueue;
|
|
73
|
+
}
|
|
74
|
+
return this.injector.get("bullmq.fallback-job");
|
|
60
75
|
}
|
|
61
76
|
async onProcess(job) {
|
|
62
77
|
const jobService = this.getJob(job.name, job.queueName);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BullMQModule.js","sourceRoot":"","sources":["../../src/BullMQModule.ts"],"names":[],"mappings":";;;;AAAA,yCAAiE;AACjE,iCAA2D;AAC3D,yCAA6C;AAC7C,
|
|
1
|
+
{"version":3,"file":"BullMQModule.js","sourceRoot":"","sources":["../../src/BullMQModule.ts"],"names":[],"mappings":";;;;AAAA,yCAAiE;AACjE,iCAA2D;AAC3D,qCAAqC;AACrC,yCAA6C;AAC7C,mCAAiF;AACjF,+BAAwB;AAGxB,+CAA4C;AAGrC,IAAM,YAAY,GAAlB,MAAM,YAAY;IAIM;IAA4C;IAFxD,MAAM,CAAe;IAEtC,YAA6B,QAAyB,EAAmB,UAAyB;QAArE,aAAQ,GAAR,QAAQ,CAAiB;QAAmB,eAAU,GAAV,UAAU,CAAe;IAAG,CAAC;IAEtG,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAO;SACR;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;SACrB;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAa,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAA,wBAAe,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IAEO,WAAW;QACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,IAAA,gBAAS,EACnB;gBACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB;gBAChD,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB;aACnC,EACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CACjC,CAAC;YAEH,IAAI,CAAC,QAAQ;iBACV,GAAG,CAAC,gBAAgB,KAAK,EAAE,EAAE;gBAC5B,IAAI,EAAE,cAAc;gBACpB,QAAQ,EAAE,IAAI,cAAK,CAAC,KAAK,EAAE,GAAG,CAAC;gBAC/B,KAAK,EAAE;oBACL,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE;iBACrC;aACF,CAAC;iBACD,MAAM,CAAQ,gBAAgB,KAAK,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY;QAClB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjE,MAAM,GAAG,GAAG,IAAA,gBAAS,EACnB;gBACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB;aACpC,EACD,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAClC,CAAC;YAEH,IAAI,CAAC,QAAQ;iBACV,GAAG,CAAC,iBAAiB,KAAK,EAAE,EAAE;gBAC7B,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,IAAI,eAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;gBAC3D,KAAK,EAAE;oBACL,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;iBACvC;aACF,CAAC;iBACD,MAAM,CAAS,iBAAiB,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,IAAY,EAAE,SAAiB;QAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAa,cAAc,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC;QAC7E,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QAClF,IAAI,mBAAmB,EAAE;YACvB,OAAO,mBAAmB,CAAC;SAC5B;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,GAAQ;QAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,UAAU,EAAE;YACf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,YAAY;aACtD,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,IAAI,GAAG,IAAI,kBAAS,CAAC;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,IAAA,SAAE,GAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAE5B,IAAI;YACF,OAAO,MAAM,IAAA,qBAAY,EAAC,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;SACzE;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,kBAAkB;gBACzB,OAAO,EAAE,EAAE,CAAC,OAAO;gBACnB,KAAK,EAAE,EAAE,CAAC,KAAK;aAChB,CAAC,CAAC;YACH,MAAM,EAAE,CAAC;SACV;gBAAS;YACR,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;SACtB;IACH,CAAC;CACF,CAAA;AA7GC;IAAC,IAAA,aAAQ,EAAC,QAAQ,CAAC;;4CACmB;AAF3B,YAAY;IADxB,IAAA,WAAM,GAAE;6CAKgC,oBAAe,EAA+B,2BAAa;GAJvF,YAAY,CA8GxB;AA9GY,oCAAY"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.JobController = void 0;
|
|
3
|
+
exports.FallbackJobController = exports.JobController = void 0;
|
|
4
4
|
const core_1 = require("@tsed/core");
|
|
5
5
|
const di_1 = require("@tsed/di");
|
|
6
6
|
function JobController(name, queue = "default", opts = {}) {
|
|
@@ -14,4 +14,13 @@ function JobController(name, queue = "default", opts = {}) {
|
|
|
14
14
|
}));
|
|
15
15
|
}
|
|
16
16
|
exports.JobController = JobController;
|
|
17
|
+
function FallbackJobController(queue) {
|
|
18
|
+
return (0, core_1.useDecorators)((0, core_1.StoreMerge)("bullmq", {
|
|
19
|
+
queue
|
|
20
|
+
}), (0, di_1.Injectable)({
|
|
21
|
+
provide: "bullmq.fallback-job" + (queue ? `.${queue}` : ""),
|
|
22
|
+
type: "bullmq:fallback-job"
|
|
23
|
+
}));
|
|
24
|
+
}
|
|
25
|
+
exports.FallbackJobController = FallbackJobController;
|
|
17
26
|
//# sourceMappingURL=JobController.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JobController.js","sourceRoot":"","sources":["../../../src/decorators/JobController.ts"],"names":[],"mappings":";;;AAAA,qCAAqD;AACrD,iCAAoC;AAGpC,SAAgB,aAAa,CAAC,IAAY,EAAE,QAAgB,SAAS,EAAE,OAAoB,EAAE;IAC3F,OAAO,IAAA,oBAAa,EAClB,IAAA,iBAAU,EAAC,QAAQ,EAAE;QACnB,IAAI;QACJ,KAAK;QACL,IAAI;KACL,CAAC,EACF,IAAA,eAAU,EAAC;QACT,OAAO,EAAE,cAAc,KAAK,IAAI,IAAI,EAAE;QACtC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY;KACjD,CAAC,CACH,CAAC;AACJ,CAAC;AAZD,sCAYC"}
|
|
1
|
+
{"version":3,"file":"JobController.js","sourceRoot":"","sources":["../../../src/decorators/JobController.ts"],"names":[],"mappings":";;;AAAA,qCAAqD;AACrD,iCAAoC;AAGpC,SAAgB,aAAa,CAAC,IAAY,EAAE,QAAgB,SAAS,EAAE,OAAoB,EAAE;IAC3F,OAAO,IAAA,oBAAa,EAClB,IAAA,iBAAU,EAAC,QAAQ,EAAE;QACnB,IAAI;QACJ,KAAK;QACL,IAAI;KACL,CAAC,EACF,IAAA,eAAU,EAAC;QACT,OAAO,EAAE,cAAc,KAAK,IAAI,IAAI,EAAE;QACtC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY;KACjD,CAAC,CACH,CAAC;AACJ,CAAC;AAZD,sCAYC;AAED,SAAgB,qBAAqB,CAAC,KAAc;IAClD,OAAO,IAAA,oBAAa,EAClB,IAAA,iBAAU,EAAC,QAAQ,EAAE;QACnB,KAAK;KACN,CAAC,EACF,IAAA,eAAU,EAAC;QACT,OAAO,EAAE,qBAAqB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,qBAAqB;KAC5B,CAAC,CACH,CAAC;AACJ,CAAC;AAVD,sDAUC"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.JobDispatcher = void 0;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
+
/* eslint-disable require-await */
|
|
5
6
|
const di_1 = require("@tsed/di");
|
|
6
7
|
const core_1 = require("@tsed/core");
|
|
7
8
|
let JobDispatcher = class JobDispatcher {
|
|
@@ -9,18 +10,44 @@ let JobDispatcher = class JobDispatcher {
|
|
|
9
10
|
constructor(injector) {
|
|
10
11
|
this.injector = injector;
|
|
11
12
|
}
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
const
|
|
15
|
-
const queue = this.injector.getMany("bullmq:queue").find((queue) => queue.name === store.queue);
|
|
13
|
+
async dispatch(job, payload, options = {}) {
|
|
14
|
+
const { queueName, jobName, defaultJobOptions } = this.resolveDispatchArgs(job);
|
|
15
|
+
const queue = this.injector.get(`bullmq.queue.${queueName}`);
|
|
16
16
|
if (!queue) {
|
|
17
|
-
throw new Error(`Queue(${
|
|
17
|
+
throw new Error(`Queue(${queueName}) not defined`);
|
|
18
18
|
}
|
|
19
|
-
return queue.add(
|
|
20
|
-
...
|
|
21
|
-
...options
|
|
19
|
+
return queue.add(jobName, payload, {
|
|
20
|
+
...defaultJobOptions,
|
|
21
|
+
...options
|
|
22
22
|
});
|
|
23
23
|
}
|
|
24
|
+
resolveDispatchArgs(job) {
|
|
25
|
+
let queueName;
|
|
26
|
+
let jobName;
|
|
27
|
+
let defaultJobOptions;
|
|
28
|
+
if (typeof job === "function") {
|
|
29
|
+
// job is passed as a Type
|
|
30
|
+
const store = core_1.Store.from(job).get("bullmq");
|
|
31
|
+
queueName = store.queue;
|
|
32
|
+
jobName = store.name;
|
|
33
|
+
defaultJobOptions = store.opts;
|
|
34
|
+
}
|
|
35
|
+
else if (typeof job === "object") {
|
|
36
|
+
// job is passed as JobDispatcherOptions
|
|
37
|
+
queueName = job.queue;
|
|
38
|
+
jobName = job.name;
|
|
39
|
+
}
|
|
40
|
+
else {
|
|
41
|
+
// job is passed as a string
|
|
42
|
+
queueName = "default";
|
|
43
|
+
jobName = job;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
queueName,
|
|
47
|
+
jobName,
|
|
48
|
+
defaultJobOptions
|
|
49
|
+
};
|
|
50
|
+
}
|
|
24
51
|
};
|
|
25
52
|
JobDispatcher = tslib_1.__decorate([
|
|
26
53
|
(0, di_1.Service)(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JobDispatcher.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcher.ts"],"names":[],"mappings":";;;;AAAA,iCAAkD;AAElD,qCAAuC;
|
|
1
|
+
{"version":3,"file":"JobDispatcher.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcher.ts"],"names":[],"mappings":";;;;AAAA,kCAAkC;AAClC,iCAAkD;AAElD,qCAAuC;AAKhC,IAAM,aAAa,GAAnB,MAAM,aAAa;IACK;IAA7B,YAA6B,QAAyB;QAAzB,aAAQ,GAAR,QAAQ,CAAiB;IAAG,CAAC;IASnD,KAAK,CAAC,QAAQ,CAAC,GAAyC,EAAE,OAAY,EAAE,UAAuB,EAAE;QACtG,MAAM,EAAC,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAE9E,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAQ,gBAAgB,SAAS,EAAE,CAAC,CAAC;QAEpE,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,SAAS,SAAS,eAAe,CAAC,CAAC;SACpD;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE;YACjC,GAAG,iBAAiB;YACpB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,GAAyC;QACnE,IAAI,SAAiB,CAAC;QACtB,IAAI,OAAe,CAAC;QACpB,IAAI,iBAA0C,CAAC;QAE/C,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;YAC7B,0BAA0B;YAC1B,MAAM,KAAK,GAAG,YAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAW,QAAQ,CAAC,CAAC;YACtD,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC;YACxB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC;YACrB,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC;SAChC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,wCAAwC;YACxC,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC;YACtB,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC;SACpB;aAAM;YACL,4BAA4B;YAC5B,SAAS,GAAG,SAAS,CAAC;YACtB,OAAO,GAAG,GAAG,CAAC;SACf;QAED,OAAO;YACL,SAAS;YACT,OAAO;YACP,iBAAiB;SAClB,CAAC;IACJ,CAAC;CACF,CAAA;AApDY,aAAa;IADzB,IAAA,YAAO,GAAE;6CAE+B,oBAAe;GAD3C,aAAa,CAoDzB;AApDY,sCAAa"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JobDispatcherOptions.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcherOptions.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dispatchers/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0DAAgC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dispatchers/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0DAAgC;AAChC,iEAAuC"}
|
package/lib/cjs/index.js
CHANGED
|
@@ -10,4 +10,5 @@ tslib_1.__exportStar(require("./contracts/JobMethods"), exports);
|
|
|
10
10
|
tslib_1.__exportStar(require("./contracts/JobStore"), exports);
|
|
11
11
|
tslib_1.__exportStar(require("./decorators/JobController"), exports);
|
|
12
12
|
tslib_1.__exportStar(require("./dispatchers/JobDispatcher"), exports);
|
|
13
|
+
tslib_1.__exportStar(require("./dispatchers/JobDispatcherOptions"), exports);
|
|
13
14
|
//# sourceMappingURL=index.js.map
|
package/lib/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,yDAA+B;AAC/B,0DAAgC;AAChC,iEAAuC;AACvC,+DAAqC;AACrC,qEAA2C;AAC3C,sEAA4C"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,yDAA+B;AAC/B,0DAAgC;AAChC,iEAAuC;AACvC,+DAAqC;AACrC,qEAA2C;AAC3C,sEAA4C;AAC5C,6EAAmD"}
|
package/lib/esm/BullMQModule.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { __decorate, __metadata } from "tslib";
|
|
2
2
|
import { DIContext, runInContext } from "@tsed/common";
|
|
3
3
|
import { Constant, InjectorService, Module } from "@tsed/di";
|
|
4
|
+
import { deepMerge } from "@tsed/core";
|
|
4
5
|
import { getComputedType } from "@tsed/schema";
|
|
5
6
|
import { Queue, Worker } from "bullmq";
|
|
6
7
|
import { v4 } from "uuid";
|
|
@@ -17,19 +18,23 @@ let BullMQModule = class BullMQModule {
|
|
|
17
18
|
if (!this.bullmq) {
|
|
18
19
|
return;
|
|
19
20
|
}
|
|
20
|
-
this.
|
|
21
|
+
if (!this.bullmq.disableWorker) {
|
|
22
|
+
this.buildWorkers();
|
|
23
|
+
}
|
|
21
24
|
this.buildQueues();
|
|
22
25
|
this.injector.getMany("bullmq:cron").map((job) => this.dispatcher.dispatch(getComputedType(job)));
|
|
23
26
|
}
|
|
24
27
|
buildQueues() {
|
|
25
28
|
this.bullmq.queues.forEach((queue) => {
|
|
29
|
+
const ops = deepMerge({
|
|
30
|
+
connection: this.bullmq.connection,
|
|
31
|
+
defaultJobOptions: this.bullmq.defaultJobOptions,
|
|
32
|
+
...this.bullmq.defaultQueueOptions
|
|
33
|
+
}, this.bullmq.queueOptions?.[queue]);
|
|
26
34
|
this.injector
|
|
27
35
|
.add(`bullmq.queue.${queue}`, {
|
|
28
36
|
type: "bullmq:queue",
|
|
29
|
-
useValue: new Queue(queue,
|
|
30
|
-
connection: this.bullmq.connection,
|
|
31
|
-
defaultJobOptions: this.bullmq.defaultJobOptions
|
|
32
|
-
}),
|
|
37
|
+
useValue: new Queue(queue, ops),
|
|
33
38
|
hooks: {
|
|
34
39
|
$onDestroy: (queue) => queue.close()
|
|
35
40
|
}
|
|
@@ -39,12 +44,14 @@ let BullMQModule = class BullMQModule {
|
|
|
39
44
|
}
|
|
40
45
|
buildWorkers() {
|
|
41
46
|
(this.bullmq.workerQueues ?? this.bullmq.queues).forEach((queue) => {
|
|
47
|
+
const ops = deepMerge({
|
|
48
|
+
connection: this.bullmq.connection,
|
|
49
|
+
...this.bullmq.defaultWorkerOptions
|
|
50
|
+
}, this.bullmq.workerOptions?.[queue]);
|
|
42
51
|
this.injector
|
|
43
52
|
.add(`bullmq.worker.${queue}`, {
|
|
44
53
|
type: "bullmq:worker",
|
|
45
|
-
useValue: new Worker(queue, this.onProcess.bind(this),
|
|
46
|
-
connection: this.bullmq.connection
|
|
47
|
-
}),
|
|
54
|
+
useValue: new Worker(queue, this.onProcess.bind(this), ops),
|
|
48
55
|
hooks: {
|
|
49
56
|
$onDestroy: (worker) => worker.close()
|
|
50
57
|
}
|
|
@@ -53,7 +60,15 @@ let BullMQModule = class BullMQModule {
|
|
|
53
60
|
});
|
|
54
61
|
}
|
|
55
62
|
getJob(name, queueName) {
|
|
56
|
-
|
|
63
|
+
const job = this.injector.get(`bullmq.job.${queueName}.${name}`);
|
|
64
|
+
if (job) {
|
|
65
|
+
return job;
|
|
66
|
+
}
|
|
67
|
+
const fallbackJobForQueue = this.injector.get(`bullmq.fallback-job.${queueName}`);
|
|
68
|
+
if (fallbackJobForQueue) {
|
|
69
|
+
return fallbackJobForQueue;
|
|
70
|
+
}
|
|
71
|
+
return this.injector.get("bullmq.fallback-job");
|
|
57
72
|
}
|
|
58
73
|
async onProcess(job) {
|
|
59
74
|
const jobService = this.getJob(job.name, job.queueName);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BullMQModule.js","sourceRoot":"","sources":["../../src/BullMQModule.ts"],"names":[],"mappings":";AAAA,OAAO,EAAa,SAAS,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AACjE,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAM,KAAK,
|
|
1
|
+
{"version":3,"file":"BullMQModule.js","sourceRoot":"","sources":["../../src/BullMQModule.ts"],"names":[],"mappings":";AAAA,OAAO,EAAa,SAAS,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AACjE,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AACrC,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAM,KAAK,EAAqB,MAAM,EAAqB,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAC,EAAE,EAAC,MAAM,MAAM,CAAC;AAGxB,OAAO,EAAC,aAAa,EAAC,MAAM,eAAe,CAAC;AAGrC,IAAM,YAAY,GAAlB,MAAM,YAAY;IAIM;IAA4C;IAFxD,MAAM,CAAe;IAEtC,YAA6B,QAAyB,EAAmB,UAAyB;QAArE,aAAQ,GAAR,QAAQ,CAAiB;QAAmB,eAAU,GAAV,UAAU,CAAe;IAAG,CAAC;IAEtG,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAO;SACR;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;SACrB;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAa,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IAEO,WAAW;QACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,SAAS,CACnB;gBACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB;gBAChD,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB;aACnC,EACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CACjC,CAAC;YAEH,IAAI,CAAC,QAAQ;iBACV,GAAG,CAAC,gBAAgB,KAAK,EAAE,EAAE;gBAC5B,IAAI,EAAE,cAAc;gBACpB,QAAQ,EAAE,IAAI,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC;gBAC/B,KAAK,EAAE;oBACL,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE;iBACrC;aACF,CAAC;iBACD,MAAM,CAAQ,gBAAgB,KAAK,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY;QAClB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACjE,MAAM,GAAG,GAAG,SAAS,CACnB;gBACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;gBAClC,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB;aACpC,EACD,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,CAClC,CAAC;YAEH,IAAI,CAAC,QAAQ;iBACV,GAAG,CAAC,iBAAiB,KAAK,EAAE,EAAE;gBAC7B,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;gBAC3D,KAAK,EAAE;oBACL,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;iBACvC;aACF,CAAC;iBACD,MAAM,CAAS,iBAAiB,KAAK,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,IAAY,EAAE,SAAiB;QAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAa,cAAc,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC;QAC7E,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QAClF,IAAI,mBAAmB,EAAE;YACvB,OAAO,mBAAmB,CAAC;SAC5B;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,GAAQ;QAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,UAAU,EAAE;YACf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,SAAS,YAAY;aACtD,CAAC,CAAC;YACH,OAAO;SACR;QAED,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,EAAE,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAE5B,IAAI;YACF,OAAO,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;SACzE;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,kBAAkB;gBACzB,OAAO,EAAE,EAAE,CAAC,OAAO;gBACnB,KAAK,EAAE,EAAE,CAAC,KAAK;aAChB,CAAC,CAAC;YACH,MAAM,EAAE,CAAC;SACV;gBAAS;YACR,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;SACtB;IACH,CAAC;CACF,CAAA;AA7GC;IAAC,QAAQ,CAAC,QAAQ,CAAC;;4CACmB;AAF3B,YAAY;IADxB,MAAM,EAAE;qCAKgC,eAAe,EAA+B,aAAa;GAJvF,YAAY,CA8GxB;SA9GY,YAAY"}
|
|
@@ -10,4 +10,12 @@ export function JobController(name, queue = "default", opts = {}) {
|
|
|
10
10
|
type: opts.repeat ? "bullmq:cron" : "bullmq:job"
|
|
11
11
|
}));
|
|
12
12
|
}
|
|
13
|
+
export function FallbackJobController(queue) {
|
|
14
|
+
return useDecorators(StoreMerge("bullmq", {
|
|
15
|
+
queue
|
|
16
|
+
}), Injectable({
|
|
17
|
+
provide: "bullmq.fallback-job" + (queue ? `.${queue}` : ""),
|
|
18
|
+
type: "bullmq:fallback-job"
|
|
19
|
+
}));
|
|
20
|
+
}
|
|
13
21
|
//# sourceMappingURL=JobController.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JobController.js","sourceRoot":"","sources":["../../../src/decorators/JobController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,QAAgB,SAAS,EAAE,OAAoB,EAAE;IAC3F,OAAO,aAAa,CAClB,UAAU,CAAC,QAAQ,EAAE;QACnB,IAAI;QACJ,KAAK;QACL,IAAI;KACL,CAAC,EACF,UAAU,CAAC;QACT,OAAO,EAAE,cAAc,KAAK,IAAI,IAAI,EAAE;QACtC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY;KACjD,CAAC,CACH,CAAC;AACJ,CAAC"}
|
|
1
|
+
{"version":3,"file":"JobController.js","sourceRoot":"","sources":["../../../src/decorators/JobController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAGpC,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,QAAgB,SAAS,EAAE,OAAoB,EAAE;IAC3F,OAAO,aAAa,CAClB,UAAU,CAAC,QAAQ,EAAE;QACnB,IAAI;QACJ,KAAK;QACL,IAAI;KACL,CAAC,EACF,UAAU,CAAC;QACT,OAAO,EAAE,cAAc,KAAK,IAAI,IAAI,EAAE;QACtC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY;KACjD,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,aAAa,CAClB,UAAU,CAAC,QAAQ,EAAE;QACnB,KAAK;KACN,CAAC,EACF,UAAU,CAAC;QACT,OAAO,EAAE,qBAAqB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,qBAAqB;KAC5B,CAAC,CACH,CAAC;AACJ,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { __decorate, __metadata } from "tslib";
|
|
2
|
+
/* eslint-disable require-await */
|
|
2
3
|
import { InjectorService, Service } from "@tsed/di";
|
|
3
4
|
import { Store } from "@tsed/core";
|
|
4
5
|
let JobDispatcher = class JobDispatcher {
|
|
@@ -6,18 +7,44 @@ let JobDispatcher = class JobDispatcher {
|
|
|
6
7
|
constructor(injector) {
|
|
7
8
|
this.injector = injector;
|
|
8
9
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
const
|
|
12
|
-
const queue = this.injector.getMany("bullmq:queue").find((queue) => queue.name === store.queue);
|
|
10
|
+
async dispatch(job, payload, options = {}) {
|
|
11
|
+
const { queueName, jobName, defaultJobOptions } = this.resolveDispatchArgs(job);
|
|
12
|
+
const queue = this.injector.get(`bullmq.queue.${queueName}`);
|
|
13
13
|
if (!queue) {
|
|
14
|
-
throw new Error(`Queue(${
|
|
14
|
+
throw new Error(`Queue(${queueName}) not defined`);
|
|
15
15
|
}
|
|
16
|
-
return queue.add(
|
|
17
|
-
...
|
|
18
|
-
...options
|
|
16
|
+
return queue.add(jobName, payload, {
|
|
17
|
+
...defaultJobOptions,
|
|
18
|
+
...options
|
|
19
19
|
});
|
|
20
20
|
}
|
|
21
|
+
resolveDispatchArgs(job) {
|
|
22
|
+
let queueName;
|
|
23
|
+
let jobName;
|
|
24
|
+
let defaultJobOptions;
|
|
25
|
+
if (typeof job === "function") {
|
|
26
|
+
// job is passed as a Type
|
|
27
|
+
const store = Store.from(job).get("bullmq");
|
|
28
|
+
queueName = store.queue;
|
|
29
|
+
jobName = store.name;
|
|
30
|
+
defaultJobOptions = store.opts;
|
|
31
|
+
}
|
|
32
|
+
else if (typeof job === "object") {
|
|
33
|
+
// job is passed as JobDispatcherOptions
|
|
34
|
+
queueName = job.queue;
|
|
35
|
+
jobName = job.name;
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
// job is passed as a string
|
|
39
|
+
queueName = "default";
|
|
40
|
+
jobName = job;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
queueName,
|
|
44
|
+
jobName,
|
|
45
|
+
defaultJobOptions
|
|
46
|
+
};
|
|
47
|
+
}
|
|
21
48
|
};
|
|
22
49
|
JobDispatcher = __decorate([
|
|
23
50
|
Service(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JobDispatcher.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcher.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,eAAe,EAAE,OAAO,EAAC,MAAM,UAAU,CAAC;AAElD,OAAO,EAAC,KAAK,EAAO,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"JobDispatcher.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcher.ts"],"names":[],"mappings":";AAAA,kCAAkC;AAClC,OAAO,EAAC,eAAe,EAAE,OAAO,EAAC,MAAM,UAAU,CAAC;AAElD,OAAO,EAAC,KAAK,EAAO,MAAM,YAAY,CAAC;AAKhC,IAAM,aAAa,GAAnB,MAAM,aAAa;IACK;IAA7B,YAA6B,QAAyB;QAAzB,aAAQ,GAAR,QAAQ,CAAiB;IAAG,CAAC;IASnD,KAAK,CAAC,QAAQ,CAAC,GAAyC,EAAE,OAAY,EAAE,UAAuB,EAAE;QACtG,MAAM,EAAC,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAE9E,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAQ,gBAAgB,SAAS,EAAE,CAAC,CAAC;QAEpE,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,SAAS,SAAS,eAAe,CAAC,CAAC;SACpD;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE;YACjC,GAAG,iBAAiB;YACpB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CAAC,GAAyC;QACnE,IAAI,SAAiB,CAAC;QACtB,IAAI,OAAe,CAAC;QACpB,IAAI,iBAA0C,CAAC;QAE/C,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;YAC7B,0BAA0B;YAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAW,QAAQ,CAAC,CAAC;YACtD,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC;YACxB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC;YACrB,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC;SAChC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,wCAAwC;YACxC,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC;YACtB,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC;SACpB;aAAM;YACL,4BAA4B;YAC5B,SAAS,GAAG,SAAS,CAAC;YACtB,OAAO,GAAG,GAAG,CAAC;SACf;QAED,OAAO;YACL,SAAS;YACT,OAAO;YACP,iBAAiB;SAClB,CAAC;IACJ,CAAC;CACF,CAAA;AApDY,aAAa;IADzB,OAAO,EAAE;qCAE+B,eAAe;GAD3C,aAAa,CAoDzB;SApDY,aAAa"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JobDispatcherOptions.js","sourceRoot":"","sources":["../../../src/dispatchers/JobDispatcherOptions.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dispatchers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,iBAAiB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dispatchers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC"}
|
package/lib/esm/index.js
CHANGED
|
@@ -7,4 +7,5 @@ export * from "./contracts/JobMethods.js";
|
|
|
7
7
|
export * from "./contracts/JobStore.js";
|
|
8
8
|
export * from "./decorators/JobController.js";
|
|
9
9
|
export * from "./dispatchers/JobDispatcher.js";
|
|
10
|
+
export * from "./dispatchers/JobDispatcherOptions.js";
|
|
10
11
|
//# sourceMappingURL=index.js.map
|
package/lib/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC"}
|