pg-boss 10.1.6 → 10.3.0

package/README.md

@@ -82,4 +82,10 @@ To run the test suite, linter and code coverage:
 npm run cover
 ```
 
-The test suite will try and create a new database named pgboss. The [config.json](test/config.json) file has the default credentials to connect to postgres. 
+The test suite will try and create a new database named pgboss. The [config.json](test/config.json) file has the default credentials to connect to postgres.
+
+The [Docker Compose](docker-compose.yaml) file can be used to start a local postgres instance for testing:
+
+```bash
+docker-compose up -d
+```

package/docker-compose.yaml

@@ -0,0 +1,15 @@
+services:
+  db:
+    image: postgres:16
+    ports:
+      - 5432:5432
+    volumes:
+      - db_volume:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB=pgboss
+      - POSTGRES_NAME=pgboss
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+
+volumes:
+  db_volume:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.1.6",
+  "version": "10.3.0",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -8,13 +8,13 @@
   },
   "dependencies": {
     "cron-parser": "^4.9.0",
-    "pg": "^8.13.0",
+    "pg": "^8.16.0",
     "serialize-error": "^8.1.0"
   },
   "devDependencies": {
-    "@types/node": "^20.16.9",
-    "luxon": "^3.5.0",
-    "mocha": "^10.7.3",
+    "@types/node": "^20.17.57",
+    "luxon": "^3.6.1",
+    "mocha": "^10.8.2",
     "nyc": "^17.1.0",
     "standard": "^17.1.2"
   },

package/src/attorney.js

@@ -143,6 +143,7 @@ function checkFetchArgs (name, options) {
   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')
+  assert(!('ignoreStartAfter' in options) || typeof options.ignoreStartAfter === 'boolean', 'ignoreStartAfter must be a boolean')
 
   options.batchSize = options.batchSize || 1
 }

package/src/manager.js

@@ -50,6 +50,7 @@ class Manager extends EventEmitter {
     this.cancelJobsCommand = plans.cancelJobs(config.schema)
     this.resumeJobsCommand = plans.resumeJobs(config.schema)
     this.deleteJobsCommand = plans.deleteJobs(config.schema)
+    this.retryJobsCommand = plans.retryJobs(config.schema)
     this.failJobsByIdCommand = plans.failJobsById(config.schema)
     this.getJobByIdCommand = plans.getJobById(config.schema)
     this.getArchivedJobByIdCommand = plans.getArchivedJobById(config.schema)
@@ -69,6 +70,7 @@ class Manager extends EventEmitter {
       this.complete,
       this.cancel,
       this.resume,
+      this.retry,
       this.deleteJob,
       this.fail,
       this.fetch,
@@ -516,6 +518,14 @@ class Manager extends EventEmitter {
     return this.mapCommandResponse(ids, result)
   }
 
+  async retry (name, id, options = {}) {
+    Attorney.assertQueueName(name)
+    const db = options.db || this.db
+    const ids = this.mapCompletionIdArg(id, 'resume')
+    const result = await db.executeSql(this.retryJobsCommand, [name, ids])
+    return this.mapCommandResponse(ids, result)
+  }
+
   async createQueue (name, options = {}) {
     name = name || options.name
 

package/src/plans.js

@@ -29,6 +29,7 @@ module.exports = {
   cancelJobs,
   resumeJobs,
   deleteJobs,
+  retryJobs,
   failJobsById,
   failJobsByTimeout,
   insertJob,
@@ -140,7 +141,7 @@ function createTableQueue (schema) {
       partition_name text,
       created_on timestamp with time zone not null default now(),
       updated_on timestamp with time zone not null default now(),
-      PRIMARY KEY (name) 
+      PRIMARY KEY (name)
     )
   `
 }
@@ -208,7 +209,7 @@ const allJobColumns = `${baseJobColumns},
   retry_count as "retryCount",
   retry_delay as "retryDelay",
   retry_backoff as "retryBackoff",
-  start_after as "startAfter",  
+  start_after as "startAfter",
   started_on as "startedOn",
   singleton_key as "singletonKey",
   singleton_on as "singletonOn",
@@ -263,7 +264,7 @@ function createQueueFunction (schema) {
       END IF;
 
       EXECUTE format('CREATE TABLE ${schema}.%I (LIKE ${schema}.job INCLUDING DEFAULTS)', table_name);
-      
+
       EXECUTE format('${formatPartitionCommand(createPrimaryKeyJob(schema))}', table_name);
       EXECUTE format('${formatPartitionCommand(createQueueForeignKeyJob(schema))}', table_name);
       EXECUTE format('${formatPartitionCommand(createQueueForeignKeyJobDeadLetter(schema))}', table_name);
@@ -292,7 +293,7 @@ function deleteQueueFunction (schema) {
     $$
     DECLARE
       table_name varchar;
-    BEGIN  
+    BEGIN
       WITH deleted as (
         DELETE FROM ${schema}.queue
         WHERE name = queue_name
@@ -400,7 +401,7 @@ function updateQueue (schema) {
 
 function getQueues (schema) {
   return `
