@proteinjs/db 1.29.2 → 1.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/db",
-  "version": "1.29.2",
+  "version": "1.30.0",
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
   "exports": {
@@ -41,7 +41,7 @@
     "test": "jest --passWithNoTests"
   },
   "dependencies": {
-    "@proteinjs/db-query": "^1.6.1",
+    "@proteinjs/db-query": "^1.6.3",
     "@proteinjs/logger": "^1.0.21",
     "@proteinjs/reflection": "^1.1.12",
     "@proteinjs/serializer": "^1.1.10",
@@ -66,5 +66,5 @@
     "ts-jest": "29.1.1",
     "typescript": "5.2.2"
   },
-  "gitHead": "bfe0871836b28eb4a3250090336b9417e73d4b69"
+  "gitHead": "fd3dd48fae93c6da8c0b3decd6dd30a506a9109a"
 }

package/src/MigrationRunner.ts

@@ -1,5 +1,5 @@
 import { Moment, moment } from './opt/moment';
-import { getDb } from './Db';
+import { Db, getDb, getDbAsSystem } from './Db';
 import { Table } from './Table';
 import { SourceRecordRepo } from './source/SourceRecordRepo';
 import { MigrationRunnerService, getMigrationRunnerService } from './services/MigrationRunnerService';
@@ -32,16 +32,41 @@ export class MigrationRunner implements MigrationRunnerService {
    */
   runMigration(id: string): Promise<void> {
     const migrationTable: Table<Migration> = new MigrationTable();
-    const migration = new SourceRecordRepo().getSourceRecord<Migration>(migrationTable.name, id);
-    if (!migration) {
-      throw new Error(`Unable to find migration source record for id: ${id}`);
+    const migration = this.resolveMigration(migrationTable, id);
+    return this.runAndRecord(migrationTable, migration, getDb);
+  }
+
+  /**
+   * Boot-path API: at server boot no user session exists, so `getDb()` (which `runMigration`
+   * records through) fail-closes on the migration table's doors. This method reads and records
+   * run state through `getDbAsSystem()` instead — it is the seam a future migrations-auto-run
+   * rides (deploy-coupled migrations call it during server startup).
+   *
+   * 'ensure' = idempotent: a row already in 'success' status is logged and skipped. A prior
+   * 'failure' row is retried by design — a fixed migration should run on the next boot.
+   */
+  async ensureMigrationRun(id: string): Promise<void> {
+    const migrationTable: Table<Migration> = new MigrationTable();
+    const db = getDbAsSystem();
+    const migrationRow = await db.get(migrationTable, { id });
+    if (migrationRow?.status === 'success') {
+      this.logger.info({ message: `Migration (${id}) already applied, skipping` });
+      return;
     }
 
-    return this.runAndRecord(migrationTable, migration);
+    const migration = this.resolveMigration(migrationTable, id);
+    await this.runAndRecord(migrationTable, migration, () => db);
   }
 
-  private async runAndRecord(migrationTable: Table<Migration>, migration: Migration): Promise<void> {
-    const db = getDb();
+  // The db is taken as a provider, resolved inside this async body: on the service path,
+  // constructing the Db is itself run infrastructure — its failure must REJECT the detached
+  // promise, not throw synchronously from runMigration (only a bogus id may reach the client).
+  private async runAndRecord(
+    migrationTable: Table<Migration>,
+    migration: Migration,
+    getRunDb: () => Db
+  ): Promise<void> {
+    const db = getRunDb();
     migration.status = 'running';
     migration.startTime = moment();
     await db.update(migrationTable, migration);
@@ -66,6 +91,15 @@ export class MigrationRunner implements MigrationRunnerService {
     });
   }
 
+  private resolveMigration(migrationTable: Table<Migration>, id: string): Migration {
+    const migration = new SourceRecordRepo().getSourceRecord<Migration>(migrationTable.name, id);
+    if (!migration) {
+      throw new Error(`Unable to find migration source record for id: ${id}`);
+    }
+
+    return migration;
+  }
+
   private duration(start: Moment, end: Moment): string {
     const duration = moment.duration(end.diff(start));
     const parts: string[] = [];