pg-boss 10.1.5 → 10.2.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.5",
+  "version": "10.2.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.14.1",
     "serialize-error": "^8.1.0"
   },
   "devDependencies": {
-    "@types/node": "^20.16.9",
-    "luxon": "^3.5.0",
-    "mocha": "^10.7.3",
+    "@types/node": "^20.17.30",
+    "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/plans.js

@@ -140,7 +140,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 +208,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 +263,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 +292,7 @@ function deleteQueueFunction (schema) {
     $$
     DECLARE
       table_name varchar;
-    BEGIN  
+    BEGIN
       WITH deleted as (
         DELETE FROM ${schema}.queue
         WHERE name = queue_name
@@ -400,7 +400,7 @@ function updateQueue (schema) {
 
 function getQueues (schema) {
   return `
-    SELECT 
+    SELECT
       name,
       policy,
       retry_limit as "retryLimit",
@@ -503,13 +503,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 +520,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 +615,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 +726,7 @@ 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
@@ -813,7 +813,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 +863,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 +886,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/src/timekeeper.js

@@ -144,7 +144,7 @@ class Timekeeper extends EventEmitter {
     const scheduled = schedules
       .filter(i => this.shouldSendIt(i.cron, i.timezone))
       .map(({ name, data, options }) =>
-        ({ name: QUEUES.SEND_IT, data: { name, data, options }, singletonKey: name, singletonSeconds: 60 }))
+        ({ name: QUEUES.SEND_IT, data: { name, data, ...options }, singletonKey: name, singletonSeconds: 60 }))
 
     if (scheduled.length > 0 && !this.stopped) {
       await this.manager.insert(scheduled)