db-migrate 1.0.0-beta.2 → 1.0.0-beta.21

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,5 +1,5 @@
 [![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)
+[![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)
 [![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)
 [![Documentation Status](https://readthedocs.org/projects/db-migrate/badge/?version=latest)](https://readthedocs.org/projects/db-migrate/?badge=latest)
@@ -31,20 +31,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 DB-Migrate is now available to you via:
 
     $ db-migrate
-    
-
-## Live support
-
-### Get help
-
-If you have an urgent problem, hire a mentor for a 1:1 live session on Git-Start:
-[![Get 1:1 live support for your issue.](https://git-start.com/assets/git-start-mentee-banner-medium.svg?sanitize=true)](https://git-start.com/help-request/create/db-migrate%2Fnode-db-migrate)
-
-### Provide help
-
-Help others in paid 1:1 live sessions to get started.
-[![Give paid 1:1 live support.](https://git-start.com/assets/git-start-mentor-banner-medium.svg?sanitize=true)](https://git-start.com/help-request/overview/db-migrate%2Fnode-db-migrate)
-
 
 ### As local module
 

package/api.js

@@ -1,10 +1,12 @@
 'use strict';
 
-var load = require('./lib/commands');
+module.exports.version = require('./package.json').version;
+
+let load;
 var log = require('db-migrate-shared').log;
-require('pkginfo')(module, 'version'); // jshint ignore:line
 var Promise;
-var onComplete = load('on-complete');
+let onComplete;
+var config = require('rc')('db-migrate');
 
 // constant hooks for this file
 var APIHooks = {
@@ -17,12 +19,18 @@ var APIHooks = {
 };
 
 function dbmigrate (plugins, isModule, options, callback) {
+  if (!options.staticLoader) load = require('./lib/commands');
+  else load = require('./lib/commands/generated.js');
+
+  onComplete = load('on-complete');
+
   var dotenv = require('dotenv');
   var setDefaultArgv = load('set-default-argv');
 
   this.internals = {
     onComplete: onComplete,
-    migrationProtocol: 1
+    migrationProtocol: 1,
+    load
   };
   if (typeof isModule !== 'function') {
     this.internals.isModule = isModule;
@@ -37,9 +45,12 @@ function dbmigrate (plugins, isModule, options, callback) {
   this.internals.dbm = require('./');
   this.dataType = this.internals.dbm.dataType;
   this.version = this.internals.dbm.version;
-  dotenv.load({
-    silent: true
-  });
+
+  var dotenvConfig = { silent: true };
+  if (config.dotenvCustomPath) {
+    dotenvConfig.path = config.dotenvCustomPath;
+  }
+  dotenv.load(dotenvConfig);
 
   /* $lab:coverage:off$ */
   if (!options || !options.throwUncatched) load('helper/register-events')();
@@ -214,6 +225,9 @@ dbmigrate.prototype = {
     if (arguments.length > 0) {
       if (typeof specification === 'number') {
         this.internals.argv.count = arguments[0];
+      } else if (typeof specification === 'string') {
+        this.internals.argv.destination = specification;
+        this.internals.argv.count = Number.MAX_VALUE;
       } else if (typeof specification === 'function') {
         callback = specification;
       }
@@ -306,13 +320,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
    */
@@ -325,7 +332,7 @@ dbmigrate.prototype = {
       this.internals.matching = scope;
     }
 
-    this.internals.argv._.push(migrationName);
+    this.internals.argv._.unshift(migrationName);
     return Promise.resolve(
       executeCreateMigration(this.internals, this.config)
     ).asCallback(callback);

package/connect.js

@@ -25,10 +25,10 @@ exports.connect = function (config, PassedClass) {
         return;
       }
 
+      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,7 +56,7 @@ exports.connect = function (config, PassedClass) {
                 null,
                 new PassedClass(
                   db,
-                  internals.argv['migrations-dir'],
+                  dirPath,
                   internals.mode !== 'static',
                   internals,
                   prefix
@@ -69,7 +69,7 @@ exports.connect = function (config, PassedClass) {
               null,
               new PassedClass(
                 db,
-                internals.argv['migrations-dir'],
+                dirPath,
                 internals.mode !== 'static',
                 internals,
                 prefix
@@ -112,7 +112,7 @@ exports.connect = function (config, PassedClass) {
           null,
           new PassedClass(
             db,
-            internals.argv['migrations-dir'],
+            dirPath,
             internals.mode !== 'static',
             internals,
             prefix

package/index.js

@@ -1,4 +1,5 @@
-require('pkginfo')(module, 'version'); // jshint ignore:line
+module.exports.version = require('./package.json').version;
+
 var fs = require('fs');
 var path = require('path');
 var log = require('db-migrate-shared').log;
@@ -46,15 +47,14 @@ function loadPlugins (options) {
   for (; i < length; ++i) {
     var plugin = require(path.join(options.cwd, 'node_modules', plugins[i]));
 
-    if (
-      typeof plugin.name !== 'string' ||
-      !plugin.hooks ||
-      !plugin.loadPlugin
-    ) {
+    if (!plugin.hooks || !plugin.loadPlugin) {
       continue;
     }
 
-    plugin.hooks.map(function (hook) {
+    // name is now derived from package name
+    plugin.name = plugins[i];
+
+    plugin.hooks.forEach(function (hook) {
       hooks[hook] = hooks[hook] || [];
       hooks[hook].push(plugin);
     });
@@ -63,15 +63,12 @@ function loadPlugins (options) {
   return hooks;
 }
 
-module.exports.getInstance = function (
-  isModule,
-  options = { cwd: process.cwd() },
-  callback
-) {
+module.exports.getInstance = function (isModule, options = {}, callback) {
   delete require.cache[require.resolve('./api.js')];
-  delete require.cache[require.resolve('optimist')];
+  delete require.cache[require.resolve('yargs')];
   var Mod = require('./api.js');
   var plugins = {};
+  options.cwd = options.cwd || process.cwd();
 
   try {
     if (!options || !options.noPlugins) plugins = loadPlugins(options);

package/lib/chain.js

@@ -1,4 +1,3 @@
-const Promise = require('bluebird');
 const DEFAULT = [
   'renameCollection',
   'dropCollection',
@@ -16,12 +15,65 @@ 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) {
     this.file = file;
     this.context = context;
     this.driver = context;
     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 +84,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);
   }
@@ -72,7 +127,7 @@ class Chain {
 
   async exec (m, ...args) {
     let ret;
-    let stat = [];
+    const stat = [];
     while (this.step()) {
       ret = await this._interface[m].apply(this._interface, args);
       stat.push(ret);

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,23 +5,47 @@ const log = require('db-migrate-shared').log;
 const mkdirp = Promise.promisify(require('mkdirp'));
 const fs = require('fs');
 const stat = Promise.promisify(fs.stat);
-const optimist = require('optimist');
+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) {
   let migrationsDir = internals.argv['migrations-dir'];
-  let folder, path;
+  let path;
+  let hooks = false;
+  let pluginTemplate = false;
+  let customWrite = false;
+  const { plugins } = internals;
 
   internals.runTimestamp = new Date();
 
@@ -33,25 +57,18 @@ async function executeCreateMigration (internals, config) {
   if (internals.argv._.length === 0) {
     log.error("'migrationName' is required.");
     if (!internals.isModule) {
-      optimist.showHelp();
+      yargs.showHelp();
     }
 
     throw new Error("'migrationName' is required.");
   }
 
-  try {
-    await createMigrationDir(migrationsDir);
-  } catch (err) {
-    log.error('Failed to create migration directory at ', migrationsDir, err);
-    throw new Error('Failed to create migration directory.');
-  }
-
   const Migration = require('../template.js');
 
   internals.argv.title = internals.argv._.shift();
-  folder = internals.argv.title.split('/');
+  const folder = internals.argv.title.toString().split('/');
 
-  internals.argv.title = folder[folder.length - 2] || folder[0];
+  internals.argv.title = folder[folder.length - 1] || folder[0];
   path = migrationsDir;
 
   if (folder.length > 1) {
@@ -61,6 +78,14 @@ async function executeCreateMigration (internals, config) {
       path += folder[i] + '/';
     }
   }
+  internals.argv['migrations-dir'] = path;
+
+  try {
+    await createMigrationDir(path);
+  } catch (err) {
+    log.error('Failed to create migration directory at ', migrationsDir, err);
+    throw new Error('Failed to create migration directory.');
+  }
 
   let templateType = Migration.TemplateType.DEFAULT_JS;
   if (
@@ -77,19 +102,81 @@ 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;
   }
-  const migration = new Migration(
-    internals.argv.title +
-      (shouldCreateCoffeeFile(internals, config) ? '.coffee' : '.js'),
-    path,
-    internals.runTimestamp,
-    templateType
-  );
+  if (plugins) {
+    hooks = plugins.hook('create:template') || [];
+  }
+
+  if (hooks !== false) {
+    for (const plugin of hooks) {
+      const template = plugin['init:template']();
+
+      if (internals.argv[template.option] || config[template.option]) {
+        pluginTemplate = plugin;
+        customWrite = plugin['create:template:custom:write'] === true;
+
+        if (customWrite) {
+          templateType = `${plugin.name}${templateType}`;
+        } else {
+          templateType = template.type;
+        }
+
+        // no reason to continue processing here
+        break;
+      }
+    }
+  }
+
+  if (!pluginTemplate && !customWrite) {
+    const migration = new Migration(
+      internals.argv.title +
+        (shouldCreateCoffeeFile(internals, config) ? '.coffee' : '.js'),
+      path,
+      internals.runTimestamp,
+      templateType,
+      internals.plugins
+    );
+
+    await migration.write();
+    log.info(util.format('Created migration at %s', migration.file.path));
+    if (shouldCreateSqlFiles(internals, config)) {
+      return createSqlFiles(internals, config);
+    }
+  } else {
+    const plugin = pluginTemplate;
 
-  await migration.write();
-  log.info(util.format('Created migration at %s', migration.file.path));
-  if (shouldCreateSqlFiles(internals, config)) {
-    return createSqlFiles(internals, config);
+    if (typeof plugin['write:template'] !== 'function') {
+      log.error(`Plugin ${plugin.name} does not have function write:template`);
+      throw new Error(`write:template not existent!`);
+    }
+
+    await plugin['write:template'](
+      { argv: { ...internals.argv }, config: { ...config } },
+      async opts => {
+        let title = internals.argv.title;
+        let _path = path;
+        const extension = opts.extension || '.js';
+
+        if (opts.suffix) {
+          title += opts.suffix;
+        }
+
+        if (opts.pathExtension) {
+          _path += opts.pathExtension;
+        }
+
+        const migration = new Migration(
+          title + extension,
+          _path,
+          internals.runTimestamp,
+          opts.type,
+          internals.plugins
+        );
+        await migration.write();
+      }
+    );
   }
 
   return Promise.resolve();
@@ -107,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'];
 
@@ -126,12 +217,13 @@ async function createSqlFiles (internals, config) {
 
   const Migration = require('../template.js');
 
-  let templateTypeDefaultSQL = Migration.TemplateType.DEFAULT_SQL;
+  const templateTypeDefaultSQL = Migration.TemplateType.DEFAULT_SQL;
   const migrationUpSQL = new Migration(
     internals.argv.title + '-up.sql',
     sqlDir,
     internals.runTimestamp,
-    templateTypeDefaultSQL
+    templateTypeDefaultSQL,
+    internals.plugins
   );
   await migrationUpSQL.write();
 
@@ -143,7 +235,8 @@ async function createSqlFiles (internals, config) {
     internals.argv.title + '-down.sql',
     sqlDir,
     internals.runTimestamp,
-    templateTypeDefaultSQL
+    templateTypeDefaultSQL,
+    internals.plugins
   );
   migrationDownSQL.write();
   log.info(

package/lib/commands/db.js

@@ -13,6 +13,8 @@ function executeDB (internals, config, callback) {
     return;
   }
 
+  delete config.getCurrent().settings.database;
+
   index.driver(config.getCurrent().settings, function (err, db) {
     assert.ifError(err);
 

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

@@ -0,0 +1,32 @@
+
+'use strict';
+
+const path = require('path');
+
+const files = {
+  "check": require('./check.js'),
+  "create-migration": require('./create-migration.js'),
+  "db": require('./db.js'),
+  "down": require('./down.js'),
+  "dump": require('./dump.js'),
+  "fn/plugin": require('./fn/plugin.js'),
+  "generated": require('./generated.js'),
+  "helper/assert": require('./helper/assert.js'),
+  "helper/load-config": require('./helper/load-config.js'),
+  "helper/migration-hook": require('./helper/migration-hook.js'),
+  "helper/register-events": require('./helper/register-events.js'),
+  "index": require('./index.js'),
+  "on-complete": require('./on-complete.js'),
+  "run": require('./run.js'),
+  "seed": require('./seed.js'),
+  "set-default-argv": require('./set-default-argv.js'),
+  "sync": require('./sync.js'),
+  "undo-seed": require('./undo-seed.js'),
+  "up": require('./up.js')
+}
+
+function register (module) {
+  return files[module];
+}
+
+module.exports = register;

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);
   });