@opens/bullmq 1.0.6 → 1.0.8
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/dist/index.d.ts +5 -2
- package/dist/index.js +27 -23
- package/dist/index.js.map +1 -1
- package/package.json +9 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import * as BullMQ from 'bullmq';
|
|
2
2
|
import { Redis } from 'ioredis';
|
|
3
|
+
import { observer } from '@opens/observability';
|
|
3
4
|
|
|
4
5
|
declare class BullMQWrapper {
|
|
5
6
|
private defaultConnection;
|
|
@@ -16,12 +17,13 @@ declare class BullMQWrapper {
|
|
|
16
17
|
removeOnCompleteCount?: number;
|
|
17
18
|
removeOnFailAge?: number;
|
|
18
19
|
removeOnFailCount?: number;
|
|
20
|
+
tracer?: typeof observer.tracer;
|
|
19
21
|
}): {
|
|
20
22
|
queue: BullMQ.Queue<any, any, string, any, any, string>;
|
|
21
23
|
worker?: undefined;
|
|
22
24
|
} | {
|
|
23
25
|
queue: BullMQ.Queue<any, any, string, any, any, string>;
|
|
24
|
-
worker: BullMQ.Worker<any,
|
|
26
|
+
worker: BullMQ.Worker<any, void, string>;
|
|
25
27
|
} | undefined;
|
|
26
28
|
createWorker(params: {
|
|
27
29
|
taskName: string;
|
|
@@ -29,13 +31,14 @@ declare class BullMQWrapper {
|
|
|
29
31
|
down?: (data: any, job: BullMQ.Job, err: unknown) => Promise<void>;
|
|
30
32
|
connection?: Redis;
|
|
31
33
|
concurrency: number;
|
|
34
|
+
tracer?: typeof observer.tracer;
|
|
32
35
|
removeOnCompleteAge?: number;
|
|
33
36
|
removeOnCompleteCount?: number;
|
|
34
37
|
removeOnFailAge?: number;
|
|
35
38
|
removeOnFailCount?: number;
|
|
36
39
|
onError?: Function;
|
|
37
40
|
}): {
|
|
38
|
-
worker: BullMQ.Worker<any,
|
|
41
|
+
worker: BullMQ.Worker<any, void, string>;
|
|
39
42
|
};
|
|
40
43
|
publishTask(params: {
|
|
41
44
|
taskName: string;
|
package/dist/index.js
CHANGED
|
@@ -36,6 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
|
|
37
37
|
// src/wrapper.ts
|
|
38
38
|
var BullMQ = __toESM(require("bullmq"));
|
|
39
|
+
var import_observability = require("@opens/observability");
|
|
39
40
|
var BullMQWrapper = class {
|
|
40
41
|
constructor(defaultConnection) {
|
|
41
42
|
this.defaultConnection = defaultConnection;
|
|
@@ -69,34 +70,37 @@ var BullMQWrapper = class {
|
|
|
69
70
|
removeOnFailCount,
|
|
70
71
|
removeOnCompleteAge,
|
|
71
72
|
removeOnCompleteCount,
|
|
72
|
-
removeOnFailAge
|
|
73
|
+
removeOnFailAge,
|
|
74
|
+
tracer
|
|
73
75
|
} = params;
|
|
74
76
|
const registeredQueue = this.taskQueues.get(taskName);
|
|
75
77
|
if (!registeredQueue) throw new Error(`No task queue for [${taskName}] found`);
|
|
76
|
-
const
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
78
|
+
const fn = async (job) => {
|
|
79
|
+
try {
|
|
80
|
+
await up(job.data, job);
|
|
81
|
+
} catch (error) {
|
|
82
|
+
if (down) await down(job.data, job, error);
|
|
83
|
+
throw error;
|
|
84
|
+
} finally {
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
const handler = tracer?.instrumentFunc({ name: taskName, type: import_observability.TRACE_TYPE.TASK }, fn) ?? fn;
|
|
88
|
+
const worker = new BullMQ.Worker(taskName, handler, {
|
|
89
|
+
concurrency,
|
|
90
|
+
connection: connection ?? this.defaultConnection,
|
|
91
|
+
removeOnComplete: {
|
|
92
|
+
age: removeOnCompleteAge ?? 60 * 60,
|
|
93
|
+
count: removeOnCompleteCount ?? 20
|
|
86
94
|
},
|
|
87
|
-
{
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
removeOnComplete: {
|
|
91
|
-
age: removeOnCompleteAge ?? 0,
|
|
92
|
-
count: removeOnCompleteCount ?? 0
|
|
93
|
-
},
|
|
94
|
-
removeOnFail: {
|
|
95
|
-
age: removeOnFailAge ?? 0,
|
|
96
|
-
count: removeOnFailCount ?? 0
|
|
97
|
-
}
|
|
95
|
+
removeOnFail: {
|
|
96
|
+
age: removeOnFailAge ?? 60 * 60,
|
|
97
|
+
count: removeOnFailCount ?? 50
|
|
98
98
|
}
|
|
99
|
-
);
|
|
99
|
+
});
|
|
100
|
+
worker.on("ready", () => {
|
|
101
|
+
console.log(`[opens/bullmq]: '${taskName}' worker is ready`);
|
|
102
|
+
});
|
|
103
|
+
worker.on("error", console.error);
|
|
100
104
|
return { worker };
|
|
101
105
|
}
|
|
102
106
|
async publishTask(params) {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/wrapper.ts","../src/default-connection.ts"],"sourcesContent":["import { BullMQWrapper } from './wrapper';\nimport { DefaultConnection } from './default-connection';\nexport const bullmq = new BullMQWrapper(DefaultConnection.getInstance());\n","import * as BullMQ from 'bullmq';\nimport { Redis } from 'ioredis';\
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/wrapper.ts","../src/default-connection.ts"],"sourcesContent":["import { BullMQWrapper } from './wrapper';\nimport { DefaultConnection } from './default-connection';\nexport const bullmq = new BullMQWrapper(DefaultConnection.getInstance());\n","import * as BullMQ from 'bullmq';\nimport { Redis } from 'ioredis';\nimport { observer, TRACE_TYPE } from '@opens/observability';\nexport class BullMQWrapper {\n private taskQueues: Map<string, BullMQ.Queue> = new Map();\n\n constructor(private defaultConnection: Redis) {}\n\n public createTask(params: {\n taskName: string;\n defaultOptions: BullMQ.DefaultJobOptions;\n connection?: Redis;\n up?: (data: any, job: BullMQ.Job) => Promise<void>;\n down?: (data: any, job: BullMQ.Job, err: unknown) => Promise<void>;\n concurrency?: number;\n removeOnCompleteAge?: number;\n removeOnCompleteCount?: number;\n removeOnFailAge?: number;\n removeOnFailCount?: number;\n tracer?: typeof observer.tracer;\n }) {\n const { taskName, up, down, defaultOptions, connection, concurrency } = params;\n if (this.taskQueues.has(taskName)) return;\n\n const queue = new BullMQ.Queue(taskName, {\n connection: this.defaultConnection ?? connection,\n defaultJobOptions: { backoff: { delay: 1000 * 60 * 5, type: 'fixed' }, attempts: 10, ...defaultOptions },\n });\n this.taskQueues.set(taskName, queue);\n console.debug(`[@opens/bullmq]: task queue'${taskName}' created`);\n if (!up) return { queue };\n\n const { worker } = this.createWorker({\n up,\n down,\n concurrency: concurrency ?? 1,\n ...params,\n });\n return { queue, worker };\n }\n\n public createWorker(params: {\n taskName: string;\n up: (data: any, job: BullMQ.Job) => Promise<void>;\n down?: (data: any, job: BullMQ.Job, err: unknown) => Promise<void>;\n connection?: Redis;\n concurrency: number;\n tracer?: typeof observer.tracer;\n removeOnCompleteAge?: number;\n removeOnCompleteCount?: number;\n removeOnFailAge?: number;\n removeOnFailCount?: number;\n onError?: Function;\n }) {\n const {\n taskName,\n up,\n down,\n concurrency,\n connection,\n removeOnFailCount,\n removeOnCompleteAge,\n removeOnCompleteCount,\n removeOnFailAge,\n tracer,\n } = params;\n\n const registeredQueue = this.taskQueues.get(taskName);\n if (!registeredQueue) throw new Error(`No task queue for [${taskName}] found`);\n const fn = async (job: BullMQ.Job) => {\n try {\n await up(job.data, job);\n } catch (error) {\n if (down) await down(job.data, job, error);\n throw error;\n } finally {\n }\n };\n const handler = tracer?.instrumentFunc({ name: taskName, type: TRACE_TYPE.TASK }, fn) ?? fn;\n\n const worker = new BullMQ.Worker(taskName, handler, {\n concurrency,\n connection: connection ?? this.defaultConnection,\n removeOnComplete: {\n age: removeOnCompleteAge ?? 60 * 60,\n count: removeOnCompleteCount ?? 20,\n },\n removeOnFail: {\n age: removeOnFailAge ?? 60 * 60,\n count: removeOnFailCount ?? 50,\n },\n });\n worker.on('ready', () => {\n console.log(`[opens/bullmq]: '${taskName}' worker is ready`);\n });\n worker.on('error', console.error);\n return { worker };\n }\n\n public async publishTask(params: { taskName: string; taskData: any; taskOptions: BullMQ.JobsOptions }) {\n const queue = this.taskQueues.get(params.taskName);\n if (!queue) return null;\n const job = await queue.add('', params.taskData, params.taskOptions);\n return job.asJSON();\n }\n\n public getTaskCount() {\n return this.taskQueues.size;\n }\n\n public async removeDeduplication(params: { taskName: string; deduplicationId: string }) {\n const queue = this.taskQueues.get(params.taskName);\n if (!queue) return 0;\n const result = await queue.removeDeduplicationKey(params.deduplicationId);\n return result;\n }\n}\n","import { Redis } from 'ioredis';\nexport class DefaultConnection {\n static getInstance() {\n const host = process.env.BULLMQ_REDIS_HOST;\n const port = process.env.BULLMQ_REDIS_PORT;\n if (!host) throw new Error('Environment variable ${BULLMQ_REDIS_HOST} is undefined');\n if (!port) throw new Error('Environment variable ${BULLMQ_REDIS_PORT} is undefined');\n return new Redis({ host, port: parseInt(port), maxRetriesPerRequest: null });\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,aAAwB;AAExB,2BAAqC;AAC9B,IAAM,gBAAN,MAAoB;AAAA,EAGzB,YAAoB,mBAA0B;AAA1B;AAAA,EAA2B;AAAA,EAFvC,aAAwC,oBAAI,IAAI;AAAA,EAIjD,WAAW,QAYf;AACD,UAAM,EAAE,UAAU,IAAI,MAAM,gBAAgB,YAAY,YAAY,IAAI;AACxE,QAAI,KAAK,WAAW,IAAI,QAAQ,EAAG;AAEnC,UAAM,QAAQ,IAAW,aAAM,UAAU;AAAA,MACvC,YAAY,KAAK,qBAAqB;AAAA,MACtC,mBAAmB,EAAE,SAAS,EAAE,OAAO,MAAO,KAAK,GAAG,MAAM,QAAQ,GAAG,UAAU,IAAI,GAAG,eAAe;AAAA,IACzG,CAAC;AACD,SAAK,WAAW,IAAI,UAAU,KAAK;AACnC,YAAQ,MAAM,+BAA+B,QAAQ,WAAW;AAChE,QAAI,CAAC,GAAI,QAAO,EAAE,MAAM;AAExB,UAAM,EAAE,OAAO,IAAI,KAAK,aAAa;AAAA,MACnC;AAAA,MACA;AAAA,MACA,aAAa,eAAe;AAAA,MAC5B,GAAG;AAAA,IACL,CAAC;AACD,WAAO,EAAE,OAAO,OAAO;AAAA,EACzB;AAAA,EAEO,aAAa,QAYjB;AACD,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI;AAEJ,UAAM,kBAAkB,KAAK,WAAW,IAAI,QAAQ;AACpD,QAAI,CAAC,gBAAiB,OAAM,IAAI,MAAM,sBAAsB,QAAQ,SAAS;AAC7E,UAAM,KAAK,OAAO,QAAoB;AACpC,UAAI;AACF,cAAM,GAAG,IAAI,MAAM,GAAG;AAAA,MACxB,SAAS,OAAO;AACd,YAAI,KAAM,OAAM,KAAK,IAAI,MAAM,KAAK,KAAK;AACzC,cAAM;AAAA,MACR,UAAE;AAAA,MACF;AAAA,IACF;AACA,UAAM,UAAU,QAAQ,eAAe,EAAE,MAAM,UAAU,MAAM,gCAAW,KAAK,GAAG,EAAE,KAAK;AAEzF,UAAM,SAAS,IAAW,cAAO,UAAU,SAAS;AAAA,MAClD;AAAA,MACA,YAAY,cAAc,KAAK;AAAA,MAC/B,kBAAkB;AAAA,QAChB,KAAK,uBAAuB,KAAK;AAAA,QACjC,OAAO,yBAAyB;AAAA,MAClC;AAAA,MACA,cAAc;AAAA,QACZ,KAAK,mBAAmB,KAAK;AAAA,QAC7B,OAAO,qBAAqB;AAAA,MAC9B;AAAA,IACF,CAAC;AACD,WAAO,GAAG,SAAS,MAAM;AACvB,cAAQ,IAAI,oBAAoB,QAAQ,mBAAmB;AAAA,IAC7D,CAAC;AACD,WAAO,GAAG,SAAS,QAAQ,KAAK;AAChC,WAAO,EAAE,OAAO;AAAA,EAClB;AAAA,EAEA,MAAa,YAAY,QAA8E;AACrG,UAAM,QAAQ,KAAK,WAAW,IAAI,OAAO,QAAQ;AACjD,QAAI,CAAC,MAAO,QAAO;AACnB,UAAM,MAAM,MAAM,MAAM,IAAI,IAAI,OAAO,UAAU,OAAO,WAAW;AACnE,WAAO,IAAI,OAAO;AAAA,EACpB;AAAA,EAEO,eAAe;AACpB,WAAO,KAAK,WAAW;AAAA,EACzB;AAAA,EAEA,MAAa,oBAAoB,QAAuD;AACtF,UAAM,QAAQ,KAAK,WAAW,IAAI,OAAO,QAAQ;AACjD,QAAI,CAAC,MAAO,QAAO;AACnB,UAAM,SAAS,MAAM,MAAM,uBAAuB,OAAO,eAAe;AACxE,WAAO;AAAA,EACT;AACF;;;ACpHA,qBAAsB;AACf,IAAM,oBAAN,MAAwB;AAAA,EAC7B,OAAO,cAAc;AACnB,UAAM,OAAO,QAAQ,IAAI;AACzB,UAAM,OAAO,QAAQ,IAAI;AACzB,QAAI,CAAC,KAAM,OAAM,IAAI,MAAM,wDAAwD;AACnF,QAAI,CAAC,KAAM,OAAM,IAAI,MAAM,wDAAwD;AACnF,WAAO,IAAI,qBAAM,EAAE,MAAM,MAAM,SAAS,IAAI,GAAG,sBAAsB,KAAK,CAAC;AAAA,EAC7E;AACF;;;AFPO,IAAM,SAAS,IAAI,cAAc,kBAAkB,YAAY,CAAC;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opens/bullmq",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
4
|
"description": "A wrapper around bullmq",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -36,5 +36,13 @@
|
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"bullmq": "^5.41.3",
|
|
38
38
|
"ioredis": "^5.5.0"
|
|
39
|
+
},
|
|
40
|
+
"peerDependencies": {
|
|
41
|
+
"@opens/observability": "^0.0.4"
|
|
42
|
+
},
|
|
43
|
+
"peerDependenciesMeta": {
|
|
44
|
+
"opens/observability": {
|
|
45
|
+
"optional": true
|
|
46
|
+
}
|
|
39
47
|
}
|
|
40
48
|
}
|