pg-boss 10.0.1 → 10.0.3

package/README.md

@@ -15,6 +15,8 @@ async function readme() {
 
   const queue = 'readme-queue'
 
+  await boss.createQueue(queue)
+
   const id = await boss.send(queue, { arg1: 'read me' })
 
   console.log(`created job ${id} in queue ${queue}`)
@@ -34,6 +36,7 @@ This will likely cater the most to teams already familiar with the simplicity of
 
 ## Summary
 * Exactly-once job delivery
+* Create jobs within your existing database transaction
 * Backpressure-compatible polling workers
 * Cron scheduling
 * Queue storage policies to support a variety of rate limiting, debouncing, and concurrency use cases

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.0.1",
+  "version": "10.0.3",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {

package/src/attorney.js

@@ -1,7 +1,13 @@
 const assert = require('assert')
 const { DEFAULT_SCHEMA } = require('./plans')
 
+const POLICY = {
+  MAX_EXPIRATION_HOURS: 24,
+  MIN_POLLING_INTERVAL_MS: 500
+}
+
 module.exports = {
+  POLICY,
   getConfig,
   checkSendArgs,
   checkQueueArgs,
@@ -12,8 +18,6 @@ module.exports = {
   assertQueueName
 }
 
-const MAX_INTERVAL_HOURS = 24
-
 const WARNINGS = {
   CLOCK_SKEW: {
     message: 'Timekeeper detected clock skew between this instance and the database server. This will not affect scheduling operations, but this warning is shown any time the skew exceeds 60 seconds.',
@@ -262,7 +266,7 @@ function applyExpirationConfig (config, defaults = {}) {
             ? config.expireInSeconds
             : null
 
-  assert(!expireIn || expireIn / 60 / 60 < MAX_INTERVAL_HOURS, `configuration assert: expiration cannot exceed ${MAX_INTERVAL_HOURS} hours`)
+  assert(!expireIn || expireIn / 60 / 60 < POLICY.MAX_EXPIRATION_HOURS, `configuration assert: expiration cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`)
 
   config.expireIn = expireIn
   config.expireInDefault = defaults?.expireIn
@@ -279,8 +283,8 @@ function applyRetryConfig (config, defaults) {
 }
 
 function applyPollingInterval (config, defaults) {
-  assert(!('pollingIntervalSeconds' in config) || config.pollingIntervalSeconds >= 0.5,
-    'configuration assert: pollingIntervalSeconds must be at least every 500ms')
+  assert(!('pollingIntervalSeconds' in config) || config.pollingIntervalSeconds >= POLICY.MIN_POLLING_INTERVAL_MS / 1000,
+    `configuration assert: pollingIntervalSeconds must be at least every ${POLICY.MIN_POLLING_INTERVAL_MS}ms`)
 
   config.pollingInterval = ('pollingIntervalSeconds' in config)
     ? config.pollingIntervalSeconds * 1000
@@ -300,7 +304,8 @@ function applyMaintenanceConfig (config) {
         ? config.maintenanceIntervalSeconds
         : 120
 
-  assert(config.maintenanceIntervalSeconds / 60 / 60 < MAX_INTERVAL_HOURS, `configuration assert: maintenance interval cannot exceed ${MAX_INTERVAL_HOURS} hours`)
+  assert(config.maintenanceIntervalSeconds / 60 / 60 < POLICY.MAX_EXPIRATION_HOURS,
+    `configuration assert: maintenance interval cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`)
 }
 
 function applyDeleteConfig (config) {
@@ -344,7 +349,8 @@ function applyMonitoringConfig (config) {
           : null
 
   if (config.monitorStateIntervalSeconds) {
-    assert(config.monitorStateIntervalSeconds / 60 / 60 < MAX_INTERVAL_HOURS, `configuration assert: state monitoring interval cannot exceed ${MAX_INTERVAL_HOURS} hours`)
+    assert(config.monitorStateIntervalSeconds / 60 / 60 < POLICY.MAX_EXPIRATION_HOURS,
+      `configuration assert: state monitoring interval cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`)
   }
 
   const TEN_MINUTES_IN_SECONDS = 600

package/src/plans.js

@@ -499,7 +499,7 @@ function fetchNextJob (schema) {
       WHERE name = $1
         AND state < '${JOB_STATES.active}'
         AND start_after < now()
-      ORDER BY ${priority && 'priority desc, '} created_on, id
+      ORDER BY ${priority ? 'priority desc, ' : ''}created_on, id
       LIMIT $2
       FOR UPDATE SKIP LOCKED
     )

package/src/worker.js

@@ -74,7 +74,7 @@ class Worker {
 
       this.lastJobDuration = duration
 
-      if (!this.stopping && !this.beenNotified && (this.interval - duration > 500)) {
+      if (!this.stopping && !this.beenNotified && (this.interval - duration) > 100) {
         this.loopDelayPromise = delay(this.interval - duration)
         await this.loopDelayPromise
         this.loopDelayPromise = null

package/types.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'events'
 
 declare namespace PgBoss {
-  
+
   type JobStates = {
     created : 'created',
     retry: 'retry',
@@ -107,13 +107,13 @@ declare namespace PgBoss {
   interface ConnectionOptions {
     db?: Db;
   }
-  
+
   type InsertOptions = ConnectionOptions;
-  
+
   type SendOptions = JobOptions & ExpirationOptions & RetentionOptions & RetryOptions & ConnectionOptions;
-  
+
   type QueuePolicy = 'standard' | 'short' | 'singleton' | 'stately'
-  
+
   type Queue = RetryOptions & ExpirationOptions & RetentionOptions & { name: string, policy?: QueuePolicy, deadLetter?: string }
   type QueueResult = Queue & { createdOn: Date, updatedOn: Date }
   type ScheduleOptions = SendOptions & { tz?: string }
@@ -334,7 +334,7 @@ declare class PgBoss extends EventEmitter {
 
   deleteJob(name: string, id: string, options?: PgBoss.ConnectionOptions): Promise<void>;
   deleteJob(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
-  
+
   complete(name: string, id: string, options?: PgBoss.ConnectionOptions): Promise<void>;
   complete(name: string, id: string, data: object, options?: PgBoss.ConnectionOptions): Promise<void>;
   complete(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
@@ -343,8 +343,8 @@ declare class PgBoss extends EventEmitter {
   fail(name: string, id: string, data: object, options?: PgBoss.ConnectionOptions): Promise<void>;
   fail(name: string, ids: string[], options?: PgBoss.ConnectionOptions): Promise<void>;
 
-  getJobById(name: string, id: string, options?: PgBoss.ConnectionOptions & { includeArchive: bool }): Promise<PgBoss.JobWithMetadata | null>;
-  
+  getJobById<T>(name: string, id: string, options?: PgBoss.ConnectionOptions & { includeArchive: boolean }): Promise<PgBoss.JobWithMetadata<T> | null>;
+
   createQueue(name: string, options?: PgBoss.Queue): Promise<void>;
   updateQueue(name: string, options?: PgBoss.Queue): Promise<void>;
   deleteQueue(name: string): Promise<void>;