github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-29 05:43:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #384 from SISheogorath/feature/automated-migrations

Browse source 
Run database migrations automatically on startup
This commit is contained in:
David Mehren 2020-07-11 21:25:59 +02:00 committed by GitHub
commit a194156b0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 70 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
package.json
View file

@ -15,7 +15,7 @@
"build": "yarn run build-backend && yarn run build-frontend",
"build-backend": "tsc",
"build-frontend": "webpack --config webpack.prod.js --progress --colors --bail",
"start": "sequelize db:migrate && node built/lib/app.js"
"start": "node built/lib/app.js"
},
"dependencies": {
"@passport-next/passport-openid": "^1.0.0",
@ -116,7 +116,6 @@
"scrypt-kdf": "^2.0.1",
"select2": "^3.5.2-browserify",
"sequelize": "^5.21.1",
"sequelize-cli": "^5.5.1",
"sequelize-typescript": "^1.1.0",
"shortid": "2.2.8",
"socket.io": "~2.1.1",
@ -128,6 +127,7 @@
"tedious": "^6.6.0",
"toobusy-js": "^0.5.1",
"turndown": "^5.0.1",
"umzug": "^2.3.0",
"uuid": "^3.1.0",
"validator": "^10.4.0",
"velocity-animate": "^1.4.0",
@ -221,6 +221,7 @@
"mocha": "^5.2.0",
"optimize-css-assets-webpack-plugin": "^5.0.3",
"script-loader": "^0.7.2",
"sequelize-cli": "^5.5.1",
"sinon": "^9.0.2",
"string-loader": "^0.0.1",
"style-loader": "^1.0.0",

5
src/lib/app.ts
View file

@ -24,7 +24,7 @@ import { config } from './config'
import { addNonceToLocals, computeDirectives } from './csp'
import { errors } from './errors'
import { logger } from './logger'
import { Revision, sequelize } from './models'
import { Revision, sequelize, runMigrations } from './models'
import { realtime, State } from './realtime'
import { handleTermSignals } from './utils/functions'
import { AuthRouter, BaseRouter, HistoryRouter, ImageRouter, NoteRouter, StatusRouter, UserRouter } from './web/'
@ -289,7 +289,8 @@ function startListen (): void {
}
// sync db then start listen
sequelize.authenticate().then(function () {
sequelize.authenticate().then(async function () {
await runMigrations()
sessionStore.sync()
// check if realtime is ready
if (realtime.isReady()) {

4
src/lib/migrations/20150504155329-create-users.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.createTable('Users', {
id: {
type: Sequelize.UUID,
@ -18,7 +18,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.dropTable('Users')
}
}

4
src/lib/migrations/20150508114741-create-notes.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.createTable('Notes', {
id: {
type: Sequelize.UUID,
@ -15,7 +15,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.dropTable('Notes')
}
}

4
src/lib/migrations/20150515125813-create-temp.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.createTable('Temp', {
id: {
type: Sequelize.STRING,
@ -12,7 +12,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.dropTable('Temp')
}
}

4
src/lib/migrations/20150702001020-update-to-0_3_1.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'shortid', {
type: Sequelize.STRING,
defaultValue: '0000000000',
@ -30,7 +30,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Notes', 'viewcount')
.then(function () {
return queryInterface.removeColumn('Notes', 'permission')

4
src/lib/migrations/20150915153700-change-notes-title-to-text.js
View file

@ -4,7 +4,7 @@ function isSQLite (sequelize) {
}
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Notes', 'title', {
type: Sequelize.TEXT
}).then(function () {
@ -15,7 +15,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Notes', 'title', {
type: Sequelize.STRING
}).then(function () {

4
src/lib/migrations/20160112220142-note-add-lastchange.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'lastchangeuserId', {
type: Sequelize.UUID
}).then(function () {
@ -17,7 +17,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Notes', 'lastchangeAt')
.then(function () {
return queryInterface.removeColumn('Notes', 'lastchangeuserId')

4
src/lib/migrations/20160420180355-note-add-alias.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'alias', {
type: Sequelize.STRING
}).then(function () {
@ -17,7 +17,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Notes', 'alias').then(function () {
return queryInterface.removeIndex('Notes', ['alias'])
})

4
src/lib/migrations/20160515114000-user-add-tokens.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Users', 'accessToken', Sequelize.STRING).then(function () {
return queryInterface.addColumn('Users', 'refreshToken', Sequelize.STRING)
}).catch(function (error) {
@ -13,7 +13,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Users', 'accessToken').then(function () {
return queryInterface.removeColumn('Users', 'refreshToken')
})

4
src/lib/migrations/20160607060246-support-revision.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'savedAt', Sequelize.DATE).then(function () {
return queryInterface.createTable('Revisions', {
id: {
@ -25,7 +25,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.dropTable('Revisions').then(function () {
return queryInterface.removeColumn('Notes', 'savedAt')
})

4
src/lib/migrations/20160703062241-support-authorship.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'authorship', Sequelize.TEXT).then(function () {
return queryInterface.addColumn('Revisions', 'authorship', Sequelize.TEXT)
}).then(function () {
@ -26,7 +26,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.dropTable('Authors').then(function () {
return queryInterface.removeColumn('Revisions', 'authorship')
}).then(function () {

4
src/lib/migrations/20161009040430-support-delete-note.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Notes', 'deletedAt', Sequelize.DATE).catch(function (error) {
if (error.message === 'SQLITE_ERROR: duplicate column name: deletedAt' || error.message === "ER_DUP_FIELDNAME: Duplicate column name 'deletedAt'" || error.message === 'column "deletedAt" of relation "Notes" already exists') {
// eslint-disable-next-line no-console
@ -11,7 +11,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Notes', 'deletedAt')
}
}

4
src/lib/migrations/20161201050312-support-email-signin.js
View file

@ -1,6 +1,6 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Users', 'email', Sequelize.TEXT).then(function () {
return queryInterface.addColumn('Users', 'password', Sequelize.TEXT).catch(function (error) {
if (error.message === "ER_DUP_FIELDNAME: Duplicate column name 'password'" || error.message === 'column "password" of relation "Users" already exists') {
@ -20,7 +20,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Users', 'email').then(function () {
return queryInterface.removeColumn('Users', 'password')
})

4
src/lib/migrations/20180306150303-fix-enum.js
View file

@ -1,11 +1,11 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Notes', 'permission', { type: Sequelize.ENUM('freely', 'editable', 'limited', 'locked', 'protected', 'private') })
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Notes', 'permission', { type: Sequelize.ENUM('freely', 'editable', 'locked', 'private') })
}
}

4
src/lib/migrations/20180326103000-use-text-in-tokens.js
View file

@ -1,7 +1,7 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Users', 'accessToken', {
type: Sequelize.TEXT
}).then(function () {
@ -11,7 +11,7 @@ module.exports = {
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.changeColumn('Users', 'accessToken', {
type: Sequelize.STRING
}).then(function () {

4
src/lib/migrations/20180525153000-user-add-delete-token.js
View file

@ -1,13 +1,13 @@
'use strict'
module.exports = {
up: function (queryInterface, Sequelize) {
up: async function (queryInterface, Sequelize) {
return queryInterface.addColumn('Users', 'deleteToken', {
type: Sequelize.UUID,
defaultValue: Sequelize.UUIDV4
})
},
down: function (queryInterface, Sequelize) {
down: async function (queryInterface, Sequelize) {
return queryInterface.removeColumn('Users', 'deleteToken')
}
}

33
src/lib/models/index.ts
View file

@ -1,5 +1,6 @@
import { Sequelize } from 'sequelize-typescript'
import { cloneDeep } from 'lodash'
import * as path from 'path'
import { Author } from './author'
import { Note } from './note'
import { Revision } from './revision'
@ -7,6 +8,8 @@ import { Temp } from './temp'
import { User } from './user'
import { logger } from '../logger'
import { config } from '../config'
import Umzug from 'umzug'
import SequelizeTypes from 'sequelize'
const dbconfig = cloneDeep(config.db)
dbconfig.logging = config.debug ? (data): void => {
@ -22,6 +25,36 @@ if (config.dbURL) {
sequelize = new Sequelize(dbconfig.database, dbconfig.username, dbconfig.password, dbconfig)
}
const umzug = new Umzug({
migrations: {
path: path.resolve(__dirname, '..', 'migrations'),
params: [
sequelize.getQueryInterface(),
SequelizeTypes
]
},
// Required wrapper function required to prevent winstion issue
// https://github.com/winstonjs/winston/issues/1577
logging: message => {
logger.info(message)
},
storage: 'sequelize',
storageOptions: {
sequelize: sequelize
}
})
export async function runMigrations(): Promise<void> {
// checks migrations and run them if they are not already applied
// exit in case of unsuccessful migrations
await umzug.up().catch(error => {
logger.error(error)
logger.error('Database migration failed. Exiting…')
process.exit(1)
})
logger.info('All migrations performed successfully')
}
sequelize.addModels([Author, Note, Revision, Temp, User])
export { Author, Note, Revision, Temp, User }

2
yarn.lock
View file

@ -10533,7 +10533,7 @@ ultron@~1.1.0:
resolved "https://registry.yarnpkg.com/ultron/-/ultron-1.1.1.tgz#9fe1536a10a664a65266a1e3ccf85fd36302bc9c"
integrity sha512-UIEXBNeYmKptWH6z8ZnqTeS8fV74zG0/eRU9VGkpzz+LIJNs8W/zM/L+7ctCkRrgbNnnR0xxw4bKOr0cW0N0Og==
umzug@^2.1.0:
umzug@^2.1.0, umzug@^2.3.0:
version "2.3.0"
resolved "https://registry.yarnpkg.com/umzug/-/umzug-2.3.0.tgz#0ef42b62df54e216b05dcaf627830a6a8b84a184"
integrity sha512-Z274K+e8goZK8QJxmbRPhl89HPO1K+ORFtm6rySPhFKfKc5GHhqdzD0SGhSWHkzoXasqJuItdhorSvY7/Cgflw==