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'
9 import { ApplicationInstance } from '../models'
11 function migrate (finalCallback: (err: Error) => void) {
14 function checkApplicationTableExists (callback) {
15 db.sequelize.getQueryInterface().showAllTables().asCallback(function (err, tables) {
16 if (err) return callback(err)
18 // No tables, we don't need to migrate anything
19 // The installer will do that
20 if (tables.length === 0) return finalCallback(null)
26 function loadMigrationVersion (callback) {
27 db.Application.loadMigrationVersion(callback)
30 function createMigrationRowIfNotExists (actualVersion, callback) {
31 if (actualVersion === null) {
32 db.Application.create({
35 return callback(err, 0)
39 return callback(null, actualVersion)
42 function abortMigrationIfNotNeeded (actualVersion, callback) {
44 if (actualVersion >= LAST_MIGRATION_VERSION) return finalCallback(null)
46 return callback(null, actualVersion)
49 function getMigrations (actualVersion, callback) {
50 // If there are a new migration scripts
51 logger.info('Begin migrations.')
53 getMigrationScripts(function (err, migrationScripts) {
54 return callback(err, actualVersion, migrationScripts)
58 function doMigrations (actualVersion, migrationScripts, callback) {
59 eachSeries(migrationScripts, function (entity: any, callbackEach) {
60 executeMigration(actualVersion, entity, callbackEach)
62 if (err) return callback(err)
64 logger.info('Migrations finished. New migration version schema: %s', LAST_MIGRATION_VERSION)
71 // ---------------------------------------------------------------------------
77 // ---------------------------------------------------------------------------
79 type GetMigrationScriptsCallback = (err: Error, filesToMigrate?: { version: string, script: string }[]) => void
80 function getMigrationScripts (callback: GetMigrationScriptsCallback) {
81 fs.readdir(path.join(__dirname, 'migrations'), function (err, files) {
82 if (err) return callback(err)
84 const filesToMigrate = []
86 files.forEach(function (file) {
87 // Filename is something like 'version-blabla.js'
88 const version = file.split('-')[0]
95 return callback(err, filesToMigrate)
99 function executeMigration (actualVersion: number, entity: { version: string, script: string }, callback: (err: Error) => void) {
100 const versionScript = parseInt(entity.version, 10)
102 // Do not execute old migration scripts
103 if (versionScript <= actualVersion) return callback(null)
105 // Load the migration module and run it
106 const migrationScriptName = entity.script
107 logger.info('Executing %s migration script.', migrationScriptName)
109 const migrationScript = require(path.join(__dirname, 'migrations', migrationScriptName))
111 db.sequelize.transaction().asCallback(function (err, t) {
112 if (err) return callback(err)
116 queryInterface: db.sequelize.getQueryInterface(),
117 sequelize: db.sequelize,
120 migrationScript.up(options, function (err) {
126 // Update the new migration version
127 db.Application.updateMigrationVersion(versionScript, t, function (err) {
133 t.commit().asCallback(callback)