-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
upgrade.js
229 lines (201 loc) · 6.89 KB
/
upgrade.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
'use strict';
var async = require('async');
var path = require('path');
var util = require('util');
var semver = require('semver');
var readline = require('readline');
var winston = require('winston');
var db = require('./database');
var 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.
* 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;
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;
var versionB;
setImmediate(next, null, files.filter(file => path.basename(file) !== 'TEMPLATE').sort(function (a, b) {
versionA = path.dirname(a).split(path.sep).pop();
versionB = path.dirname(b).split(path.sep).pop();
var semverCompare = semver.compare(versionA, versionB);
if (semverCompare) {
return semverCompare;
}
var timestampA = require(a).timestamp;
var timestampB = require(b).timestamp;
return timestampA - timestampB;
}));
},
async.apply(Upgrade.appendPluginScripts),
function (files, next) {
// check duplicates and error
const seen = {};
const dupes = [];
files.forEach((file) => {
if (seen[file]) {
dupes.push(file);
} else {
seen[file] = true;
}
});
if (dupes.length) {
winston.error('Found duplicate upgrade scripts\n' + dupes);
return next(new Error('[[error:duplicate-upgrade-scripts]]'));
}
next(null, files);
},
], callback);
};
Upgrade.appendPluginScripts = function (files, callback) {
async.waterfall([
// Find all active plugins
async.apply(db.getSortedSetRange.bind(db), 'plugins:active', 0, -1),
// Read plugin.json and check for upgrade scripts
function (plugins, next) {
async.each(plugins, function (plugin, next) {
var configPath = path.join(__dirname, '../node_modules', plugin, 'plugin.json');
try {
var 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);
});
},
], callback);
};
Upgrade.check = async function () {
// Throw 'schema-out-of-date' if not all upgrade scripts have run
const files = await Upgrade.getAll();
const executed = await db.getSortedSetRange('schemaLog', 0, -1);
const remainder = files.filter(name => !executed.includes(path.basename(name, '.js')));
if (remainder.length > 0) {
throw new Error('schema-out-of-date');
}
};
Upgrade.run = function (callback) {
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) {
if (!data.completed.includes(path.basename(cur, '.js'))) {
memo.push(cur);
} else {
skipped += 1;
}
return memo;
}, queue);
Upgrade.process(queue, skipped, callback);
});
};
Upgrade.runParticular = function (names, callback) {
console.log('\nParsing upgrade scripts... ');
async.waterfall([
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);
},
], callback);
};
Upgrade.process = function (files, skipCount, callback) {
console.log('OK'.green + ' | '.reset + String(files.length).cyan + ' script(s) found'.cyan + (skipCount > 0 ? ', '.cyan + String(skipCount).cyan + ' skipped'.cyan : ''));
async.waterfall([
function (next) {
async.parallel({
schemaDate: async.apply(db.get, 'schemaDate'),
schemaLogCount: async.apply(db.sortedSetCard, 'schemaLog'),
}, next);
},
function (results, next) {
async.eachSeries(files, async (file) => {
var scriptExport = require(file);
var date = new Date(scriptExport.timestamp);
var version = path.dirname(file).split('/').pop();
var progress = {
current: 0,
total: 0,
incr: Upgrade.incrementProgress,
script: scriptExport,
date: date,
};
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'))) {
process.stdout.write(' skipped\n'.grey);
await db.sortedSetAdd('schemaLog', Date.now(), path.basename(file, '.js'));
return;
}
// Promisify method if necessary
if (scriptExport.method.constructor && scriptExport.method.constructor.name !== 'AsyncFunction') {
scriptExport.method = util.promisify(scriptExport.method);
}
// Do the upgrade...
try {
await scriptExport.method.bind({
progress: progress,
})();
} catch (err) {
console.error('Error occurred');
throw err;
}
process.stdout.write(' OK\n'.green);
// 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) {
this.current += value || 1;
// Redraw the progress bar every 100 units
if (this.current % 100 === 0) {
var percentage = 0;
var filled = 0;
var unfilled = 15;
if (this.total) {
percentage = Math.floor((this.current / this.total) * 100) + '%';
filled = Math.floor((this.current / this.total) * 15);
unfilled = Math.max(0, 15 - filled);
}
readline.cursorTo(process.stdout, 0);
process.stdout.write(' [' + (filled ? new Array(filled).join('#') : '') + new Array(unfilled).join(' ') + '] (' + this.current + '/' + (this.total || '??') + ') ' + percentage + ' ');
}
};
require('./promisify')(Upgrade);