pg-boss 9.0.1 → 9.0.3

package/README.md

@@ -2,7 +2,7 @@ Queueing jobs in Node.js using PostgreSQL like a boss.
 
 [![PostgreSql Version](https://img.shields.io/badge/PostgreSQL-11+-blue.svg?maxAge=2592000)](http://www.postgresql.org)
 [![npm version](https://badge.fury.io/js/pg-boss.svg)](https://badge.fury.io/js/pg-boss)
-[![Build Status](https://app.travis-ci.com/timgit/pg-boss.svg?branch=master)](https://app.travis-ci.com/github/timgit/pg-boss)
+![Build](https://github.com/timgit/pg-boss/actions/workflows/ci.yml/badge.svg?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/timgit/pg-boss/badge.svg?branch=master)](https://coveralls.io/github/timgit/pg-boss?branch=master)
 
 ```js
@@ -33,7 +33,7 @@ async function someAsyncJobHandler(job) {
 
 pg-boss is a job queue built in Node.js on top of PostgreSQL in order to provide background processing and reliable asynchronous execution to Node.js applications.
 
-pg-boss relies on [SKIP LOCKED](http://blog.2ndquadrant.com/what-is-select-skip-locked-for-in-postgresql-9-5), a feature added to postgres specifically for message queues, in order to resolve record locking challenges inherent with relational databases. This brings the safety of guaranteed atomic commits of a relational database to your asynchronous job processing.
+pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-select-skip-locked-for-in-postgresql-9-5/), a feature added to postgres specifically for message queues, in order to resolve record locking challenges inherent with relational databases. This brings the safety of guaranteed atomic commits of a relational database to your asynchronous job processing.
 
 This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "9.0.1",
+  "version": "9.0.3",
   "description": "Queueing jobs in Node.js using PostgreSQL like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -16,8 +16,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.0.0",
-    "coveralls": "^3.1.0",
+    "@types/node": "^20.3.3",
     "luxon": "^3.0.1",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0",
@@ -25,10 +24,7 @@
   },
   "scripts": {
     "test": "standard && mocha",
-    "cover": "nyc --reporter=text npm test",
-    "travis-cover": "nyc --reporter=text npm run travis-test",
-    "travis-test": "standard && mocha --jobs 0 --exit",
-    "forcover": "npm run travis-cover && nyc report --reporter=text-lcov | coveralls",
+    "cover": "nyc npm test",
     "export-schema": "node ./scripts/construct.js",
     "export-migration": "node ./scripts/migrate.js",
     "export-rollback": "node ./scripts/rollback.js",
@@ -47,7 +43,12 @@
       "src/**/*.js"
     ],
     "sourceMap": false,
-    "instrument": true
+    "instrument": true,
+    "reporter": [
+      "lcov",
+      "text-summary",
+      "text"
+    ]
   },
   "standard": {
     "globals": [
@@ -55,6 +56,7 @@
       "it",
       "before",
       "after",
+      "before",
       "beforeEach",
       "afterEach"
     ]

package/src/index.js

@@ -94,14 +94,13 @@ class PgBoss extends EventEmitter {
       return this
     }
 
-    this.stopped = false
-
     if (this.db.isOurs && !this.db.opened) {
       await this.db.open()
     }
 
     await this.contractor.start()
 
+    this.stopped = false
     this.started = true
 
     this.manager.start()

package/types.d.ts

@@ -107,16 +107,23 @@ declare namespace PgBoss {
     newJobCheckIntervalSeconds?: number;
   }
 
-  interface JobFetchOptions {
+  interface CommonJobFetchOptions {
+    includeMetadata?: boolean;
+    enforceSingletonQueueActiveLimit?: boolean;
+  }
+
+  type JobFetchOptions  = CommonJobFetchOptions & {
     teamSize?: number;
     teamConcurrency?: number;
     teamRefill?: boolean;
-    batchSize?: number;
-    includeMetadata?: boolean;
-    enforceSingletonQueueActiveLimit?: boolean;
+  }
+
+  type BatchJobFetchOptions = CommonJobFetchOptions & {
+    batchSize: number;
   }
 
   type WorkOptions = JobFetchOptions & JobPollingOptions
+  type BatchWorkOptions = BatchJobFetchOptions & JobPollingOptions
 
   type FetchOptions = {
     includeMetadata?: boolean;
@@ -124,11 +131,19 @@ declare namespace PgBoss {
   } & ConnectionOptions;
 
   interface WorkHandler<ReqData> {
-    (job: PgBoss.Job<ReqData>): Promise<void>;
+    (job: PgBoss.Job<ReqData>): Promise<any>;
+  }
+
+  interface BatchWorkHandler<ReqData> {
+    (job: PgBoss.Job<ReqData>[]): Promise<any>;
   }
 
   interface WorkWithMetadataHandler<ReqData> {
-    (job: PgBoss.JobWithMetadata<ReqData>): Promise<void>;
+    (job: PgBoss.JobWithMetadata<ReqData>): Promise<any>;
+  }
+
+  interface BatchWorkWithMetadataHandler<ReqData> {
+    (job: PgBoss.JobWithMetadata<ReqData>[]): Promise<any>;
   }
 
   interface Request {
@@ -302,6 +317,9 @@ declare class PgBoss extends EventEmitter {
   work<ReqData>(name: string, options: PgBoss.WorkOptions & { includeMetadata: true }, handler: PgBoss.WorkWithMetadataHandler<ReqData>): Promise<string>;
   work<ReqData>(name: string, options: PgBoss.WorkOptions, handler: PgBoss.WorkHandler<ReqData>): Promise<string>;
 
+  work<ReqData>(name: string, options: PgBoss.BatchWorkOptions & { includeMetadata: true }, handler: PgBoss.BatchWorkWithMetadataHandler<ReqData>): Promise<string>;
+  work<ReqData>(name: string, options: PgBoss.BatchWorkOptions, handler: PgBoss.BatchWorkHandler<ReqData>): Promise<string>;
+
   onComplete(name: string, handler: Function): Promise<string>;
   onComplete(name: string, options: PgBoss.WorkOptions, handler: Function): Promise<string>;