server/initializers/migrator.ts

   1 import { waterfall, eachSeries } from 'async'
   2 import * as fs from 'fs'
   3 import * as path from 'path'
   4 import * as Sequelize from 'sequelize'
   5
   6 import { database as db } from './database'
   7 import { LAST_MIGRATION_VERSION } from './constants'
   8 import { logger } from '../helpers'
   9
  10 function migrate (finalCallback: (err: Error) => void) {
  11   waterfall([
  12
  13     function checkApplicationTableExists (callback) {
  14       db.sequelize.getQueryInterface().showAllTables().asCallback(function (err, tables) {
  15         if (err) return callback(err)
  16
  17         // No tables, we don't need to migrate anything
  18         // The installer will do that
  19         if (tables.length === 0) return finalCallback(null)
  20
  21         return callback(null)
  22       })
  23     },
  24
  25     function loadMigrationVersion (callback) {
  26       db.Application.loadMigrationVersion(callback)
  27     },
  28
  29     function createMigrationRowIfNotExists (actualVersion, callback) {
  30       if (actualVersion === null) {
  31         db.Application.create({
  32           migrationVersion: 0
  33         }, function (err) {
  34           return callback(err, 0)
  35         })
  36       }
  37
  38       return callback(null, actualVersion)
  39     },
  40
  41     function abortMigrationIfNotNeeded (actualVersion, callback) {
  42       // No need migrations
  43       if (actualVersion >= LAST_MIGRATION_VERSION) return finalCallback(null)
  44
  45       return callback(null, actualVersion)
  46     },
  47
  48     function getMigrations (actualVersion, callback) {
  49       // If there are a new migration scripts
  50       logger.info('Begin migrations.')
  51
  52       getMigrationScripts(function (err, migrationScripts) {
  53         return callback(err, actualVersion, migrationScripts)
  54       })
  55     },
  56
  57     function doMigrations (actualVersion, migrationScripts, callback) {
  58       eachSeries(migrationScripts, function (entity: any, callbackEach) {
  59         executeMigration(actualVersion, entity, callbackEach)
  60       }, function (err) {
  61         if (err) return callback(err)
  62
  63         logger.info('Migrations finished. New migration version schema: %s', LAST_MIGRATION_VERSION)
  64         return callback(null)
  65       })
  66     }
  67   ], finalCallback)
  68 }
  69
  70 // ---------------------------------------------------------------------------
  71
  72 export {
  73   migrate
  74 }
  75
  76 // ---------------------------------------------------------------------------
  77
  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)
  82
  83     const filesToMigrate = []
  84
  85     files.forEach(function (file) {
  86       // Filename is something like 'version-blabla.js'
  87       const version = file.split('-')[0]
  88       filesToMigrate.push({
  89         version,
  90         script: file
  91       })
  92     })
  93
  94     return callback(err, filesToMigrate)
  95   })
  96 }
  97
  98 function executeMigration (actualVersion: number, entity: { version: string, script: string }, callback: (err: Error) => void) {
  99   const versionScript = parseInt(entity.version, 10)
 100
 101   // Do not execute old migration scripts
 102   if (versionScript <= actualVersion) return callback(null)
 103
 104   // Load the migration module and run it
 105   const migrationScriptName = entity.script
 106   logger.info('Executing %s migration script.', migrationScriptName)
 107
 108   const migrationScript = require(path.join(__dirname, 'migrations', migrationScriptName))
 109
 110   db.sequelize.transaction().asCallback(function (err, t) {
 111     if (err) return callback(err)
 112
 113     const options = {
 114       transaction: t,
 115       queryInterface: db.sequelize.getQueryInterface(),
 116       sequelize: db.sequelize,
 117       Sequelize: Sequelize
 118     }
 119     migrationScript.up(options, function (err) {
 120       if (err) {
 121         t.rollback()
 122         return callback(err)
 123       }
 124
 125       // Update the new migration version
 126       db.Application.updateMigrationVersion(versionScript, t, function (err) {
 127         if (err) {
 128           t.rollback()
 129           return callback(err)
 130         }
 131
 132         t.commit().asCallback(callback)
 133       })
 134     })
 135   })
 136 }