pg-boss 7.1.0 → 7.3.0

package/README.md

@@ -38,6 +38,7 @@ pg-boss relies on [SKIP LOCKED](http://blog.2ndquadrant.com/what-is-select-skip-
 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
+* Exactly-once job delivery
 * Backpressure-compatible polling workers
 * Cron scheduling
 * Pub/sub API for fan-out queue relationships

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "7.1.0",
+  "version": "7.3.0",
   "description": "Queueing jobs in Node.js using PostgreSQL like a boss",
   "main": "./src/index.js",
   "engines": {

package/src/manager.js

@@ -56,6 +56,7 @@ class Manager extends EventEmitter {
     this.insertJobsCommand = plans.insertJobs(config.schema)
     this.completeJobsCommand = plans.completeJobs(config.schema)
     this.cancelJobsCommand = plans.cancelJobs(config.schema)
+    this.resumeJobsCommand = plans.resumeJobs(config.schema)
     this.failJobsCommand = plans.failJobs(config.schema)
     this.getJobByIdCommand = plans.getJobById(config.schema)
     this.getArchivedJobByIdCommand = plans.getArchivedJobById(config.schema)
@@ -67,11 +68,13 @@ class Manager extends EventEmitter {
     this.functions = [
       this.complete,
       this.cancel,
+      this.resume,
       this.fail,
       this.fetch,
       this.fetchCompleted,
       this.work,
       this.offWork,
+      this.notifyWorker,
       this.onComplete,
       this.offComplete,
       this.publish,
@@ -292,6 +295,12 @@ class Manager extends EventEmitter {
     })
   }
 
+  notifyWorker (workerId) {
+    if (this.workers.has(workerId)) {
+      this.workers.get(workerId).notify()
+    }
+  }
+
   async subscribe (event, name) {
     assert(event, 'Missing required argument')
     assert(name, 'Missing required argument')
@@ -541,6 +550,12 @@ class Manager extends EventEmitter {
     return this.mapCompletionResponse(ids, result)
   }
 
+  async resume (id) {
+    const ids = this.mapCompletionIdArg(id, 'resume')
+    const result = await this.db.executeSql(this.resumeJobsCommand, [ids])
+    return this.mapCompletionResponse(ids, result)
+  }
+
   async deleteQueue (queue, options) {
     assert(queue, 'Missing queue name argument')
     const sql = plans.deleteQueue(this.config.schema, options)

package/src/plans.js

@@ -26,6 +26,7 @@ module.exports = {
   fetchNextJob,
   completeJobs,
   cancelJobs,
+  resumeJobs,
   failJobs,
   insertJob,
   insertJobs,
@@ -497,6 +498,19 @@ function cancelJobs (schema) {
   `
 }
 
+function resumeJobs (schema) {
+  return `
+    with results as (
+      UPDATE ${schema}.job
+      SET completedOn = NULL,
+        state = '${states.created}'
+      WHERE id IN (SELECT UNNEST($1::uuid[]))
+      RETURNING 1
+    )
+    SELECT COUNT(*) from results
+  `
+}
+
 function insertJob (schema) {
   return `
     INSERT INTO ${schema}.job (

package/src/worker.js

@@ -27,6 +27,15 @@ class Worker {
     this.stopping = false
     this.stopped = false
     this.loopDelayPromise = null
+    this.beenNotified = false
+  }
+
+  notify () {
+    this.beenNotified = true
+
+    if (this.loopDelayPromise) {
+      this.loopDelayPromise.clear()
+    }
   }
 
   async start () {
@@ -36,6 +45,7 @@ class Worker {
       const started = Date.now()
 
       try {
+        this.beenNotified = false
         const jobs = await this.fetch()
 
         this.lastFetchedOn = Date.now()
@@ -64,7 +74,7 @@ class Worker {
 
       this.lastJobDuration = duration
 
-      if (!this.stopping && duration < this.interval) {
+      if (!this.stopping && !this.beenNotified && duration < this.interval) {
         this.loopDelayPromise = delay(this.interval - duration)
         await this.loopDelayPromise
         this.loopDelayPromise = null

package/types.d.ts

@@ -102,6 +102,7 @@ declare namespace PgBoss {
   interface JobFetchOptions {
     teamSize?: number;
     teamConcurrency?: number;
+    teamRefill?: boolean;
     batchSize?: number;
     includeMetadata?: boolean;
   }
@@ -307,6 +308,12 @@ declare class PgBoss extends EventEmitter {
   offWork(name: string): Promise<void>;
   offWork(options: PgBoss.OffWorkOptions): Promise<void>;
 
+  /**
+   * Notify worker that something has changed
+   * @param workerId 
+   */
+  notifyWorker(workerId: string): void;
+
   subscribe(event: string, name: string): Promise<void>;
   unsubscribe(event: string, name: string): Promise<void>;
   publish(event: string): Promise<string[]>;
@@ -329,6 +336,9 @@ declare class PgBoss extends EventEmitter {
   cancel(id: string): Promise<void>;
   cancel(ids: string[]): Promise<void>;
 
+  resume(id: string): Promise<void>;
+  resume(ids: string[]): Promise<void>;
+
   complete(id: string): Promise<void>;
   complete(id: string, data: object): Promise<void>;
   complete(ids: string[]): Promise<void>;