rake-db 2.10.73 → 2.11.0

package/dist/index.d.ts

@@ -89,8 +89,9 @@ type ConstraintArg = {
  * @param tx - database adapter that executes inside a transaction
  * @param up - migrate or rollback
  * @param config - config of `rakeDb`
+ * @param asts - array of migration ASTs to collect changes into
  */
-declare const createMigrationInterface: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(tx: TransactionAdapter, up: boolean, config: RakeDbConfig<CT>) => DbMigration<CT>;
+declare const createMigrationInterface: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(tx: TransactionAdapter, up: boolean, config: RakeDbConfig<CT>, asts: RakeDbAst[]) => DbMigration<CT>;
 declare class Migration<CT extends ColumnTypesBase> {
     adapter: TransactionAdapter;
     log?: QueryLogObject;
@@ -1002,6 +1003,16 @@ type AppCodeUpdater = {
     }): Promise<void>;
     afterAll(params: AppCodeUpdaterParams): Promise<void>;
 };
+type MigrationItem = {
+    path: string;
+    version: string;
+    /**
+     * Function that loads the migration content,
+     * can store lazy import of a migration file.
+     * Promise can return `{ default: x }` where `x` is a return of `change` or an array of such returns.
+     */
+    load(): Promise<unknown>;
+};
 
 declare const createDb: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>) => Promise<void>;
 declare const dropDb: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(arg: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>) => Promise<void>;
@@ -1013,8 +1024,8 @@ declare const makeFileTimeStamp: () => string;
 
 type ChangeCallback<CT extends ColumnTypesBase = ColumnTypesBase> = (db: DbMigration<CT>, up: boolean) => Promise<void>;
 
-declare const migrateOrRollback: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args: string[], up: boolean) => Promise<void>;
-declare const changeCache: Record<string, ChangeCallback[] | undefined>;
+declare const RAKE_DB_LOCK_KEY = "8582141715823621641";
+type MigrateFn = <CT extends ColumnTypesBase>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args?: string[]) => Promise<void>;
 /**
  * Will run all pending yet migrations, sequentially in order,
  * will apply `change` functions top-to-bottom.
@@ -1023,20 +1034,22 @@ declare const changeCache: Record<string, ChangeCallback[] | undefined>;
  * @param config - specifies how to load migrations, may have `appCodeUpdater`, callbacks, and logger.
  * @param args - pass none or `all` to run all migrations, pass int for how many to migrate, `--code` to enable and `--code false` to disable `useCodeUpdater`.
  */
-declare const migrate: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args?: string[]) => Promise<void>;
+declare const migrate: MigrateFn;
 /**
  * Will roll back one latest applied migration,
  * will apply `change` functions bottom-to-top.
  *
  * Takes the same options as {@link migrate}.
  */
-declare const rollback: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args?: string[]) => Promise<void>;
+declare const rollback: MigrateFn;
 /**
  * Calls {@link rollback} and then {@link migrate}.
  *
  * Takes the same options as {@link migrate}.
  */
