db-migrate 1.0.0-beta.3 → 1.0.0-beta.31

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
 

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')();
@@ -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');
 
@@ -320,13 +345,6 @@ dbmigrate.prototype = {
     return log.silence(isSilent);
   },
 
-  /**
-   * Transition migrations to the latest defined protocol.
-   */
-  transition: function () {
-    load('transition')(this.internals);
-  },
-
   /**
    * Creates a correctly formatted migration
    */

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,7 +82,7 @@ exports.connect = function (config, PassedClass) {
               null,
               new PassedClass(
                 db,
-                internals.argv['migrations-dir'],
+                dirPath,
                 internals.mode !== 'static',
                 internals,
                 prefix
@@ -100,6 +113,7 @@ exports.connect = function (config, PassedClass) {
                 db,
                 oldClose,
                 prefix,
+                db2,
                 cb
               );
             };
@@ -112,10 +126,11 @@ exports.connect = function (config, PassedClass) {
           null,
           new PassedClass(
             db,
-            internals.argv['migrations-dir'],
+            dirPath,
             internals.mode !== 'static',
             internals,
-            prefix
+            prefix,
+            { db2 }
           )
         );
       }
@@ -142,6 +157,7 @@ function migrationFiles (
   db,
   close,
   prefix,
+  db2,
   cb
 ) {
   var file;
@@ -187,7 +203,8 @@ function migrationFiles (
         internals.argv['migrations-dir'],
         internals.mode !== 'static',
         internals,
-        prefix
+        prefix,
+        { db2 }
       )
     );
 

package/lib/chain.js

@@ -1,4 +1,3 @@
-const Promise = require('bluebird');
 const DEFAULT = [
   'renameCollection',
   'dropCollection',
@@ -16,12 +15,66 @@ const DEFAULT = [
   'removeForeignKey'
 ];
 
+let rollbackCounter = 0;
+let rollbackSignal = null;
+let signal = null;
+let counter = 0;
+
+const dbmControl = {
+  inc: () => {
+    ++counter;
+  },
+
+  signal: () => {
+    signal = true;
+  },
+
+  hasSignaled: () => {
+    return signal;
+  },
+
+  previousSignal: () => {
+    const r = rollbackSignal;
+    // we reset on retrieval and mark as retrieved
+    rollbackSignal = rollbackSignal === null ? null : false;
+    return r;
+  },
+
+  get: () => {
+    return counter;
+  },
+
+  getPrevious: () => {
+    const r = rollbackCounter;
+
+    // we reset on retrieval and mark as retrieved
+    rollbackCounter = rollbackCounter > 0 ? false : 0;
+
+    return r;
+  }
+};
+
 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;
+      this.udriver._dbmControl = true;
+      const runSql = this.udriver.runSql;
+      this.udriver._dbmControlRSQL = runSql;
+
+      // couple runSql
+      this.udriver.runSql = function (...args) {
+        return runSql.apply(this, args).then(x => {
+          ++counter;
+          return x;
+        });
+      };
+    }
     this.internals = internals;
     this.chains = [];
     this.interfaces = [];
@@ -32,20 +85,23 @@ class Chain {
     DEFAULT.concat(Object.keys(this.context.learnable || [])).forEach(
       method => {
         this[method] = function (...args) {
-          let cb = args.pop();
-          if (typeof cb !== 'function') {
-            args.push(cb);
-            cb = undefined;
-          }
-
-          return Promise.resolve(
-            this.exec.apply(this, [method].concat(args))
-          ).asCallback(cb);
+          // we don't handle any callbacks here, v2 ultimately deprecates them
+
+          this.transferInt();
+
+          return this.exec.apply(this, [method].concat(args));
         };
       }
     );
   }
 
+  transferInt () {
+    rollbackCounter = counter;
+    counter = 0;
+    rollbackSignal = signal;
+    signal = null;
+  }
+
   addChain (chain) {
     this.chains.push(chain);
   }
@@ -58,7 +114,8 @@ class Chain {
         this.context,
         this.file,
         this.udriver,
-        this.internals
+        this.internals,
+        this.pdriver
       );
     }
 
@@ -81,6 +138,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

@@ -5,18 +5,38 @@ 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 mkdirp(dir);
   }
 
