pg-boss 10.0.0-beta8 → 10.0.0

package/README.md

@@ -19,7 +19,7 @@ async function readme() {
 
   console.log(`created job ${id} in queue ${queue}`)
 
-  await boss.work(queue, async job => {
+  await boss.work(queue, async ([ job ]) => {
     console.log(`received job ${job.id} with data ${JSON.stringify(job.data)}`)
   })
 }
@@ -27,19 +27,21 @@ async function readme() {
 
 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](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.
+pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-select-skip-locked-for-in-postgresql-9-5/), a feature built specifically for message queues to resolve record locking challenges inherent with relational databases. This provides exactly-once delivery and the safety of guaranteed atomic commits to 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
+
+## Summary
 * Exactly-once job delivery
 * Backpressure-compatible polling workers
 * Cron scheduling
+* Queue storage policies to support a variety of rate limiting, debouncing, and concurrency use cases
+* Priority queues, dead letter queues, job deferral, automatic retries with exponential backoff
 * Pub/sub API for fan-out queue relationships
-* Priority queues, deferral, retries (with exponential backoff), rate limiting, debouncing
-* Table operations via SQL for bulk loads via COPY or INSERT
+* Raw SQL support for non-Node.js runtimes via INSERT or COPY
+* Serverless function compatible
 * Multi-master compatible (for example, in a Kubernetes ReplicaSet)
-* Dead letter queues
 
 ## Requirements
 * Node 20 or higher
@@ -47,7 +49,7 @@ This will likely cater the most to teams already familiar with the simplicity of
 
 ## Installation
 
-``` bash
+```bash
 # npm
 npm install pg-boss
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.0.0-beta8",
+  "version": "10.0.0",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -8,8 +8,6 @@
   },
   "dependencies": {
     "cron-parser": "^4.0.0",
-    "lodash.debounce": "^4.0.8",
-    "p-map": "^4.0.0",
     "pg": "^8.5.1",
     "serialize-error": "^8.1.0"
   },

package/src/attorney.js

@@ -122,26 +122,25 @@ function checkWorkArgs (name, args, defaults) {
 
   options = { ...options }
 
-  applyNewJobCheckInterval(options, defaults)
+  applyPollingInterval(options, defaults)
 
-  assert(!('teamConcurrency' in options) ||
-    (Number.isInteger(options.teamConcurrency) && options.teamConcurrency >= 1 && options.teamConcurrency <= 1000),
-  'teamConcurrency must be an integer between 1 and 1000')
-
-  assert(!('teamSize' in options) || (Number.isInteger(options.teamSize) && options.teamSize >= 1), 'teamSize must be an integer > 0')
   assert(!('batchSize' in options) || (Number.isInteger(options.batchSize) && options.batchSize >= 1), 'batchSize must be an integer > 0')
   assert(!('includeMetadata' in options) || typeof options.includeMetadata === 'boolean', 'includeMetadata must be a boolean')
+  assert(!('priority' in options) || typeof options.priority === 'boolean', 'priority must be a boolean')
+
+  options.batchSize = options.batchSize || 1
 
   return { options, callback }
 }
 
-function checkFetchArgs (name, batchSize, options) {
+function checkFetchArgs (name, options) {
   assert(name, 'missing queue name')
 
-  assert(!batchSize || (Number.isInteger(batchSize) && batchSize >= 1), 'batchSize must be an integer > 0')
+  assert(!('batchSize' in options) || (Number.isInteger(options.batchSize) && options.batchSize >= 1), 'batchSize must be an integer > 0')
   assert(!('includeMetadata' in options) || typeof options.includeMetadata === 'boolean', 'includeMetadata must be a boolean')
+  assert(!('priority' in options) || typeof options.priority === 'boolean', 'priority must be a boolean')
 
-  return { name }
+  options.batchSize = options.batchSize || 1
 }
 
 function getConfig (value) {
@@ -163,7 +162,7 @@ function getConfig (value) {
   applyDeleteConfig(config)
   applyMonitoringConfig(config)
 
-  applyNewJobCheckInterval(config)
+  applyPollingInterval(config)
   applyExpirationConfig(config)
   applyRetentionConfig(config)
 
@@ -186,8 +185,8 @@ function assertPostgresObjectName (name) {
 }
 
 function assertQueueName (name) {
+  assert(name, 'Name is required')
   assert(typeof name === 'string', 'Name must be a string')
-  assert(name.length <= 50, 'Name cannot exceed 50 characters')
   assert(/[\w-]/.test(name), 'Name can only contain alphanumeric characters, underscores, or hyphens')
 }
 
@@ -279,18 +278,13 @@ function applyRetryConfig (config, defaults) {
   config.retryBackoffDefault = defaults?.retryBackoff
 }
 
-function applyNewJobCheckInterval (config, defaults) {
-  assert(!('newJobCheckInterval' in config) || config.newJobCheckInterval >= 500,
-    'configuration assert: newJobCheckInterval must be at least every 500ms')
-
-  assert(!('newJobCheckIntervalSeconds' in config) || config.newJobCheckIntervalSeconds >= 1,
-    'configuration assert: newJobCheckIntervalSeconds must be at least every second')
+function applyPollingInterval (config, defaults) {
+  assert(!('pollingIntervalSeconds' in config) || config.pollingIntervalSeconds >= 0.5,
+    'configuration assert: pollingIntervalSeconds must be at least every 500ms')
 
-  config.newJobCheckInterval = ('newJobCheckIntervalSeconds' in config)
-    ? config.newJobCheckIntervalSeconds * 1000
-    : ('newJobCheckInterval' in config)
-        ? config.newJobCheckInterval
-        : defaults?.newJobCheckInterval || 2000
+  config.pollingInterval = ('pollingIntervalSeconds' in config)
+    ? config.pollingIntervalSeconds * 1000
+    : defaults?.pollingInterval || 2000
 }
 
 function applyMaintenanceConfig (config) {

package/src/boss.js

@@ -171,34 +171,6 @@ class Boss extends EventEmitter {
   async drop () {
     await this.db.executeSql(this.dropCommand)
   }
-
-  async setMaintenanceTime () {
-    await this.db.executeSql(this.setMaintenanceTimeCommand)
-  }
-
-  async getMaintenanceTime () {
-    const { rows } = await this.db.executeSql(this.getMaintenanceTimeCommand)
-
-    let { maintained_on: maintainedOn, seconds_ago: secondsAgo } = rows[0]
-
-    secondsAgo = secondsAgo !== null ? parseFloat(secondsAgo) : 999_999_999
-
-    return { maintainedOn, secondsAgo }
-  }
-
-  async setMonitorTime () {
-    await this.db.executeSql(this.setMonitorTimeCommand)
-  }
-
-  async getMonitorTime () {
-    const { rows } = await this.db.executeSql(this.getMonitorTimeCommand)
-
-    let { monitored_on: monitoredOn, seconds_ago: secondsAgo } = rows[0]
-
-    secondsAgo = secondsAgo !== null ? parseFloat(secondsAgo) : 999_999_999
-
-    return { monitoredOn, secondsAgo }
-  }
 }
 
 module.exports = Boss

package/src/contractor.js

@@ -86,15 +86,15 @@ class Contractor {
     }
   }
 
-  async next (version) {
-    const commands = migrationStore.next(this.config.schema, version, this.migrations)
-    await this.db.executeSql(commands)
-  }
-
-  async rollback (version) {
-    const commands = migrationStore.rollback(this.config.schema, version, this.migrations)
-    await this.db.executeSql(commands)
-  }
+  // async next (version) {
+  //   const commands = migrationStore.next(this.config.schema, version, this.migrations)
+  //   await this.db.executeSql(commands)
+  // }
+
+  // async rollback (version) {
+  //   const commands = migrationStore.rollback(this.config.schema, version, this.migrations)
+  //   await this.db.executeSql(commands)
+  // }
 }
 
 module.exports = Contractor

package/src/db.js

@@ -29,15 +29,15 @@ class Db extends EventEmitter {
 
   async executeSql (text, values) {
     if (this.opened) {
-      if (this.config.debug === true) {
-        console.log(`${new Date().toISOString()}: DEBUG SQL`)
-        console.log(text)
-
-        if (values) {
-          console.log(`${new Date().toISOString()}: DEBUG VALUES`)
-          console.log(values)
-        }
-      }
+      // if (this.config.debug === true) {
+      //   console.log(`${new Date().toISOString()}: DEBUG SQL`)
+      //   console.log(text)
+
+      //   if (values) {
+      //     console.log(`${new Date().toISOString()}: DEBUG VALUES`)
+      //     console.log(values)
+      //   }
+      // }
 
       return await this.pool.query(text, values)
     }

package/src/index.js

@@ -149,7 +149,7 @@ class PgBoss extends EventEmitter {
       return
     }
 
-    let { destroy = false, graceful = true, timeout = 30000, wait = true } = options
+    let { close = true, graceful = true, timeout = 30000, wait = true } = options
 
     timeout = Math.max(timeout, 1000)
 
@@ -168,7 +168,7 @@ class PgBoss extends EventEmitter {
 
           await this.#manager.failWip()
 
-          if (this.#db.isOurs && this.#db.opened && destroy) {
+          if (this.#db.isOurs && this.#db.opened && close) {
             await this.#db.close()
           }