@nest-boot/bullmq-mikro-orm 8.0.3-beta.1 → 8.0.4-beta.1
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/bullmq-mikro-orm-module-options.interface.d.ts +6 -0
- package/dist/bullmq-mikro-orm.module.d.ts +17 -0
- package/dist/bullmq-mikro-orm.module.js +17 -0
- package/dist/bullmq-mikro-orm.module.js.map +1 -1
- package/dist/bullmq-mikro-orm.service.d.ts +3 -0
- package/dist/bullmq-mikro-orm.service.js +28 -8
- package/dist/bullmq-mikro-orm.service.js.map +1 -1
- package/dist/entities/job.entity.d.ts +20 -0
- package/dist/entities/job.entity.js +21 -0
- package/dist/entities/job.entity.js.map +1 -1
- package/dist/enums/job-status.enum.d.ts +9 -0
- package/dist/enums/job-status.enum.js +9 -0
- package/dist/enums/job-status.enum.js.map +1 -1
- package/dist/utils/convert-bullmq-job-state-to-job-status.util.d.ts +5 -0
- package/dist/utils/convert-bullmq-job-state-to-job-status.util.js +5 -0
- package/dist/utils/convert-bullmq-job-state-to-job-status.util.js.map +1 -1
- package/dist/utils/should-include-queue.util.d.ts +13 -0
- package/dist/utils/should-include-queue.util.js +16 -0
- package/dist/utils/should-include-queue.util.js.map +1 -1
- package/package.json +10 -10
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
import { type EntityClass, type EntityData } from "@mikro-orm/core";
|
|
2
2
|
import { Job } from "bullmq";
|
|
3
3
|
import { JobEntity } from "./entities/job.entity.js";
|
|
4
|
+
/** Configuration options for the BullMQ-MikroORM integration module. */
|
|
4
5
|
export interface BullMQMikroORMModuleOptions<T extends JobEntity = JobEntity> {
|
|
6
|
+
/** The MikroORM entity class used to persist BullMQ jobs. */
|
|
5
7
|
jobEntity: EntityClass<T>;
|
|
8
|
+
/** Time-to-live (in milliseconds) after which completed/failed jobs are deleted. */
|
|
6
9
|
jobTTL?: number;
|
|
10
|
+
/** Custom function to convert a BullMQ job into entity data for persistence. */
|
|
7
11
|
convertJobToEntityData?: (job: Job) => EntityData<T> | Promise<EntityData<T>>;
|
|
12
|
+
/** Queue names to include for persistence. If unset, all queues are included. */
|
|
8
13
|
includeQueues?: string[];
|
|
14
|
+
/** Queue names to exclude from persistence. */
|
|
9
15
|
excludeQueues?: string[];
|
|
10
16
|
}
|
|
@@ -2,7 +2,24 @@ import { ConfigurableModuleAsyncOptions } from "@nestjs/common";
|
|
|
2
2
|
import { ConfigurableModuleClass } from "./bullmq-mikro-orm.module-definition.js";
|
|
3
3
|
import { BullMQMikroORMModuleOptions } from "./bullmq-mikro-orm-module-options.interface.js";
|
|
4
4
|
import { JobEntity } from "./entities/job.entity.js";
|
|
5
|
+
/**
|
|
6
|
+
* Module that integrates BullMQ job events with MikroORM persistence.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Subscribes to BullMQ queue events and automatically persists job state
|
|
10
|
+
* changes to the database using the configured entity.
|
|
11
|
+
*/
|
|
5
12
|
export declare class BullMQMikroORMModule extends ConfigurableModuleClass {
|
|
13
|
+
/**
|
|
14
|
+
* Registers the module with synchronous options.
|
|
15
|
+
* @param options - Configuration including the job entity class
|
|
16
|
+
* @returns Dynamic module configuration
|
|
17
|
+
*/
|
|
6
18
|
static forRoot<T extends JobEntity = JobEntity>(options: BullMQMikroORMModuleOptions<T>): import("@nestjs/common").DynamicModule;
|
|
19
|
+
/**
|
|
20
|
+
* Registers the module with asynchronous options via factory functions.
|
|
21
|
+
* @param options - Async configuration options
|
|
22
|
+
* @returns Dynamic module configuration
|
|
23
|
+
*/
|
|
7
24
|
static forRootAsync<T extends JobEntity = JobEntity>(options: ConfigurableModuleAsyncOptions<BullMQMikroORMModuleOptions<T>>): import("@nestjs/common").DynamicModule;
|
|
8
25
|
}
|
|
@@ -8,10 +8,27 @@ import { Global, Module } from "@nestjs/common";
|
|
|
8
8
|
import { DiscoveryModule } from "@nestjs/core";
|
|
9
9
|
import { ConfigurableModuleClass } from "./bullmq-mikro-orm.module-definition.js";
|
|
10
10
|
import { BullMQMikroORMService } from "./bullmq-mikro-orm.service.js";
|
|
11
|
+
/**
|
|
12
|
+
* Module that integrates BullMQ job events with MikroORM persistence.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Subscribes to BullMQ queue events and automatically persists job state
|
|
16
|
+
* changes to the database using the configured entity.
|
|
17
|
+
*/
|
|
11
18
|
let BullMQMikroORMModule = class BullMQMikroORMModule extends ConfigurableModuleClass {
|
|
19
|
+
/**
|
|
20
|
+
* Registers the module with synchronous options.
|
|
21
|
+
* @param options - Configuration including the job entity class
|
|
22
|
+
* @returns Dynamic module configuration
|
|
23
|
+
*/
|
|
12
24
|
static forRoot(options) {
|
|
13
25
|
return super.forRoot(options);
|
|
14
26
|
}
|
|
27
|
+
/**
|
|
28
|
+
* Registers the module with asynchronous options via factory functions.
|
|
29
|
+
* @param options - Async configuration options
|
|
30
|
+
* @returns Dynamic module configuration
|
|
31
|
+
*/
|
|
15
32
|
static forRootAsync(options) {
|
|
16
33
|
return super.forRootAsync(options);
|
|
17
34
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bullmq-mikro-orm.module.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAkC,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"bullmq-mikro-orm.module.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAkC,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AAMI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,uBAAuB;IAC/D;;;;OAIG;IACH,MAAM,CAAC,OAAO,CACZ,OAAuC;QAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CACjB,OAAuE;QAEvE,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AAtBY,oBAAoB;IALhC,MAAM,EAAE;IACR,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,eAAe,CAAC;QAC1B,SAAS,EAAE,CAAC,qBAAqB,CAAC;KACnC,CAAC;GACW,oBAAoB,CAsBhC"}
|
|
@@ -8,12 +8,15 @@ export declare class BullMQMikroORMService implements OnApplicationBootstrap {
|
|
|
8
8
|
private readonly discoveryService;
|
|
9
9
|
private readonly em;
|
|
10
10
|
private readonly options;
|
|
11
|
+
private readonly logger;
|
|
11
12
|
private readonly jobTTL;
|
|
12
13
|
private readonly includeQueues;
|
|
13
14
|
private readonly excludeQueues;
|
|
14
15
|
constructor(discoveryService: DiscoveryService, em: EntityManager, options: BullMQMikroORMModuleOptions);
|
|
15
16
|
convertJobToEntityData(job: Job, jobState: JobState): Promise<EntityData<JobEntity>>;
|
|
16
17
|
upsertJob(job: Job, jobState: JobState): Promise<void>;
|
|
18
|
+
/** Records history without turning an observer failure into a worker failure. */
|
|
19
|
+
private recordJobEvent;
|
|
17
20
|
cleanHistoryJobs(): Promise<void>;
|
|
18
21
|
onApplicationBootstrap(): void;
|
|
19
22
|
}
|
|
@@ -10,19 +10,21 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
11
11
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
12
12
|
};
|
|
13
|
+
var BullMQMikroORMService_1;
|
|
13
14
|
import { EntityManager } from "@mikro-orm/core";
|
|
14
15
|
import { WorkerHost } from "@nest-boot/bullmq";
|
|
15
16
|
import { Cron } from "@nest-boot/schedule";
|
|
16
|
-
import { Inject, Injectable, } from "@nestjs/common";
|
|
17
|
+
import { Inject, Injectable, Logger, } from "@nestjs/common";
|
|
17
18
|
import { DiscoveryService } from "@nestjs/core";
|
|
18
19
|
import { Queue } from "bullmq";
|
|
19
20
|
import { MODULE_OPTIONS_TOKEN } from "./bullmq-mikro-orm.module-definition.js";
|
|
20
21
|
import { convertBullmqJobStateToJobStatus } from "./utils/convert-bullmq-job-state-to-job-status.util.js";
|
|
21
22
|
import { shouldIncludeQueue } from "./utils/should-include-queue.util.js";
|
|
22
|
-
let BullMQMikroORMService = class BullMQMikroORMService {
|
|
23
|
+
let BullMQMikroORMService = BullMQMikroORMService_1 = class BullMQMikroORMService {
|
|
23
24
|
discoveryService;
|
|
24
25
|
em;
|
|
25
26
|
options;
|
|
27
|
+
logger = new Logger(BullMQMikroORMService_1.name);
|
|
26
28
|
jobTTL = 1000 * 60 * 60 * 24 * 30;
|
|
27
29
|
includeQueues = [];
|
|
28
30
|
excludeQueues = [];
|
|
@@ -65,6 +67,13 @@ let BullMQMikroORMService = class BullMQMikroORMService {
|
|
|
65
67
|
onConflictFields: ["id"],
|
|
66
68
|
});
|
|
67
69
|
}
|
|
70
|
+
/** Records history without turning an observer failure into a worker failure. */
|
|
71
|
+
recordJobEvent(job, state) {
|
|
72
|
+
void this.upsertJob(job, state).catch((error) => {
|
|
73
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
74
|
+
this.logger.error(`Failed to persist job ${job.queueName}:${job.id ?? "unknown"} (${state}): ${message}`, error instanceof Error ? error.stack : undefined);
|
|
75
|
+
});
|
|
76
|
+
}
|
|
68
77
|
async cleanHistoryJobs() {
|
|
69
78
|
await this.em.fork().nativeDelete(this.options.jobEntity, {
|
|
70
79
|
updatedAt: {
|
|
@@ -78,16 +87,27 @@ let BullMQMikroORMService = class BullMQMikroORMService {
|
|
|
78
87
|
.filter((provider) => provider.instance instanceof Queue)
|
|
79
88
|
.filter((provider) => shouldIncludeQueue(provider.instance.name, this.includeQueues, this.excludeQueues))
|
|
80
89
|
.forEach((provider) => {
|
|
81
|
-
void provider.instance.on("waiting", (job) =>
|
|
90
|
+
void provider.instance.on("waiting", (job) => {
|
|
91
|
+
this.recordJobEvent(job, "waiting");
|
|
92
|
+
});
|
|
82
93
|
});
|
|
83
94
|
instanceWrappers
|
|
84
95
|
.filter((provider) => provider.instance instanceof WorkerHost)
|
|
85
96
|
.filter((provider) => shouldIncludeQueue(provider.instance.worker.name, this.includeQueues, this.excludeQueues))
|
|
86
97
|
.forEach((provider) => {
|
|
87
|
-
provider.instance.worker.on("active", (job) =>
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
provider.instance.worker.on("
|
|
98
|
+
provider.instance.worker.on("active", (job) => {
|
|
99
|
+
this.recordJobEvent(job, "active");
|
|
100
|
+
});
|
|
101
|
+
provider.instance.worker.on("progress", (job) => {
|
|
102
|
+
this.recordJobEvent(job, "active");
|
|
103
|
+
});
|
|
104
|
+
provider.instance.worker.on("completed", (job) => {
|
|
105
|
+
this.recordJobEvent(job, "completed");
|
|
106
|
+
});
|
|
107
|
+
provider.instance.worker.on("failed", (job) => {
|
|
108
|
+
if (job)
|
|
109
|
+
this.recordJobEvent(job, "failed");
|
|
110
|
+
});
|
|
91
111
|
});
|
|
92
112
|
}
|
|
93
113
|
};
|
|
@@ -97,7 +117,7 @@ __decorate([
|
|
|
97
117
|
__metadata("design:paramtypes", []),
|
|
98
118
|
__metadata("design:returntype", Promise)
|
|
99
119
|
], BullMQMikroORMService.prototype, "cleanHistoryJobs", null);
|
|
100
|
-
BullMQMikroORMService = __decorate([
|
|
120
|
+
BullMQMikroORMService = BullMQMikroORMService_1 = __decorate([
|
|
101
121
|
Injectable(),
|
|
102
122
|
__param(2, Inject(MODULE_OPTIONS_TOKEN)),
|
|
103
123
|
__metadata("design:paramtypes", [DiscoveryService,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bullmq-mikro-orm.service.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.service.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"bullmq-mikro-orm.service.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,OAAO,EAAmB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EACL,MAAM,EACN,UAAU,EACV,MAAM,GAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAA2B,KAAK,EAAE,MAAM,QAAQ,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAG/E,OAAO,EAAE,gCAAgC,EAAE,MAAM,wDAAwD,CAAC;AAC1G,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAGnE,IAAM,qBAAqB,6BAA3B,MAAM,qBAAqB;IASb;IACA;IAEA;IAXF,MAAM,GAAG,IAAI,MAAM,CAAC,uBAAqB,CAAC,IAAI,CAAC,CAAC;IAEhD,MAAM,GAAW,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IAE1C,aAAa,GAAa,EAAE,CAAC;IAC7B,aAAa,GAAa,EAAE,CAAC;IAE9C,YACmB,gBAAkC,EAClC,EAAiB,EAEjB,OAAoC;QAHpC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,OAAE,GAAF,EAAE,CAAe;QAEjB,YAAO,GAAP,OAAO,CAA6B;QAErD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC;QACtE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,GAAQ,EACR,QAAkB;QAElB,IAAI,cAAc,GAAG,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC;QAE1C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,cAAc,GAAG,QAAQ,CAAC;QAC5B,CAAC;QAED,OAAO;YACL,EAAE,EAAE,GAAG,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE;YACtC,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,IAAI,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI;YACtB,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI;YACpC,YAAY,EAAE,GAAG,CAAC,YAAY,IAAI,IAAI;YACtC,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,MAAM,EAAE,gCAAgC,CAAC,cAAc,CAAC;YACxD,SAAS,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI;YAC7D,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;YAC5D,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC;YAClC,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB;gBACrC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC;gBAChD,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAQ,EAAE,QAAkB;QAC1C,MAAM,IAAI,CAAC,EAAE;aACV,IAAI,EAAE;aACN,MAAM,CACL,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,MAAM,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,EAChD;YACE,gBAAgB,EAAE,CAAC,IAAI,CAAC;SACzB,CACF,CAAC;IACN,CAAC;IAED,iFAAiF;IACzE,cAAc,CAAC,GAAQ,EAAE,KAAe;QAC9C,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACvD,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,yBAAyB,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,IAAI,SAAS,KAAK,KAAK,MAAM,OAAO,EAAE,EACtF,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACjD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAGK,AAAN,KAAK,CAAC,gBAAgB;QACpB,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACxD,SAAS,EAAE;gBACT,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;aACxC;SACF,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB;QACpB,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;QAE9D,gBAAgB;aACb,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,YAAY,KAAK,CAAC;aACxD,MAAM,CAAC,CAAC,QAAgC,EAAE,EAAE,CAC3C,kBAAkB,CAChB,QAAQ,CAAC,QAAQ,CAAC,IAAI,EACtB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,aAAa,CACnB,CACF;aACA,OAAO,CAAC,CAAC,QAAgC,EAAE,EAAE;YAC5C,KAAK,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC3C,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,gBAAgB;aACb,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,YAAY,UAAU,CAAC;aAC7D,MAAM,CAAC,CAAC,QAAqC,EAAE,EAAE,CAChD,kBAAkB,CAChB,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAC7B,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,aAAa,CACnB,CACF;aACA,OAAO,CAAC,CAAC,QAAqC,EAAE,EAAE;YACjD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC9C,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC/C,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC5C,IAAI,GAAG;oBAAE,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACF,CAAA;AAlDO;IADL,IAAI,CAAC,WAAW,CAAC;;;;6DAOjB;AA/EU,qBAAqB;IADjC,UAAU,EAAE;IAYR,WAAA,MAAM,CAAC,oBAAoB,CAAC,CAAA;qCAFM,gBAAgB;QAC9B,aAAa;GAVzB,qBAAqB,CA2HjC"}
|
|
@@ -1,17 +1,37 @@
|
|
|
1
1
|
import { type Opt } from "@mikro-orm/core";
|
|
2
2
|
import { type JobProgress } from "bullmq";
|
|
3
|
+
/**
|
|
4
|
+
* Abstract base entity for persisting BullMQ job data in the database.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Extend this entity in your application to create a concrete job table.
|
|
8
|
+
* Automatically populated by the BullMQ-MikroORM subscriber.
|
|
9
|
+
*/
|
|
3
10
|
export declare abstract class JobEntity {
|
|
11
|
+
/** BullMQ job identifier. */
|
|
4
12
|
id: string;
|
|
13
|
+
/** Name of the BullMQ queue this job belongs to. */
|
|
5
14
|
queueName: string;
|
|
15
|
+
/** Job name (type identifier). */
|
|
6
16
|
name: string;
|
|
17
|
+
/** JSON payload of the job. */
|
|
7
18
|
data: any;
|
|
19
|
+
/** Return value from the job processor, if completed. */
|
|
8
20
|
returnValue?: any;
|
|
21
|
+
/** Error message if the job failed. */
|
|
9
22
|
failedReason?: string;
|
|
23
|
+
/** Job priority (lower values = higher priority). */
|
|
10
24
|
priority: number;
|
|
25
|
+
/** Current progress of the job (number or object). */
|
|
11
26
|
progress: Opt<JobProgress>;
|
|
27
|
+
/** Current status of the job. */
|
|
12
28
|
status: string;
|
|
29
|
+
/** Timestamp when the job started processing. */
|
|
13
30
|
startedAt?: Date;
|
|
31
|
+
/** Timestamp when the job finished processing. */
|
|
14
32
|
finishedAt?: Date;
|
|
33
|
+
/** Timestamp when the job was created. */
|
|
15
34
|
createdAt: Opt<Date>;
|
|
35
|
+
/** Timestamp of the last update. */
|
|
16
36
|
updatedAt: Opt<Date>;
|
|
17
37
|
}
|
|
@@ -10,19 +10,40 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
import { t } from "@mikro-orm/core";
|
|
11
11
|
import { Entity, Enum, Index, PrimaryKey, Property, } from "@mikro-orm/decorators/legacy";
|
|
12
12
|
import { JobStatus } from "../enums/job-status.enum.js";
|
|
13
|
+
/**
|
|
14
|
+
* Abstract base entity for persisting BullMQ job data in the database.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Extend this entity in your application to create a concrete job table.
|
|
18
|
+
* Automatically populated by the BullMQ-MikroORM subscriber.
|
|
19
|
+
*/
|
|
13
20
|
let JobEntity = class JobEntity {
|
|
21
|
+
/** BullMQ job identifier. */
|
|
14
22
|
id;
|
|
23
|
+
/** Name of the BullMQ queue this job belongs to. */
|
|
15
24
|
queueName;
|
|
25
|
+
/** Job name (type identifier). */
|
|
16
26
|
name;
|
|
27
|
+
/** JSON payload of the job. */
|
|
17
28
|
data;
|
|
29
|
+
/** Return value from the job processor, if completed. */
|
|
18
30
|
returnValue;
|
|
31
|
+
/** Error message if the job failed. */
|
|
19
32
|
failedReason;
|
|
33
|
+
/** Job priority (lower values = higher priority). */
|
|
20
34
|
priority;
|
|
35
|
+
/** Current progress of the job (number or object). */
|
|
36
|
+
// eslint-disable-next-line @nest-boot/entity-property-config-from-types
|
|
21
37
|
progress;
|
|
38
|
+
/** Current status of the job. */
|
|
22
39
|
status;
|
|
40
|
+
/** Timestamp when the job started processing. */
|
|
23
41
|
startedAt;
|
|
42
|
+
/** Timestamp when the job finished processing. */
|
|
24
43
|
finishedAt;
|
|
44
|
+
/** Timestamp when the job was created. */
|
|
25
45
|
createdAt = new Date();
|
|
46
|
+
/** Timestamp of the last update. */
|
|
26
47
|
updatedAt = new Date();
|
|
27
48
|
};
|
|
28
49
|
__decorate([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job.entity.js","sourceRoot":"","sources":["../../src/entities/job.entity.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAY,CAAC,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EACL,MAAM,EACN,IAAI,EACJ,KAAK,EACL,UAAU,EACV,QAAQ,GACT,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"job.entity.js","sourceRoot":"","sources":["../../src/entities/job.entity.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAY,CAAC,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EACL,MAAM,EACN,IAAI,EACJ,KAAK,EACL,UAAU,EACV,QAAQ,GACT,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD;;;;;;GAMG;AAEI,IAAe,SAAS,GAAxB,MAAe,SAAS;IAC7B,6BAA6B;IAE7B,EAAE,CAAU;IAEZ,oDAAoD;IAEpD,SAAS,CAAU;IAEnB,kCAAkC;IAGlC,IAAI,CAAU;IAEd,+BAA+B;IAE/B,IAAI,CAAO;IAEX,yDAAyD;IAEzD,WAAW,CAAO;IAElB,uCAAuC;IAEvC,YAAY,CAAU;IAEtB,qDAAqD;IAErD,QAAQ,CAAU;IAElB,sDAAsD;IACtD,wEAAwE;IAExE,QAAQ,CAAoB;IAE5B,iCAAiC;IAGjC,MAAM,CAAU;IAEhB,iDAAiD;IAEjD,SAAS,CAAQ;IAEjB,kDAAkD;IAElD,UAAU,CAAQ;IAElB,0CAA0C;IAG1C,SAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IAElC,oCAAoC;IAOpC,SAAS,GAAc,IAAI,IAAI,EAAE,CAAC;CACnC,CAAA;AA1DC;IADC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;;qCACnB;AAIZ;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;;4CACV;AAKnB;IAFC,KAAK,EAAE;IACP,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;;uCACf;AAId;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;;uCAChB;AAIX;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACzB;AAIlB;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACvB;AAItB;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;;2CACZ;AAKlB;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;;2CACC;AAK5B;IAFC,KAAK,EAAE;IACP,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;;yCACjB;AAIhB;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACnC,IAAI;4CAAC;AAIjB;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAClC,IAAI;6CAAC;AAKlB;IAFC,KAAK,EAAE;IACP,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;4CAClB;AASlC;IANC,KAAK,EAAE;IACP,QAAQ,CAAC;QACR,IAAI,EAAE,CAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;4CACgC;AA5Dd,SAAS;IAD9B,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,SAAS,CA6D9B"}
|
|
@@ -1,10 +1,19 @@
|
|
|
1
|
+
/** Enumeration of possible BullMQ job statuses persisted in the database. */
|
|
1
2
|
export declare enum JobStatus {
|
|
3
|
+
/** Job is actively being processed. */
|
|
2
4
|
ACTIVE = "active",
|
|
5
|
+
/** Job has completed successfully. */
|
|
3
6
|
COMPLETED = "completed",
|
|
7
|
+
/** Job is delayed and will be processed later. */
|
|
4
8
|
DELAYED = "delayed",
|
|
9
|
+
/** Job has failed after exhausting all retry attempts. */
|
|
5
10
|
FAILED = "failed",
|
|
11
|
+
/** Job is waiting in the prioritized queue. */
|
|
6
12
|
PRIORITIZED = "prioritized",
|
|
13
|
+
/** Job status is unknown. */
|
|
7
14
|
UNKNOWN = "unknown",
|
|
15
|
+
/** Job is waiting in the queue to be processed. */
|
|
8
16
|
WAITING = "waiting",
|
|
17
|
+
/** Job is waiting for its child jobs to complete. */
|
|
9
18
|
WAITING_CHILDREN = "waiting-children"
|
|
10
19
|
}
|
|
@@ -1,12 +1,21 @@
|
|
|
1
|
+
/** Enumeration of possible BullMQ job statuses persisted in the database. */
|
|
1
2
|
export var JobStatus;
|
|
2
3
|
(function (JobStatus) {
|
|
4
|
+
/** Job is actively being processed. */
|
|
3
5
|
JobStatus["ACTIVE"] = "active";
|
|
6
|
+
/** Job has completed successfully. */
|
|
4
7
|
JobStatus["COMPLETED"] = "completed";
|
|
8
|
+
/** Job is delayed and will be processed later. */
|
|
5
9
|
JobStatus["DELAYED"] = "delayed";
|
|
10
|
+
/** Job has failed after exhausting all retry attempts. */
|
|
6
11
|
JobStatus["FAILED"] = "failed";
|
|
12
|
+
/** Job is waiting in the prioritized queue. */
|
|
7
13
|
JobStatus["PRIORITIZED"] = "prioritized";
|
|
14
|
+
/** Job status is unknown. */
|
|
8
15
|
JobStatus["UNKNOWN"] = "unknown";
|
|
16
|
+
/** Job is waiting in the queue to be processed. */
|
|
9
17
|
JobStatus["WAITING"] = "waiting";
|
|
18
|
+
/** Job is waiting for its child jobs to complete. */
|
|
10
19
|
JobStatus["WAITING_CHILDREN"] = "waiting-children";
|
|
11
20
|
})(JobStatus || (JobStatus = {}));
|
|
12
21
|
//# sourceMappingURL=job-status.enum.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job-status.enum.js","sourceRoot":"","sources":["../../src/enums/job-status.enum.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"job-status.enum.js","sourceRoot":"","sources":["../../src/enums/job-status.enum.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,MAAM,CAAN,IAAY,SAiBX;AAjBD,WAAY,SAAS;IACnB,uCAAuC;IACvC,8BAAiB,CAAA;IACjB,sCAAsC;IACtC,oCAAuB,CAAA;IACvB,kDAAkD;IAClD,gCAAmB,CAAA;IACnB,0DAA0D;IAC1D,8BAAiB,CAAA;IACjB,+CAA+C;IAC/C,wCAA2B,CAAA;IAC3B,6BAA6B;IAC7B,gCAAmB,CAAA;IACnB,mDAAmD;IACnD,gCAAmB,CAAA;IACnB,qDAAqD;IACrD,kDAAqC,CAAA;AACvC,CAAC,EAjBW,SAAS,KAAT,SAAS,QAiBpB"}
|
|
@@ -1,3 +1,8 @@
|
|
|
1
1
|
import { JobState } from "bullmq";
|
|
2
2
|
import { JobStatus } from "../enums/job-status.enum.js";
|
|
3
|
+
/**
|
|
4
|
+
* Converts a BullMQ job state to the internal JobStatus enum.
|
|
5
|
+
* @param state - The BullMQ job state or "unknown".
|
|
6
|
+
* @returns The corresponding JobStatus enum value.
|
|
7
|
+
*/
|
|
3
8
|
export declare function convertBullmqJobStateToJobStatus(state: JobState | "unknown"): JobStatus;
|
|
@@ -1,4 +1,9 @@
|
|
|
1
1
|
import { JobStatus } from "../enums/job-status.enum.js";
|
|
2
|
+
/**
|
|
3
|
+
* Converts a BullMQ job state to the internal JobStatus enum.
|
|
4
|
+
* @param state - The BullMQ job state or "unknown".
|
|
5
|
+
* @returns The corresponding JobStatus enum value.
|
|
6
|
+
*/
|
|
2
7
|
export function convertBullmqJobStateToJobStatus(state) {
|
|
3
8
|
switch (state) {
|
|
4
9
|
case "active":
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"convert-bullmq-job-state-to-job-status.util.js","sourceRoot":"","sources":["../../src/utils/convert-bullmq-job-state-to-job-status.util.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"convert-bullmq-job-state-to-job-status.util.js","sourceRoot":"","sources":["../../src/utils/convert-bullmq-job-state-to-job-status.util.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,KAA2B;IAE3B,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,SAAS,CAAC,MAAM,CAAC;QAE1B,KAAK,WAAW;YACd,OAAO,SAAS,CAAC,SAAS,CAAC;QAE7B,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,OAAO,CAAC;QAE3B,KAAK,QAAQ;YACX,OAAO,SAAS,CAAC,MAAM,CAAC;QAE1B,KAAK,aAAa;YAChB,OAAO,SAAS,CAAC,WAAW,CAAC;QAE/B,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,OAAO,CAAC;QAE3B,KAAK,kBAAkB;YACrB,OAAO,SAAS,CAAC,gBAAgB,CAAC;QAEpC;YACE,OAAO,SAAS,CAAC,OAAO,CAAC;IAC7B,CAAC;AACH,CAAC"}
|
|
@@ -1 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Determines whether a queue should be included.
|
|
3
|
+
* @param queueName - The queue name.
|
|
4
|
+
* @param includeQueues - List of queues to include (empty means include all).
|
|
5
|
+
* @param excludeQueues - List of queues to exclude.
|
|
6
|
+
* @returns True if the queue should be included.
|
|
7
|
+
*
|
|
8
|
+
* Rules:
|
|
9
|
+
* 1. If in excludeQueues, return false.
|
|
10
|
+
* 2. If includeQueues is empty, return true (include all non-excluded queues).
|
|
11
|
+
* 3. If in includeQueues, return true.
|
|
12
|
+
* 4. Otherwise return false.
|
|
13
|
+
*/
|
|
1
14
|
export declare function shouldIncludeQueue(queueName: string, includeQueues: string[], excludeQueues: string[]): boolean;
|
|
@@ -1,10 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Determines whether a queue should be included.
|
|
3
|
+
* @param queueName - The queue name.
|
|
4
|
+
* @param includeQueues - List of queues to include (empty means include all).
|
|
5
|
+
* @param excludeQueues - List of queues to exclude.
|
|
6
|
+
* @returns True if the queue should be included.
|
|
7
|
+
*
|
|
8
|
+
* Rules:
|
|
9
|
+
* 1. If in excludeQueues, return false.
|
|
10
|
+
* 2. If includeQueues is empty, return true (include all non-excluded queues).
|
|
11
|
+
* 3. If in includeQueues, return true.
|
|
12
|
+
* 4. Otherwise return false.
|
|
13
|
+
*/
|
|
1
14
|
export function shouldIncludeQueue(queueName, includeQueues, excludeQueues) {
|
|
15
|
+
// Check exclude list first (takes priority)
|
|
2
16
|
if (excludeQueues.includes(queueName)) {
|
|
3
17
|
return false;
|
|
4
18
|
}
|
|
19
|
+
// If no include list is specified, include all non-excluded queues
|
|
5
20
|
if (includeQueues.length === 0) {
|
|
6
21
|
return true;
|
|
7
22
|
}
|
|
23
|
+
// Check if in include list
|
|
8
24
|
return includeQueues.includes(queueName);
|
|
9
25
|
}
|
|
10
26
|
//# sourceMappingURL=should-include-queue.util.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"should-include-queue.util.js","sourceRoot":"","sources":["../../src/utils/should-include-queue.util.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"should-include-queue.util.js","sourceRoot":"","sources":["../../src/utils/should-include-queue.util.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAAiB,EACjB,aAAuB,EACvB,aAAuB;IAEvB,4CAA4C;IAC5C,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mEAAmE;IACnE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nest-boot/bullmq-mikro-orm",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.4-beta.1",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "https://github.com/nest-boot/nest-boot.git",
|
|
@@ -40,12 +40,12 @@
|
|
|
40
40
|
"typescript": "^6.0.3",
|
|
41
41
|
"vite-tsconfig-paths": "^5.1.4",
|
|
42
42
|
"vitest": "^4.1.11",
|
|
43
|
-
"@nest-boot/bullmq": "^8.0.
|
|
44
|
-
"@nest-boot/eslint-config": "^8.0.
|
|
45
|
-
"@nest-boot/eslint-plugin": "^8.0.
|
|
46
|
-
"@nest-boot/request-context": "^8.0.
|
|
47
|
-
"@nest-boot/schedule": "^8.0.
|
|
48
|
-
"@nest-boot/tsconfig": "^8.0.0-beta.
|
|
43
|
+
"@nest-boot/bullmq": "^8.0.4-beta.0",
|
|
44
|
+
"@nest-boot/eslint-config": "^8.0.1-beta.0",
|
|
45
|
+
"@nest-boot/eslint-plugin": "^8.0.1-beta.0",
|
|
46
|
+
"@nest-boot/request-context": "^8.0.1-beta.0",
|
|
47
|
+
"@nest-boot/schedule": "^8.0.4-beta.0",
|
|
48
|
+
"@nest-boot/tsconfig": "^8.0.0-beta.4"
|
|
49
49
|
},
|
|
50
50
|
"peerDependencies": {
|
|
51
51
|
"@mikro-orm/core": "^7.0.0",
|
|
@@ -56,9 +56,9 @@
|
|
|
56
56
|
"bullmq": "^5.0.0",
|
|
57
57
|
"reflect-metadata": "^0.2.2",
|
|
58
58
|
"rxjs": "^7.0.0",
|
|
59
|
-
"@nest-boot/bullmq": "^8.0.
|
|
60
|
-
"@nest-boot/
|
|
61
|
-
"@nest-boot/
|
|
59
|
+
"@nest-boot/bullmq": "^8.0.4-beta.0",
|
|
60
|
+
"@nest-boot/schedule": "^8.0.4-beta.0",
|
|
61
|
+
"@nest-boot/request-context": "^8.0.1-beta.0"
|
|
62
62
|
},
|
|
63
63
|
"publishConfig": {
|
|
64
64
|
"access": "public"
|