Replace migration mechanism

Old migration mechanism removed due to incompatibility issues.

New npm task 'create-migration' added  to set up new migrations

All existing migrations have been updated to use the new module (and renamed for consistency).

Author: taylortom

conf/migrations.js

@@ -0,0 +1,6 @@
+module.exports = {
+  migrationsDir: "migrations",
+  changelogCollectionName: "changelog",
+  migrationFileExtension: ".js",
+  useFileHash: false
+};

install.js

@@ -316,7 +316,7 @@ function start() {
       createMasterTenant,
       createSuperUser,
       buildFrontend,
-      syncMigrations
+      installHelpers.runMigrations
     ], function(error, results) {
       if(error) {
         console.error('ERROR: ', error);
@@ -517,18 +517,6 @@ function buildFrontend(callback) {
   });
 }
 
-//As this is a fresh install we dont need to run the migrations so add them to the db and set them to up
-function syncMigrations(callback) {
-  installHelpers.syncMigrations(function(err, migrations) {
-    database.getDatabase(function(err, db) {
-      if(err) {
-        return callback(err);
-      }
-      db.update('migration', {}, {'state': 'up'}, callback)
-    }, masterTenant._id)
-  });
-}
-
 // helper functions
 
 function addConfig(newConfigItems) {

lib/application.js

@@ -364,9 +364,10 @@ Origin.prototype.startServer = function (options) {
         app.router = router(app);
         // handle different server states
         app.emit(serverOptions.minimal ? "minimalServerStarted" : "serverStarted", app.server);
-        if(!options.skipStartLog) {
-          logger.log('info', `Server started listening on port ${port}`);
-        }
+
+        runMigrations().then(() => {
+          if(!options.skipStartLog) logger.log('info', `Server started listening on port ${port}`);
+        });
         var writeRebuildFile = function(courseFolder, callback) {
           var OutputConstants = require('./outputmanager').Constants;
           var buildFolder = path.join(courseFolder, OutputConstants.Folders.Build);
@@ -398,6 +399,19 @@ Origin.prototype.startServer = function (options) {
   });
 };
 
+async function runMigrations() {
+  try {
+    const collections = await app.db.conn.db.collections();
+    if(!collections.find(c => c.collectionName === 'changelog')) {
+      logger.log('info', 'Need to run migrations. This is a one-time task.');
+      await installHelpers.runMigrations();
+      logger.log('info', 'Migrations run successfully');
+    }
+  } catch(e) {
+    logger.log('error', e);
+  }
+}
+
 Origin.prototype.restartServer = function () {
   var app = this;
   if (app._httpServer) {

lib/installHelpers.js

@@ -9,7 +9,6 @@ var inquirer = require('inquirer');
 var logger = require('./logger');
 var logUpdate = require('log-update');
 var mailer = require('./mailer');
-var migrateMongoose = require('migrate-mongoose');
 var optimist = require('optimist');
 var path = require('path');
 var request = require('request');
@@ -71,8 +70,7 @@ var exports = module.exports = {
   getInstalledVersions,
   getLatestVersions,
   getUpdateData,
-  getMigrationConfig,
-  syncMigrations,
+  runMigrations,
   installFramework,
   updateFramework,
   cloneRepo,
@@ -313,38 +311,29 @@ function getFrameworkRoot() {
   return path.join(configuration.serverRoot, 'temp', configuration.getConfig('masterTenantID'), 'adapt_framework');
 }
 
-function getMigrationConfig(callback) {
-  var confPath = path.join(configuration.serverRoot, 'conf', 'migrate.json');
-  fs.readJson(confPath, callback);
+async function runMigrations(callback) {
+  const { config, up } = require('migrate-mongo');
+  let data;
+  try {
+    config.set(require(path.resolve(__dirname, '..', 'conf', 'migrations.js')));
+    const { db, client } = await getAppDbConnection();
+    data = await up(db, client);
+  } catch(e) {
+    if(callback) return callback(e);
+    throw e;
+  }
+  if(callback) callback(null, data);
+  return data;
 }
 
-/**
- * Adds all migrations to the DB in a down state
- * @param callback
- */
-function syncMigrations(callback) {
-  getMigrationConfig(function(err, config) {
-    if(err){
-      return callback(err)
+const getAppDbConnection = () => {
+  return new Promise(resolve => {
+    const app = require(path.resolve(__dirname, 'application'))();
+    if(!!app._httpServer) {
+      return resolve(app.db.conn);
     }
-
-    fs.ensureDir(config.migrationsDir, function(err) {
-      if(err){
-        return callback(err)
-      }
-
-      var migrator = new migrateMongoose({
-        migrationsPath: config.migrationsDir,
-        dbConnectionUri: config.dbConnectionUri,
-        autosync: true
-      });
-
-      migrator.sync()
-        .then(
-          function(value) { return callback(null, value) },
-          function(reason) { return callback(reason); }
-        )
-    });
+    app.on('serverStarted', () => resolve(app.db.conn));
+    app.run({ skipVersionCheck: true, skipDependencyCheck: true });
   });
 }
 

migrations/20181108112051-purgesessions.js

@@ -0,0 +1,11 @@
+/** 
+ * Removes all old sessions from the database
+ */
+ module.exports = {
+  async up(db, client) {
+    try {
+      await db.dropCollection('sessions');
+    } catch(e) {}
+  },
+  async down(db, client) {}
+};

migrations/20190411153144-replacepurgedroles.js

@@ -0,0 +1,27 @@
+/**
+ * The following roles have been removed: Product Manager, Course Creator
+ * Any existing users with these roles will be mapped to Tenant Admin and Super Admin respectively.
+ */
+module.exports = {
+  async up(db, client) {
+    const roles = db.collection('roles');
+    const users = db.collection('users');
+    const replacements = [
+      ['Product Manager', 'Course Creator'], 
+      ['Tenant Admin', 'Super Admin']
+    ];
+    await Promise.all(replacements.map(async ([oldName, newName]) => {
+      const [oldRole, newRole] = await Promise.all([ roles.find({ name: oldName }), roles.find({ name: newName }) ]);
+      if(!oldRole) {
+        return;
+      }
+      if(!newRole) {
+        throw new Error(`Db must define the ${newRole} to replace ${oldRole}`);
+      }
+      await users.updateMany({ roles: { $in: [oldRole._id] } }, { $set: { roles: [newRole._id] } });
+      await roles.deleteOne({ name: oldName });
+    }));
+  },
+
+  async down(db, client) {}
+};

migrations/20220908105711-convertarialabels.js

@@ -0,0 +1,43 @@
+const origin = require('../lib/application');
+/** 
+ * Converts all config._ariaLevels properties to new number format
+ * Removes any content items which use the _ariaLevel override default value of 0 (any non-zero values are left)
+ */
+module.exports = {
+  async up(db, client) {
+    const collection = db.collection('configs');
+    const oldDefaults = {
+      _menu: 1,
+      _menuGroup: 2,
+      _menuItem: 2,
+      _page: 1,
+      _article: 2,
+      _block: 3,
+      _component: 4,
+      _componentItem: 5,
+      _notify: 1,
+    };
+    const props = origin().db.getModel('config')?.schema?.tree?._accessibility?._ariaLevels?.properties;
+    if(!props) {
+      throw new Error(`Couldn't parse ARIA level defaults`);
+    }
+    const newDefaults = Object.entries(props).reduce((m, [k, v]) => Object.assign(m, { [k]: v.default }), {});
+    const configs = await (collection.find().toArray());
+
+    await Promise.all(configs.map(async c => {
+      if(!c?._accessibility?._ariaLevels) {
+        return;
+      }
+      const levels = c._accessibility._ariaLevels;
+      Object.entries(levels).forEach(([k, v]) => levels[k] = (v === oldDefaults[k]) ? newDefaults[k] : v.toString());
+      return collection.updateOne({ _id: c._id }, { $set: c });
+    }));
+
+    await Promise.all(['contentobjects', 'articles', 'blocks', 'components'].map(c => {
+      const collection = db.collection(c);
+      return collection.updateMany({ _ariaLevel: 0 }, { $set: { _ariaLevel: "" } });
+    }));
+  },
+
+  async down(db, client) {}
+};

migrations/20220908162037-purgemigrations.js

@@ -0,0 +1,11 @@
+/** 
+ * Removes the deprecated migrations database collection
+ */
+module.exports = {
+  async up(db, client) {
+    try {
+      await db.dropCollection('migrations');
+    } catch(e) {}
+  },
+  async down(db, client) {}
+};