1 import { waterfall, eachSeries } from 'async'
2 import * as fs from 'fs'
3 import * as path from 'path'
4 import * as Sequelize from 'sequelize'
6 import { database as db } from './database'
7 import { LAST_MIGRATION_VERSION } from './constants'
8 import { logger } from '../helpers'
10 function migrate (finalCallback: (err: Error) => void) {
13 function checkApplicationTableExists (callback) {
14 db.sequelize.getQueryInterface().showAllTables().asCallback(function (err, tables) {
15 if (err) return callback(err)
17 // No tables, we don't need to migrate anything
18 // The installer will do that
19 if (tables.length === 0) return finalCallback(null)
25 function loadMigrationVersion (callback) {
26 db.Application.loadMigrationVersion(callback)
29 function createMigrationRowIfNotExists (actualVersion, callback) {
30 if (actualVersion === null) {
31 db.Application.create({
34 return callback(err, 0)
38 return callback(null, actualVersion)
41 function abortMigrationIfNotNeeded (actualVersion, callback) {
43 if (actualVersion >= LAST_MIGRATION_VERSION) return finalCallback(null)
45 return callback(null, actualVersion)
48 function getMigrations (actualVersion, callback) {
49 // If there are a new migration scripts
50 logger.info('Begin migrations.')
52 getMigrationScripts(function (err, migrationScripts) {
53 return callback(err, actualVersion, migrationScripts)
57 function doMigrations (actualVersion, migrationScripts, callback) {
58 eachSeries(migrationScripts, function (entity: any, callbackEach) {
59 executeMigration(actualVersion, entity, callbackEach)
61 if (err) return callback(err)
63 logger.info('Migrations finished. New migration version schema: %s', LAST_MIGRATION_VERSION)
70 // ---------------------------------------------------------------------------
76 // ---------------------------------------------------------------------------
78 type GetMigrationScriptsCallback = (err: Error, filesToMigrate?: { version: string, script: string }[]) => void
79 function getMigrationScripts (callback: GetMigrationScriptsCallback) {
80 fs.readdir(path.join(__dirname, 'migrations'), function (err, files) {
81 if (err) return callback(err)
83 const filesToMigrate = []
85 files.forEach(function (file) {
86 // Filename is something like 'version-blabla.js'
87 const version = file.split('-')[0]
94 return callback(err, filesToMigrate)
98 function executeMigration (actualVersion: number, entity: { version: string, script: string }, callback: (err: Error) => void) {
99 const versionScript = parseInt(entity.version, 10)
101 // Do not execute old migration scripts
102 if (versionScript <= actualVersion) return callback(null)
104 // Load the migration module and run it
105 const migrationScriptName = entity.script
106 logger.info('Executing %s migration script.', migrationScriptName)
108 const migrationScript = require(path.join(__dirname, 'migrations', migrationScriptName))
110 db.sequelize.transaction().asCallback(function (err, t) {
111 if (err) return callback(err)
115 queryInterface: db.sequelize.getQueryInterface(),
116 sequelize: db.sequelize,
119 migrationScript.up(options, function (err) {
125 // Update the new migration version
126 db.Application.updateMigrationVersion(versionScript, t, function (err) {
132 t.commit().asCallback(callback)