114 lines
4.1 KiB
JavaScript
114 lines
4.1 KiB
JavaScript
const moment = require('moment');
|
|
const debug = require('debug')('knex-migrator:locking');
|
|
const errors = require('./errors');
|
|
const database = require('./database');
|
|
|
|
/**
|
|
* @description Private helper to lock the migrations_lock table.
|
|
* @TODO Locks in Sqlite won't work, because Sqlite doesn't offer read locks (https://github.com/TryGhost/knex-migrator/issues/87)
|
|
* @returns {*}
|
|
*/
|
|
module.exports.lock = function (connection) {
|
|
debug('Lock.');
|
|
|
|
return database.createTransaction(connection, function (transacting) {
|
|
return transacting('migrations_lock')
|
|
.where({
|
|
lock_key: 'km01'
|
|
})
|
|
.forUpdate()
|
|
.then(function (data) {
|
|
if (!data || !data.length || data[0].locked) {
|
|
throw new errors.MigrationsAreLockedError({
|
|
message: 'Migrations are running at the moment. Please wait that the lock get`s released.',
|
|
context: 'Either the release was never released because of a e.g. died process or a parallel process is migrating at the moment.',
|
|
help: 'If your database looks okay, you can manually release the lock by running `UPDATE migrations_lock set locked=0 where lock_key=\'km01\';`.'
|
|
});
|
|
}
|
|
|
|
return (transacting || connection)('migrations_lock')
|
|
.where({
|
|
lock_key: 'km01'
|
|
})
|
|
.update({
|
|
locked: 1,
|
|
acquired_at: moment().format('YYYY-MM-DD HH:mm:ss')
|
|
});
|
|
})
|
|
.catch(function (err) {
|
|
if (errors.utils.isGhostError(err)) {
|
|
throw err;
|
|
}
|
|
|
|
throw new errors.LockError({
|
|
message: 'Error while acquire the migration lock.',
|
|
err: err
|
|
});
|
|
});
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @description Private helper to determine whether the database is locked or not.
|
|
* @returns {boolean}
|
|
*/
|
|
module.exports.isLocked = function (connection) {
|
|
return connection('migrations_lock')
|
|
.where({
|
|
lock_key: 'km01'
|
|
})
|
|
.then(function (data) {
|
|
if (!data || !data.length || data[0].locked) {
|
|
throw new errors.MigrationsAreLockedError({
|
|
message: 'Migration lock was never released or currently a migration is running.',
|
|
help: 'If you are sure no migration is running, check your data and if your database is in a broken state, you could run `yarn knex-migrator rollback`.'
|
|
});
|
|
}
|
|
|
|
return false;
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @description Private helper to unlock the database table "migrations_lock".
|
|
* @TODO Locks in Sqlite won't work, because Sqlite doesn't offer read locks (https://github.com/TryGhost/knex-migrator/issues/87)
|
|
* @returns {*}
|
|
*/
|
|
module.exports.unlock = function (connection) {
|
|
debug('Unlock.');
|
|
|
|
return database.createTransaction(connection, function (transacting) {
|
|
return transacting('migrations_lock')
|
|
.where({
|
|
lock_key: 'km01'
|
|
})
|
|
.forUpdate()
|
|
.then(function (data) {
|
|
if (!data || !data.length || !data[0].locked) {
|
|
throw new errors.MigrationsAreLockedError({
|
|
message: 'Migration lock was already released?.'
|
|
});
|
|
}
|
|
|
|
return transacting('migrations_lock')
|
|
.where({
|
|
lock_key: 'km01'
|
|
})
|
|
.update({
|
|
locked: 0,
|
|
released_at: moment().format('YYYY-MM-DD HH:mm:ss')
|
|
});
|
|
})
|
|
.catch(function (err) {
|
|
if (errors.utils.isGhostError(err)) {
|
|
throw err;
|
|
}
|
|
|
|
throw new errors.UnlockError({
|
|
message: 'Error while releasing the migration lock.',
|
|
err: err
|
|
});
|
|
});
|
|
});
|
|
};
|