@alexify/migronaut 2.1.0 → 2.3.0

package/src/core/options.js

@@ -152,6 +152,20 @@ function assertConvergeAfterUpValid(converge, filename, to) {
   }
 }
 
+/**
+ * `onBackgroundPending`: what a run does at a migration that `requires` a
+ * background migration not completed yet — `'error'` (throw
+ * BackgroundPendingError) or `'stop'` (end the run there, cleanly).
+ */
+function assertBackgroundPendingValid(onBackgroundPending) {
+  if (onBackgroundPending === undefined) return;
+  if (onBackgroundPending !== 'error' && onBackgroundPending !== 'stop') {
+    throw new ConfigInvalidError("onBackgroundPending must be 'error' or 'stop'", {
+      onBackgroundPending,
+    });
+  }
+}
+
 /** `up(filename, options)` */
 function assertUpOptions(filename, options) {
   assertFilename(filename);
@@ -167,6 +181,7 @@ function assertUpOptions(filename, options) {
   assertOrderedValid(options.ordered, filename);
   assertConvergeAfterUpValid(options.converge, filename, options.to);
   assertChecksumValid(options.checksum, filename);
+  assertBackgroundPendingValid(options.onBackgroundPending);
   assertActorValid(options);
 }
 
@@ -198,11 +213,26 @@ function assertDryRunOptions(filename, options) {
 
 /** `converge(options)` */
 function assertConvergeOptions(options) {
-  for (const key of ['dryRun', 'prune', 'noLock', 'ordered', 'rebuildUnique']) {
+  for (const key of [
+    'dryRun',
+    'prune',
+    'noLock',
+    'ordered',
+    'rebuildUnique',
+    'waitForSearchIndexes',
+  ]) {
     if (options[key] !== undefined && typeof options[key] !== 'boolean') {
       throw new ConfigInvalidError(`${key} must be a boolean`, { [key]: options[key] });
     }
   }
+  // A dry run builds nothing, so there is nothing to wait for — asking for
+  // both is a mistake worth saying, not a wait that silently never happens.
+  if (options.dryRun && options.waitForSearchIndexes) {
+    throw new ConfigInvalidError('waitForSearchIndexes cannot be combined with dryRun', {
+      dryRun: true,
+      waitForSearchIndexes: true,
+    });
+  }
   assertActorValid(options);
 }
 
@@ -239,6 +269,7 @@ function assertImportOptions(options) {
 }
 
 module.exports = {
+  assertActorValid,
   assertConvergeOptions,
   assertDownOptions,
   assertDryRunOptions,

package/src/core/run.js

@@ -41,6 +41,7 @@ const { MigratorKit, RECORD_LOCK_WAIT } = require('./migrator.js');
 async function runMigrations(config = {}, options = {}) {
   const {
     noLock,
+    onBackgroundPending,
     onLockHeld = 'throw',
     // Left undefined unless given: the default then follows the holder's TTL.
     lockWaitTimeoutMs,
@@ -71,6 +72,11 @@ async function runMigrations(config = {}, options = {}) {
   kit.on('converge:end', (event) => {
     if (event.trigger === 'up' && event.success) converge = event.result;
   });
+  // With onBackgroundPending: 'stop', where the run stopped and what for.
+  const waiting = [];
+  kit.on('background:waiting', (event) => {
+    waiting.push({ migration: event.migration, waitsFor: event.waitsFor });
+  });
 
   // An abort reaches the run wherever it is: the wait loop sees the signal
   // between polls, and kit.stop() stops a run that is setting up or between
@@ -90,20 +96,28 @@ async function runMigrations(config = {}, options = {}) {
       waited,
       waitedMs,
       attempts,
-    } = await withLockWait(() => kit.up(undefined, noLock ? { noLock: true } : {}), {
-      onLockHeld,
-      ...(lockWaitTimeoutMs !== undefined ? { lockWaitTimeoutMs } : {}),
-      ...(lockPollIntervalMs !== undefined ? { lockPollIntervalMs } : {}),
-      // Resolved AFTER connect, from the kit's own merged config: a `logger:
-      // null` in the config file must silence the wait lines too, not only
-      // the kit's own.
-      logger: kit.logger,
-      ...(signal ? { signal } : {}),
-      onSettle: (wait) => kit[RECORD_LOCK_WAIT](wait),
-    });
+    } = await withLockWait(
+      () =>
+        kit.up(undefined, {
+          ...(noLock ? { noLock: true } : {}),
+          ...(onBackgroundPending !== undefined ? { onBackgroundPending } : {}),
+        }),
+      {
+        onLockHeld,
+        ...(lockWaitTimeoutMs !== undefined ? { lockWaitTimeoutMs } : {}),
+        ...(lockPollIntervalMs !== undefined ? { lockPollIntervalMs } : {}),
+        // Resolved AFTER connect, from the kit's own merged config: a `logger:
+        // null` in the config file must silence the wait lines too, not only
+        // the kit's own.
+        logger: kit.logger,
+        ...(signal ? { signal } : {}),
+        onSettle: (wait) => kit[RECORD_LOCK_WAIT](wait),
+      },
+    );
     return {
       applied,
-      upToDate: applied.length === 0,
+      upToDate: applied.length === 0 && waiting.length === 0,
+      ...(waiting.length > 0 ? { waiting } : {}),
       waited,
       waitedMs,
       attempts,

package/src/core/runner.js

@@ -197,4 +197,4 @@ async function runMigration(params) {
   }
 }
 
-module.exports = { runMigration };
+module.exports = { isTransactionsUnsupported, runMigration };