Merge pull request #366 from timgit/failed-archive-config

Failed archive config

docs/readme.md

@@ -343,6 +343,12 @@ Queue options contain the following constructor-only settings.
 
   Default: 12 hours
 
+* **archiveFailedAfterSeconds**
+
+    Specifies how long in seconds failed jobs get archived. Note: a warning will be emitted if set to lower than 60s and cron processing will be disabled.
+
+  Default: `archiveCompletedAfterSeconds`
+
 **Monitoring options**
 
 * **monitorStateIntervalSeconds** - int, default undefined

package.json

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

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')

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)

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()
         )

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
     }