-declare const redo: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args?: string[]) => Promise<void>;
+declare const redo: MigrateFn;
+declare const migrateOrRollback: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(trx: TransactionAdapter, config: RakeDbConfig<CT>, files: MigrationItem[], count: number, asts: RakeDbAst[], up: boolean) => Promise<void>;
+declare const changeCache: Record<string, ChangeCallback[] | undefined>;
 
 /**
  * Type of {@link rakeDb} function
@@ -1078,6 +1091,6 @@ declare const rakeDb: RakeDbFn;
 
 declare const saveMigratedVersion: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: SilentQueries, version: string, config: RakeDbConfig<CT>) => Promise<void>;
 declare const removeMigratedVersion: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: SilentQueries, version: string, config: RakeDbConfig<CT>) => Promise<void>;
-declare const getMigratedVersionsMap: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: Adapter, config: RakeDbConfig<CT>) => Promise<Record<string, boolean>>;
+declare const getMigratedVersionsMap: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: TransactionAdapter, config: RakeDbConfig<CT>) => Promise<Record<string, boolean>>;
 
-export { AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DbMigration, DropMode, Migration, MigrationColumnTypes, RakeDbAst, RakeDbConfig, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, dropDb, generate, getMigratedVersionsMap, makeFileTimeStamp, migrate, migrateOrRollback, rakeDb, redo, removeMigratedVersion, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
+export { AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DbMigration, DropMode, Migration, MigrationColumnTypes, RAKE_DB_LOCK_KEY, RakeDbAst, RakeDbConfig, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, dropDb, generate, getMigratedVersionsMap, makeFileTimeStamp, migrate, migrateOrRollback, rakeDb, redo, removeMigratedVersion, resetDb, rollback, saveMigratedVersion, writeMigrationFile };

package/dist/index.js

@@ -1396,7 +1396,7 @@ var __spreadValues$3 = (a, b) => {
   return a;
 };
 var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-const createMigrationInterface = (tx, up, config) => {
+const createMigrationInterface = (tx, up, config, asts) => {
   const adapter = new pqb.TransactionAdapter(tx, tx.client, tx.types);
   const { query, arrays } = adapter;
   const log = pqb.logParamToLogObject(config.logger || console, config.log);
@@ -1415,7 +1415,7 @@ const createMigrationInterface = (tx, up, config) => {
   for (const key of Object.getOwnPropertyNames(proto)) {
     db[key] = proto[key];
   }
-  db.migratedAsts = [];
+  db.migratedAsts = asts;
   return Object.assign(db, {
     adapter,
     log,
@@ -2200,8 +2200,7 @@ const removeMigratedVersion = async (db, version, config) => {
 const getMigratedVersionsMap = async (db, config) => {
   try {
     const result = await db.arrays(
-      `SELECT *
-       FROM ${quoteWithSchema({ name: config.migrationsTable })}`
+      `SELECT * FROM ${quoteWithSchema({ name: config.migrationsTable })}`
     );
     return Object.fromEntries(result.rows.map((row) => [row[0], true]));
   } catch (err) {
@@ -2229,128 +2228,156 @@ var __spreadValues$2 = (a, b) => {
     }
   return a;
 };
+const RAKE_DB_LOCK_KEY = "8582141715823621641";
+function makeMigrateFn(defaultCount, up, fn) {
+  return async (options, config, args = []) => {
+    const files = await getMigrations(config, up);
+    const count = getCount(args);
+    const conf = prepareConfig(config, args, count);
+    const asts = [];
+    const appCodeUpdaterCache = {};
+    const { appCodeUpdater } = conf;
+    const arrOptions = orchidCore.toArray(options);
+    let localAsts = asts;
+    for (const opts of arrOptions) {
+      const adapter = new pqb.Adapter(opts);
+      try {
+        await adapter.transaction(begin, async (trx) => {
+          await trx.query(
+            `SELECT pg_advisory_xact_lock('${RAKE_DB_LOCK_KEY}')`
+          );
+          await fn(
+            trx,
+            conf,
+            files,
+            count != null ? count : defaultCount,
+            localAsts
+          );
+        });
+      } finally {
+        await adapter.close();
+      }
+      localAsts = [];
+    }
+    await runCodeUpdaterAfterAll(
+      arrOptions[0],
+      config,
+      appCodeUpdater,
+      asts,
+      appCodeUpdaterCache
+    );
+  };
+}
+const migrate = makeMigrateFn(
+  Infinity,
+  true,
+  (trx, configs, files, count, asts) => migrateOrRollback(trx, configs, files, count, asts, true)
+);
+const rollback = makeMigrateFn(
+  1,
+  false,
+  (trx, config, files, count, asts) => migrateOrRollback(trx, config, files, count, asts, false)
+);
+const redo = makeMigrateFn(
+  1,
+  false,
+  async (trx, config, files, count, asts) => {
+    await migrateOrRollback(trx, config, files, count, asts, false);
+    files.reverse();
+    await migrateOrRollback(trx, config, files, count, asts, true);
+    files.reverse();
+  }
+);
 const getDb = (adapter) => pqb.createDb({ adapter });
-const migrateOrRollback = async (options, config, args, up) => {
-  var _a, _b, _c, _d, _e, _f;
-  config = __spreadValues$2({}, config);
-  const files = await getMigrations(config, up);
-  let count = up ? Infinity : 1;
-  let argI = 0;
+const getCount = (args) => {
   const num = args[0] === "all" ? Infinity : parseInt(args[0]);
-  if (!isNaN(num)) {
-    argI++;
-    count = num;
-  }
-  const arg = args[argI];
+  return isNaN(num) ? void 0 : num;
+};
+function prepareConfig(config, args, count) {
+  config = __spreadValues$2({}, config);
+  const i = count === void 0 ? 0 : 1;
+  const arg = args[i];
   if (arg === "--code") {
-    config.useCodeUpdater = args[argI + 1] !== "false";
+    config.useCodeUpdater = args[i + 1] !== "false";
   }
   if (!config.useCodeUpdater)
     delete config.appCodeUpdater;
-  const appCodeUpdaterCache = {};
-  for (const opts of orchidCore.toArray(options)) {
-    const adapter = new pqb.Adapter(opts);
-    let db;
-    if (up) {
-      await ((_a = config.beforeMigrate) == null ? void 0 : _a.call(config, db != null ? db : db = getDb(adapter)));
-    } else {
-      await ((_b = config.beforeRollback) == null ? void 0 : _b.call(config, db != null ? db : db = getDb(adapter)));
-    }
-    const migratedVersions = await getMigratedVersionsMap(adapter, config);
-    try {
-      for (const file of files) {
-        if (up && migratedVersions[file.version] || !up && !migratedVersions[file.version]) {
-          continue;
-        }
-        if (count-- <= 0)
-          break;
-        await processMigration(
-          adapter,
-          up,
-          file,
-          config,
-          opts,
-          appCodeUpdaterCache
-        );
-        (_c = config.logger) == null ? void 0 : _c.log(
-          `${up ? "Migrated" : "Rolled back"} ${orchidCore.pathToLog(file.path)}`
-        );
-      }
-      if (up) {
-        await ((_d = config.afterMigrate) == null ? void 0 : _d.call(config, db != null ? db : db = getDb(adapter)));
-      } else {
-        await ((_e = config.afterRollback) == null ? void 0 : _e.call(config, db != null ? db : db = getDb(adapter)));
-      }
-    } finally {
-      await ((_f = config.appCodeUpdater) == null ? void 0 : _f.afterAll({
-        options: opts,
-        basePath: config.basePath,
-        cache: appCodeUpdaterCache,
-        logger: config.logger,
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        baseTable: config.baseTable,
-        import: config.import
-      }));
-      await adapter.close();
+  return config;
+}
+const migrateOrRollback = async (trx, config, files, count, asts, up) => {
+  var _a, _b, _c;
+  let db;
+  await ((_a = config[up ? "beforeMigrate" : "beforeRollback"]) == null ? void 0 : _a.call(config, db != null ? db : db = getDb(trx)));
+  const migratedVersions = await getMigratedVersionsMap(trx, config);
+  for (const file of files) {
+    if (up && migratedVersions[file.version] || !up && !migratedVersions[file.version]) {
+      continue;
     }
-    delete config.appCodeUpdater;
+    if (count-- <= 0)
+      break;
+    await runMigration(trx, up, file, config, asts);
+    (_b = config.logger) == null ? void 0 : _b.log(
+      `${up ? "Migrated" : "Rolled back"} ${orchidCore.pathToLog(file.path)}`
+    );
   }
+  await ((_c = config[up ? "afterMigrate" : "afterRollback"]) == null ? void 0 : _c.call(config, db != null ? db : db = getDb(trx)));
 };
-const changeCache = {};
-const begin = {
-  text: "BEGIN",
-  values: orchidCore.emptyArray
-};
-const processMigration = async (db, up, file, config, options, appCodeUpdaterCache) => {
-  var _a;
-  const asts = await db.transaction(begin, async (tx) => {
-    clearChanges();
-    let changes = changeCache[file.path];
-    if (!changes) {
-      const module = await file.load();
-      const exported = (module == null ? void 0 : module.default) && orchidCore.toArray(module.default);
-      if (config.forceDefaultExports && !exported) {
-        throw new RakeDbError(
-          `Missing a default export in ${file.path} migration`
-        );
-      }
-      changes = exported || getCurrentChanges();
-      changeCache[file.path] = changes;
-    }
-    const db2 = createMigrationInterface(tx, up, config);
-    if (changes.length) {
-      const from = up ? 0 : changes.length - 1;
-      const to = up ? changes.length : -1;
-      const step = up ? 1 : -1;
-      for (let i = from; i !== to; i += step) {
-        await changes[i](db2, up);
-      }
-    }
-    await (up ? saveMigratedVersion : removeMigratedVersion)(
-      db2.adapter,
-      file.version,
-      config
-    );
-    return db2.migratedAsts;
-  });
+async function runCodeUpdaterAfterAll(options, config, appCodeUpdater, asts, cache) {
   for (const ast of asts) {
-    await ((_a = config.appCodeUpdater) == null ? void 0 : _a.process({
+    await (appCodeUpdater == null ? void 0 : appCodeUpdater.process({
       ast,
       options,
       basePath: config.basePath,
-      cache: appCodeUpdaterCache,
+      cache,
       logger: config.logger,
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       baseTable: config.baseTable,
       import: config.import
     }));
   }
+  await (appCodeUpdater == null ? void 0 : appCodeUpdater.afterAll({
+    options,
+    basePath: config.basePath,
+    cache,
+    logger: config.logger,
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    baseTable: config.baseTable,
+    import: config.import
+  }));
+}
+const changeCache = {};
+const begin = {
+  text: "BEGIN",
+  values: orchidCore.emptyArray
 };
-const migrate = (options, config, args = []) => migrateOrRollback(options, config, args, true);
-const rollback = (options, config, args = []) => migrateOrRollback(options, config, args, false);
-const redo = async (options, config, args = []) => {
-  await migrateOrRollback(options, config, args, false);
-  await migrateOrRollback(options, config, args, true);
+const runMigration = async (trx, up, file, config, asts) => {
+  clearChanges();
+  let changes = changeCache[file.path];
+  if (!changes) {
+    const module = await file.load();
+    const exported = (module == null ? void 0 : module.default) && orchidCore.toArray(module.default);
+    if (config.forceDefaultExports && !exported) {
+      throw new RakeDbError(
+        `Missing a default export in ${file.path} migration`
+      );
+    }
+    changes = exported || getCurrentChanges();
+    changeCache[file.path] = changes;
+  }
+  const db = createMigrationInterface(trx, up, config, asts);
+  if (changes.length) {
+    const from = up ? 0 : changes.length - 1;
+    const to = up ? changes.length : -1;
+    const step = up ? 1 : -1;
+    for (let i = from; i !== to; i += step) {
+      await changes[i](db, up);
+    }
+  }
+  await (up ? saveMigratedVersion : removeMigratedVersion)(
+    db.adapter,
+    file.version,
+    config
+  );
 };
 
 const execute = async (options, sql) => {
@@ -3860,6 +3887,7 @@ Migrate and rollback common arguments:
 `;
 
 exports.Migration = Migration;
+exports.RAKE_DB_LOCK_KEY = RAKE_DB_LOCK_KEY;
 exports.changeCache = changeCache;
 exports.createDb = createDb;
 exports.createMigrationInterface = createMigrationInterface;