refactor: rewrite src/upgrade.js with async/await

src/cli/upgrade.js

@@ -101,7 +101,9 @@ function runUpgrade(upgrades, options) {
 	async.series([
 		db.init,
 		require('../meta').configs.init,
-		async.apply(upgrade.runParticular, upgrades),
+		async function () {
+			await upgrade.runParticular(upgrades);
+		},
 	], function (err) {
 		if (err) {
 			throw err;

src/upgrade.js

@@ -1,47 +1,44 @@
+
 'use strict';
 
-var async = require('async');
+const path = require('path');
-var path = require('path');
+const util = require('util');
-var util = require('util');
+const semver = require('semver');
-var semver = require('semver');
+const readline = require('readline');
-var readline = require('readline');
+const winston = require('winston');
-var winston = require('winston');
 
-var db = require('./database');
+const db = require('./database');
-var file = require('./file');
+const file = require('./file');
 
 /*
  * Need to write an upgrade script for NodeBB? Cool.
  *
- * 1. Copy TEMPLATE to a file name of your choice. Try to be succinct.
+ * 1. Copy TEMPLATE to a unique file name of your choice. Try to be succinct.
  * 2. Open up that file and change the user-friendly name (can be longer/more descriptive than the file name)
  *    and timestamp (don't forget the timestamp!)
  * 3. Add your script under the "method" property
  */
 
-var Upgrade = module.exports;
+const Upgrade = module.exports;
+
+Upgrade.getAll = async function () {
+	let files = await file.walk(path.join(__dirname, './upgrades'));
 
-Upgrade.getAll = function (callback) {
-	async.waterfall([
-		async.apply(file.walk, path.join(__dirname, './upgrades')),
-		function (files, next) {
 	// Sort the upgrade scripts based on version
-			var versionA;
+	files = files.filter(file => path.basename(file) !== 'TEMPLATE').sort(function (a, b) {
-			var versionB;
+		const versionA = path.dirname(a).split(path.sep).pop();
-			setImmediate(next, null, files.filter(file => path.basename(file) !== 'TEMPLATE').sort(function (a, b) {
+		const versionB = path.dirname(b).split(path.sep).pop();
-				versionA = path.dirname(a).split(path.sep).pop();
+		const semverCompare = semver.compare(versionA, versionB);
-				versionB = path.dirname(b).split(path.sep).pop();
-				var semverCompare = semver.compare(versionA, versionB);
 		if (semverCompare) {
 			return semverCompare;
 		}
-				var timestampA = require(a).timestamp;
+		const timestampA = require(a).timestamp;
-				var timestampB = require(b).timestamp;
+		const timestampB = require(b).timestamp;
 		return timestampA - timestampB;
-			}));
+	});
-		},
+
-		async.apply(Upgrade.appendPluginScripts),
+	await Upgrade.appendPluginScripts(files);
-		function (files, next) {
+
 	// check duplicates and error
 	const seen = {};
 	const dupes = [];
@@ -54,41 +51,29 @@ Upgrade.getAll = function (callback) {
 	});
 	if (dupes.length) {
 		winston.error('Found duplicate upgrade scripts\n' + dupes);
-				return next(new Error('[[error:duplicate-upgrade-scripts]]'));
+		throw new Error('[[error:duplicate-upgrade-scripts]]');
 	}
-			next(null, files);
+
-		},
+	return files;
-	], callback);
 };
 
-Upgrade.appendPluginScripts = function (files, callback) {
+Upgrade.appendPluginScripts = async function (files) {
-	async.waterfall([
 	// Find all active plugins
-		async.apply(db.getSortedSetRange.bind(db), 'plugins:active', 0, -1),
+	const plugins = await db.getSortedSetRange('plugins:active', 0, -1);
-
+	plugins.forEach((plugin) => {
-		// Read plugin.json and check for upgrade scripts
+		const configPath = path.join(__dirname, '../node_modules', plugin, 'plugin.json');
-		function (plugins, next) {
-			async.each(plugins, function (plugin, next) {
-				var configPath = path.join(__dirname, '../node_modules', plugin, 'plugin.json');
 		try {
-					var pluginConfig = require(configPath);
+			const pluginConfig = require(configPath);
 			if (pluginConfig.hasOwnProperty('upgrades') && Array.isArray(pluginConfig.upgrades)) {
 				pluginConfig.upgrades.forEach(function (script) {
 					files.push(path.join(path.dirname(configPath), script));
 				});
 			}
-
-					next();
 		} catch (e) {
 			winston.warn('[upgrade/appendPluginScripts] Unable to read plugin.json for plugin `' + plugin + '`. Skipping.');
-					process.nextTick(next);
 		}
-			}, function (err) {
-				// Return list of upgrade scripts for continued processing
-				next(err, files);
 	});
-		},
+	return files;
-	], callback);
 };
 
 Upgrade.check = async function () {
@@ -101,68 +86,47 @@ Upgrade.check = async function () {
 	}
 };
 
-Upgrade.run = function (callback) {
+Upgrade.run = async function () {
 	console.log('\nParsing upgrade scripts... ');
-	var queue = [];
-	var skipped = 0;
-
-	async.parallel({
-		// Retrieve list of upgrades that have already been run
-		completed: async.apply(db.getSortedSetRange, 'schemaLog', 0, -1),
-		// ... and those available to be run
-		available: Upgrade.getAll,
-	}, function (err, data) {
-		if (err) {
-			return callback(err);
-		}
 
-		queue = data.available.reduce(function (memo, cur) {
+	const [completed, available] = await Promise.all([
-			if (!data.completed.includes(path.basename(cur, '.js'))) {
+		db.getSortedSetRange('schemaLog', 0, -1),
-				memo.push(cur);
+		Upgrade.getAll(),
-			} else {
+	]);
+
+	let skipped = 0;
+	const queue = available.filter(function (cur) {
+		const upgradeRan = completed.includes(path.basename(cur, '.js'));
+		if (upgradeRan) {
 			skipped += 1;
 		}
-
+		return !upgradeRan;
-			return memo;
-		}, queue);
-
-		Upgrade.process(queue, skipped, callback);
 	});
+
+	await Upgrade.process(queue, skipped);
 };
 
-Upgrade.runParticular = function (names, callback) {
+Upgrade.runParticular = async function (names) {
 	console.log('\nParsing upgrade scripts... ');
-
+	const files = await file.walk(path.join(__dirname, './upgrades'));
-	async.waterfall([
+	await Upgrade.appendPluginScripts(files);
-		function (next) {
-			file.walk(path.join(__dirname, './upgrades'), next);
-		},
-		function (files, next) {
-			Upgrade.appendPluginScripts(files, next);
-		},
-		function (files, next) {
 	const upgrades = files.filter(file => names.includes(path.basename(file, '.js')));
-			Upgrade.process(upgrades, 0, next);
+	await Upgrade.process(upgrades, 0);
-		},
-	], callback);
 };
 
-Upgrade.process = function (files, skipCount, callback) {
+Upgrade.process = async function (files, skipCount) {
 	console.log('OK'.green + ' | '.reset + String(files.length).cyan + ' script(s) found'.cyan + (skipCount > 0 ? ', '.cyan + String(skipCount).cyan + ' skipped'.cyan : ''));
-
+	const [schemaDate, schemaLogCount] = await Promise.all([
-	async.waterfall([
+		db.get('schemaDate'),
-		function (next) {
+		db.sortedSetCard('schemaLog'),
-			async.parallel({
+	]);
-				schemaDate: async.apply(db.get, 'schemaDate'),
+
-				schemaLogCount: async.apply(db.sortedSetCard, 'schemaLog'),
+	for (const file of files) {
-			}, next);
+		/* eslint-disable no-await-in-loop */
-		},
+		const scriptExport = require(file);
-		function (results, next) {
+		const date = new Date(scriptExport.timestamp);
-			async.eachSeries(files, async (file) => {
+		const version = path.dirname(file).split('/').pop();
-				var scriptExport = require(file);
+		const progress = {
-				var date = new Date(scriptExport.timestamp);
-				var version = path.dirname(file).split('/').pop();
-				var progress = {
 			current: 0,
 			total: 0,
 			incr: Upgrade.incrementProgress,
@@ -173,8 +137,9 @@ Upgrade.process = function (files, skipCount, callback) {
 		process.stdout.write('  → '.white + String('[' + [date.getUTCFullYear(), date.getUTCMonth() + 1, date.getUTCDate()].join('/') + '] ').gray + String(scriptExport.name).reset + '...');
 
 		// For backwards compatibility, cross-reference with schemaDate (if found). If a script's date is older, skip it
-				if ((!results.schemaDate && !results.schemaLogCount) || (scriptExport.timestamp <= results.schemaDate && semver.lt(version, '1.5.0'))) {
+		if ((!schemaDate && !schemaLogCount) || (scriptExport.timestamp <= schemaDate && semver.lt(version, '1.5.0'))) {
 			process.stdout.write(' skipped\n'.grey);
+
 			await db.sortedSetAdd('schemaLog', Date.now(), path.basename(file, '.js'));
 			return;
 		}
@@ -198,13 +163,9 @@ Upgrade.process = function (files, skipCount, callback) {
 
 		// Record success in schemaLog
 		await db.sortedSetAdd('schemaLog', Date.now(), path.basename(file, '.js'));
-			}, next);
+	}
-		},
+
-		function (next) {
 	console.log('Schema update complete!\n'.green);
-			setImmediate(next);
-		},
-	], callback);
 };
 
 Upgrade.incrementProgress = function (value) {