rake-db 2.15.2 → 2.15.4

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as pqb from 'pqb';
 import { ColumnsShape, Db as Db$1, ColumnType, EnumColumn, raw, Adapter, IndexColumnOptions, IndexOptions, ForeignKeyOptions, DbResult, TransactionAdapter, QueryLogObject, TextColumn, TableData, NoPrimaryKeyOption, SingleColumnIndexOptions, DefaultColumnTypes, QueryLogOptions, AdapterOptions } from 'pqb';
-import { EmptyObject, RawSQLBase, ColumnSchemaConfig, MaybeArray, ColumnTypeBase, RecordString } from 'orchid-core';
+import { EmptyObject, RawSQLBase, ColumnSchemaConfig, MaybeArray, ColumnTypeBase, RecordOptionalString } from 'orchid-core';
 
 interface CreateTableResult<Table extends string, Shape extends ColumnsShape> {
     table: Db$1<Table, Shape>;
@@ -1066,6 +1066,16 @@ declare const generateTimeStamp: () => string;
 
 type ChangeCallback<CT extends RakeDbColumnTypes> = (db: DbMigration<CT>, up: boolean) => Promise<void>;
 
+declare const saveMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare const deleteMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
+declare class NoMigrationsTableError extends Error {
+}
+type RakeDbAppliedVersions = {
+    map: RecordOptionalString;
+    sequence: number[];
+};
+declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig, CT>(ctx: RakeDbCtx, adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>, renameTo?: RakeDbMigrationId) => Promise<RakeDbAppliedVersions>;
+
 declare const RAKE_DB_LOCK_KEY = "8582141715823621641";
 type MigrateFn = <SchemaConfig extends ColumnSchemaConfig, CT extends RakeDbColumnTypes>(ctx: RakeDbCtx, options: MaybeArray<AdapterOptions>, config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<void>;
 /**
@@ -1090,7 +1100,7 @@ declare const rollback: MigrateFn;
  * Takes the same options as {@link migrate}.
  */
 declare const redo: MigrateFn;
-declare const migrateOrRollback: (ctx: RakeDbCtx, trx: TransactionAdapter, config: RakeDbConfig<ColumnSchemaConfig, RakeDbColumnTypes>, set: MigrationsSet, count: number, asts: RakeDbAst[], up: boolean, skipLock?: boolean) => Promise<void>;
+declare const migrateOrRollback: (trx: TransactionAdapter, config: RakeDbConfig<ColumnSchemaConfig, RakeDbColumnTypes>, set: MigrationsSet, versions: RakeDbAppliedVersions, count: number, asts: RakeDbAst[], up: boolean, force?: boolean, skipLock?: boolean) => Promise<void>;
 declare const changeCache: Record<string, ChangeCallback<RakeDbColumnTypes>[] | undefined>;
 
 /**
@@ -1131,10 +1141,4 @@ type RakeDbChangeFn<CT extends RakeDbColumnTypes> = (fn: ChangeCallback<CT>) =>
  */
 declare const rakeDb: RakeDbFn;
 
-declare const saveMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
-declare const removeMigratedVersion: <SchemaConfig extends ColumnSchemaConfig, CT>(db: SilentQueries, version: string, name: string, config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
-declare class NoMigrationsTableError extends Error {
-}
-declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig, CT>(ctx: RakeDbCtx, adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>) => Promise<RecordString>;
-
-export { AnyRakeDbConfig, AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, ConstraintArg, DbMigration, DropMode, InputRakeDbConfig, Migration, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAst, RakeDbBaseTable, RakeDbColumnTypes, RakeDbConfig, RakeDbMigrationId, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, redo, removeMigratedVersion, resetDb, rollback, saveMigratedVersion, writeMigrationFile };
+export { AnyRakeDbConfig, AppCodeUpdater, AppCodeUpdaterParams, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, ConstraintArg, DbMigration, DropMode, InputRakeDbConfig, Migration, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbColumnTypes, RakeDbConfig, RakeDbMigrationId, SilentQueries, TableOptions, changeCache, createDb, createMigrationInterface, deleteMigratedVersion, dropDb, generate, generateTimeStamp, getDatabaseAndUserFromOptions, getMigratedVersionsMap, makeFileVersion, migrate, migrateOrRollback, migrationConfigDefaults, processRakeDbConfig, rakeDb, redo, resetDb, rollback, saveMigratedVersion, writeMigrationFile };

package/dist/index.js

@@ -2237,7 +2237,7 @@ const saveMigratedVersion = async (db, version, name, config) => {
     values: [version, name]
   });
 };
-const removeMigratedVersion = async (db, version, name, config) => {
+const deleteMigratedVersion = async (db, version, name, config) => {
   const res = await db.silentArrays({
     text: `DELETE FROM ${quoteWithSchema({
       name: config.migrationsTable
@@ -2250,13 +2250,13 @@ const removeMigratedVersion = async (db, version, name, config) => {
 };
 class NoMigrationsTableError extends Error {
 }
-const getMigratedVersionsMap = async (ctx, adapter, config) => {
+const getMigratedVersionsMap = async (ctx, adapter, config, renameTo) => {
   try {
     const table = quoteWithSchema({
       name: config.migrationsTable
     });
     const result = await adapter.arrays(
-      `SELECT * FROM ${table}`
+      `SELECT * FROM ${table} ORDER BY version`
     );
     if (!result.fields[1]) {
       const { migrations } = await getMigrations(ctx, config, true);
@@ -2288,7 +2288,11 @@ const getMigratedVersionsMap = async (ctx, adapter, config) => {
         `ALTER TABLE ${table} ALTER COLUMN name SET NOT NULL`
       );
     }
-    return Object.fromEntries(result.rows);
+    let versions = Object.fromEntries(result.rows);
+    if (renameTo) {
+      versions = await renameMigrations(config, adapter, versions, renameTo);
+    }
+    return { map: versions, sequence: result.rows.map((row) => +row[0]) };
   } catch (err) {
     if (err.code === "42P01") {
       throw new NoMigrationsTableError();
@@ -2297,6 +2301,47 @@ const getMigratedVersionsMap = async (ctx, adapter, config) => {
     }
   }
 };
+async function renameMigrations(config, trx, versions, renameTo) {
+  let first;
+  for (const version in versions) {
+    first = version;
+    break;
+  }
+  if (!first || getMigrationVersion(config, first))
+    return versions;
+  const fileName = fileNamesToChangeMigrationId[renameTo];
+  const filePath = path.join(config.migrationsPath, fileName);
+  const json = await fs.readFile(filePath, "utf-8");
+  let data;
+  try {
+    data = JSON.parse(json);
+    if (typeof data !== "object")
+      throw new Error("Config for renaming is not an object");
+  } catch (err) {
+    throw new Error(`Failed to read ${node_url.pathToFileURL(filePath)}`, {
+      cause: err
+    });
+  }
+  const values = [];
+  const updatedVersions = {};
+  for (const version in versions) {
+    const name = versions[version];
+    const key = `${version}_${name}`;
+    let newVersion = data[key];
+    if (!newVersion) {
+      throw new Error(
+        `Failed to find an entry for the migrated ${key} in the ${fileName} config`
+      );
+    }
+    if (renameTo === "serial") {
+      newVersion = String(newVersion).padStart(4, "0");
+    }
+    updatedVersions[newVersion] = name;
+    values.push([version, name, newVersion]);
+  }
+  await renameMigrationVersionsInDb(config, trx, values);
+  return updatedVersions;
+}
 
 const createMigrationsTable = async (db, config) => {
   var _a, _b, _c;
@@ -2347,8 +2392,17 @@ const RAKE_DB_LOCK_KEY = "8582141715823621641";
 function makeMigrateFn(defaultCount, up, fn) {
   return async (ctx, options, config, args = []) => {
     const set = await getMigrations(ctx, config, up);
-    const count = getCount(args);
-    const conf = prepareConfig(config, args, count);
+    const arg = args[0];
+    let force = arg === "force";
+    let count;
+    if (arg === "force") {
+      force = true;
+    } else {
+      force = false;
+      const num = arg === "all" ? Infinity : parseInt(arg);
+      count = isNaN(num) ? void 0 : num;
+    }
+    const conf = prepareConfig(config, args, count === void 0 || force);
     const asts = [];
     const appCodeUpdaterCache = {};
     const { appCodeUpdater } = conf;
@@ -2358,13 +2412,20 @@ function makeMigrateFn(defaultCount, up, fn) {
       const adapter = new pqb.Adapter(opts);
       try {
         await transaction(adapter, async (trx) => {
-          await fn(
+          const versions = await getMigratedVersionsMap(
             ctx,
+            trx,
+            config,
+            set.renameTo
+          );
+          await fn(
             trx,
             conf,
             set,
+            versions,
             count != null ? count : defaultCount,
-            localAsts
+            localAsts,
+            force
           );
         });
       } catch (err) {
@@ -2372,7 +2433,21 @@ function makeMigrateFn(defaultCount, up, fn) {
           await transaction(adapter, async (trx) => {
             const config2 = conf;
             await createMigrationsTable(trx, config2);
-            await fn(ctx, trx, config2, set, count != null ? count : defaultCount, localAsts);
+            const versions = await getMigratedVersionsMap(
+              ctx,
+              trx,
+              config2,
+              set.renameTo
+            );
+            await fn(
+              trx,
+              config2,
+              set,
+              versions,
+              count != null ? count : defaultCount,
+              localAsts,
+              force
+            );
           });
         } else {
           throw err;
@@ -2394,31 +2469,37 @@ function makeMigrateFn(defaultCount, up, fn) {
 const migrate = makeMigrateFn(
   Infinity,
   true,
-  (ctx, trx, config, migrations, count, asts) => migrateOrRollback(ctx, trx, config, migrations, count, asts, true)
+  (trx, config, set, versions, count, asts, force) => migrateOrRollback(trx, config, set, versions, count, asts, true, force)
 );
 const rollback = makeMigrateFn(
   1,
   false,
-  (ctx, trx, config, migrations, count, asts) => migrateOrRollback(ctx, trx, config, migrations, count, asts, false)
+  (trx, config, set, versions, count, asts, force) => migrateOrRollback(trx, config, set, versions, count, asts, false, force)
 );
 const redo = makeMigrateFn(
   1,
   true,
-  async (ctx, trx, config, set, count, asts) => {
+  async (trx, config, set, versions, count, asts, force) => {
     set.migrations.reverse();
-    await migrateOrRollback(ctx, trx, config, set, count, asts, false);
+    await migrateOrRollback(trx, config, set, versions, count, asts, false);
     set.migrations.reverse();
-    await migrateOrRollback(ctx, trx, config, set, count, asts, true, true);
+    await migrateOrRollback(
+      trx,
+      config,
+      set,
+      versions,
+      count,
+      asts,
+      true,
+      force,
+      true
+    );
   }
 );
 const getDb = (adapter) => pqb.createDb({ adapter });
-const getCount = (args) => {
-  const num = args[0] === "all" ? Infinity : parseInt(args[0]);
-  return isNaN(num) ? void 0 : num;
-};
-function prepareConfig(config, args, count) {
+function prepareConfig(config, args, hasArg) {
   config = __spreadValues$5({}, config);
-  const i = count === void 0 ? 0 : 1;
+  const i = hasArg ? 0 : 1;
   const arg = args[i];
   if (arg === "--code") {
     config.useCodeUpdater = args[i + 1] !== "false";
@@ -2427,75 +2508,79 @@ function prepareConfig(config, args, count) {
     delete config.appCodeUpdater;
   return config;
 }
-const migrateOrRollback = async (ctx, trx, config, set, count, asts, up, skipLock) => {
+const migrateOrRollback = async (trx, config, set, versions, count, asts, up, force, skipLock) => {
   var _a, _b, _c;
+  const { sequence, map: versionsMap } = versions;
+  if (up) {
+    const rollbackTo = checkMigrationOrder(set, versions, force);
+    if (rollbackTo) {
+      let i = sequence.length - 1;
+      for (; i >= 0; i--) {
+        if (rollbackTo >= sequence[i]) {
+          i++;
+          break;
+        }
+      }
+      if (i < 0)
+        i = 0;
+      set.migrations.reverse();
+      await migrateOrRollback(
+        trx,
+        config,
+        set,
+        versions,
+        sequence.length - i,
+        asts,
+        false
+      );
+      set.migrations.reverse();
+    }
+  }
   if (!skipLock)
     await queryLock(trx);
   let db;
   await ((_a = config[up ? "beforeMigrate" : "beforeRollback"]) == null ? void 0 : _a.call(config, db != null ? db : db = getDb(trx)));
-  let migratedVersions = await getMigratedVersionsMap(ctx, trx, config);
-  if (set.renameTo) {
-    migratedVersions = await renameMigrations(
-      config,
-      trx,
-      migratedVersions,
-      set.renameTo
-    );
-  }
   for (const file of set.migrations) {
-    if (up && migratedVersions[file.version] || !up && !migratedVersions[file.version]) {
+    if (up && versionsMap[file.version] || !up && !versionsMap[file.version]) {
       continue;
     }
     if (count-- <= 0)
       break;
     await runMigration(trx, up, file, config, asts);
+    if (up) {
+      const name = path.basename(file.path);
+      versionsMap[file.version] = name;
+      sequence.push(+file.version);
+    } else {
+      versionsMap[file.version] = void 0;
+      sequence.pop();
+    }
     (_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)));
 };
-async function renameMigrations(config, trx, migratedVersions, renameTo) {
-  let first;
-  for (const version in migratedVersions) {
-    first = version;
-    break;
-  }
-  if (!first || getMigrationVersion(config, first))
-    return migratedVersions;
-  const fileName = fileNamesToChangeMigrationId[renameTo];
-  const filePath = path.join(config.migrationsPath, fileName);
-  const json = await fs.readFile(filePath, "utf-8");
-  let data;
-  try {
-    data = JSON.parse(json);
-    if (typeof data !== "object")
-      throw new Error("Config for renaming is not an object");
-  } catch (err) {
-    throw new Error(`Failed to read ${node_url.pathToFileURL(filePath)}`, {
-      cause: err
-    });
-  }
-  const values = [];
-  const updatedVersions = {};
-  for (const version in migratedVersions) {
-    const name = migratedVersions[version];
-    const key = `${version}_${name}`;
-    let newVersion = data[key];
-    if (!newVersion) {
-      throw new Error(
-        `Failed to find an entry for the migrated ${key} in the ${fileName} config`
-      );
-    }
-    if (renameTo === "serial") {
-      newVersion = String(newVersion).padStart(4, "0");
+const checkMigrationOrder = (set, { sequence, map }, force) => {
+  const last = sequence[sequence.length - 1];
+  if (last) {
+    for (const file of set.migrations) {
+      const version = +file.version;
+      if (version > last || map[version])
+        continue;
+      if (!force) {
+        throw new Error(
+          `Cannot migrate ${path.basename(
+            file.path
+          )} because the higher position ${map[last]} was already migrated.
+Run \`**db command** up force\` to rollback the above migrations and migrate all`
+        );
+      }
+      return version;
     }
-    updatedVersions[newVersion] = name;
-    values.push([version, name, newVersion]);
   }
-  await renameMigrationVersionsInDb(config, trx, values);
-  return updatedVersions;
-}
+  return;
+};
 async function runCodeUpdaterAfterAll(options, config, appCodeUpdater, asts, cache) {
   for (const ast of asts) {
     await (appCodeUpdater == null ? void 0 : appCodeUpdater.process({
@@ -2543,7 +2628,7 @@ const runMigration = async (trx, up, file, config, asts) => {
       await changes[i](db, up);
     }
   }
-  await (up ? saveMigratedVersion : removeMigratedVersion)(
+  await (up ? saveMigratedVersion : deleteMigratedVersion)(
     db.adapter,
     file.version,
     path.basename(file.path).slice(file.version.length + 1),
@@ -4035,7 +4120,7 @@ const listMigrationsStatuses = async (options, config, args) => {
   let maxNameLength = 4;
   for (let i = 0; i < options.length; i++) {
     const list = migrated[i];
-    const key = Object.entries(list).map(([version, up]) => `${version}${up ? "t" : "f"}`).join("");
+    const key = Object.entries(list.map).map(([version, up]) => `${version}${up ? "t" : "f"}`).join("");
     const database = options[i].database || new URL(options[i].databaseURL).pathname.slice(1);
     if (map[key]) {
       map[key].databases.push(database);
@@ -4055,7 +4140,7 @@ const listMigrationsStatuses = async (options, config, args) => {
           maxNameLength = name.length;
         }
         return {
-          up: !!list[item.version],
+          up: !!list.map[item.version],
           version: item.version,
           name,
           url: node_url.pathToFileURL(item.path)
@@ -4161,8 +4246,8 @@ const rebase = async (options, config) => {
   if (start === -1)
     return;
   const combinedVersionsMap = {};
-  for (const map of versionMaps) {
-    Object.assign(combinedVersionsMap, map);
+  for (const versions of versionMaps) {
+    Object.assign(combinedVersionsMap, versions.map);
   }
   const renames = [];
   const renamesMap = {};
@@ -4398,13 +4483,15 @@ Commands:
   reset                   drop, create and migrate databases
   pull                    generate a combined migration for an existing database
   new                     create new migration file, see below
-  migrate                 migrate pending migrations, run recurrent
-  up                      migrate pending migrations, don't run recurrent
+  up                      migrate pending migrations
+  migrate                 migrate pending migrations, also run recurrent
+  up|migrate force        resolve the case of a non-migrated file in the middle
   rollback or down        rollback the last migrated
   redo                    rollback and migrate, run recurrent
   status or s             list migrations statuses
   status path or s p      list migrations statuses and paths to files
   rec or recurrent        run recurrent migrations
+  rebase                  move local migrations below the new ones from upstream
   change-ids serial       change migrations ids to 4 digit serial
   change-ids serial 42    change migrations ids to custom digits serial
   change-ids timestamp    change migrations ids to timestamps
@@ -4430,6 +4517,7 @@ exports.RAKE_DB_LOCK_KEY = RAKE_DB_LOCK_KEY;
 exports.changeCache = changeCache;
 exports.createDb = createDb;
 exports.createMigrationInterface = createMigrationInterface;
+exports.deleteMigratedVersion = deleteMigratedVersion;
 exports.dropDb = dropDb;
 exports.generate = generate;
 exports.generateTimeStamp = generateTimeStamp;
@@ -4442,7 +4530,6 @@ exports.migrationConfigDefaults = migrationConfigDefaults;
 exports.processRakeDbConfig = processRakeDbConfig;
 exports.rakeDb = rakeDb;
 exports.redo = redo;
-exports.removeMigratedVersion = removeMigratedVersion;
 exports.resetDb = resetDb;
 exports.rollback = rollback;
 exports.saveMigratedVersion = saveMigratedVersion;