pipework 0.293.0 → 0.294.0

package/src/data/migrate/run.ts

@@ -1,3 +1,4 @@
+import postgres from 'postgres'
 import { sql } from '../query/index.js'
 import type { Manifold } from '../../core/pipework.js'
 import type { ResolvedDatabase } from '../../core/config/index.js'
@@ -6,6 +7,7 @@ import { OWNER_LABEL_MIGRATE } from '../db/owner-labels.js'
 import { checkMigrations, type MigrationCheckResult } from './check.js'
 import { readAppliedState } from './applied.js'
 import { applyMigrations, type MigrationNotice } from './apply.js'
+import { repairInvalidIndexes, InvalidIndexRepairError, type InvalidIndex } from './invalid-indexes.js'
 import { provisionFrameworkTables, type FrameworkTablesResult } from './provision-framework.js'
 
 // Deliberately empty of hazard switches. Authorization for a hazardous
@@ -24,8 +26,16 @@ export interface MigrateResult {
   safetyCheck: MigrationCheckResult
   /** No-transaction files picked up half applied and finished. Issue #378. */
   resumed: ResumedMigration[]
-  /** INVALID indexes a cut CREATE INDEX CONCURRENTLY left, dropped before the resumed statement reran. Issue #1003. */
+  /** INVALID indexes a cut CREATE INDEX CONCURRENTLY left, dropped before the statement that builds them reran. Issues #1003, #1005. */
   droppedInvalidIndexes: DroppedInvalidIndex[]
+  /**
+   * Every INVALID index this run met, with its case, what was done or must be
+   * done, and the outcome: (a) an owned index rebuilt, (b) a leftover of an owned
+   * index dropped, (c) anything else, untouched. Issue #1005.
+   */
+  invalidIndexes: InvalidIndex[]
+  /** Set when the catalog read for INVALID indexes failed, so none were checked. Issue #1005. */
+  invalidIndexReadError: string | null
   /** Notices and warnings raised by migration statements, in arrival order. Issue #970. */
   notices: MigrateNotice[]
   /** Trace/audit tables, columns and day partitions this run provisioned. */
@@ -54,6 +64,8 @@ export interface MigrateNotice extends MigrationNotice {
   statements: number
 }
 
+export { InvalidIndexRepairError, type InvalidIndex }
+
 export class UnsafeMigrationError extends Error {
   override readonly name = 'UnsafeMigrationError'
   constructor(
@@ -76,7 +88,34 @@ export async function migrateAll(instance: Manifold, options: MigrateOptions = {
   return results
 }
 
+/** One key per database: advisory locks are scoped to the database they are taken in. */
+const MIGRATE_LOCK_KEY = `hashtextextended('pipework.migrate', 0)`
+
+/**
+ * The connection that holds the run lock. It must live as long as the run: the
+ * default `max_lifetime` would close it mid-run and release the lock, so both
+ * timeouts are off, as in src/test/setup.ts.
+ */
+export function openRunLock(url: string): ReturnType<typeof postgres> {
+  return postgres(url, { max: 1, idle_timeout: 0, max_lifetime: 0, onnotice: () => {} })
+}
+
+/**
+ * Runs one database's migrations and index repairs under a session advisory
+ * lock held for the whole run. A second run at once waits for it, then finds
+ * nothing to apply. The lock dies with its connection. Issue #1005.
+ */
 export async function migrateOne(instance: Manifold, dbConfig: ResolvedDatabase, options: MigrateOptions = {}): Promise<MigrateResult> {
+  const lock = openRunLock(dbConfig.url)
+  try {
+    await lock.unsafe(`SELECT pg_advisory_lock(${MIGRATE_LOCK_KEY})`)
+    return await migrateLocked(instance, dbConfig, options)
+  } finally {
+    await lock.end()
+  }
+}
+
+async function migrateLocked(instance: Manifold, dbConfig: ResolvedDatabase, options: MigrateOptions): Promise<MigrateResult> {
   const conn = instance.pool.getOrCreate(dbConfig, 'owner', OWNER_LABEL_MIGRATE)
 
   // Scope the safety gate to pending migrations only — hazards in already-applied
@@ -124,6 +163,15 @@ export async function migrateOne(instance: Manifold, dbConfig: ResolvedDatabase,
     },
   })
 
+  // After a run that finished without error only; a failing migration throws
+  // above and its rerun resumes and checks then. Throws when an owned index
+  // cannot be made valid.
+  const repaired = await repairInvalidIndexes({
+    migrationsFolder: dbConfig.migrations!,
+    migrationsTable: dbConfig.migrationTable,
+    connectionUrl: dbConfig.url,
+  })
+
   // Trace and audit storage rides the default database; their partitioned
   // tables are kept out of generated migrations (#313), so migrate provisions them.
   const frameworkTables = await provisionFrameworkTables(
@@ -146,6 +194,8 @@ export async function migrateOne(instance: Manifold, dbConfig: ResolvedDatabase,
     safetyCheck,
     resumed,
     droppedInvalidIndexes,
+    invalidIndexes: repaired.indexes,
+    invalidIndexReadError: repaired.readError,
     notices,
     frameworkTables,
   }