pg-boss 8.3.1 → 8.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "8.3.1",
+  "version": "8.4.1",
   "description": "Queueing jobs in Node.js using PostgreSQL like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -32,7 +32,8 @@
     "export-schema": "node ./scripts/construct.js",
     "export-migration": "node ./scripts/migrate.js",
     "export-rollback": "node ./scripts/rollback.js",
-    "tsc": "tsc --noEmit types.d.ts"
+    "tsc": "tsc --noEmit types.d.ts",
+    "readme": "node ./test/readme.js"
   },
   "mocha": {
     "timeout": 10000,

package/src/attorney.js

@@ -159,6 +159,7 @@ function getConfig (value) {
   applyDatabaseConfig(config)
   applyMaintenanceConfig(config)
   applyArchiveConfig(config)
+  applyArchiveFailedConfig(config)
   applyDeleteConfig(config)
   applyMonitoringConfig(config)
   applyUuidConfig(config)
@@ -195,6 +196,19 @@ function applyArchiveConfig (config) {
   }
 }
 
+function applyArchiveFailedConfig (config) {
+  assert(!('archiveFailedAfterSeconds' in config) || config.archiveFailedAfterSeconds >= 1,
+    'configuration assert: archiveFailedAfterSeconds must be at least every second and less than ')
+
+  config.archiveFailedSeconds = config.archiveFailedAfterSeconds || config.archiveSeconds
+  config.archiveFailedInterval = `${config.archiveFailedSeconds} seconds`
+
+  // Do not emit warning twice
+  if (config.archiveFailedSeconds < 60 && config.archiveSeconds >= 60) {
+    emitWarning(WARNINGS.CRON_DISABLED)
+  }
+}
+
 function applyCompletionConfig (config, defaults) {
   assert(!('onComplete' in config) || config.onComplete === true || config.onComplete === false,
     'configuration assert: onComplete must be either true or false')

package/src/boss.js

@@ -33,7 +33,7 @@ class Boss extends EventEmitter {
     this.events = events
 
     this.expireCommand = plans.locked(config.schema, plans.expire(config.schema))
-    this.archiveCommand = plans.locked(config.schema, plans.archive(config.schema, config.archiveInterval))
+    this.archiveCommand = plans.locked(config.schema, plans.archive(config.schema, config.archiveInterval, config.archiveFailedInterval))
     this.purgeCommand = plans.locked(config.schema, plans.purge(config.schema, config.deleteAfter))
     this.getMaintenanceTimeCommand = plans.getMaintenanceTime(config.schema)
     this.setMaintenanceTimeCommand = plans.setMaintenanceTime(config.schema)

package/src/manager.js

@@ -341,7 +341,7 @@ class Manager extends EventEmitter {
   }
 
   async sendOnce (name, data, options, key) {
-    options = options || {}
+    options = options ? { ...options } : {}
 
     options.singletonKey = key || name
 
@@ -351,7 +351,7 @@ class Manager extends EventEmitter {
   }
 
   async sendSingleton (name, data, options) {
-    options = options || {}
+    options = options ? { ...options } : {}
 
     options.singletonKey = SINGLETON_QUEUE_KEY
 
@@ -361,7 +361,7 @@ class Manager extends EventEmitter {
   }
 
   async sendAfter (name, data, options, after) {
-    options = options || {}
+    options = options ? { ...options } : {}
     options.startAfter = after
 
     const result = Attorney.checkSendArgs([name, data, options], this.config)
@@ -370,7 +370,7 @@ class Manager extends EventEmitter {
   }
 
   async sendThrottled (name, data, options, seconds, key) {
-    options = options || {}
+    options = options ? { ...options } : {}
     options.singletonSeconds = seconds
     options.singletonNextSlot = false
     options.singletonKey = key
@@ -381,7 +381,7 @@ class Manager extends EventEmitter {
   }
 
   async sendDebounced (name, data, options, seconds, key) {
-    options = options || {}
+    options = options ? { ...options } : {}
     options.singletonSeconds = seconds
     options.singletonNextSlot = true
     options.singletonKey = key

package/src/plans.js

@@ -601,7 +601,7 @@ function insertJobs (schema) {
       keepUntil,
       on_complete
     )
-    SELECT 
+    SELECT
       COALESCE(id, gen_random_uuid()) as id,
       name,
       data,
@@ -639,12 +639,16 @@ function purge (schema, interval) {
   `
 }
 
-function archive (schema, interval) {
+function archive (schema, completedInterval, failedInterval = completedInterval) {
   return `
     WITH archived_rows AS (
       DELETE FROM ${schema}.job
-      WHERE
-        completedOn < (now() - interval '${interval}')
+      WHERE (
+          state <> '${states.failed}' AND completedOn < (now() - interval '${completedInterval}')
+        )
+        OR (
+          state = '${states.failed}' AND completedOn < (now() - interval '${failedInterval}')
+        )
         OR (
           state < '${states.active}' AND keepUntil < now()
         )

package/src/timekeeper.js

@@ -45,7 +45,7 @@ class Timekeeper extends EventEmitter {
 
   async start () {
     // setting the archive config too low breaks the cron 60s debounce interval so don't even try
-    if (this.config.archiveSeconds < 60) {
+    if (this.config.archiveSeconds < 60 || this.config.archiveFailedSeconds < 60) {
       return
     }
 
@@ -88,29 +88,47 @@ class Timekeeper extends EventEmitter {
   }
 
   async monitorCron () {
-    const { secondsAgo } = await this.getCronTime()
+    try {
+      if (this.config.__test__force_cron_monitoring_error) {
+        throw new Error(this.config.__test__force_cron_monitoring_error)
+      }
 
-    if (secondsAgo > 60) {
-      await this.checkSchedulesAsync()
+      const { secondsAgo } = await this.getCronTime()
+
+      if (secondsAgo > 60) {
+        await this.checkSchedulesAsync()
+      }
+    } catch (err) {
+      this.emit(this.events.error, err)
     }
   }
 
   async cacheClockSkew () {
-    const { rows } = await this.db.executeSql(this.getTimeCommand)
+    let skew = 0
+
+    try {
+      if (this.config.__test__force_clock_monitoring_error) {
+        throw new Error(this.config.__test__force_clock_monitoring_error)
+      }
 
-    const local = Date.now()
+      const { rows } = await this.db.executeSql(this.getTimeCommand)
 
-    const dbTime = parseFloat(rows[0].time)
+      const local = Date.now()
 
-    const skew = dbTime - local
+      const dbTime = parseFloat(rows[0].time)
 
-    const skewSeconds = Math.abs(skew) / 1000
+      skew = dbTime - local
 
-    if (skewSeconds >= 60 || this.config.__test__force_clock_skew_warning) {
-      Attorney.warnClockSkew(`Instance clock is ${skewSeconds}s ${skew > 0 ? 'slower' : 'faster'} than database.`)
-    }
+      const skewSeconds = Math.abs(skew) / 1000
 
-    this.clockSkew = skew
+      if (skewSeconds >= 60 || this.config.__test__force_clock_skew_warning) {
+        Attorney.warnClockSkew(`Instance clock is ${skewSeconds}s ${skew > 0 ? 'slower' : 'faster'} than database.`)
+      }
+    } catch (err) {
+      this.emit(this.events.error, err)
+    } finally {
+      this.clockSkew = skew
+    }
   }
 
   async checkSchedulesAsync () {
@@ -128,7 +146,7 @@ class Timekeeper extends EventEmitter {
 
     try {
       if (this.config.__test__throw_clock_monitoring) {
-        throw new Error('clock monitoring error')
+        throw new Error(this.config.__test__throw_clock_monitoring)
       }
 
       const items = await this.getSchedules()

package/types.d.ts

@@ -44,6 +44,7 @@ declare namespace PgBoss {
     maintenanceIntervalMinutes?: number;
 
     archiveCompletedAfterSeconds?: number;
+    archiveFailedAfterSeconds?: number;
   }
 
   type ConstructorOptions =