-
Notifications
You must be signed in to change notification settings - Fork 10.4k
/
migrations.js
418 lines (359 loc) · 11.2 KB
/
migrations.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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
import moment from 'moment';
/*
Adds migration capabilities. Migrations are defined like:
Migrations.add({
up: function() {}, //*required* code to run to migrate upwards
version: 1, //*required* number to identify migration order
down: function() {}, //*optional* code to run to migrate downwards
name: 'Something' //*optional* display name for the migration
});
The ordering of migrations is determined by the version you set.
To run the migrations, set the MIGRATE environment variable to either
'latest' or the version number you want to migrate to. Optionally, append
',exit' if you want the migrations to exit the meteor process, e.g if you're
migrating from a script (remember to pass the --once parameter).
e.g:
MIGRATE="latest" mrt # ensure we'll be at the latest version and run the app
MIGRATE="latest,exit" mrt --once # ensure we'll be at the latest version and exit
MIGRATE="2,exit" mrt --once # migrate to version 2 and exit
Note: Migrations will lock ensuring only 1 app can be migrating at once. If
a migration crashes, the control record in the migrations collection will
remain locked and at the version it was at previously, however the db could
be in an inconsistant state.
*/
// since we'll be at version 0 by default, we should have a migration set for
// it.
var DefaultMigration = {
version: 0,
up: function() {
// @TODO: check if collection "migrations" exist
// If exists, rename and rerun _migrateTo
}
};
Migrations = {
_list: [DefaultMigration],
options: {
// false disables logging
log: true,
// null or a function
logger: null,
// enable/disable info log "already at latest."
logIfLatest: true,
// lock will be valid for this amount of minutes
lockExpiration: 5,
// retry interval in seconds
retryInterval: 10,
// max number of attempts to retry unlock
maxAttempts: 30,
// migrations collection name
collectionName: "migrations"
// collectionName: "rocketchat_migrations"
},
config: function(opts) {
this.options = _.extend({}, this.options, opts);
},
}
Migrations._collection = new Mongo.Collection(Migrations.options.collectionName);
/* Create a box around messages for displaying on a console.log */
function makeABox(message, color = 'red') {
if (!_.isArray(message)) {
message = message.split("\n");
}
let len = _(message).reduce(function(memo, msg) {
return Math.max(memo, msg.length)
}, 0) + 4;
let text = message.map((msg) => {
return "|" [color] + s.lrpad(msg, len)[color] + "|" [color]
}).join("\n");
let topLine = "+" [color] + s.pad('', len, '-')[color] + "+" [color];
let separator = "|" [color] + s.pad('', len, '') + "|" [color];
let bottomLine = "+" [color] + s.pad('', len, '-')[color] + "+" [color];
return `\n${topLine}\n${separator}\n${text}\n${separator}\n${bottomLine}\n`;
}
/*
Logger factory function. Takes a prefix string and options object
and uses an injected `logger` if provided, else falls back to
Meteor's `Log` package.
Will send a log object to the injected logger, on the following form:
message: String
level: String (info, warn, error, debug)
tag: 'Migrations'
*/
function createLogger(prefix) {
check(prefix, String);
// Return noop if logging is disabled.
if (Migrations.options.log === false) {
return function() {};
}
return function(level, message) {
check(level, Match.OneOf('info', 'error', 'warn', 'debug'));
check(message, Match.OneOf(String, [String]));
var logger = Migrations.options && Migrations.options.logger;
if (logger && _.isFunction(logger)) {
logger({
level: level,
message: message,
tag: prefix
});
} else {
Log[level]({
message: prefix + ': ' + message
});
}
}
}
var log;
var options = Migrations.options;
// collection holding the control record
log = createLogger('Migrations');
['info', 'warn', 'error', 'debug'].forEach(function(level) {
log[level] = _.partial(log, level);
});
// if (process.env.MIGRATE)
// Migrations.migrateTo(process.env.MIGRATE);
// Add a new migration:
// {up: function *required
// version: Number *required
// down: function *optional
// name: String *optional
// }
Migrations.add = function(migration) {
if (typeof migration.up !== 'function')
throw new Meteor.Error('Migration must supply an up function.');
if (typeof migration.version !== 'number')
throw new Meteor.Error('Migration must supply a version number.');
if (migration.version <= 0)
throw new Meteor.Error('Migration version must be greater than 0');
// Freeze the migration object to make it hereafter immutable
Object.freeze(migration);
this._list.push(migration);
this._list = _.sortBy(this._list, function(m) {
return m.version;
});
}
// Attempts to run the migrations using command in the form of:
// e.g 'latest', 'latest,exit', 2
// use 'XX,rerun' to re-run the migration at that version
Migrations.migrateTo = function(command) {
if (_.isUndefined(command) || command === '' || this._list.length === 0)
throw new Error("Cannot migrate using invalid command: " + command);
if (typeof command === 'number') {
var version = command;
} else {
var version = command.split(',')[0];
var subcommand = command.split(',')[1];
}
const maxAttempts = Migrations.options.maxAttempts;
const retryInterval = Migrations.options.retryInterval;
for (let attempts = 1; attempts <= maxAttempts; attempts++) {
if (version === 'latest') {
migrated = this._migrateTo(_.last(this._list).version);
} else {
migrated = this._migrateTo(parseInt(version), (subcommand === 'rerun'));
}
if (migrated) {
break;
} else {
let willRetry;
if (attempts < maxAttempts) {
willRetry = ` Trying again in ${retryInterval} seconds.`;
Meteor._sleepForMs(retryInterval * 1000);
} else {
willRetry = "";
}
console.log(`Not migrating, control is locked. Attempt ${attempts}/${maxAttempts}.${willRetry}`.yellow);
}
}
if (!migrated) {
let control = this._getControl(); // Side effect: upserts control document.
console.log(makeABox([
"ERROR! SERVER STOPPED",
"",
"Your database migration control is locked.",
"Please make sure you are running the latest version and try again.",
"If the problem persists, please contact support.",
"",
"This Rocket.Chat version: " + RocketChat.Info.version,
"Database locked at version: " + control.version,
"Database target version: " + (version === 'latest' ? _.last(this._list).version : version),
"",
"Commit: " + RocketChat.Info.commit.hash,
"Date: " + RocketChat.Info.commit.date,
"Branch: " + RocketChat.Info.commit.branch,
"Tag: " + RocketChat.Info.commit.tag
]));
process.exit(1);
}
// remember to run meteor with --once otherwise it will restart
if (subcommand === 'exit')
process.exit(0);
}
// just returns the current version
Migrations.getVersion = function() {
return this._getControl().version;
}
// migrates to the specific version passed in
Migrations._migrateTo = function(version, rerun) {
var self = this;
var control = this._getControl(); // Side effect: upserts control document.
var currentVersion = control.version;
if (lock() === false) {
// log.info('Not migrating, control is locked.');
// Warning
return false;
}
if (rerun) {
log.info('Rerunning version ' + version);
migrate('up', version);
log.info('Finished migrating.');
unlock();
return true;
}
if (currentVersion === version) {
if (this.options.logIfLatest) {
log.info('Not migrating, already at version ' + version);
}
unlock();
return true;
}
var startIdx = this._findIndexByVersion(currentVersion);
var endIdx = this._findIndexByVersion(version);
// log.info('startIdx:' + startIdx + ' endIdx:' + endIdx);
log.info('Migrating from version ' + this._list[startIdx].version + ' -> ' + this._list[endIdx].version);
// run the actual migration
function migrate(direction, idx) {
var migration = self._list[idx];
if (typeof migration[direction] !== 'function') {
unlock();
throw new Meteor.Error('Cannot migrate ' + direction + ' on version ' + migration.version);
}
function maybeName() {
return migration.name ? ' (' + migration.name + ')' : '';
}
log.info('Running ' + direction + '() on version ' + migration.version + maybeName());
try {
migration[direction](migration);
} catch (e) {
console.log(makeABox([
"ERROR! SERVER STOPPED",
"",
"Your database migration failed:",
e.message,
"",
"Please make sure you are running the latest version and try again.",
"If the problem persists, please contact support.",
"",
"This Rocket.Chat version: " + RocketChat.Info.version,
"Database locked at version: " + control.version,
"Database target version: " + version,
"",
"Commit: " + RocketChat.Info.commit.hash,
"Date: " + RocketChat.Info.commit.date,
"Branch: " + RocketChat.Info.commit.branch,
"Tag: " + RocketChat.Info.commit.tag
]));
process.exit(1);
}
}
// Returns true if lock was acquired.
function lock() {
const date = new Date();
const dateMinusInterval = moment(date).subtract(self.options.lockExpiration, 'minutes').toDate();
const build = RocketChat.Info ? RocketChat.Info.build.date : date;
// This is atomic. The selector ensures only one caller at a time will see
// the unlocked control, and locking occurs in the same update's modifier.
// All other simultaneous callers will get false back from the update.
return self._collection.update({
_id: 'control',
$or: [{
locked: false
}, {
lockedAt: {
$lt: dateMinusInterval
}
}, {
buildAt: {
$ne: build
}
}]
}, {
$set: {
locked: true,
lockedAt: date,
buildAt: build
}
}) === 1;
}
// Side effect: saves version.
function unlock() {
self._setControl({
locked: false,
version: currentVersion
});
}
if (currentVersion < version) {
for (var i = startIdx; i < endIdx; i++) {
migrate('up', i + 1);
currentVersion = self._list[i + 1].version;
self._setControl({
locked: true,
version: currentVersion
});
}
} else {
for (var i = startIdx; i > endIdx; i--) {
migrate('down', i);
currentVersion = self._list[i - 1].version;
self._setControl({
locked: true,
version: currentVersion
});
}
}
unlock();
log.info('Finished migrating.');
}
// gets the current control record, optionally creating it if non-existant
Migrations._getControl = function() {
var control = this._collection.findOne({
_id: 'control'
});
return control || this._setControl({
version: 0,
locked: false
});
}
// sets the control record
Migrations._setControl = function(control) {
// be quite strict
check(control.version, Number);
check(control.locked, Boolean);
this._collection.update({
_id: 'control'
}, {
$set: {
version: control.version,
locked: control.locked
}
}, {
upsert: true
});
return control;
}
// returns the migration index in _list or throws if not found
Migrations._findIndexByVersion = function(version) {
for (var i = 0; i < this._list.length; i++) {
if (this._list[i].version === version)
return i;
}
throw new Meteor.Error('Can\'t find migration version ' + version);
}
//reset (mainly intended for tests)
Migrations._reset = function() {
this._list = [{
version: 0,
up: function() {}
}];
this._collection.remove({});
}
RocketChat.Migrations = Migrations;