@wavezync/nestjs-pgboss 2.0.1 → 2.2.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.
Files changed (12) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  3. package/README.MD +4 -0
  4. package/dist/handler-scanner.service.js +7 -4
  5. package/dist/handler-scanner.service.js.map +1 -1
  6. package/dist/pgboss.service.d.ts +5 -4
  7. package/dist/pgboss.service.js +9 -6
  8. package/dist/pgboss.service.js.map +1 -1
  9. package/lib/handler-scanner.service.ts +12 -8
  10. package/lib/pgboss.service.ts +26 -10
  11. package/package.json +1 -1
  12. package/test/pgboss.service.spec.ts +6 -2
package/.github/ISSUE_TEMPLATE/bug_report.md ADDED
@@ -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.
package/.github/ISSUE_TEMPLATE/feature_request.md ADDED
@@ -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
@@ -63,6 +63,10 @@ export class JobSchedulerService {
63
63
 
64
64
  ```
65
65
 
66
+ #### Access `boss` Directly
67
+
68
+ You can access the `PgBoss` instance directly via `pgBossService.boss`
69
+
66
70
  #### Handle jobs using the `@Job` decorator
67
71
 
68
72
  ```ts
package/dist/handler-scanner.service.js CHANGED
@@ -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 = methodRef.bind(instance);
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
  }
package/dist/handler-scanner.service.js.map CHANGED
@@ -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;AACxC,2CAAoD;AAG7C,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,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC9B,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,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE9C,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,CAAC,CAAC;gBACzD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAA;AArEY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,mBAAU,GAAE;qCAKuB,8BAAa;QACjB,gBAAS;QACF,uBAAgB;GAN1C,qBAAqB,CAqEjC"}
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,10 @@
1
- import PgBoss, { BatchWorkOptions, WorkHandler } from "pg-boss";
1
+ import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
2
2
  export declare class PgBossService {
3
- private readonly boss;
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
- registerCronJob<TData extends object>(name: string, cron: string, handler: WorkHandler<TData>, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
8
- registerJob<TData extends object>(name: string, handler: WorkHandler<TData>, options?: BatchWorkOptions): Promise<void>;
8
+ registerCronJob<TData extends object>(name: string, cron: string, handler: WorkWithMetadataHandler<TData>, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
9
+ registerJob<TData extends object>(name: string, handler: WorkWithMetadataHandler<TData>, options?: PgBoss.BatchWorkOptions): Promise<void>;
9
10
  }
package/dist/pgboss.service.js CHANGED
@@ -22,20 +22,23 @@ const common_2 = require("@nestjs/common");
22
22
  const consts_1 = require("./utils/consts");
23
23
  let PgBossService = class PgBossService {
24
24
  constructor(boss) {
25
- this.boss = boss;
25
+ this.pgBoss = boss;
26
+ }
27
+ get boss() {
28
+ return this.pgBoss;
26
29
  }
27
30
  async scheduleJob(name, data, options) {
28
- await this.boss.send(name, data, options);
31
+ await this.pgBoss.send(name, data, options);
29
32
  }
30
33
  async scheduleCronJob(name, cron, data, options) {
31
- await this.boss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
34
+ await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
32
35
  }
33
36
  async registerCronJob(name, cron, handler, data, options) {
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);
37
+ await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
38
+ await this.pgBoss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
36
39
  }
37
40
  async registerJob(name, handler, options) {
38
- await this.boss.work(name, options, handler);
41
+ await this.pgBoss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
39
42
  }
40
43
  };
41
44
  exports.PgBossService = PgBossService;
package/dist/pgboss.service.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAAgE;AAChE,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,OAA2B,EAC3B,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,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAA2B,EAC3B,OAA0B;QAE1B,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;CACF,CAAA;AAtCY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAwB,iBAAM;GADpD,aAAa,CAsCzB"}
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;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,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,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,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,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,MAAM,CAAC,IAAI,CACpB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AAtDY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAIE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAO,iBAAM;GAHnC,aAAa,CAsDzB"}
package/lib/handler-scanner.service.ts CHANGED
@@ -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 { BatchWorkOptions } from "pg-boss";
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<BatchWorkOptions>(
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 = methodRef.bind(instance);
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,18 +1,26 @@
1
1
  import { Injectable } from "@nestjs/common";
2
- import PgBoss, { BatchWorkOptions, WorkHandler } from "pg-boss";
2
+ import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
3
3
  import { Inject } from "@nestjs/common";
4
4
  import { PGBOSS_TOKEN } from "./utils/consts";
5
5
 
6
6
  @Injectable()
7
7
  export class PgBossService {
8
- constructor(@Inject(PGBOSS_TOKEN) private readonly boss: PgBoss) {}
8
+ private pgBoss: PgBoss;
9
+
10
+ constructor(@Inject(PGBOSS_TOKEN) boss: PgBoss) {
11
+ this.pgBoss = boss;
12
+ }
13
+
14
+ get boss(): PgBoss {
15
+ return this.pgBoss;
16
+ }
9
17
 
10
18
  async scheduleJob<TData extends object>(
11
19
  name: string,
12
20
  data: TData,
13
21
  options?: PgBoss.SendOptions,
14
22
  ) {
15
- await this.boss.send(name, data, options);
23
+ await this.pgBoss.send(name, data, options);
16
24
  }
17
25
 
18
26
  async scheduleCronJob<TData extends object>(
@@ -21,25 +29,33 @@ export class PgBossService {
21
29
  data?: TData,
22
30
  options?: PgBoss.ScheduleOptions,
23
31
  ) {
24
- await this.boss.schedule(name, cron, data ?? {}, options ?? {});
32
+ await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
25
33
  }
26
34
 
27
35
  async registerCronJob<TData extends object>(
28
36
  name: string,
29
37
  cron: string,
30
- handler: WorkHandler<TData>,
38
+ handler: WorkWithMetadataHandler<TData>,
31
39
  data?: TData,
32
40
  options?: PgBoss.ScheduleOptions,
33
41
  ) {
34
- await this.boss.schedule(name, cron, data ?? {}, options ?? {});
35
- await this.boss.work(name, handler);
42
+ await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
43
+ await this.pgBoss.work<TData>(
44
+ name,
45
+ { ...options, includeMetadata: true },
46
+ handler,
47
+ );
36
48
  }
37
49
 
38
50
  async registerJob<TData extends object>(
39
51
  name: string,
40
- handler: WorkHandler<TData>,
41
- options?: BatchWorkOptions,
52
+ handler: WorkWithMetadataHandler<TData>,
53
+ options?: PgBoss.BatchWorkOptions,
42
54
  ) {
43
- await this.boss.work(name, options, handler);
55
+ await this.pgBoss.work<TData>(
56
+ name,
57
+ { ...options, includeMetadata: true },
58
+ handler,
59
+ );
44
60
  }
45
61
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wavezync/nestjs-pgboss",
3
- "version": "2.0.1",
3
+ "version": "2.2.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",
package/test/pgboss.service.spec.ts 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("test-cron-job", handler);
78
+ expect(mockPgBoss.work).toHaveBeenCalledWith(
79
+ "test-cron-job",
80
+ { includeMetadata: true, tz: "UTC" },
81
+ handler,
82
+ );
79
83
  });
80
84
  });
81
85
  });