feat: allow instantiation of instance to call methods with config set via api

Author: powderham

.gitignore

@@ -7,4 +7,10 @@ node_modules
 
 # Istanbul test coverage
 coverage
-.nyc_output
+.nyc_output
+
+// .npmignore
+/src
+
+*.log
+/node_modules

bin/migrate-mongo.js

@@ -33,7 +33,7 @@ program
       .init()
       .then(() =>
         console.log(
-          `Initialization successful. Please edit the generated \`${migrateMongo.config.getConfigFilename()}\` file`
+          `Initialization successful. Please edit the generated \`${migrateMongo.configFile.getConfigFilename()}\` file`
         )
       )
       .catch(err => handleError(err))
@@ -48,7 +48,7 @@ program
     migrateMongo
       .create(description)
       .then(fileName => 
-        migrateMongo.config.read().then(config => {
+        migrateMongo.configFile.read().then(config => {
           console.log(`Created: ${config.migrationsDir}/${fileName}`);
         })
       )

lib/MigrateMongo.js

@@ -0,0 +1,25 @@
+const up = require("./instance_methods/up");
+const down = require("./instance_methods/down");
+const status = require("./instance_methods/status");
+const database = require("./instance_methods/database");
+const validateConfig = require("./utils/validateConfig");
+
+class MigrateMongo {
+  constructor(config) {
+    if (!config) {
+      throw new Error("No config passed to MigrateMongo instance");
+    }
+    validateConfig(config);
+
+    this.config = config;
+
+    const statusWithConfig = status(config);
+
+    this.up = up(config, statusWithConfig);
+    this.down = down(config, statusWithConfig);
+    this.status = statusWithConfig;
+    this.database = database(config);
+  }
+}
+
+module.exports = MigrateMongo;

lib/actions/status.js

@@ -1,11 +1,14 @@
 const { find } = require("lodash");
 const migrationsDir = require("../env/migrationsDir");
 const configFile = require("../env/configFile");
+const getJavaScriptFilesFromPath = require("../utils/getJavaScriptFilesFromPath");
 
 module.exports = async db => {
   await migrationsDir.shouldExist();
   await configFile.shouldExist();
-  const fileNames = await migrationsDir.getFileNames();
+  
+  const migrationsDirPath = migrationsDir.resolveMigrationsDirPath();
+  const fileNames = await getJavaScriptFilesFromPath(migrationsDirPath);
 
   const config = await configFile.read();
   const collectionName = config.changelogCollectionName;

lib/env/database.js

@@ -1,6 +1,7 @@
 const { MongoClient } = require("mongodb");
 const _ = require("lodash");
 const configFile = require("./configFile");
+const validateConfig = require("../utils/validateConfig");
 
 module.exports = {
   async connect() {
@@ -9,21 +10,9 @@ module.exports = {
     const databaseName = _.get(config, "mongodb.databaseName");
     const options = _.get(config, "mongodb.options");
 
-    if (!url) {
-      throw new Error("No `url` defined in config file!");
-    }
+    validateConfig(config);
 
-    if (!databaseName) {
-      throw new Error(
-        "No `databaseName` defined in config file! This is required since migrate-mongo v3. " +
-          "See https://github.com/seppevs/migrate-mongo#initialize-a-new-project"
-      );
-    }
-
-    const client = await MongoClient.connect(
-      url,
-      options
-    );
+    const client = await MongoClient.connect(url, options);
 
     const db = client.db(databaseName);
     db.close = client.close;

lib/env/migrationsDir.js

@@ -1,6 +1,7 @@
 const fs = require("fs-extra");
 const path = require("path");
 const configFile = require("./configFile");
+const getAbsoluteFilePath = require("../utils/getAbsoluteFilePath");
 
 const DEFAULT_MIGRATIONS_DIR_NAME = "migrations";
 
@@ -18,15 +19,14 @@ async function resolveMigrationsDirPath() {
     migrationsDir = DEFAULT_MIGRATIONS_DIR_NAME;
   }
 
-  if (path.isAbsolute(migrationsDir)) {
-    return migrationsDir;
-  }
-  return path.join(process.cwd(), migrationsDir);
+  return getAbsoluteFilePath(migrationsDir);
 }
 
 module.exports = {
   resolve: resolveMigrationsDirPath,
 
+  resolveMigrationsDirPath,
+
   async shouldExist() {
     const migrationsDir = await resolveMigrationsDirPath();
     try {
@@ -52,12 +52,6 @@ module.exports = {
     }
   },
 
-  async getFileNames() {
-    const migrationsDir = await resolveMigrationsDirPath();
-    const files = await fs.readdir(migrationsDir);
-    return files.filter(file => path.extname(file) === ".js");
-  },
-
   async loadMigration(fileName) {
     const migrationsDir = await resolveMigrationsDirPath();
     return require(path.join(migrationsDir, fileName)); // eslint-disable-line

lib/instance_methods/database.js

@@ -0,0 +1,26 @@
+const { MongoClient } = require("mongodb");
+
+const database = config => ({
+  connect: async () => {
+    const { url, databaseName, options } = config.mongodb;
+
+    if (!url) {
+      throw new Error("No `url` defined in config file!");
+    }
+
+    if (!databaseName) {
+      throw new Error(
+        "No `databaseName` defined in config file! This is required since migrate-mongo v3. " +
+          "See https://github.com/seppevs/migrate-mongo#initialize-a-new-project"
+      );
+    }
+
+    const client = await MongoClient.connect(url, options);
+
+    const db = client.db(databaseName);
+    db.close = client.close;
+    return db;
+  }
+});
+
+module.exports = database;

lib/instance_methods/down.js

@@ -0,0 +1,39 @@
+const _ = require("lodash");
+const fnArgs = require("fn-args");
+const { promisify } = require("util");
+const loadMigration = require("../utils/loadMigration");
+
+module.exports = (config, status) => async db => {
+  const downgraded = [];
+  const statusItems = await status(db, config);
+  const appliedItems = statusItems.filter(item => item.appliedAt !== "PENDING");
+  const lastAppliedItem = _.last(appliedItems);
+
+  if (lastAppliedItem) {
+    try {
+      const migration = loadMigration(
+        config.migrationDir,
+        lastAppliedItem.fileName
+      );
+
+      const args = fnArgs(migration.down);
+      const down = args.length > 1 ? promisify(migration.down) : migration.down;
+      await down(db);
+    } catch (err) {
+      throw new Error(
+        `Could not migrate down ${lastAppliedItem.fileName}: ${err.message}`
+      );
+    }
+
+    const collectionName = config.changelogCollectionName;
+    const collection = db.collection(collectionName);
+    try {
+      await collection.deleteOne({ fileName: lastAppliedItem.fileName });
+      downgraded.push(lastAppliedItem.fileName);
+    } catch (err) {
+      throw new Error(`Could not update changelog: ${err.message}`);
+    }
+  }
+
+  return downgraded;
+};

lib/instance_methods/status.js

@@ -0,0 +1,32 @@
+const { find } = require("lodash");
+const getJavaScriptFilesFromPath = require("../utils/getJavaScriptFilesFromPath");
+const getAbsoluteFilePath = require("../utils/getAbsoluteFilePath");
+
+const status = config => async db => {
+  const migrationsDir = getAbsoluteFilePath(config.migrationsDir);
+  const fileNames = await getJavaScriptFilesFromPath(migrationsDir);
+
+  let collectionName = "changelog";
+
+  if (config.changelogCollectionName) {
+    collectionName = config.changelogCollectionName;
+  } else {
+    collectionName = "changelog";
+    console.warn(
+      'No changelogCollectionName found in confg - defaulting to "changelog"'
+    );
+  }
+
+  const collection = db.collection(collectionName);
+  const changelog = await collection.find({}).toArray();
+
+  const statusTable = fileNames.map(fileName => {
+    const itemInLog = find(changelog, { fileName });
+    const appliedAt = itemInLog ? itemInLog.appliedAt.toJSON() : "PENDING";
+    return { fileName, appliedAt };
+  });
+
+  return statusTable;
+};
+
+module.exports = status;

lib/instance_methods/up.js

@@ -0,0 +1,51 @@
+const _ = require("lodash");
+const pEachSeries = require("p-each-series");
+const fnArgs = require("fn-args");
+const { promisify } = require("util");
+const loadMigration = require("../utils/loadMigration");
+
+module.exports = (config, status) => async db => {
+  const statusItems = await status(db, config);
+  const pendingItems = _.filter(statusItems, { appliedAt: "PENDING" });
+  const migrated = [];
+
+  const migrateItem = async item => {
+    try {
+      const migration = loadMigration(config.migrationsDir, item.fileName);
+      const args = fnArgs(migration.up);
+      const up = args.length > 1 ? promisify(migration.up) : migration.up;
+      await up(db);
+    } catch (err) {
+      const error = new Error(
+        `Could not migrate up ${item.fileName}: ${err.message}`
+      );
+      error.migrated = migrated;
+      throw error;
+    }
+
+    let collectionName;
+    if (config.changelogCollectionName) {
+      collectionName = config.changelogCollectionName;
+    } else {
+      collectionName = "changelog";
+      console.warn(
+        'No changelogCollectionName found in confg - defaulting to "changelog"'
+      );
+    }
+
+    const collection = db.collection(collectionName);
+
+    const { fileName } = item;
+    const appliedAt = new Date();
+
+    try {
+      await collection.insertOne({ fileName, appliedAt });
+    } catch (err) {
+      throw new Error(`Could not update changelog: ${err.message}`);
+    }
+    migrated.push(item.fileName);
+  };
+
+  await pEachSeries(pendingItems, migrateItem);
+  return migrated;
+};