db-migrate 1.2.0 → 1.4.0

package/README.md

@@ -10,6 +10,15 @@
 
 Database migration framework for node.js
 
+> **New: [db-migrate for meta](https://github.com/db-migrate/meta-db-migrate)**
+>
+> db-migrate rewritten in meta: your program ships with its migrations
+> compiled in, as one binary, no node.js needed to migrate. It uses the same
+> migrations table and the same state as db-migrate, v2 migrations included,
+> so a database migrated by one of them can be carried on by the other.
+>
+> [Try meta-db-migrate](https://github.com/db-migrate/meta-db-migrate)
+
 # Platinum sponsors
 
 [<img src="https://www.wizardtales.com/wzrdtales.png" width="100">](https://www.wizardtales.com)
@@ -67,14 +76,6 @@ db-migrate to use the `tunnel` setting of your database config:
 
     $ npm install db-migrate-plugin-tunnel-ssh
 
-## db-migrate for meta
-
-[meta-db-migrate](https://github.com/db-migrate/meta-db-migrate) is db-migrate
-rewritten in meta: a program ships with its migrations compiled in, as one
-binary. It uses the same migrations table and the same state as db-migrate,
-v2 migrations included, so a database migrated by one of them can be carried
-on by the other.
-
 ## Resources and usage instructions
 
 Please follow the link below, for usage instructions examples and the full

package/api.js

@@ -422,69 +422,50 @@ dbmigrate.prototype = {
   },
 
   /**
-   * Seeds either the static or version controlled seeders, controlled by
-   * the passed mode.
+   * Runs the jobs of background migrations, see lib/work.js for the
+   * options. Returns { done, stop }, done resolves with the jobs done and
+   * failed.
    */
-  seed: function (mode, scope, callback) {
-    var executeSeed = load('seed');
-    if (scope) {
-      this.internals.migrationMode = scope;
-      this.internals.matching = scope;
+  executeWork: function (options) {
+    return load('work')(this.internals, this.config, options);
+  },
+
+  /**
+   * Inserts the rows of the static seeds in seeds-dir, all or the one named,
+   * removing the rows of their earlier runs first.
+   */
+  seed: function (name, callback) {
+    if (typeof name === 'function') {
+      callback = name;
+      name = undefined;
     }
 
-    this.internals.mode = mode || 'vc';
-    return Promise.resolve(executeSeed(this.internals, this.config)).asCallback(
+    this.internals.seedName = name;
+    return Promise.resolve(load('seed')(this.internals, this.config)).asCallback(
       callback
     );
   },
 
   /**
-   * Execute the down function of currently executed seeds.
+   * Removes the rows inserted by the static seeds, all or the one named.
    */
-  undoSeed: function (specification, scope, callback) {
-    var executeUndoSeed = load('undo-seed');
-    if (arguments.length > 0) {
-      if (typeof specification === 'number') {
-        this.internals.argv.count = specification;
-
-        if (scope) {
-          this.internals.migrationMode = scope;
-          this.internals.matching = scope;
-        }
-      } else if (typeof specification === 'string') {
-        this.internals.migrationMode = scope;
-        this.internals.matching = scope;
-      }
+  undoSeed: function (name, callback) {
+    if (typeof name === 'function') {
+      callback = name;
+      name = undefined;
     }
 
+    this.internals.seedName = name;
     return Promise.resolve(
-      executeUndoSeed(this.internals, this.config)
+      load('undo-seed')(this.internals, this.config)
     ).asCallback(callback);
   },
 
   /**
-   * Execute the reset function of currently executed seeds.
+   * Removes the rows inserted by all static seeds.
    */
-  resetSeed: function (specification, scope, callback) {
-    var executeUndoSeed = load('undo-seed');
-    if (arguments.length > 0) {
-      if (typeof specification === 'number') {
-        this.internals.argv.count = specification;
-
-        if (scope) {
-          this.internals.migrationMode = scope;
-          this.internals.matching = scope;
-        }
-      } else if (typeof specification === 'string') {
-        this.internals.migrationMode = scope;
-        this.internals.matching = scope;
-      }
-    }
-
-    this.internals.argv.count = Number.MAX_VALUE;
-    return Promise.resolve(
-      executeUndoSeed(this.internals, this.config)
-    ).asCallback(callback);
+  resetSeed: function (callback) {
+    return this.undoSeed(undefined, callback);
   },
 
   /**

package/lib/commands/generated.js

@@ -17,6 +17,7 @@ const files = {
   "helper/migration-hook": require('./helper/migration-hook.js'),
   "helper/register-events": require('./helper/register-events.js'),
   "helper/scopes": require('./helper/scopes.js'),
+  "helper/seeder": require('./helper/seeder.js'),
   "index": require('./index.js'),
   "on-complete": require('./on-complete.js'),
   "run": require('./run.js'),
@@ -24,7 +25,8 @@ const files = {
   "set-default-argv": require('./set-default-argv.js'),
   "sync": require('./sync.js'),
   "undo-seed": require('./undo-seed.js'),
-  "up": require('./up.js')
+  "up": require('./up.js'),
+  "work": require('./work.js')
 }
 
 function register (module) {

package/lib/commands/helper/seeder.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const Seed = require('../../seed');
+
+/**
+ * Connects like the migrations do, the seeds need the schema of the state
+ * to know the tables they can insert into.
+ */
+module.exports = async function (internals, config, action) {
+  const Migrator = require('../../walker.js');
+  const index = require('../../../connect');
+
+  const migrator = await index.connect(
+    {
+      config: config.getCurrent().settings,
+      internals: internals,
+      prefix: 'migration'
+    },
+    Migrator
+  );
+
+  try {
+    await migrator.createMigrationsTable();
+    await Seed[action](migrator, internals.seedName);
+    return internals.onComplete(migrator, internals);
+  } catch (err) {
+    return internals.onComplete(migrator, internals, err);
+  }
+};

package/lib/commands/run.js

@@ -97,21 +97,19 @@ function run (internals, config) {
         report(load('db')(internals, config));
       }
       break;
-    case 'seed':
-      internals.mode = folder[1] || 'vc';
-      internals.migrationMode = folder[2];
+    case 'seed': {
+      // seed [name], seed down [name], seed reset
+      const args = internals.argv._.map(String);
+      const undo = args[0] === 'down' || args[0] === 'reset';
 
-      if (internals.argv._[0] === 'down' || internals.argv._[0] === 'reset') {
-        if (internals.argv._[0] === 'reset') {
-          internals.argv.count = Number.MAX_VALUE;
-        }
-
-        internals.argv._.shift();
-        report(load('undo-seed')(internals, config));
-      } else {
-        report(load('seed')(internals, config));
+      if (undo) {
+        args.shift();
       }
+
+      internals.seedName = args[0];
+      report(load(undo ? 'undo-seed' : 'seed')(internals, config));
       break;
+    }
 
     default:
       var plugins = internals.plugins;
@@ -125,7 +123,7 @@ function run (internals, config) {
         );
       } else {
         log.error(
-          'Invalid Action: Must be [up|down|check|create|reset|sync|db].'
+          'Invalid Action: Must be [up|down|check|create|reset|sync|db|seed].'
         );
         yargs.showHelp();
         process.exit(1);

package/lib/commands/seed.js

@@ -1,14 +1,10 @@
 'use strict';
 
+const seeder = require('./helper/seeder');
+
 /**
- * Seeders are not part of db-migrate 1.0, their implementation was never
- * finished. A new concept follows separately, see #687.
+ * Inserts the rows of the static seeds, removing those of earlier runs.
  */
-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 = function (internals, config) {
+  return seeder(internals, config, 'run');
 };

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

@@ -16,6 +16,7 @@ module.exports = function (internals, isModule) {
     'migrations-dir': internals.cwd + '/migrations',
     'vcseeder-dir': internals.cwd + '/VCSeeder',
     'staticseeder-dir': internals.cwd + '/Seeder',
+    'seeds-dir': internals.cwd + '/seeds',
     'ignore-completed-migrations': false,
     'backup-state': false,
     'lock-timeout': 60000,
@@ -26,7 +27,7 @@ module.exports = function (internals, isModule) {
     internals.argv = yargs
       .default(defaultConfig)
       .usage(
-        'Usage: db-migrate [up|down|check|reset|sync|create|db] ' +
+        'Usage: db-migrate [up|down|check|reset|sync|create|db|seed] ' +
           '[[dbname/]migrationName|all] [options]'
       )
       .describe(
@@ -111,6 +112,8 @@ module.exports = function (internals, isModule) {
       .string('vcseeder-dir')
       .describe('staticseeder-dir', 'Set the path to the Seeder directory.')
       .string('staticseeder-dir')
+      .describe('seeds-dir', 'Set the path to the directory of the seeds.')
+      .string('seeds-dir')
       .describe('non-transactional', 'Explicitly disable transactions')
       .boolean('non-transactional')
       .describe('ignore-completed-migrations', 'Start at the first migration')

package/lib/commands/undo-seed.js

@@ -1,14 +1,10 @@
 'use strict';
 
+const seeder = require('./helper/seeder');
+
 /**
- * Seeders are not part of db-migrate 1.0, their implementation was never
- * finished. A new concept follows separately, see #687.
+ * Removes the rows inserted by the static seeds.
  */
-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 = function (internals, config) {
+  return seeder(internals, config, 'undo');
 };

package/lib/commands/work.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const migrationHook = require('./helper/migration-hook.js');
+const executeWork = require('../work');
+
+/**
+ * Runs the jobs of background migrations, returns { done, stop }.
+ */
+module.exports = function (internals, config, options) {
+  let worker = null;
+  let stopped = false;
+
+  const done = Promise.resolve(migrationHook(internals)).then(() => {
+    if (stopped) {
+      return { done: [], failed: [] };
+    }
+
+    worker = executeWork(internals, config, options);
+    return worker.done;
+  });
+
+  return {
+    done,
+    stop: () => {
+      stopped = true;
+      if (worker) {
+        worker.stop();
+      }
+
+      return done;
+    }
+  };
+};