rake-db 2.27.18 → 2.27.19

package/dist/index.d.ts

@@ -322,6 +322,9 @@ interface PickRenameMigrations {
 interface PickMigrationsTable {
     migrationsTable: string;
 }
+interface PickTransactionSetting {
+    transaction: 'single' | 'per-migration';
+}
 interface PickMigrationCallbacks {
     beforeChange?: ChangeCallback$1;
     afterChange?: ChangeCallback$1;
@@ -344,7 +347,7 @@ interface RakeDbBaseConfig<SchemaConfig extends ColumnSchemaConfig, CT = Default
     noPrimaryKey?: NoPrimaryKeyOption;
     baseTable?: RakeDbBaseTable<CT>;
 }
-interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends RakeDbBaseConfig<SchemaConfig, CT>, PickBasePath {
+interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends RakeDbBaseConfig<SchemaConfig, CT>, PickBasePath, PickTransactionSetting {
     columnTypes: CT;
     dbScript: string;
     recurrentPath: string;
@@ -489,7 +492,7 @@ interface RakeDbRenameMigrationsInput {
     map: RakeDbRenameMigrationsMap;
 }
 declare const migrationConfigDefaults: RakeDbBaseConfig<ColumnSchemaConfig>;
-declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<pqb.ColumnTypeBase<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, pqb.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>) => RakeDbConfig<SchemaConfig, CT>;
+declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<pqb.ColumnTypeBase<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, pqb.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>, args?: string[]) => RakeDbConfig<SchemaConfig, CT>;
 
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
@@ -1521,15 +1524,16 @@ declare const promptSelect: ({ message, options, active, inactive, }: {
 
 declare const saveMigratedVersion: (db: SilentQueries, version: string, name: string, config: PickMigrationsTable) => Promise<void>;
 
-interface MigrateFnConfig extends MigrateOrRollbackConfig, PickAfterChangeCommit, PickBasePath, PickImport, PickMigrationsPath {
+interface MigrateFnConfig extends MigrateOrRollbackConfig, PickAfterChangeCommit, PickBasePath, PickImport, PickMigrationsPath, PickTransactionSetting {
 }
-type MigrateFn = (params: {
+interface MigrateFnParams {
     ctx?: RakeDbCtx;
     adapter: AdapterBase;
     config: MigrateFnConfig;
     count?: number;
     force?: boolean;
-}) => Promise<void>;
+}
+type MigrateFn = (params: MigrateFnParams) => Promise<void>;
 /**
  * Will run all pending yet migrations, sequentially in order,
  * will apply `change` functions top-to-bottom.
@@ -1540,7 +1544,7 @@ type MigrateFn = (params: {
  */
 declare const migrate: MigrateFn;
 declare const migrateAndClose: MigrateFn;
-interface MigrateOrRollbackConfig extends PickMigrationCallbacks, PickMigrationId, QueryLogOptions, PickForceDefaultExports, PickMigrationsTable {
+interface MigrateOrRollbackConfig extends PickMigrationCallbacks, PickMigrationId, QueryLogOptions, PickForceDefaultExports, PickMigrationsTable, PickTransactionSetting {
     columnTypes: unknown;
 }
 

package/dist/index.js

@@ -17,154 +17,6 @@ const clearChanges = () => {
 const getCurrentChanges = () => currentChanges;
 const pushChange = (change) => currentChanges.push(change);
 
-const migrationConfigDefaults = {
-  schemaConfig: pqb.defaultSchemaConfig,
-  migrationsPath: path.join("src", "db", "migrations"),
-  migrationId: { serial: 4 },
-  migrationsTable: "schemaMigrations",
-  snakeCase: false,
-  commands: {},
-  log: true,
-  logger: console,
-  import() {
-    throw new Error(
-      "Add `import: (path) => import(path),` setting to `rakeDb` config"
-    );
-  }
-};
-const ensureMigrationsPath = (config) => {
-  if (!config.migrationsPath) {
-    config.migrationsPath = migrationConfigDefaults.migrationsPath;
-  }
-  if (!path.isAbsolute(config.migrationsPath)) {
-    config.migrationsPath = path.resolve(
-      config.basePath,
-      config.migrationsPath
-    );
-  }
-  return config;
-};
-const ensureBasePathAndDbScript = (config, intermediateCallers = 0) => {
-  if (config.basePath && config.dbScript) return config;
-  let filePath = pqb.getStackTrace()?.[3 + intermediateCallers].getFileName();
-  if (!filePath) {
-    throw new Error(
-      "Failed to determine path to db script. Please set basePath option of rakeDb"
-    );
-  }
-  if (filePath.startsWith("file://")) {
-    filePath = node_url.fileURLToPath(filePath);
-  }
-  const ext = path.extname(filePath);
-  if (ext !== ".ts" && ext !== ".js" && ext !== ".mjs") {
-    throw new Error(
-      `Add a .ts suffix to the "${path.basename(filePath)}" when calling it`
-    );
-  }
-  config.basePath = path.dirname(filePath);
-  config.dbScript = path.basename(filePath);
-  return config;
-};
-const processRakeDbConfig = (config) => {
-  const result = { ...migrationConfigDefaults, ...config };
-  if (!result.log) {
-    delete result.logger;
-  }
-  ensureBasePathAndDbScript(result, 1);
-  ensureMigrationsPath(result);
-  if (!result.recurrentPath) {
-    result.recurrentPath = path.join(
-      result.migrationsPath,
-      "recurrent"
-    );
-  }
-  if ("recurrentPath" in result && !path.isAbsolute(result.recurrentPath)) {
-    result.recurrentPath = path.resolve(result.basePath, result.recurrentPath);
-  }
-  if ("baseTable" in config && config.baseTable) {
-    const { types, snakeCase, language } = config.baseTable.prototype;
-    result.columnTypes = types || pqb.makeColumnTypes(pqb.defaultSchemaConfig);
-    if (snakeCase) result.snakeCase = true;
-    if (language) result.language = language;
-  } else {
-    const ct = "columnTypes" in config && config.columnTypes;
-    result.columnTypes = (typeof ct === "function" ? ct(
-      pqb.makeColumnTypes(pqb.defaultSchemaConfig)
-    ) : ct) || pqb.makeColumnTypes(pqb.defaultSchemaConfig);
-  }
-  if (config.migrationId === "serial") {
-    result.migrationId = { serial: 4 };
-  }
-  return result;
-};
-
-const getFirstWordAndRest = (input) => {
-  const i = input.search(/(?=[A-Z])|[-_ ]/);
-  if (i !== -1) {
-    const restStart = input[i] === "-" || input[i] === "_" || input[i] === " " ? i + 1 : i;
-    const rest = input.slice(restStart);
-    return [input.slice(0, i), rest[0].toLowerCase() + rest.slice(1)];
-  } else {
-    return [input];
-  }
-};
-const getTextAfterRegExp = (input, regex, length) => {
-  let i = input.search(regex);
-  if (i === -1) return;
-  if (input[i] === "-" || input[i] === "_" || input[i] === " ") i++;
-  i += length;
-  const start = input[i] == "-" || input[i] === "_" || input[i] === " " ? i + 1 : i;
-  const text = input.slice(start);
-  return text[0].toLowerCase() + text.slice(1);
-};
-const getTextAfterTo = (input) => {
-  return getTextAfterRegExp(input, /(To|-to|_to| to)[A-Z-_ ]/, 2);
-};
-const getTextAfterFrom = (input) => {
-  return getTextAfterRegExp(input, /(From|-from|_from| from)[A-Z-_ ]/, 4);
-};
-const joinColumns = (columns) => {
-  return columns.map((column) => `"${column}"`).join(", ");
-};
-const quoteWithSchema = ({
-  schema,
-  name
-}) => quoteTable(schema, name);
-const quoteTable = (schema, table) => schema ? `"${schema}"."${table}"` : `"${table}"`;
-const getSchemaAndTableFromName = (name) => {
-  const i = name.indexOf(".");
-  return i !== -1 ? [name.slice(0, i), name.slice(i + 1)] : [void 0, name];
-};
-const quoteNameFromString = (string) => {
-  return quoteTable(...getSchemaAndTableFromName(string));
-};
-const quoteCustomType = (s) => {
-  const [schema, type] = getSchemaAndTableFromName(s);
-  return schema ? '"' + schema + '".' + type : type;
-};
-const quoteSchemaTable = (arg) => {
-  return pqb.singleQuote(concatSchemaAndName(arg));
-};
-const concatSchemaAndName = ({
-  schema,
-  name
-}) => {
-  return schema ? `${schema}.${name}` : name;
-};
-const makePopulateEnumQuery = (item) => {
-  const [schema, name] = getSchemaAndTableFromName(item.enumName);
-  return {
-    text: `SELECT unnest(enum_range(NULL::${quoteTable(schema, name)}))::text`,
-    then(result) {
-      item.options.push(...result.rows.map(([value]) => value));
-    }
-  };
-};
-const transaction = (adapter, fn) => {
-  return adapter.transaction(void 0, fn);
-};
-const queryLock = (trx) => trx.query(`SELECT pg_advisory_xact_lock('${RAKE_DB_LOCK_KEY}')`);
-
 const versionToString = (config, version) => config.migrationId === "timestamp" ? `${version}` : `${version}`.padStart(config.migrationId.serial, "0");
 const columnTypeToSql = (item) => {
   return item.data.isOfCustomType ? item instanceof pqb.DomainColumn ? quoteNameFromString(item.dataType) : quoteCustomType(item.toSQL()) : item.toSQL();
@@ -3068,6 +2920,9 @@ const createMigrationsTable = async (db, config) => {
 };
 
 const RAKE_DB_LOCK_KEY = "8582141715823621641";
+const transactionIfSingle = (params, fn) => {
+  return params.config.transaction === "single" ? transaction(params.adapter, fn) : fn(params.adapter);
+};
 function makeMigrateFn(up, fn) {
   return async (params) => {
     const ctx = params.ctx || {};
@@ -3076,7 +2931,7 @@ function makeMigrateFn(up, fn) {
     const force = params.force ?? false;
     let migrations;
     try {
-      await transaction(params.adapter, async (trx) => {
+      await transactionIfSingle(params, async (trx) => {
         const versions = await getMigratedVersionsMap(
           ctx,
           trx,
@@ -3087,7 +2942,7 @@ function makeMigrateFn(up, fn) {
       });
     } catch (err) {
       if (err instanceof NoMigrationsTableError) {
-        await transaction(params.adapter, async (trx) => {
+        await transactionIfSingle(params, async (trx) => {
           await createMigrationsTable(trx, params.config);
           const versions = await getMigratedVersionsMap(
             ctx,
@@ -3206,6 +3061,7 @@ const migrateOrRollback = async (trx, config, set, versions, count, up, redo2, f
   }
   let loggedAboutStarting = false;
   let migrations;
+  const migrationRunner = config.transaction === "single" ? runMigration : runMigrationInOwnTransaction;
   for (const file of set.migrations) {
     if (up && versionsMap[file.version] || !up && !versionsMap[file.version]) {
       continue;
@@ -3219,7 +3075,7 @@ const migrateOrRollback = async (trx, config, set, versions, count, up, redo2, f
       );
     }
     const changes = await getChanges(file, config);
-    const adapter = await runMigration(trx, up, changes, config);
+    const adapter = await migrationRunner(trx, up, changes, config);
     await changeMigratedVersion(adapter, up, file, config);
     (migrations ?? (migrations = [])).push(file);
     if (up) {
@@ -3298,6 +3154,9 @@ const getChanges = async (file, config) => {
   }
   return changes;
 };
+const runMigrationInOwnTransaction = (adapter, ...rest) => {
+  return transaction(adapter, (trx) => runMigration(trx, ...rest));
+};
 const runMigration = async (trx, up, changes, config) => {
   const db = createMigrationInterface(trx, up, config);
   if (changes.length) {
@@ -3319,6 +3178,176 @@ const changeMigratedVersion = async (adapter, up, file, config) => {
   );
 };
 
+const getFirstWordAndRest = (input) => {
+  const i = input.search(/(?=[A-Z])|[-_ ]/);
+  if (i !== -1) {
+    const restStart = input[i] === "-" || input[i] === "_" || input[i] === " " ? i + 1 : i;
+    const rest = input.slice(restStart);
+    return [input.slice(0, i), rest[0].toLowerCase() + rest.slice(1)];
+  } else {
+    return [input];
+  }
+};
+const getTextAfterRegExp = (input, regex, length) => {
+  let i = input.search(regex);
+  if (i === -1) return;
+  if (input[i] === "-" || input[i] === "_" || input[i] === " ") i++;
+  i += length;
+  const start = input[i] == "-" || input[i] === "_" || input[i] === " " ? i + 1 : i;
+  const text = input.slice(start);
+  return text[0].toLowerCase() + text.slice(1);
+};
+const getTextAfterTo = (input) => {
+  return getTextAfterRegExp(input, /(To|-to|_to| to)[A-Z-_ ]/, 2);
+};
+const getTextAfterFrom = (input) => {
+  return getTextAfterRegExp(input, /(From|-from|_from| from)[A-Z-_ ]/, 4);
+};
+const joinColumns = (columns) => {
+  return columns.map((column) => `"${column}"`).join(", ");
+};
+const quoteWithSchema = ({
+  schema,
+  name
+}) => quoteTable(schema, name);
+const quoteTable = (schema, table) => schema ? `"${schema}"."${table}"` : `"${table}"`;
+const getSchemaAndTableFromName = (name) => {
+  const i = name.indexOf(".");
+  return i !== -1 ? [name.slice(0, i), name.slice(i + 1)] : [void 0, name];
+};
+const quoteNameFromString = (string) => {
+  return quoteTable(...getSchemaAndTableFromName(string));
+};
+const quoteCustomType = (s) => {
+  const [schema, type] = getSchemaAndTableFromName(s);
+  return schema ? '"' + schema + '".' + type : type;
+};
+const quoteSchemaTable = (arg) => {
+  return pqb.singleQuote(concatSchemaAndName(arg));
+};
+const concatSchemaAndName = ({
+  schema,
+  name
+}) => {
+  return schema ? `${schema}.${name}` : name;
+};
+const makePopulateEnumQuery = (item) => {
+  const [schema, name] = getSchemaAndTableFromName(item.enumName);
+  return {
+    text: `SELECT unnest(enum_range(NULL::${quoteTable(schema, name)}))::text`,
+    then(result) {
+      item.options.push(...result.rows.map(([value]) => value));
+    }
+  };
+};
+const transaction = (adapter, fn) => {
+  return adapter.transaction(void 0, fn);
+};
+const queryLock = (trx) => trx.query(`SELECT pg_advisory_xact_lock('${RAKE_DB_LOCK_KEY}')`);
+const getCliParam = (args, name) => {
+  if (args) {
+    const key = "--" + name;
+    for (let i = 0; i < args.length; i += 1) {
+      const arg = args[i];
+      if (arg === key) return args[i + 1];
+      else if (arg.startsWith(key)) return arg.slice(key.length + 1);
+    }
+  }
+  return;
+};
+
+const migrationConfigDefaults = {
+  schemaConfig: pqb.defaultSchemaConfig,
+  migrationsPath: path.join("src", "db", "migrations"),
+  migrationId: { serial: 4 },
+  migrationsTable: "schemaMigrations",
+  snakeCase: false,
+  commands: {},
+  log: true,
+  logger: console,
+  import() {
+    throw new Error(
+      "Add `import: (path) => import(path),` setting to `rakeDb` config"
+    );
+  }
+};
+const ensureMigrationsPath = (config) => {
+  if (!config.migrationsPath) {
+    config.migrationsPath = migrationConfigDefaults.migrationsPath;
+  }
+  if (!path.isAbsolute(config.migrationsPath)) {
+    config.migrationsPath = path.resolve(
+      config.basePath,
+      config.migrationsPath
+    );
+  }
+  return config;
+};
+const ensureBasePathAndDbScript = (config, intermediateCallers = 0) => {
+  if (config.basePath && config.dbScript) return config;
+  let filePath = pqb.getStackTrace()?.[3 + intermediateCallers].getFileName();
+  if (!filePath) {
+    throw new Error(
+      "Failed to determine path to db script. Please set basePath option of rakeDb"
+    );
+  }
+  if (filePath.startsWith("file://")) {
+    filePath = node_url.fileURLToPath(filePath);
+  }
+  const ext = path.extname(filePath);
+  if (ext !== ".ts" && ext !== ".js" && ext !== ".mjs") {
+    throw new Error(
+      `Add a .ts suffix to the "${path.basename(filePath)}" when calling it`
+    );
+  }
+  config.basePath = path.dirname(filePath);
+  config.dbScript = path.basename(filePath);
+  return config;
+};
+const processRakeDbConfig = (config, args) => {
+  const result = { ...migrationConfigDefaults, ...config };
+  if (!result.log) {
+    delete result.logger;
+  }
+  ensureBasePathAndDbScript(result, 1);
+  ensureMigrationsPath(result);
+  if (!result.recurrentPath) {
+    result.recurrentPath = path.join(
+      result.migrationsPath,
+      "recurrent"
+    );
+  }
+  if ("recurrentPath" in result && !path.isAbsolute(result.recurrentPath)) {
+    result.recurrentPath = path.resolve(result.basePath, result.recurrentPath);
+  }
+  if ("baseTable" in config && config.baseTable) {
+    const { types, snakeCase, language } = config.baseTable.prototype;
+    result.columnTypes = types || pqb.makeColumnTypes(pqb.defaultSchemaConfig);
+    if (snakeCase) result.snakeCase = true;
+    if (language) result.language = language;
+  } else {
+    const ct = "columnTypes" in config && config.columnTypes;
+    result.columnTypes = (typeof ct === "function" ? ct(
+      pqb.makeColumnTypes(pqb.defaultSchemaConfig)
+    ) : ct) || pqb.makeColumnTypes(pqb.defaultSchemaConfig);
+  }
+  if (config.migrationId === "serial") {
+    result.migrationId = { serial: 4 };
+  }
+  const transaction = getCliParam(args, "transaction");
+  if (transaction) {
+    if (transaction !== "single" && transaction !== "per-migration") {
+      throw new Error(
+        `Unsupported transaction param ${transaction}, expected single or per-migration`
+      );
+    }
+    result.transaction = transaction;
+  } else if (!result.transaction) {
+    result.transaction = "single";
+  }
+  return result;
+};
+
 const ESC = "\x1B";
 const CSI = `${ESC}[`;
 const cursorShow = `${CSI}?25h`;
@@ -5786,7 +5815,7 @@ const rakeDbCommands = {
 };
 
 const rakeDbWithAdapters = (adapters, partialConfig, args = process.argv.slice(2)) => {
-  const config = processRakeDbConfig(partialConfig);
+  const config = processRakeDbConfig(partialConfig, args);
   const promise = runCommand(
     adapters,
     config,
@@ -5840,7 +5869,8 @@ const makeMigrateAdapter = (config) => {
         columnTypes: conf.columnTypes || pqb.makeColumnTypes(pqb.defaultSchemaConfig),
         migrationId: conf.migrationId || migrationConfigDefaults.migrationId,
         migrationsTable: conf.migrationsTable || migrationConfigDefaults.migrationsTable,
-        import: conf.import || migrationConfigDefaults.import
+        import: conf.import || migrationConfigDefaults.import,
+        transaction: conf.transaction || "single"
       }
     });
   };