-  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) {
@@ -82,8 +102,9 @@ async function executeCreateMigration (internals, config) {
     templateType = Migration.TemplateType.SQL_FILE_LOADER;
   } else if (shouldCreateCoffeeFile(internals, config)) {
     templateType = Migration.TemplateType.DEFAULT_COFFEE;
+  } else if (shouldCreateV2File(internals, config)) {
+    templateType = Migration.TemplateType.V2_DEFAULT;
   }
-
   if (plugins) {
     hooks = plugins.hook('create:template') || [];
   }
@@ -173,6 +194,10 @@ function shouldCreateCoffeeFile (internals, config) {
   return internals.argv['coffee-file'] || config['coffee-file'];
 }
 
+function shouldCreateV2File (internals, config) {
+  return internals.argv['v2-file'] || config['v2-file'];
+}
+
 async function createSqlFiles (internals, config) {
   let migrationsDir = internals.argv['migrations-dir'];
 

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/dump.js

@@ -0,0 +1,22 @@
+const path = require('path');
+const log = require('db-migrate-shared').log;
+
+async function prepare (internals, config) {
+  const index = require('../../connect');
+
+  return index.driver({
+    config: config.getCurrent().settings,
+    internals: internals
+  });
+}
+
+module.exports = async function (internals, config) {
+  const driver = await prepare(internals, config);
+
+  try {
+    const res = await driver.backupGet(internals.argv);
+    return internals.onComplete(driver, internals, null, res);
+  } catch (err) {
+    return internals.onComplete(driver, internals, err);
+  }
+};

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

@@ -8,6 +8,8 @@ const files = {
   "create-migration": require('./create-migration.js'),
   "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'),
@@ -20,7 +22,6 @@ const files = {
   "seed": require('./seed.js'),
   "set-default-argv": require('./set-default-argv.js'),
   "sync": require('./sync.js'),
-  "transition": require('./transition.js'),
   "undo-seed": require('./undo-seed.js'),
   "up": require('./up.js')
 }

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

@@ -4,11 +4,13 @@ var log = require('db-migrate-shared').log;
 
 function registerEvents () {
   process.on('uncaughtException', function (err) {
+    log.error('uncaughtException');
     log.error(err.stack || err);
     process.exit(1);
   });
 
   process.on('unhandledRejection', function (reason) {
+    log.error('unhandledRejection');
     log.error(reason.stack || reason);
     process.exit(1);
   });

package/lib/commands/run.js

@@ -5,16 +5,12 @@ var yargs = require('yargs');
 
 function run (internals, config) {
   const { load } = internals;
-  const transition = load('transition');
   var action = internals.argv._.shift();
   var folder = action.split(':');
 
   action = folder[0];
 
   switch (action) {
-    case 'transition':
-      transition(internals);
-      break;
     case 'create':
       if (folder[1]) {
         internals.matching = folder[1];
@@ -40,6 +36,7 @@ function run (internals, config) {
 
       executeSync(internals, config);
       break;
+    case 'fix':
     case 'up':
     case 'down':
     case 'reset':
@@ -62,6 +59,9 @@ function run (internals, config) {
       if (action === 'up') {
         var executeUp = load('up');
         executeUp(internals, config);
+      } else if (action === 'fix') {
+        var executeFix = load('fix');
+        executeFix(internals, config);
       } else {
         var executeDown = load('down');
         executeDown(internals, config);
@@ -114,8 +114,7 @@ function run (internals, config) {
         );
       } else {
         log.error(
-          'Invalid Action: Must be [up|down|check|create|reset|sync|' +
-            'db|transition].'
+          'Invalid Action: Must be [up|down|check|create|reset|sync|db].'
         );
         yargs.showHelp();
         process.exit(1);

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

@@ -16,14 +16,15 @@ 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
   };
 
   if (!isModule) {
     internals.argv = yargs
       .default(defaultConfig)
       .usage(
-        'Usage: db-migrate [up|down|check|reset|sync|create|db|transition] ' +
+        'Usage: db-migrate [up|down|check|reset|sync|create|db] ' +
           '[[dbname/]migrationName|all] [options]'
       )
       .describe(
@@ -64,6 +65,8 @@ module.exports = function (internals, isModule) {
       .boolean('version')
       .describe('config', 'Location of the database.json file.')
       .string('config')
+      .describe('v2-file', 'Create v2 schema migration')
+      .boolean('v2-file')
       .describe(
         'sql-file',
         'Automatically create two sql files for up and down statements in ' +
@@ -111,6 +114,8 @@ 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')
       .parse();
   } else {
     internals.argv = Object.assign(defaultConfig, internals.cmdOptions);

package/lib/commands/sync.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/up.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');