pg-boss 10.1.3 → 10.1.5

package/README.md

@@ -40,7 +40,7 @@ pg-boss relies on [SKIP LOCKED](https://www.2ndquadrant.com/en/blog/what-is-sele
 This will likely cater the most to teams already familiar with the simplicity of relational database semantics and operations (SQL, querying, and backups). It will be especially useful to those already relying on PostgreSQL that want to limit how many systems are required to monitor and support in their architecture.
 
 
-## Summary
+## Summary <!-- {docsify-ignore-all} -->
 * Exactly-once job delivery
 * Create jobs within your existing database transaction
 * Backpressure-compatible polling workers
@@ -67,7 +67,7 @@ yarn add pg-boss
 ```
 
 ## Documentation
-* [Docs](docs/readme.md)
+* [Docs](https://timgit.github.io/pg-boss/)
 
 ## Contributing
 To setup a development environment for this library:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.1.3",
+  "version": "10.1.5",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {
@@ -8,14 +8,14 @@
   },
   "dependencies": {
     "cron-parser": "^4.9.0",
-    "pg": "^8.12.0",
+    "pg": "^8.13.0",
     "serialize-error": "^8.1.0"
   },
   "devDependencies": {
-    "@types/node": "^20.16.5",
+    "@types/node": "^20.16.9",
     "luxon": "^3.5.0",
     "mocha": "^10.7.3",
-    "nyc": "^17.0.0",
+    "nyc": "^17.1.0",
     "standard": "^17.1.2"
   },
   "scripts": {
@@ -23,7 +23,8 @@
     "cover": "nyc npm test",
     "tsc": "tsc --noEmit types.d.ts",
     "readme": "node ./test/readme.js",
-    "migrate": "node -e 'console.log(require(\"./src\").getMigrationPlans())'"
+    "db:migrate": "node -e 'console.log(require(\"./src\").getMigrationPlans())'",
+    "db:construct": "node -e 'console.log(require(\"./src\").getConstructionPlans())'"
   },
   "mocha": {
     "timeout": 10000,

package/src/migrationStore.js

@@ -64,6 +64,72 @@ function migrate (value, version, migrations) {
 
 function getAll (schema) {
   return [
+    {
+      release: '10.1.5',
+      version: 24,
+      previous: 23,
+      install: [
+        `
+        CREATE OR REPLACE FUNCTION ${schema}.create_queue(queue_name text, options json)
+        RETURNS VOID AS
+        $$
+        DECLARE
+          table_name varchar := 'j' || encode(sha224(queue_name::bytea), 'hex');
+          queue_created_on timestamptz;
+        BEGIN
+
+          WITH q as (
+            INSERT INTO ${schema}.queue (
+              name,
+              policy,
+              retry_limit,
+              retry_delay,
+              retry_backoff,
+              expire_seconds,
+              retention_minutes,
+              dead_letter,
+              partition_name
+            )
+            VALUES (
+              queue_name,
+              options->>'policy',
+              (options->>'retryLimit')::int,
+              (options->>'retryDelay')::int,
+              (options->>'retryBackoff')::bool,
+              (options->>'expireInSeconds')::int,
+              (options->>'retentionMinutes')::int,
+              options->>'deadLetter',
+              table_name
+            )
+            ON CONFLICT DO NOTHING
+            RETURNING created_on
+          )
+          SELECT created_on into queue_created_on from q;
+
+          IF queue_created_on IS NULL THEN
+            RETURN;
+          END IF;
+
+          EXECUTE format('CREATE TABLE ${schema}.%I (LIKE ${schema}.job INCLUDING DEFAULTS)', table_name);
+          
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD PRIMARY KEY (name, id)', table_name);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT q_fkey FOREIGN KEY (name) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', table_name);
+          EXECUTE format('ALTER TABLE ${schema}.%1$I ADD CONSTRAINT dlq_fkey FOREIGN KEY (dead_letter) REFERENCES ${schema}.queue (name) ON DELETE RESTRICT DEFERRABLE INITIALLY DEFERRED', table_name);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i1 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''created'' AND policy = ''short''', table_name);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i2 ON ${schema}.%1$I (name, COALESCE(singleton_key, '''')) WHERE state = ''active'' AND policy = ''singleton''', table_name);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i3 ON ${schema}.%1$I (name, state, COALESCE(singleton_key, '''')) WHERE state <= ''active'' AND policy = ''stately''', table_name);
+          EXECUTE format('CREATE UNIQUE INDEX %1$s_i4 ON ${schema}.%1$I (name, singleton_on, COALESCE(singleton_key, '''')) WHERE state <> ''cancelled'' AND singleton_on IS NOT NULL', table_name);
+          EXECUTE format('CREATE INDEX %1$s_i5 ON ${schema}.%1$I (name, start_after) INCLUDE (priority, created_on, id) WHERE state < ''active''', table_name);
+
+          EXECUTE format('ALTER TABLE ${schema}.%I ADD CONSTRAINT cjc CHECK (name=%L)', table_name, queue_name);
+          EXECUTE format('ALTER TABLE ${schema}.job ATTACH PARTITION ${schema}.%I FOR VALUES IN (%L)', table_name, queue_name);
+        END;
+        $$
+        LANGUAGE plpgsql
+        `
+      ],
+      uninstall: []
+    },
     {
       release: '10.1.1',
       version: 23,

package/src/plans.js

@@ -332,7 +332,7 @@ function createPrimaryKeyArchive (schema) {
 }
 
 function createIndexJobPolicyShort (schema) {
-  return `CREATE UNIQUE INDEX job_i1 ON ${schema}.job (name, COALESCE(singleton_key, '')) WHERE state = '${JOB_STATES.created}' AND policy = '${QUEUE_POLICIES.short}';`
+  return `CREATE UNIQUE INDEX job_i1 ON ${schema}.job (name, COALESCE(singleton_key, '')) WHERE state = '${JOB_STATES.created}' AND policy = '${QUEUE_POLICIES.short}'`
 }
 
 function createIndexJobPolicySingleton (schema) {

package/version.json

@@ -1,3 +1,3 @@
 {
-  "schema": 23
+  "schema": 24
 }