db-migrate 1.0.0-beta.9 → 1.0.0-rc.0

package/LICENSE

@@ -20,3 +20,29 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+AI OSS License
+
+Copyright (c) 2015 db-migrate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software, as well as in results by
+AI models, which result from the source code this License applies to.
+The source code is not allowed to be used for training except for
+models that itself are open source.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -1,10 +1,6 @@
 [![Backers on Open Collective](https://opencollective.com/node-db-migrate/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/node-db-migrate/sponsors/badge.svg)](#sponsors)
-[![Build Status](https://travis-ci.org/db-migrate/node-db-migrate.svg?branch=master)](https://travis-ci.org/db-migrate/node-db-migrate)
-[![Dependency Status](https://david-dm.org/db-migrate/node-db-migrate.svg)](https://david-dm.org/db-migrate/node-db-migrate)
-[![devDependency Status](https://david-dm.org/db-migrate/node-db-migrate/dev-status.svg)](https://david-dm.org/db-migrate/node-db-migrate#info=devDependencies)
+[![Build Status](https://github.com/db-migrate/node-db-migrate/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/db-migrate/node-db-migrate/actions/workflows/ci.yml)
 [![Documentation Status](https://readthedocs.org/projects/db-migrate/badge/?version=latest)](https://readthedocs.org/projects/db-migrate/?badge=latest)
-[![Code Quality: Javascript](https://img.shields.io/lgtm/grade/javascript/g/db-migrate/node-db-migrate.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/db-migrate/node-db-migrate/context:javascript)
-[![Total Alerts](https://img.shields.io/lgtm/alerts/g/db-migrate/node-db-migrate.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/db-migrate/node-db-migrate/alerts)
 
 # db-migrate
 
@@ -24,6 +20,11 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 # Usage
 
+## Requirements
+
+Officially supported is Node.js 24 and newer. Older versions may work, but
+are not tested.
+
 ## Installation
 
     $ npm install -g db-migrate
@@ -53,6 +54,13 @@ DB-Migrate is now available to you via:
 - Mongodb (https://github.com/mongodb/node-mongodb-native)
   https://github.com/db-migrate/mongodb
 
+## Connecting through an SSH tunnel
+
+Tunnels are provided by plugins. Install the ssh tunnel plugin next to
+db-migrate to use the `tunnel` setting of your database config:
+
+    $ npm install db-migrate-plugin-tunnel-ssh
+
 ## Resources and usage instructions
 
 Please follow the link below, for usage instructions examples and the full

package/api.js

@@ -50,7 +50,7 @@ function dbmigrate (plugins, isModule, options, callback) {
   if (config.dotenvCustomPath) {
     dotenvConfig.path = config.dotenvCustomPath;
   }
-  dotenv.load(dotenvConfig);
+  dotenv.config(dotenvConfig);
 
   /* $lab:coverage:off$ */
   if (!options || !options.throwUncatched) load('helper/register-events')();
@@ -105,7 +105,7 @@ function dbmigrate (plugins, isModule, options, callback) {
 dbmigrate.prototype = {
   /**
    * Add a global defined variable to db-migrate, to enable access from
-   * local migrations without configuring pathes.
+   * local migrations without configuring paths.
    *
    * @return boolean
    */
@@ -245,6 +245,31 @@ dbmigrate.prototype = {
     );
   },
 
+  fix: function (specification, opts, callback) {
+    var executeFix = load('fix');
+
+    if (arguments.length > 0) {
+      if (typeof specification === 'string') {
+        this.internals.argv.destination = specification;
+      } else if (typeof specification === 'number') {
+        this.internals.argv.count = specification;
+      } else if (typeof specification === 'function') {
+        callback = specification;
+      }
+
+      if (typeof opts === 'string') {
+        this.internals.migrationMode = opts;
+        this.internals.matching = opts;
+      } else if (typeof opts === 'function') {
+        callback = opts;
+      }
+    }
+
+    return Promise.resolve(executeFix(this.internals, this.config)).nodeify(
+      callback
+    );
+  },
+
   check: function (specification, opts, callback) {
     var executeCheck = load('check');
 

package/connect.js

@@ -9,7 +9,9 @@ var path = require('path');
 var log = require('db-migrate-shared').log;
 const Promise = require('bluebird');
 
-exports.connect = function (config, PassedClass) {
+Promise.promisifyAll(driver);
+
+exports.connect = async function (config, PassedClass) {
   var internals = {};
   var prefix = 'migration';
   if (config.config) {
@@ -18,6 +20,8 @@ exports.connect = function (config, PassedClass) {
     config = config.config;
   }
 
+  const db2 = await driver.connectAsync(config, internals);
+
   return Promise.fromCallback(callback => {
     driver.connect(config, internals, function (err, db) {
       if (err) {
@@ -25,10 +29,18 @@ exports.connect = function (config, PassedClass) {
         return;
       }
 
+      const realClose = db.close;
+      // close both lines with one disconnect action
+      db.close = function (cb) {
+        db2.close(function () {});
+        db.close = realClose;
+        db.close(cb);
+      };
+
+      var dirPath = path.resolve(
+        internals.argv['migrations-dir'] || 'migrations'
+      );
       if (internals.migrationMode) {
-        var dirPath = path.resolve(
-          internals.argv['migrations-dir'] || 'migrations'
-        );
         if (internals.migrationMode !== 'all') {
           var switched = false;
           var newConf;
@@ -56,10 +68,11 @@ exports.connect = function (config, PassedClass) {
                 null,
                 new PassedClass(
                   db,
-                  internals.argv['migrations-dir'],
+                  dirPath,
                   internals.mode !== 'static',
                   internals,
-                  prefix
+                  prefix,
+                  { db2 }
                 )
               );
             });
@@ -69,10 +82,11 @@ exports.connect = function (config, PassedClass) {
               null,
               new PassedClass(
                 db,
-                internals.argv['migrations-dir'],
+                dirPath,
                 internals.mode !== 'static',
                 internals,
-                prefix
+                prefix,
+                { db2 }
               )
             );
           }
@@ -100,6 +114,7 @@ exports.connect = function (config, PassedClass) {
                 db,
                 oldClose,
                 prefix,
+                db2,
                 cb
               );
             };
@@ -112,10 +127,11 @@ exports.connect = function (config, PassedClass) {
           null,
           new PassedClass(
             db,
-            internals.argv['migrations-dir'],
+            dirPath,
             internals.mode !== 'static',
             internals,
-            prefix
+            prefix,
+            { db2 }
           )
         );
       }
@@ -142,6 +158,7 @@ function migrationFiles (
   db,
   close,
   prefix,
+  db2,
   cb
 ) {
   var file;
@@ -187,7 +204,8 @@ function migrationFiles (
         internals.argv['migrations-dir'],
         internals.mode !== 'static',
         internals,
-        prefix
+        prefix,
+        { db2 }
       )
     );
 

package/lib/chain.js

@@ -1,3 +1,5 @@
+const log = require('db-migrate-shared').log;
+
 const DEFAULT = [
   'renameCollection',
   'dropCollection',
@@ -15,6 +17,21 @@ const DEFAULT = [
   'removeForeignKey'
 ];
 
+/**
+ * Human readable form of an instruction for the log, like
+ * addColumn("users", "email")
+ */
+const describe = (method, args) =>
+  `${method}(${args
+    .filter(
+      a =>
+        typeof a === 'string' ||
+        typeof a === 'number' ||
+        (Array.isArray(a) && a.every(x => typeof x === 'string'))
+    )
+    .map(a => JSON.stringify(a))
+    .join(', ')})`;
+
 let rollbackCounter = 0;
 let rollbackSignal = null;
 let signal = null;
@@ -55,10 +72,11 @@ const dbmControl = {
 };
 
 class Chain {
-  constructor (context, file, driver, internals) {
+  constructor (context, file, driver, internals, pdriver) {
     this.file = file;
     this.context = context;
     this.driver = context;
+    this.pdriver = pdriver;
     this.udriver = driver;
     if (this.udriver._dbmControl !== true) {
       this.udriver._counter = dbmControl;
@@ -81,6 +99,14 @@ class Chain {
     this._step = null;
     this._interface = null;
 
+    /**
+     * op: number of the current step, the instructions of a migration
+     * recovery: progress of an interrupted previous run to resume from,
+     *           see State.startMigration
+     */
+    this.op = 0;
+    this.recovery = null;
+
     DEFAULT.concat(Object.keys(this.context.learnable || [])).forEach(
       method => {
         this[method] = function (...args) {
@@ -113,7 +139,8 @@ class Chain {
         this.context,
         this.file,
         this.udriver,
-        this.internals
+        this.internals,
+        this.pdriver
       );
     }
 
@@ -128,7 +155,34 @@ class Chain {
   async exec (m, ...args) {
     let ret;
     const stat = [];
+    const op = ++this.op;
+    const recovery = this.recovery;
+    this.internals.migrationOp = op;
+    this.current = describe(m, args);
+
+    if (recovery && op <= recovery.done) {
+      log.info(
+        `[recovery] ${this.file.name}: skipping already executed step ` +
+          `${op}/${recovery.done} ${describe(m, args)}`
+      );
+      return ret;
+    }
+
+    // the step was interrupted after its reverse operation was recorded,
+    // but before it finished on the database
+    const learned = recovery !== null && op <= recovery.learned;
+    if (learned) {
+      log.info(
+        `[recovery] ${this.file.name}: executing interrupted step ${op} ` +
+          `${describe(m, args)} without learning it again`
+      );
+    }
+
     while (this.step()) {
+      if (learned && this._step.learns) {
+        continue;
+      }
+
       ret = await this._interface[m].apply(this._interface, args);
       stat.push(ret);
 
@@ -136,6 +190,7 @@ class Chain {
         this._step.useState(ret);
       }
 
+      // need to check if we still want this
       if (this._step.hasModification) {
         const ret = this._step.modify(
           this.context,

package/lib/commands/check.js

@@ -21,15 +21,15 @@ async function prepare (internals, config) {
     );
 
     if (internals.locTitle) {
-      migrator.migrationsDir = path.resolve(
+      migrator.directory = path.resolve(
         internals.argv['migrations-dir'],
         internals.locTitle
       );
     } else {
-      migrator.migrationsDir = path.resolve(internals.argv['migrations-dir']);
+      migrator.directory = path.resolve(internals.argv['migrations-dir']);
     }
 
-    internals.migrationsDir = migrator.migrationsDir;
+    internals.migrationsDir = migrator.directory;
 
     await migrator.createMigrationsTable();
     log.verbose('migration table created');

package/lib/commands/create-migration.js

@@ -2,21 +2,40 @@
 
 const Promise = require('bluebird');
 const log = require('db-migrate-shared').log;
-const mkdirp = Promise.promisify(require('mkdirp'));
 const fs = require('fs');
 const stat = Promise.promisify(fs.stat);
+const writeFile = Promise.promisify(fs.writeFile);
 const yargs = require('yargs');
 const util = require('util');
+const path = require('path');
 
 async function createMigrationDir (dir) {
   const res = await stat(dir).catch(_ => {
     return { err: true };
   });
   if (res && res.err === true) {
-    return mkdirp(dir);
+    await fs.promises.mkdir(dir, { recursive: true });
   }
 
-  return Promise.resolve();
+  // Create migrations/package.json to ensure migration files are
+  // executed as CJS and not ESM
+  // https://github.com/db-migrate/node-db-migrate/issues/721
+  const packageJsonPath = path.resolve(dir, 'package.json');
+
+  await stat(packageJsonPath).then(
+    async () => {
+      const packageJson = require(packageJsonPath);
+      packageJson.type = 'commonjs';
+      const packageJsonStr = JSON.stringify(packageJson, null, 2);
+      await writeFile(packageJsonPath, packageJsonStr, 'utf-8');
+    },
+    async (err) => {
+      const packageJson = JSON.stringify({
+        type: 'commonjs'
+      }, null, 2)
+      await writeFile(packageJsonPath, packageJson, 'utf-8');
+    }
+  )
 }
 
 async function executeCreateMigration (internals, config) {
@@ -155,6 +174,7 @@ async function executeCreateMigration (internals, config) {
           internals.plugins
         );
         await migration.write();
+        log.info(util.format('Created migration at %s', migration.file.path));
       }
     );
   }

package/lib/commands/down.js

@@ -22,7 +22,7 @@ async function prepare (internals, config) {
       Migrator
     );
 
-    migrator.migrationsDir = path.resolve(internals.argv['migrations-dir']);
+    migrator.directory = path.resolve(internals.argv['migrations-dir']);
 
     await migrator.createMigrationsTable();
     log.verbose('migration table created');

package/lib/commands/fix.js

@@ -0,0 +1,53 @@
+var path = require('path');
+var log = require('db-migrate-shared').log;
+var migrationHook = require('./helper/migration-hook.js');
+
+async function prepare (internals, config) {
+  try {
+    await migrationHook(internals);
+    var Migrator = require('../walker.js');
+    var index = require('../../connect');
+
+    if (!internals.argv.count) {
+      internals.argv.count = Number.MAX_VALUE;
+    }
+    const migrator = await index.connect(
+      {
+        config: config.getCurrent().settings,
+        internals: internals,
+        prefix: 'migration'
+      },
+      Migrator
+    );
+
+    if (internals.locTitle) {
+      migrator.directory = path.resolve(
+        internals.argv['migrations-dir'],
+        internals.locTitle
+      );
+    } else {
+      migrator.directory = path.resolve(internals.argv['migrations-dir']);
+    }
+
+    internals.migrationsDir = migrator.directory;
+    const backupState = internals.argv['backup-state'];
+
+    await migrator.createMigrationsTable({ emptyState: true, backupState });
+    log.verbose('migration table created');
+
+    return migrator;
+  } catch (err) {
+    throw err;
+  }
+}
+
+module.exports = async function (internals, config) {
+  const migrator = await prepare(internals, config);
+
+  try {
+    const res = await migrator.fix(internals.argv);
+    return internals.onComplete(migrator, internals, null, res);
+  } catch (err) {
+    return internals.onComplete(migrator, internals, err);
+  }
+};

package/lib/commands/generated.js

@@ -9,6 +9,7 @@ const files = {
   "db": require('./db.js'),
   "down": require('./down.js'),
   "dump": require('./dump.js'),
+  "fix": require('./fix.js'),
   "fn/plugin": require('./fn/plugin.js'),
   "generated": require('./generated.js'),
   "helper/assert": require('./helper/assert.js'),

package/lib/commands/helper/register-events.js

@@ -1,17 +1,18 @@
 'use strict';
 
 var log = require('db-migrate-shared').log;
+var formatError = require('../../format-error');
 
 function registerEvents () {
   process.on('uncaughtException', function (err) {
     log.error('uncaughtException');
-    log.error(err.stack || err);
+    log.error(formatError(err, { verbose: global.verbose }));
     process.exit(1);
   });
 
   process.on('unhandledRejection', function (reason) {
     log.error('unhandledRejection');
-    log.error(reason.stack || reason);
+    log.error(formatError(reason, { verbose: global.verbose }));
     process.exit(1);
   });
 }

package/lib/commands/run.js

@@ -2,6 +2,17 @@
 
 var log = require('db-migrate-shared').log;
 var yargs = require('yargs');
+var formatError = require('../format-error');
+
+/**
+ * Print a failed command once, with the context of the failure, and exit.
+ */
+function report (result) {
+  return Promise.resolve(result).catch(function (err) {
+    log.error(formatError(err, { verbose: global.verbose }));
+    process.exit(1);
+  });
+}
 
 function run (internals, config) {
   const { load } = internals;
@@ -16,7 +27,7 @@ function run (internals, config) {
         internals.matching = folder[1];
         internals.migrationMode = folder[1];
       }
-      load('create-migration')(internals, config);
+      report(load('create-migration')(internals, config));
       break;
     case 'sync':
       var executeSync = load('sync');
@@ -34,8 +45,9 @@ function run (internals, config) {
         internals.migrationMode = folder[1];
       }
 
-      executeSync(internals, config);
+      report(executeSync(internals, config));
       break;
+    case 'fix':
     case 'up':
     case 'down':
     case 'reset':
@@ -57,10 +69,13 @@ function run (internals, config) {
 
       if (action === 'up') {
         var executeUp = load('up');
-        executeUp(internals, config);
+        report(executeUp(internals, config));
+      } else if (action === 'fix') {
+        var executeFix = load('fix');
+        report(executeFix(internals, config));
       } else {
         var executeDown = load('down');
-        executeDown(internals, config);
+        report(executeDown(internals, config));
       }
       break;
 
@@ -72,14 +87,14 @@ function run (internals, config) {
         internals.migrationMode = folder[1];
       }
 
-      executeCheck(internals, config);
+      report(executeCheck(internals, config));
       break;
     case 'db':
       if (folder.length < 1) {
         log.info('Please enter a valid command, i.e. db:create|db:drop');
       } else {
         internals.mode = folder[1];
-        load('db')(internals, config);
+        report(load('db')(internals, config));
       }
       break;
     case 'seed':
@@ -92,9 +107,9 @@ function run (internals, config) {
         }
 
         internals.argv._.shift();
-        load('undo-seed')(internals, config);
+        report(load('undo-seed')(internals, config));
       } else {
-        load('seed')(internals, config);
+        report(load('seed')(internals, config));
       }
       break;
 

package/lib/commands/seed.js

@@ -1,48 +1,14 @@
 'use strict';
 
-var assert = require('assert');
-var path = require('path');
-var _assert = require('./helper/assert');
-
-function executeSeed (internals, config, callback) {
-  var index = require('../../connect');
-  var Seeder = require('../walker.js');
-
-  if (internals.argv._.length > 0) {
-    internals.argv.destination = internals.argv._.shift().toString();
-  }
-
-  index.connect(
-    {
-      config: config.getCurrent().settings,
-      internals: internals,
-      prefix: 'seed'
-    },
-    Seeder,
-    function (err, seeder) {
-      assert.ifError(err);
-      var seedDir =
-        internals.mode !== 'static' ? 'vcseeder-dir' : 'staticseeder-dir';
-
-      seeder.seedDir = path.resolve(internals.argv[seedDir]);
-
-      if (internals.mode === 'static') {
-        seeder.seed(
-          internals.argv,
-          internals.onComplete.bind(this, seeder, internals, callback)
-        );
-      } else {
-        seeder.createSeedsTable(function (err) {
-          if (_assert(err, callback)) {
-            seeder.seed(
-              internals.argv,
-              internals.onComplete.bind(this, seeder, internals, callback)
-            );
-          }
-        });
-      }
-    }
+/**
+ * Seeders are not part of db-migrate 1.0, their implementation was never
+ * finished. A new concept follows separately, see #687.
+ */
+module.exports = function () {
+  return Promise.reject(
+    new Error(
+      'Seeders are not supported by db-migrate 1.0. The unfinished seeders ' +
+        'of db-migrate 0.11 are still available there.'
+    )
   );
-}
-
-module.exports = executeSeed;
+};

package/lib/commands/set-default-argv.js

@@ -16,7 +16,10 @@ module.exports = function (internals, isModule) {
     'migrations-dir': internals.cwd + '/migrations',
     'vcseeder-dir': internals.cwd + '/VCSeeder',
     'staticseeder-dir': internals.cwd + '/Seeder',
-    'ignore-completed-migrations': false
+    'ignore-completed-migrations': false,
+    'backup-state': false,
+    'lock-timeout': 60000,
+    'lock-interval': 1000
   };
 
   if (!isModule) {
@@ -113,6 +116,19 @@ module.exports = function (internals, isModule) {
       .boolean('ignore-completed-migrations')
       .describe('log-level', 'Set the log-level, for example sql|warn')
       .string('log-level')
+      .describe('backup-state', 'For use with fix, to take a backup of the current state before continuing.')
+      .boolean('backup-state')
+      .describe(
+        'lock-timeout',
+        'Milliseconds without any sign of life after which a migration lock' +
+          ' held by another process is considered stale and taken over.'
+      )
+      .number('lock-timeout')
+      .describe(
+        'lock-interval',
+        'Milliseconds between checks while waiting for the migration lock.'
+      )
+      .number('lock-interval')
       .parse();
   } else {
     internals.argv = Object.assign(defaultConfig, internals.cmdOptions);