pg-boss 7.0.0 → 7.1.0

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-9.5+-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://travis-ci.com/timgit/pg-boss.svg?branch=master)](https://travis-ci.com/timgit/pg-boss)
+[![Build Status](https://app.travis-ci.com/timgit/pg-boss.svg?branch=master)](https://app.travis-ci.com/github/timgit/pg-boss)
 [![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,20 +33,19 @@ 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 introduced in PostgreSQL 9.5 written 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](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.
 
 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.
 
 ## Features
-* Backpressure-compatible workers for polling queues
-* Distributed cron-based job scheduling with database clock synchronization
+* Backpressure-compatible polling workers
+* Cron scheduling
 * Pub/sub API for fan-out queue relationships
-* Job deferral, retries (with exponential backoff), throttling, rate limiting, debouncing
-* Job completion hooks for orchestrations/sagas
-* Direct send, fetch and completion APIs for custom integrations
+* Deferral, retries (with exponential backoff), rate limiting, debouncing
+* Completion jobs for orchestrations/sagas
 * Direct table access for bulk loads via COPY or INSERT
-* Multi-master compatible when running multiple instances (for example, in a Kubernetes ReplicaSet)
-* Automatic provisioning of required storage
+* Multi-master compatible (for example, in a Kubernetes ReplicaSet)
+* Automatic creation and migration of storage tables
 * Automatic maintenance operations to manage table growth
 
 ## Requirements

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Queueing jobs in Node.js using PostgreSQL like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -15,6 +15,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@types/node": "^17.0.2",
     "coveralls": "^3.1.0",
     "luxon": "^2.0.1",
     "mocha": "^9.0.1",
@@ -27,7 +28,8 @@
     "forcover": "npm run cover && nyc report --reporter=text-lcov | coveralls",
     "export-schema": "node ./scripts/construct.js",
     "export-migration": "node ./scripts/migrate.js",
-    "export-rollback": "node ./scripts/rollback.js"
+    "export-rollback": "node ./scripts/rollback.js",
+    "tsc": "tsc --noEmit types.d.ts"
   },
   "mocha": {
     "timeout": 10000,

package/src/index.js

@@ -73,12 +73,14 @@ class PgBoss extends EventEmitter {
 
     function promoteFunction (obj, func) {
       this[func.name] = (...args) => {
-        if (this.stopped || this.stoppingOn) {
-          const state = this.stoppingOn ? 'stopping' : 'stopped'
+        const shouldRun = !this.started || !((func.name === 'work' || func.name === 'onComplete') && (this.stopped || this.stoppingOn))
+
+        if (shouldRun) {
+          return func.apply(obj, args)
+        } else {
+          const state = this.stoppingOn ? 'stopping' : this.stopped ? 'stopped' : !this.started ? 'not started' : 'started'
           return Promise.reject(new Error(`pg-boss is ${state}.`))
         }
-
-        return func.apply(obj, args)
       }
     }
 
@@ -100,6 +102,8 @@ class PgBoss extends EventEmitter {
 
     await this.contractor.start()
 
+    this.started = true
+
     this.manager.start()
 
     if (!this.config.noSupervisor) {
@@ -132,10 +136,6 @@ class PgBoss extends EventEmitter {
     await this.timekeeper.stop()
 
     const shutdown = async () => {
-      if (this.db.isOurs) {
-        await this.db.close()
-      }
-
       this.stopped = true
       this.stoppingOn = null
 

package/types.d.ts

@@ -1,3 +1,5 @@
+import { EventEmitter } from 'events'
+
 declare namespace PgBoss {
   interface Db {
     executeSql(text: string, values: any[]): Promise<{ rows: any[]; rowCount: number }>;
@@ -201,7 +203,7 @@ declare namespace PgBoss {
     done: JobDoneCallback<ResData>;
   }
 
-  interface MonitorStates {
+  interface MonitorState {
     all: number;
     created: number;
     retry: number;
@@ -210,7 +212,10 @@ declare namespace PgBoss {
     expired: number;
     cancelled: number;
     failed: number;
-    queues: object;
+  }
+
+  interface MonitorStates extends MonitorState {
+    queues: { [queueName: string]: MonitorState };
   }
 
   interface Worker {
@@ -239,7 +244,7 @@ declare namespace PgBoss {
 
 }
 
-declare class PgBoss {
+declare class PgBoss extends EventEmitter {
   constructor(connectionString: string);
   constructor(options: PgBoss.ConstructorOptions);
 
@@ -254,20 +259,20 @@ declare class PgBoss {
   static getRollbackPlans(schema: string): string;
   static getRollbackPlans(): string;
 
-  on(event: "error", handler: (error: Error) => void): void;
-  off(event: "error", handler: (error: Error) => void): void;
+  on(event: "error", handler: (error: Error) => void): this;
+  off(event: "error", handler: (error: Error) => void): this;
 
-  on(event: "maintenance", handler: () => void): void;
-  off(event: "maintenance", handler: () => void): void;
+  on(event: "maintenance", handler: () => void): this;
+  off(event: "maintenance", handler: () => void): this;
 
-  on(event: "monitor-states", handler: (monitorStates: PgBoss.MonitorStates) => void): void;
-  off(event: "monitor-states", handler: (monitorStates: PgBoss.MonitorStates) => void): void;
+  on(event: "monitor-states", handler: (monitorStates: PgBoss.MonitorStates) => void): this;
+  off(event: "monitor-states", handler: (monitorStates: PgBoss.MonitorStates) => void): this;
 
-  on(event: "wip", handler: (data: PgBoss.Worker[]) => void): void;
-  off(event: "wip", handler: (data: PgBoss.Worker[]) => void): void;
+  on(event: "wip", handler: (data: PgBoss.Worker[]) => void): this;
+  off(event: "wip", handler: (data: PgBoss.Worker[]) => void): this;
 
-  on(event: "stopped", handler: () => void): void;
-  off(event: "stopped", handler: () => void): void;
+  on(event: "stopped", handler: () => void): this;
+  off(event: "stopped", handler: () => void): this;
 
   start(): Promise<PgBoss>;
   stop(options?: PgBoss.StopOptions): Promise<void>;
@@ -304,7 +309,9 @@ declare class PgBoss {
 
   subscribe(event: string, name: string): Promise<void>;
   unsubscribe(event: string, name: string): Promise<void>;
-  publish(request: Resolute.Request): Promise<string[]>;
+  publish(event: string): Promise<string[]>;
+  publish(event: string, data: object): Promise<string[]>;
+  publish(event: string, data: object, options: PgBoss.SendOptions): Promise<string[]>;
 
   offComplete(name: string): Promise<void>;
   offComplete(options: PgBoss.OffWorkOptions): Promise<void>;