-    SELECT 
+    SELECT
       name,
       policy,
       retry_limit as "retryLimit",
@@ -503,13 +504,13 @@ function insertVersion (schema, version) {
 }
 
 function fetchNextJob (schema) {
-  return ({ includeMetadata, priority = true } = {}) => `
+  return ({ includeMetadata, priority = true, ignoreStartAfter = false } = {}) => `
     WITH next as (
       SELECT id
       FROM ${schema}.job
       WHERE name = $1
         AND state < '${JOB_STATES.active}'
-        AND start_after < now()
+        ${ignoreStartAfter ? '' : 'AND start_after < now()'}
       ORDER BY ${priority ? 'priority desc, ' : ''}created_on, id
       LIMIT $2
       FOR UPDATE SKIP LOCKED
@@ -520,7 +521,7 @@ function fetchNextJob (schema) {
       retry_count = CASE WHEN started_on IS NOT NULL THEN retry_count + 1 ELSE retry_count END
     FROM next
     WHERE name = $1 AND j.id = next.id
-    RETURNING j.${includeMetadata ? allJobColumns : baseJobColumns}      
+    RETURNING j.${includeMetadata ? allJobColumns : baseJobColumns}
   `
 }
 
@@ -615,7 +616,7 @@ function failJobs (schema, where, output) {
           END as completed_on,
         keep_until,
         dead_letter,
-        policy,        
+        policy,
         ${output}
       FROM deleted_jobs
       ON CONFLICT DO NOTHING
@@ -726,7 +727,22 @@ function deleteJobs (schema) {
     with results as (
       DELETE FROM ${schema}.job
       WHERE name = $1
-        AND id IN (SELECT UNNEST($2::uuid[]))        
+        AND id IN (SELECT UNNEST($2::uuid[]))
+      RETURNING 1
+    )
+    SELECT COUNT(*) from results
+  `
+}
+
+function retryJobs (schema) {
+  return `
+    with results as (
+      UPDATE ${schema}.job
+      SET state = '${JOB_STATES.retry}',
+        retry_limit = retry_limit + 1
+      WHERE name = $1
+        AND id IN (SELECT UNNEST($2::uuid[]))
+        AND state = '${JOB_STATES.failed}'
       RETURNING 1
     )
     SELECT COUNT(*) from results
@@ -813,7 +829,7 @@ function insertJob (schema) {
 function insertJobs (schema) {
   return `
     WITH defaults as (
-      SELECT 
+      SELECT
         $2 as expire_in,
         $3 as keep_until,
         $4::int as retry_limit,
@@ -863,7 +879,7 @@ function insertJobs (schema) {
         WHEN COALESCE("retryBackoff", q.retry_backoff, defaults.retry_backoff, false)
           THEN GREATEST(COALESCE("retryDelay", q.retry_delay, defaults.retry_delay), 1)
         ELSE COALESCE("retryDelay", q.retry_delay, defaults.retry_delay, 0)
-        END as retry_delay,      
+        END as retry_delay,
       COALESCE("retryBackoff", q.retry_backoff, defaults.retry_backoff, false) as retry_backoff,
       q.policy
     FROM (
@@ -886,7 +902,7 @@ function insertJobs (schema) {
         "expireInSeconds" integer,
         "keepUntil" timestamp with time zone,
         "deadLetter" text
-      ) 
+      )
     ) j
     JOIN ${schema}.queue q ON j.name = q.name,
       defaults

package/types.d.ts

@@ -334,6 +334,9 @@ declare class PgBoss extends EventEmitter {
   resume(name: string, id: string, options?: PgBoss.ConnectionOptions): Promise<void>;
   resume(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
 
+  retry(name: string, id: string, options?: PgBoss.ConnectionOptions): Promise<void>;
+  retry(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
+
   deleteJob(name: string, id: string, options?: PgBoss.ConnectionOptions): Promise<void>;
   deleteJob(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;