Retry limit default for vanilla SQL (#482)

* add node namespace to core modules * migration for vanilla sql retry_limit default * versioning
timgit · Aug 27, 2024 · 877387e · 877387e
1 parent ac94885
commit 877387e
Show file tree

Hide file tree

Showing 43 changed files with 101 additions and 75 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pg-boss",
-  "version": "10.0.5",
+  "version": "10.0.6",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "main": "./src/index.js",
   "engines": {

diff --git a/src/attorney.js b/src/attorney.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const { DEFAULT_SCHEMA } = require('./plans')
 
 const POLICY = {

diff --git a/src/boss.js b/src/boss.js
@@ -1,4 +1,4 @@
-const EventEmitter = require('events')
+const EventEmitter = require('node:events')
 const plans = require('./plans')
 const { delay } = require('./tools')
 

diff --git a/src/contractor.js b/src/contractor.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const plans = require('./plans')
 const { DEFAULT_SCHEMA } = plans
 const migrationStore = require('./migrationStore')
@@ -46,8 +46,7 @@ class Contractor {
       const version = await this.schemaVersion()
 
       if (schemaVersion > version) {
-        throw new Error('Migrations are not supported to v10')
-        // await this.migrate(version)
+        await this.migrate(version)
       }
     } else {
       await this.create()
@@ -86,15 +85,15 @@ class Contractor {
     }
   }
 
-  // async next (version) {
-  //   const commands = migrationStore.next(this.config.schema, version, this.migrations)
-  //   await this.db.executeSql(commands)
-  // }
+  async next (version) {
+    const commands = migrationStore.next(this.config.schema, version, this.migrations)
+    await this.db.executeSql(commands)
+  }
 
-  // async rollback (version) {
-  //   const commands = migrationStore.rollback(this.config.schema, version, this.migrations)
-  //   await this.db.executeSql(commands)
-  // }
+  async rollback (version) {
+    const commands = migrationStore.rollback(this.config.schema, version, this.migrations)
+    await this.db.executeSql(commands)
+  }
 }
 
 module.exports = Contractor
diff --git a/src/db.js b/src/db.js
@@ -1,4 +1,4 @@
-const EventEmitter = require('events')
+const EventEmitter = require('node:events')
 const pg = require('pg')
 
 class Db extends EventEmitter {

diff --git a/src/index.js b/src/index.js
@@ -1,4 +1,4 @@
-const EventEmitter = require('events')
+const EventEmitter = require('node:events')
 const plans = require('./plans')
 const Attorney = require('./attorney')
 const Contractor = require('./contractor')

diff --git a/src/manager.js b/src/manager.js
@@ -1,6 +1,6 @@
-const assert = require('assert')
-const EventEmitter = require('events')
-const { randomUUID } = require('crypto')
+const assert = require('node:assert')
+const EventEmitter = require('node:events')
+const { randomUUID } = require('node:crypto')
 const { serializeError: stringify } = require('serialize-error')
 const { delay } = require('./tools')
 const Attorney = require('./attorney')

diff --git a/src/migrationStore.js b/src/migrationStore.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const plans = require('./plans')
 
 module.exports = {
@@ -64,5 +64,16 @@ function migrate (value, version, migrations) {
 
 function getAll (schema) {
   return [
+    {
+      release: '10.0.6',
+      version: 22,
+      previous: 21,
+      install: [
+        `ALTER TABLE ${schema}.job ALTER COLUMN retry_limit SET DEFAULT 2`
+      ],
+      uninstall: [
+        `ALTER TABLE ${schema}.job ALTER COLUMN retry_limit SET DEFAULT 0`
+      ]
+    }
   ]
 }
diff --git a/src/plans.js b/src/plans.js
@@ -65,7 +65,7 @@ module.exports = {
   DEFAULT_SCHEMA
 }
 
-const assert = require('assert')
+const assert = require('node:assert')
 
 function create (schema, version) {
   const commands = [
@@ -179,7 +179,7 @@ function createTableJob (schema) {
       priority integer not null default(0),
       data jsonb,
       state ${schema}.job_state not null default('${JOB_STATES.created}'),
-      retry_limit integer not null default(0),
+      retry_limit integer not null default(2),
       retry_count integer not null default(0),
       retry_delay integer not null default(0),
       retry_backoff boolean not null default false,

diff --git a/src/timekeeper.js b/src/timekeeper.js
@@ -1,4 +1,4 @@
-const EventEmitter = require('events')
+const EventEmitter = require('node:events')
 const plans = require('./plans')
 const cronParser = require('cron-parser')
 const Attorney = require('./attorney')

diff --git a/src/tools.js b/src/tools.js
@@ -3,7 +3,7 @@ module.exports = {
 }
 
 function delay (ms, error) {
-  const { setTimeout } = require('timers/promises')
+  const { setTimeout } = require('node:timers/promises')
   const ac = new AbortController()
 
   const promise = new Promise((resolve, reject) => {

diff --git a/test/archiveTest.js b/test/archiveTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 const { delay } = require('../src/tools')
 const { JOB_STATES } = require('../src/plans')

diff --git a/test/backgroundErrorTest.js b/test/backgroundErrorTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const PgBoss = require('../')
 const { delay } = require('../src/tools')
 

diff --git a/test/cancelTest.js b/test/cancelTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 
 describe('cancel', function () {

diff --git a/test/completeTest.js b/test/completeTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 const PgBoss = require('../')
 

diff --git a/test/configTest.js b/test/configTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const PgBoss = require('../')
 const helper = require('./testHelper')
 

diff --git a/test/databaseTest.js b/test/databaseTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const PgBoss = require('../')
 
 describe('database', function () {

diff --git a/test/delayTest.js b/test/delayTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 const { delay } = require('../src/tools')
 

diff --git a/test/deleteTest.js b/test/deleteTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 
 describe('delete', async function () {

diff --git a/test/expireTest.js b/test/expireTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 const { delay } = require('../src/tools')
 

diff --git a/test/exportTest.js b/test/exportTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const PgBoss = require('../')
 const currentSchemaVersion = require('../version.json').schema
 

diff --git a/test/failureTest.js b/test/failureTest.js
@@ -1,5 +1,5 @@
 const { delay } = require('../src/tools')
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 
 describe('failure', function () {

diff --git a/test/fetchTest.js b/test/fetchTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 
 describe('fetch', function () {

diff --git a/test/insertTest.js b/test/insertTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const { randomUUID } = require('crypto')
 const helper = require('./testHelper')
 

diff --git a/test/maintenanceTest.js b/test/maintenanceTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 const { delay } = require('../src/tools')
 

diff --git a/test/managerTest.js b/test/managerTest.js
@@ -1,5 +1,5 @@
 const { delay } = require('../src/tools')
-const assert = require('assert')
+const assert = require('node:assert')
 const helper = require('./testHelper')
 
 describe('manager', function () {

diff --git a/test/migrationTest.js b/test/migrationTest.js
@@ -1,4 +1,4 @@
-const assert = require('assert')
+const assert = require('node:assert')
 const PgBoss = require('../')
 const helper = require('./testHelper')
 const Contractor = require('../src/contractor')
@@ -32,23 +32,39 @@ describe('migration', function () {
     }
   })
 
-  it.skip('should migrate to previous version and back again', async function () {
+  it('should migrate to previous version and back again', async function () {
     const { contractor } = this.test
 
     await contractor.create()
 
     await contractor.rollback(currentSchemaVersion)
-    const oldVersion = await contractor.version()
+    const oldVersion = await contractor.schemaVersion()
 
     assert.notStrictEqual(oldVersion, currentSchemaVersion)
 
     await contractor.migrate(oldVersion)
-    const newVersion = await contractor.version()
+    const newVersion = await contractor.schemaVersion()
 
     assert.strictEqual(newVersion, currentSchemaVersion)
   })
 
-  it.skip('should migrate to latest during start if on previous schema version', async function () {
+  it('should install next version via contractor', async function () {
+    const { contractor } = this.test
+
+    await contractor.create()
+
+    await contractor.rollback(currentSchemaVersion)
+
+    const oneVersionAgo = await contractor.schemaVersion()
+
+    await contractor.next(oneVersionAgo)
+
+    const version = await contractor.schemaVersion()
+
+    assert.strictEqual(version, currentSchemaVersion)
+  })
+
+  it('should migrate to latest during start if on previous schema version', async function () {
     const { contractor } = this.test
 
     await contractor.create()
@@ -61,7 +77,7 @@ describe('migration', function () {
 
     await boss.start()
 
-    const version = await contractor.version()
+    const version = await contractor.schemaVersion()
 
     assert.strictEqual(version, currentSchemaVersion)
   })
@@ -88,22 +104,22 @@ describe('migration', function () {
     await boss.send(queue)
 
     await contractor.rollback(currentSchemaVersion)
-    const oneVersionAgo = await contractor.version()
+    const oneVersionAgo = await contractor.schemaVersion()
 
     assert.notStrictEqual(oneVersionAgo, currentSchemaVersion)
 
     await contractor.rollback(oneVersionAgo)
-    const twoVersionsAgo = await contractor.version()
+    const twoVersionsAgo = await contractor.schemaVersion()
 
     assert.notStrictEqual(twoVersionsAgo, oneVersionAgo)
 
     await contractor.next(twoVersionsAgo)
-    const oneVersionAgoPart2 = await contractor.version()
+    const oneVersionAgoPart2 = await contractor.schemaVersion()
 
     assert.strictEqual(oneVersionAgo, oneVersionAgoPart2)
 
     await contractor.next(oneVersionAgo)
-    const version = await contractor.version()
+    const version = await contractor.schemaVersion()
 
     assert.strictEqual(version, currentSchemaVersion)
 
@@ -118,18 +134,18 @@ describe('migration', function () {
     await contractor.create()
 
     await contractor.rollback(currentSchemaVersion)
-    const oneVersionAgo = await contractor.version()
+    const oneVersionAgo = await contractor.schemaVersion()
     assert.strictEqual(oneVersionAgo, currentSchemaVersion - 1)
 
     await contractor.rollback(oneVersionAgo)
-    const twoVersionsAgo = await contractor.version()
+    const twoVersionsAgo = await contractor.schemaVersion()
     assert.strictEqual(twoVersionsAgo, currentSchemaVersion - 2)
 
     const config = { ...this.test.bossConfig }
     const boss = this.test.boss = new PgBoss(config)
     await boss.start()
 
-    const version = await contractor.version()
+    const version = await contractor.schemaVersion()
 
     assert.strictEqual(version, currentSchemaVersion)
   })
@@ -146,7 +162,7 @@ describe('migration', function () {
     }
   })
 
-  it.skip('should roll back an error during a migration', async function () {
+  it('should roll back an error during a migration', async function () {
     const { contractor } = this.test
 
     const config = { ...this.test.bossConfig }
@@ -158,7 +174,7 @@ describe('migration', function () {
 
     await contractor.create()
     await contractor.rollback(currentSchemaVersion)
-    const oneVersionAgo = await contractor.version()
+    const oneVersionAgo = await contractor.schemaVersion()
 
     const boss1 = new PgBoss(config)
 
@@ -170,7 +186,7 @@ describe('migration', function () {
       await boss1.stop({ graceful: false, wait: false })
     }
 
-    const version1 = await contractor.version()
+    const version1 = await contractor.schemaVersion()
 
     assert.strictEqual(version1, oneVersionAgo)
 
@@ -181,7 +197,7 @@ describe('migration', function () {
 
     await boss2.start()
 
-    const version2 = await contractor.version()
+    const version2 = await contractor.schemaVersion()
 
     assert.strictEqual(version2, currentSchemaVersion)
 
@@ -199,7 +215,7 @@ describe('migration', function () {
     }
   })
 
-  it.skip('should not migrate if migrate option is false', async function () {
+  it('should not migrate if migrate option is false', async function () {
     const { contractor } = this.test
 
     await contractor.create()