@adonis-agora/durable 0.20.0 → 0.21.0

package/dist/stubs/database/migrations/create_durable_tables.stub

@@ -2,102 +2,46 @@
   exports({ to: app.migrationsPath(`${new Date().getTime()}_create_durable_tables.ts`) })
 }}}
 import { BaseSchema } from '@adonisjs/lucid/schema'
+import db from '@adonisjs/lucid/services/db'
+import { createDurableTables, dropDurableTables } from '@adonis-agora/durable'
 
 /**
- * Durable workflow tables for the @adonis-agora/durable `lucid` state store: runs, step checkpoints, the
- * search-attribute side-table, signal waiters, buffered signals and buffered events. JSON payloads are stored as TEXT (the store
- * (de)serializes them) and timestamps as epoch-ms integers, so the schema is portable across
- * SQLite / Postgres / MySQL.
+ * Durable workflow tables for the @adonis-agora/durable `lucid` state store: runs, step checkpoints,
+ * the search-attribute side-table, signal waiters, buffered signals and buffered events.
+ *
+ * This migration DELEGATES to the library instead of reproducing its DDL. The schema belongs to the
+ * library — `LucidStateStore` decides what columns it reads and writes — so a hand-copied snapshot
+ * here can only ever be right until the next release. It was wrong before: the stub shipped without
+ * `last_heartbeat_at` / `heartbeat_progress`, which the store writes on every step beat, and nothing
+ * failed only because the provider's boot-time `ensureSchema()` silently `ALTER`ed them in. Calling
+ * `createDurableTables` makes that drift impossible rather than merely tested for.
+ *
+ * `createDurableTables` is idempotent (`hasTable` / `hasColumn` guarded) and additive-only, so it is
+ * safe to run against a database that already has some or all of the tables.
+ *
+ * `db` (the `Database` manager from `@adonisjs/lucid/services/db`) rather than `this.db`:
+ * `createDurableTables` needs `db.connection(name).schema`, and the `this.db` a migration gets is a
+ * `QueryClientContract` — one already-resolved client, with no `.connection()`. `this.db` still
+ * supplies the connection NAME, so `node ace migration:run --connection=x` provisions the tables on
+ * connection `x` and not on the default.
  */
 export default class extends BaseSchema {
-  async up() {
-    this.schema.createTable('durable_workflow_runs', (table) => {
-      table.string('id').primary()
-      table.string('workflow').notNullable()
-      table.string('workflow_version').notNullable()
-      table.string('status').notNullable()
-      table.string('namespace').notNullable().defaultTo('default')
-      table.text('input')
-      table.text('output')
-      table.text('error')
-      table.bigInteger('wake_at')
-      table.string('locked_by')
-      table.bigInteger('locked_until')
-      table.integer('recovery_attempts')
-      table.text('tags')
-      table.text('search_attributes')
-      table.integer('priority')
-      table.bigInteger('created_at').notNullable()
-      table.bigInteger('updated_at').notNullable()
-      table.index(['status'], 'durable_runs_status_idx')
-      table.index(['status', 'wake_at'], 'durable_runs_due_idx')
-      table.index(['namespace', 'status', 'created_at'], 'durable_runs_namespace_idx')
-    })
-
-    this.schema.createTable('durable_step_checkpoints', (table) => {
-      table.string('run_id').notNullable()
-      table.integer('seq').notNullable()
-      table.string('name').notNullable()
-      table.string('kind').notNullable()
-      table.string('step_id').notNullable()
-      table.string('status').notNullable()
-      table.text('input')
-      table.text('output')
-      table.text('error')
-      table.text('events')
-      table.integer('attempts').notNullable()
-      table.string('worker_group')
-      table.bigInteger('wake_at')
-      table.string('parallel_group')
-      table.bigInteger('enqueued_at')
-      table.bigInteger('started_at').notNullable()
-      table.bigInteger('finished_at').notNullable()
-      table.primary(['run_id', 'seq'])
-      table.index(['run_id', 'name'], 'durable_checkpoints_name_idx')
-    })
-
-    this.schema.createTable('durable_run_attributes', (table) => {
-      table.string('run_id').notNullable()
-      table.string('key').notNullable()
-      table.string('str_value')
-      table.double('num_value')
-      table.primary(['run_id', 'key'])
-      table.index(['key', 'num_value'], 'durable_run_attributes_num_idx')
-      table.index(['key', 'str_value'], 'durable_run_attributes_str_idx')
-    })
+  /**
+   * REQUIRED, not a preference. The DDL below runs through the `Database` manager, which checks out
+   * its OWN connection from the pool — it is not part of the transaction the migrator would otherwise
+   * open for this migration. With `pool: { max: 1 }` (Adonis's own SQLite guidance) that transaction
+   * would hold the only connection while `createDurableTables` waited for a free one, and the
+   * migration would hang until the acquire timeout. Nothing is lost by opting out: the statements were
+   * never inside that transaction anyway, and re-running an interrupted `createDurableTables` is a
+   * no-op.
+   */
+  static disableTransactions = true
 
-    this.schema.createTable('durable_signal_waiters', (table) => {
-      table.string('token').primary()
-      table.string('run_id').notNullable()
-      table.integer('seq').notNullable()
-      table.string('parallel_group')
-    })
-
-    this.schema.createTable('durable_buffered_signals', (table) => {
-      table.increments('id').primary()
-      table.string('token').notNullable()
-      table.text('payload')
-      table.index(['token'], 'durable_buffered_signals_token_idx')
-    })
-
-    // Reliable (buffered) events: a publish matching no live waiter keeps ONE copy here, consumed by
-    // the first future matching `waitForEvent`. Keyed by `name` (many waiters share a name with
-    // different `match`); `id` is the caller-minted PK; `published_at` is epoch-ms.
-    this.schema.createTable('durable_buffered_events', (table) => {
-      table.string('id').primary()
-      table.string('name').notNullable()
-      table.text('payload')
-      table.bigInteger('published_at').notNullable()
-      table.index(['name', 'published_at'], 'durable_buffered_events_name_idx')
-    })
+  async up() {
+    await createDurableTables(db, this.db.connectionName)
   }
 
   async down() {
-    this.schema.dropTableIfExists('durable_buffered_events')
-    this.schema.dropTableIfExists('durable_buffered_signals')
-    this.schema.dropTableIfExists('durable_signal_waiters')
-    this.schema.dropTableIfExists('durable_run_attributes')
-    this.schema.dropTableIfExists('durable_step_checkpoints')
-    this.schema.dropTableIfExists('durable_workflow_runs')
+    await dropDurableTables(db, this.db.connectionName)
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonis-agora/durable",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Durable cross-app workflows for AdonisJS — deterministic replay engine, AdonisJS binding, ace commands, dashboard, OpenTelemetry, Telescope, testing harness and Redis admission, all in one package. Part of the Agora ecosystem.",
   "license": "MIT",
   "repository": {
@@ -158,6 +158,7 @@
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^1.30.0",
     "@opentelemetry/sdk-trace-base": "^1.30.0",
+    "@types/better-sqlite3": "^7.6.0",
     "@types/node": "^20.0.0",
     "better-sqlite3": "^11.0.0",
     "bullmq": "^5.0.0",
@@ -168,7 +169,7 @@
     "zod": "^3.25.0"
   },
   "engines": {
-    "node": ">=20.6.0"
+    "node": ">=20.6.0 <23"
   },
   "keywords": [
     "adonisjs",
@@ -184,10 +185,12 @@
     "agora"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.json && pnpm run copy:stubs",
+    "build": "pnpm run clean && tsc -p tsconfig.build.json && pnpm run copy:stubs && pnpm run check:dist",
+    "check:dist": "node ../../scripts/assert-build-output.mjs dist src/index.js",
+    "clean": "rm -rf dist",
     "copy:stubs": "mkdir -p dist/stubs/config dist/stubs/database/migrations dist/stubs/make/workflow dist/assets && cp stubs/config/durable.stub dist/stubs/config/durable.stub && cp stubs/config/durable_dashboard.stub dist/stubs/config/durable_dashboard.stub && cp -r stubs/database/migrations/. dist/stubs/database/migrations/ && cp stubs/make/workflow/main.stub dist/stubs/make/workflow/main.stub && cp assets/dashboard.html dist/assets/dashboard.html",
     "test": "vitest run --passWithNoTests",
     "test:watch": "vitest",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
+    "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.tests.json"
   }
 }