@wavezync/nestjs-pgboss 2.1.0 → 3.0.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/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- package/README.MD +4 -0
- package/dist/handler-scanner.service.js +3 -2
- package/dist/handler-scanner.service.js.map +1 -1
- package/dist/pgboss.service.d.ts +3 -2
- package/dist/pgboss.service.js +14 -6
- package/dist/pgboss.service.js.map +1 -1
- package/dist/utils/helpers.d.ts +3 -0
- package/dist/utils/helpers.js +20 -0
- package/dist/utils/helpers.js.map +1 -0
- package/lib/handler-scanner.service.ts +8 -6
- package/lib/pgboss.service.ts +21 -8
- package/lib/utils/helpers.ts +22 -0
- package/package.json +2 -2
- package/test/pgboss.service.spec.ts +4 -2
- package/dist/utils/conversion-helper.d.ts +0 -2
- package/dist/utils/conversion-helper.js +0 -7
- package/dist/utils/conversion-helper.js.map +0 -1
- package/lib/utils/conversion-helper.ts +0 -10
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help us improve
|
|
4
|
+
title: ''
|
|
5
|
+
labels: ''
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
**Describe the bug**
|
|
11
|
+
A clear and concise description of what the bug is.
|
|
12
|
+
|
|
13
|
+
**To Reproduce**
|
|
14
|
+
Steps to reproduce the behavior:
|
|
15
|
+
1. Go to '...'
|
|
16
|
+
2. Click on '....'
|
|
17
|
+
3. Scroll down to '....'
|
|
18
|
+
4. See error
|
|
19
|
+
|
|
20
|
+
**Expected behavior**
|
|
21
|
+
A clear and concise description of what you expected to happen.
|
|
22
|
+
|
|
23
|
+
**Screenshots**
|
|
24
|
+
If applicable, add screenshots to help explain your problem.
|
|
25
|
+
|
|
26
|
+
**Desktop (please complete the following information):**
|
|
27
|
+
- OS: [e.g. iOS]
|
|
28
|
+
- Browser [e.g. chrome, safari]
|
|
29
|
+
- Version [e.g. 22]
|
|
30
|
+
|
|
31
|
+
**Smartphone (please complete the following information):**
|
|
32
|
+
- Device: [e.g. iPhone6]
|
|
33
|
+
- OS: [e.g. iOS8.1]
|
|
34
|
+
- Browser [e.g. stock browser, safari]
|
|
35
|
+
- Version [e.g. 22]
|
|
36
|
+
|
|
37
|
+
**Additional context**
|
|
38
|
+
Add any other context about the problem here.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for this project
|
|
4
|
+
title: ''
|
|
5
|
+
labels: ''
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
**Is your feature request related to a problem? Please describe.**
|
|
11
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
12
|
+
|
|
13
|
+
**Describe the solution you'd like**
|
|
14
|
+
A clear and concise description of what you want to happen.
|
|
15
|
+
|
|
16
|
+
**Describe alternatives you've considered**
|
|
17
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
|
18
|
+
|
|
19
|
+
**Additional context**
|
|
20
|
+
Add any other context or screenshots about the feature request here.
|
package/README.MD
CHANGED
|
@@ -15,6 +15,7 @@ const core_1 = require("@nestjs/core");
|
|
|
15
15
|
const pgboss_service_1 = require("./pgboss.service");
|
|
16
16
|
const job_decorator_1 = require("./decorators/job.decorator");
|
|
17
17
|
const consts_1 = require("./utils/consts");
|
|
18
|
+
const helpers_1 = require("./utils/helpers");
|
|
18
19
|
let HandlerScannerService = class HandlerScannerService {
|
|
19
20
|
constructor(pgBossService, reflector, modulesContainer) {
|
|
20
21
|
this.pgBossService = pgBossService;
|
|
@@ -44,8 +45,8 @@ let HandlerScannerService = class HandlerScannerService {
|
|
|
44
45
|
const cronOptions = this.reflector.get(job_decorator_1.CRON_OPTIONS, methodRef);
|
|
45
46
|
if (jobName) {
|
|
46
47
|
const boundHandler = async (job) => {
|
|
47
|
-
const
|
|
48
|
-
await methodRef.call(instance,
|
|
48
|
+
const extractedJob = (0, helpers_1.normalizeJob)(job);
|
|
49
|
+
await methodRef.call(instance, extractedJob);
|
|
49
50
|
};
|
|
50
51
|
try {
|
|
51
52
|
if (cronExpression) {
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AACxC,6CAA+C;AAGxC,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,CACpC,4BAAY,EACZ,SAAS,CACV,CAAC;YAEF,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,YAAY,GAAiC,KAAK,EAAE,GAAG,EAAE,EAAE;oBAC/D,MAAM,YAAY,GAAG,IAAA,sBAAY,EAAC,GAAG,CAAC,CAAC;oBACvC,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;gBAC/C,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,UAAU,CACX,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;AA1EY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;qCAKuB,8BAAa;QACjB,gBAAS;QACF,uBAAgB;GAN1C,qBAAqB,CA0EjC"}
|
package/dist/pgboss.service.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
2
2
|
export declare class PgBossService {
|
|
3
|
-
private
|
|
3
|
+
private pgBoss;
|
|
4
4
|
constructor(boss: PgBoss);
|
|
5
|
+
get boss(): PgBoss;
|
|
5
6
|
scheduleJob<TData extends object>(name: string, data: TData, options?: PgBoss.SendOptions): Promise<void>;
|
|
6
7
|
scheduleCronJob<TData extends object>(name: string, cron: string, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
|
|
7
8
|
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.
|
|
9
|
+
registerJob<TData extends object>(name: string, handler: WorkWithMetadataHandler<TData>, options?: PgBoss.WorkOptions): Promise<void>;
|
|
9
10
|
}
|
package/dist/pgboss.service.js
CHANGED
|
@@ -20,22 +20,30 @@ const common_1 = require("@nestjs/common");
|
|
|
20
20
|
const pg_boss_1 = __importDefault(require("pg-boss"));
|
|
21
21
|
const common_2 = require("@nestjs/common");
|
|
22
22
|
const consts_1 = require("./utils/consts");
|
|
23
|
+
const helpers_1 = require("./utils/helpers");
|
|
23
24
|
let PgBossService = class PgBossService {
|
|
24
25
|
constructor(boss) {
|
|
25
|
-
this.
|
|
26
|
+
this.pgBoss = boss;
|
|
27
|
+
}
|
|
28
|
+
get boss() {
|
|
29
|
+
return this.pgBoss;
|
|
26
30
|
}
|
|
27
31
|
async scheduleJob(name, data, options) {
|
|
28
|
-
await this.
|
|
32
|
+
await this.pgBoss.createQueue(name);
|
|
33
|
+
await this.pgBoss.send(name, data, options);
|
|
29
34
|
}
|
|
30
35
|
async scheduleCronJob(name, cron, data, options) {
|
|
31
|
-
await this.
|
|
36
|
+
await this.pgBoss.createQueue(name);
|
|
37
|
+
await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
|
|
32
38
|
}
|
|
33
39
|
async registerCronJob(name, cron, handler, data, options) {
|
|
34
|
-
await this.
|
|
35
|
-
await this.
|
|
40
|
+
await this.pgBoss.createQueue(name);
|
|
41
|
+
await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
|
|
42
|
+
await this.pgBoss.work(name, Object.assign(Object.assign({}, (0, helpers_1.transformOptions)(options)), { includeMetadata: true }), handler);
|
|
36
43
|
}
|
|
37
44
|
async registerJob(name, handler, options) {
|
|
38
|
-
await this.
|
|
45
|
+
await this.pgBoss.createQueue(name);
|
|
46
|
+
await this.pgBoss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
|
|
39
47
|
}
|
|
40
48
|
};
|
|
41
49
|
exports.PgBossService = PgBossService;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAA0D;AAC1D,2CAAwC;AACxC,2CAA8C;
|
|
1
|
+
{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAA0D;AAC1D,2CAAwC;AACxC,2CAA8C;AAC9C,6CAAmD;AAG5C,IAAM,aAAa,GAAnB,MAAM,aAAa;IAGxB,YAAkC,IAAY;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,IAAW,EACX,OAA4B;QAE5B,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,OAAuC,EACvC,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;QAClE,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,kCACC,IAAA,0BAAgB,EAAC,OAAO,CAAC,KAAE,eAAe,EAAE,IAAI,KACrD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAAuC,EACvC,OAA4B;QAE5B,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AA1DY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAIE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAO,iBAAM;GAHnC,aAAa,CA0DzB"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.transformOptions = transformOptions;
|
|
4
|
+
exports.normalizeJob = normalizeJob;
|
|
5
|
+
function transformOptions(options) {
|
|
6
|
+
if (!options)
|
|
7
|
+
return {};
|
|
8
|
+
const transformedOptions = Object.assign({}, options);
|
|
9
|
+
if (typeof options.priority === "number") {
|
|
10
|
+
transformedOptions.priority = options.priority > 0;
|
|
11
|
+
}
|
|
12
|
+
return transformedOptions;
|
|
13
|
+
}
|
|
14
|
+
function normalizeJob(job) {
|
|
15
|
+
if (typeof job === "object" && "0" in job) {
|
|
16
|
+
return job[0];
|
|
17
|
+
}
|
|
18
|
+
return job;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../lib/utils/helpers.ts"],"names":[],"mappings":";;AAEA,4CAYC;AAED,oCAKC;AAnBD,SAAgB,gBAAgB,CAC9B,OAAqD;IAErD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAExB,MAAM,kBAAkB,qBAAa,OAAO,CAAE,CAAC;IAE/C,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACzC,kBAAkB,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,SAAgB,YAAY,CAAC,GAAQ;IACnC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1C,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
|
|
@@ -10,6 +10,7 @@ import {
|
|
|
10
10
|
import { InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
|
|
11
11
|
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
12
12
|
import { LOGGER } from "./utils/consts";
|
|
13
|
+
import { normalizeJob } from "./utils/helpers";
|
|
13
14
|
|
|
14
15
|
@Injectable()
|
|
15
16
|
export class HandlerScannerService {
|
|
@@ -52,14 +53,15 @@ export class HandlerScannerService {
|
|
|
52
53
|
CRON_EXPRESSION,
|
|
53
54
|
methodRef,
|
|
54
55
|
);
|
|
55
|
-
const cronOptions = this.reflector.get<
|
|
56
|
+
const cronOptions = this.reflector.get<PgBoss.ScheduleOptions>(
|
|
57
|
+
CRON_OPTIONS,
|
|
58
|
+
methodRef,
|
|
59
|
+
);
|
|
56
60
|
|
|
57
61
|
if (jobName) {
|
|
58
62
|
const boundHandler: WorkWithMetadataHandler<any> = async (job) => {
|
|
59
|
-
const
|
|
60
|
-
|
|
61
|
-
};
|
|
62
|
-
await methodRef.call(instance, jobData);
|
|
63
|
+
const extractedJob = normalizeJob(job);
|
|
64
|
+
await methodRef.call(instance, extractedJob);
|
|
63
65
|
};
|
|
64
66
|
try {
|
|
65
67
|
if (cronExpression) {
|
|
@@ -75,7 +77,7 @@ export class HandlerScannerService {
|
|
|
75
77
|
await this.pgBossService.registerJob(
|
|
76
78
|
jobName,
|
|
77
79
|
boundHandler,
|
|
78
|
-
jobOptions
|
|
80
|
+
jobOptions,
|
|
79
81
|
);
|
|
80
82
|
this.logger.log(`Registered job: ${jobName}`);
|
|
81
83
|
}
|
package/lib/pgboss.service.ts
CHANGED
|
@@ -2,17 +2,27 @@ import { Injectable } from "@nestjs/common";
|
|
|
2
2
|
import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
|
|
3
3
|
import { Inject } from "@nestjs/common";
|
|
4
4
|
import { PGBOSS_TOKEN } from "./utils/consts";
|
|
5
|
+
import { transformOptions } from "./utils/helpers";
|
|
5
6
|
|
|
6
7
|
@Injectable()
|
|
7
8
|
export class PgBossService {
|
|
8
|
-
|
|
9
|
+
private pgBoss: PgBoss;
|
|
10
|
+
|
|
11
|
+
constructor(@Inject(PGBOSS_TOKEN) boss: PgBoss) {
|
|
12
|
+
this.pgBoss = boss;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
get boss(): PgBoss {
|
|
16
|
+
return this.pgBoss;
|
|
17
|
+
}
|
|
9
18
|
|
|
10
19
|
async scheduleJob<TData extends object>(
|
|
11
20
|
name: string,
|
|
12
21
|
data: TData,
|
|
13
22
|
options?: PgBoss.SendOptions,
|
|
14
23
|
) {
|
|
15
|
-
await this.
|
|
24
|
+
await this.pgBoss.createQueue(name);
|
|
25
|
+
await this.pgBoss.send(name, data, options);
|
|
16
26
|
}
|
|
17
27
|
|
|
18
28
|
async scheduleCronJob<TData extends object>(
|
|
@@ -21,7 +31,8 @@ export class PgBossService {
|
|
|
21
31
|
data?: TData,
|
|
22
32
|
options?: PgBoss.ScheduleOptions,
|
|
23
33
|
) {
|
|
24
|
-
await this.
|
|
34
|
+
await this.pgBoss.createQueue(name);
|
|
35
|
+
await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
|
|
25
36
|
}
|
|
26
37
|
|
|
27
38
|
async registerCronJob<TData extends object>(
|
|
@@ -31,10 +42,11 @@ export class PgBossService {
|
|
|
31
42
|
data?: TData,
|
|
32
43
|
options?: PgBoss.ScheduleOptions,
|
|
33
44
|
) {
|
|
34
|
-
await this.
|
|
35
|
-
await this.
|
|
45
|
+
await this.pgBoss.createQueue(name);
|
|
46
|
+
await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
|
|
47
|
+
await this.pgBoss.work<TData>(
|
|
36
48
|
name,
|
|
37
|
-
{ ...options, includeMetadata: true },
|
|
49
|
+
{ ...transformOptions(options), includeMetadata: true },
|
|
38
50
|
handler,
|
|
39
51
|
);
|
|
40
52
|
}
|
|
@@ -42,9 +54,10 @@ export class PgBossService {
|
|
|
42
54
|
async registerJob<TData extends object>(
|
|
43
55
|
name: string,
|
|
44
56
|
handler: WorkWithMetadataHandler<TData>,
|
|
45
|
-
options?: PgBoss.
|
|
57
|
+
options?: PgBoss.WorkOptions,
|
|
46
58
|
) {
|
|
47
|
-
await this.
|
|
59
|
+
await this.pgBoss.createQueue(name);
|
|
60
|
+
await this.pgBoss.work<TData>(
|
|
48
61
|
name,
|
|
49
62
|
{ ...options, includeMetadata: true },
|
|
50
63
|
handler,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import PgBoss from "pg-boss";
|
|
2
|
+
|
|
3
|
+
export function transformOptions(
|
|
4
|
+
options?: PgBoss.WorkOptions | PgBoss.ScheduleOptions,
|
|
5
|
+
) {
|
|
6
|
+
if (!options) return {};
|
|
7
|
+
|
|
8
|
+
const transformedOptions: any = { ...options };
|
|
9
|
+
|
|
10
|
+
if (typeof options.priority === "number") {
|
|
11
|
+
transformedOptions.priority = options.priority > 0;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
return transformedOptions;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export function normalizeJob(job: any) {
|
|
18
|
+
if (typeof job === "object" && "0" in job) {
|
|
19
|
+
return job[0];
|
|
20
|
+
}
|
|
21
|
+
return job;
|
|
22
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wavezync/nestjs-pgboss",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"description": "A NestJS module that integrates pg-boss for job scheduling and handling.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "samaratungajs@wavezync.com",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"peerDependencies": {
|
|
24
24
|
"@nestjs/common": "^9 || ^10",
|
|
25
25
|
"@nestjs/core": "^9 || ^10",
|
|
26
|
-
"pg-boss": "^
|
|
26
|
+
"pg-boss": "^10",
|
|
27
27
|
"reflect-metadata": "^0.1.13 || ^0.2.0",
|
|
28
28
|
"rxjs": "^7.2.0"
|
|
29
29
|
},
|
|
@@ -13,6 +13,8 @@ describe("PgBossService", () => {
|
|
|
13
13
|
work: jest.fn(),
|
|
14
14
|
send: jest.fn(),
|
|
15
15
|
schedule: jest.fn(),
|
|
16
|
+
createQueue: jest.fn(),
|
|
17
|
+
getQueue: jest.fn(),
|
|
16
18
|
} as any;
|
|
17
19
|
|
|
18
20
|
const module: TestingModule = await Test.createTestingModule({
|
|
@@ -32,13 +34,13 @@ describe("PgBossService", () => {
|
|
|
32
34
|
describe("registerJob", () => {
|
|
33
35
|
it("should call PgBoss work with correct parameters", async () => {
|
|
34
36
|
const handler = jest.fn();
|
|
35
|
-
const options = {
|
|
37
|
+
const options = {};
|
|
36
38
|
|
|
37
39
|
await service.registerJob("test-job", handler, options);
|
|
38
40
|
|
|
39
41
|
expect(mockPgBoss.work).toHaveBeenCalledWith(
|
|
40
42
|
"test-job",
|
|
41
|
-
{
|
|
43
|
+
{ includeMetadata: true },
|
|
42
44
|
handler,
|
|
43
45
|
);
|
|
44
46
|
});
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.convertToBatchWorkOptions = convertToBatchWorkOptions;
|
|
4
|
-
function convertToBatchWorkOptions(jobOptions = {}) {
|
|
5
|
-
return Object.assign(Object.assign({}, jobOptions), { batchSize: 1 });
|
|
6
|
-
}
|
|
7
|
-
//# sourceMappingURL=conversion-helper.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"conversion-helper.js","sourceRoot":"","sources":["../../lib/utils/conversion-helper.ts"],"names":[],"mappings":";;AAEA,8DAOC;AAPD,SAAgB,yBAAyB,CACvC,aAAyB,EAAE;IAE3B,uCACK,UAAU,KACb,SAAS,EAAE,CAAC,IACZ;AACJ,CAAC"}
|