@wavezync/nestjs-pgboss 2.0.1 → 2.1.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/dist/handler-scanner.service.js +7 -4
- package/dist/handler-scanner.service.js.map +1 -1
- package/dist/pgboss.service.d.ts +3 -3
- package/dist/pgboss.service.js +2 -2
- package/dist/pgboss.service.js.map +1 -1
- package/lib/handler-scanner.service.ts +12 -8
- package/lib/pgboss.service.ts +14 -6
- package/package.json +1 -1
- package/test/pgboss.service.spec.ts +6 -2
|
@@ -10,11 +10,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
|
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.HandlerScannerService = void 0;
|
|
13
|
+
const common_1 = require("@nestjs/common");
|
|
13
14
|
const core_1 = require("@nestjs/core");
|
|
14
15
|
const pgboss_service_1 = require("./pgboss.service");
|
|
15
16
|
const job_decorator_1 = require("./decorators/job.decorator");
|
|
16
17
|
const consts_1 = require("./utils/consts");
|
|
17
|
-
const common_1 = require("@nestjs/common");
|
|
18
18
|
let HandlerScannerService = class HandlerScannerService {
|
|
19
19
|
constructor(pgBossService, reflector, modulesContainer) {
|
|
20
20
|
this.pgBossService = pgBossService;
|
|
@@ -26,7 +26,7 @@ let HandlerScannerService = class HandlerScannerService {
|
|
|
26
26
|
for (const module of this.modulesContainer.values()) {
|
|
27
27
|
const providers = [...module.providers.values()];
|
|
28
28
|
for (const provider of providers) {
|
|
29
|
-
this.scanProvider(provider);
|
|
29
|
+
await this.scanProvider(provider);
|
|
30
30
|
}
|
|
31
31
|
}
|
|
32
32
|
}
|
|
@@ -43,7 +43,10 @@ let HandlerScannerService = class HandlerScannerService {
|
|
|
43
43
|
const cronExpression = this.reflector.get(job_decorator_1.CRON_EXPRESSION, methodRef);
|
|
44
44
|
const cronOptions = this.reflector.get(job_decorator_1.CRON_OPTIONS, methodRef);
|
|
45
45
|
if (jobName) {
|
|
46
|
-
const boundHandler =
|
|
46
|
+
const boundHandler = async (job) => {
|
|
47
|
+
const jobData = Object.assign({}, job);
|
|
48
|
+
await methodRef.call(instance, jobData);
|
|
49
|
+
};
|
|
47
50
|
try {
|
|
48
51
|
if (cronExpression) {
|
|
49
52
|
await this.pgBossService.registerCronJob(jobName, cronExpression, boundHandler, {}, cronOptions);
|
|
@@ -55,7 +58,7 @@ let HandlerScannerService = class HandlerScannerService {
|
|
|
55
58
|
}
|
|
56
59
|
}
|
|
57
60
|
catch (error) {
|
|
58
|
-
this.logger.error(`Error registering job ${jobName}
|
|
61
|
+
this.logger.error(`Error registering job ${jobName}:`, error);
|
|
59
62
|
}
|
|
60
63
|
}
|
|
61
64
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"handler-scanner.service.js","sourceRoot":"","sources":["../lib/handler-scanner.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAA2D;AAC3D,qDAAiD;AACjD,8DAKoC;AAGpC,2CAAwC;
|
|
1
|
+
{"version":3,"file":"handler-scanner.service.js","sourceRoot":"","sources":["../lib/handler-scanner.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAoD;AACpD,uCAA2D;AAC3D,qDAAiD;AACjD,8DAKoC;AAGpC,2CAAwC;AAGjC,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAGhC,YACmB,aAA4B,EAC5B,SAAoB,EACpB,gBAAkC;QAFlC,kBAAa,GAAb,aAAa,CAAe;QAC5B,cAAS,GAAT,SAAS,CAAW;QACpB,qBAAgB,GAAhB,gBAAgB,CAAkB;QALpC,WAAM,GAAG,IAAI,eAAM,CAAC,eAAM,CAAC,CAAC;IAM1C,CAAC;IAEJ,KAAK,CAAC,uBAAuB;QAC3B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;YAEjD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,QAA8B;QACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO;QAEtD,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,WAAW,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,MAAM,CAC9D,CAAC,MAAM,EAAE,EAAE,CACT,MAAM,KAAK,aAAa,IAAI,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU,CACrE,CAAC;QAEF,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAS,wBAAQ,EAAE,SAAS,CAAC,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CACnC,2BAAW,EACX,SAAS,CACV,CAAC;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CACvC,+BAAe,EACf,SAAS,CACV,CAAC;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAM,4BAAY,EAAE,SAAS,CAAC,CAAC;YAErE,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,YAAY,GAAiC,KAAK,EAAE,GAAG,EAAE,EAAE;oBAC/D,MAAM,OAAO,qBACR,GAAG,CACP,CAAC;oBACF,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC1C,CAAC,CAAC;gBACF,IAAI,CAAC;oBACH,IAAI,cAAc,EAAE,CAAC;wBACnB,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CACtC,OAAO,EACP,cAAc,EACd,YAAY,EACZ,EAAE,EACF,WAAW,CACZ,CAAC;wBACF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;oBACrD,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAClC,OAAO,EACP,YAAY,EACZ,UAAqC,CACtC,CAAC;wBACF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,OAAO,EAAE,CAAC,CAAC;oBAChD,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAA;AAzEY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;qCAKuB,8BAAa;QACjB,gBAAS;QACF,uBAAgB;GAN1C,qBAAqB,CAyEjC"}
|
package/dist/pgboss.service.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import PgBoss, {
|
|
1
|
+
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
2
2
|
export declare class PgBossService {
|
|
3
3
|
private readonly boss;
|
|
4
4
|
constructor(boss: PgBoss);
|
|
5
5
|
scheduleJob<TData extends object>(name: string, data: TData, options?: PgBoss.SendOptions): Promise<void>;
|
|
6
6
|
scheduleCronJob<TData extends object>(name: string, cron: string, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
|
|
7
|
-
registerCronJob<TData extends object>(name: string, cron: string, handler:
|
|
8
|
-
registerJob<TData extends object>(name: string, handler:
|
|
7
|
+
registerCronJob<TData extends object>(name: string, cron: string, handler: WorkWithMetadataHandler<TData>, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
|
|
8
|
+
registerJob<TData extends object>(name: string, handler: WorkWithMetadataHandler<TData>, options?: PgBoss.BatchWorkOptions): Promise<void>;
|
|
9
9
|
}
|
package/dist/pgboss.service.js
CHANGED
|
@@ -32,10 +32,10 @@ let PgBossService = class PgBossService {
|
|
|
32
32
|
}
|
|
33
33
|
async registerCronJob(name, cron, handler, data, options) {
|
|
34
34
|
await this.boss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
|
|
35
|
-
await this.boss.work(name, handler);
|
|
35
|
+
await this.boss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
|
|
36
36
|
}
|
|
37
37
|
async registerJob(name, handler, options) {
|
|
38
|
-
await this.boss.work(name, options, handler);
|
|
38
|
+
await this.boss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
|
|
39
39
|
}
|
|
40
40
|
};
|
|
41
41
|
exports.PgBossService = PgBossService;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,
|
|
1
|
+
{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAA0D;AAC1D,2CAAwC;AACxC,2CAA8C;AAGvC,IAAM,aAAa,GAAnB,MAAM,aAAa;IACxB,YAAmD,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnE,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,IAAW,EACX,OAA4B;QAE5B,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,OAAuC,EACvC,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAAuC,EACvC,OAAiC;QAEjC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AA9CY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAwB,iBAAM;GADpD,aAAa,CA8CzB"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Injectable, Logger } from "@nestjs/common";
|
|
1
2
|
import { Reflector, ModulesContainer } from "@nestjs/core";
|
|
2
3
|
import { PgBossService } from "./pgboss.service";
|
|
3
4
|
import {
|
|
@@ -7,9 +8,8 @@ import {
|
|
|
7
8
|
CRON_OPTIONS,
|
|
8
9
|
} from "./decorators/job.decorator";
|
|
9
10
|
import { InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
|
|
10
|
-
import {
|
|
11
|
+
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
11
12
|
import { LOGGER } from "./utils/consts";
|
|
12
|
-
import { Injectable, Logger } from "@nestjs/common";
|
|
13
13
|
|
|
14
14
|
@Injectable()
|
|
15
15
|
export class HandlerScannerService {
|
|
@@ -26,7 +26,7 @@ export class HandlerScannerService {
|
|
|
26
26
|
const providers = [...module.providers.values()];
|
|
27
27
|
|
|
28
28
|
for (const provider of providers) {
|
|
29
|
-
this.scanProvider(provider);
|
|
29
|
+
await this.scanProvider(provider);
|
|
30
30
|
}
|
|
31
31
|
}
|
|
32
32
|
}
|
|
@@ -44,7 +44,7 @@ export class HandlerScannerService {
|
|
|
44
44
|
for (const methodName of methodNames) {
|
|
45
45
|
const methodRef = instance[methodName];
|
|
46
46
|
const jobName = this.reflector.get<string>(JOB_NAME, methodRef);
|
|
47
|
-
const jobOptions = this.reflector.get<
|
|
47
|
+
const jobOptions = this.reflector.get<PgBoss.WorkOptions>(
|
|
48
48
|
JOB_OPTIONS,
|
|
49
49
|
methodRef,
|
|
50
50
|
);
|
|
@@ -55,8 +55,12 @@ export class HandlerScannerService {
|
|
|
55
55
|
const cronOptions = this.reflector.get<any>(CRON_OPTIONS, methodRef);
|
|
56
56
|
|
|
57
57
|
if (jobName) {
|
|
58
|
-
const boundHandler =
|
|
59
|
-
|
|
58
|
+
const boundHandler: WorkWithMetadataHandler<any> = async (job) => {
|
|
59
|
+
const jobData = {
|
|
60
|
+
...job,
|
|
61
|
+
};
|
|
62
|
+
await methodRef.call(instance, jobData);
|
|
63
|
+
};
|
|
60
64
|
try {
|
|
61
65
|
if (cronExpression) {
|
|
62
66
|
await this.pgBossService.registerCronJob(
|
|
@@ -71,12 +75,12 @@ export class HandlerScannerService {
|
|
|
71
75
|
await this.pgBossService.registerJob(
|
|
72
76
|
jobName,
|
|
73
77
|
boundHandler,
|
|
74
|
-
jobOptions,
|
|
78
|
+
jobOptions as PgBoss.BatchWorkOptions,
|
|
75
79
|
);
|
|
76
80
|
this.logger.log(`Registered job: ${jobName}`);
|
|
77
81
|
}
|
|
78
82
|
} catch (error) {
|
|
79
|
-
this.logger.error(`Error registering job ${jobName}
|
|
83
|
+
this.logger.error(`Error registering job ${jobName}:`, error);
|
|
80
84
|
}
|
|
81
85
|
}
|
|
82
86
|
}
|
package/lib/pgboss.service.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Injectable } from "@nestjs/common";
|
|
2
|
-
import PgBoss, {
|
|
2
|
+
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
3
3
|
import { Inject } from "@nestjs/common";
|
|
4
4
|
import { PGBOSS_TOKEN } from "./utils/consts";
|
|
5
5
|
|
|
@@ -27,19 +27,27 @@ export class PgBossService {
|
|
|
27
27
|
async registerCronJob<TData extends object>(
|
|
28
28
|
name: string,
|
|
29
29
|
cron: string,
|
|
30
|
-
handler:
|
|
30
|
+
handler: WorkWithMetadataHandler<TData>,
|
|
31
31
|
data?: TData,
|
|
32
32
|
options?: PgBoss.ScheduleOptions,
|
|
33
33
|
) {
|
|
34
34
|
await this.boss.schedule(name, cron, data ?? {}, options ?? {});
|
|
35
|
-
await this.boss.work(
|
|
35
|
+
await this.boss.work<TData>(
|
|
36
|
+
name,
|
|
37
|
+
{ ...options, includeMetadata: true },
|
|
38
|
+
handler,
|
|
39
|
+
);
|
|
36
40
|
}
|
|
37
41
|
|
|
38
42
|
async registerJob<TData extends object>(
|
|
39
43
|
name: string,
|
|
40
|
-
handler:
|
|
41
|
-
options?: BatchWorkOptions,
|
|
44
|
+
handler: WorkWithMetadataHandler<TData>,
|
|
45
|
+
options?: PgBoss.BatchWorkOptions,
|
|
42
46
|
) {
|
|
43
|
-
await this.boss.work(
|
|
47
|
+
await this.boss.work<TData>(
|
|
48
|
+
name,
|
|
49
|
+
{ ...options, includeMetadata: true },
|
|
50
|
+
handler,
|
|
51
|
+
);
|
|
44
52
|
}
|
|
45
53
|
}
|
package/package.json
CHANGED
|
@@ -38,7 +38,7 @@ describe("PgBossService", () => {
|
|
|
38
38
|
|
|
39
39
|
expect(mockPgBoss.work).toHaveBeenCalledWith(
|
|
40
40
|
"test-job",
|
|
41
|
-
{ batchSize: 5 },
|
|
41
|
+
{ batchSize: 5, includeMetadata: true },
|
|
42
42
|
handler,
|
|
43
43
|
);
|
|
44
44
|
});
|
|
@@ -75,7 +75,11 @@ describe("PgBossService", () => {
|
|
|
75
75
|
data,
|
|
76
76
|
{ tz: "UTC" },
|
|
77
77
|
);
|
|
78
|
-
expect(mockPgBoss.work).toHaveBeenCalledWith(
|
|
78
|
+
expect(mockPgBoss.work).toHaveBeenCalledWith(
|
|
79
|
+
"test-cron-job",
|
|
80
|
+
{ includeMetadata: true, tz: "UTC" },
|
|
81
|
+
handler,
|
|
82
|
+
);
|
|
79
83
|
});
|
|
80
84
|
});
|
|
81
85
|
});
|