chore: replace manual DB updates with Flyway migrations

Author: nakrovati

README.md

@@ -39,14 +39,6 @@ Yes, you can use your synchronization server in the application by specifying it
 
 ## Installation
 
-### MySQL schema
-
-Before deploying the sync server, you have to run the SQL script to set up the schema for your MySQL database:
-
-```shell
-mysql -h hostname -u user database < ./database.sql
-```
-
 ### Docker
 
 Build image container:

build.gradle.kts

@@ -2,6 +2,7 @@ plugins {
 	alias(libs.plugins.kotlin.jvm)
 	alias(libs.plugins.ktor)
 	alias(libs.plugins.kotlin.plugin.serialization)
+	alias(libs.plugins.flyway)
 }
 
 group = "org.kotatsu"
@@ -31,6 +32,8 @@ dependencies {
 	implementation(libs.ktor.server.auto.head.response)
     implementation(libs.ktorm.core)
     implementation(libs.ktorm.support.mysql)
+	implementation(libs.flyway.core)
+	implementation(libs.flyway.mysql)
 	implementation(libs.hikaricp)
 	implementation(libs.mysql.connector.j)
 	implementation(libs.mariadb.java.client)

database.sql

@@ -3,6 +3,7 @@ kotlin-version = "2.2.0"
 ktor-version = "3.2.2"
 ktorm-version = "4.1.1"
 logback-version = "1.5.18"
+flyway = "11.10.3"
 
 [libraries]
 ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor-version" }
@@ -15,6 +16,8 @@ ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor-
 ktor-server-content-negotiation = { module = "io.ktor:ktor-server-content-negotiation", version.ref = "ktor-version" }
 ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor-version" }
 ktor-server-status-pages = { module = "io.ktor:ktor-server-status-pages", version.ref = "ktor-version" }
+flyway-core = { module = "org.flywaydb:flyway-core", version.ref = "flyway" }
+flyway-mysql = { module = "org.flywaydb:flyway-mysql", version.ref = "flyway" }
 
 ktorm-core = { module = "org.ktorm:ktorm-core", version.ref = "ktorm-version" }
 ktorm-support-mysql = { module = "org.ktorm:ktorm-support-mysql", version.ref = "ktorm-version" }
@@ -31,3 +34,4 @@ kotlin-test-junit = { module = "org.jetbrains.kotlin:kotlin-test-junit", version
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin-version" }
 ktor = { id = "io.ktor.plugin", version.ref = "ktor-version" }
 kotlin-plugin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin-version" }
+flyway = { id = "org.flywaydb.flyway", version.ref = "flyway"}

gradle/libs.versions.toml

@@ -11,6 +11,7 @@ lateinit var database: Database
 fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)
 
 fun Application.module() {
+	runMigrations()
 	configureSerialization()
 	configureDatabase()
 	configureAuthentication()

src/main/kotlin/org/kotatsu/Application.kt

@@ -5,7 +5,7 @@ import org.ktorm.entity.Entity
 interface UserEntity : Entity<UserEntity> {
 	var id: Int
 	var email: String
-	var password: String
+	var passwordHash: String
 	var nickname: String?
 	var favouritesSyncTimestamp: Long?
 	var historySyncTimestamp: Long?

src/main/kotlin/org/kotatsu/model/user/UserEntity.kt

@@ -8,7 +8,7 @@ import org.ktorm.schema.varchar
 object UsersTable : Table<UserEntity>("users") {
 	val id = int("id").primaryKey().bindTo { it.id }
 	val email = varchar("email").bindTo { it.email }
-	val password = varchar("password").bindTo { it.password }
+	val passwordHash = varchar("password_hash").bindTo { it.passwordHash }
 	val nickname = varchar("nickname").bindTo { it.nickname }
 	val favouritesSyncTimestamp = long("favourites_sync_timestamp").bindTo { it.favouritesSyncTimestamp }
 	val historySyncTimestamp = long("history_sync_timestamp").bindTo { it.historySyncTimestamp }

src/main/kotlin/org/kotatsu/model/user/UsersTable.kt

@@ -0,0 +1,20 @@
+package org.kotatsu.plugins
+
+import io.ktor.server.application.*
+import org.flywaydb.core.Flyway
+
+fun Application.runMigrations() {
+	val dbConfig = environment.config.config("database")
+
+	val host = dbConfig.property("host").getString()
+	val port = dbConfig.property("port").getString()
+	val dbName = dbConfig.property("name").getString()
+	val user = dbConfig.property("user").getString()
+	val password = dbConfig.property("password").getString()
+
+	val flyway = Flyway.configure()
+		.dataSource("jdbc:mysql://$host:$port/$dbName", user, password)
+		.load()
+
+	flyway.migrate()
+}

src/main/kotlin/org/kotatsu/plugins/Migration.kt

@@ -20,8 +20,8 @@ suspend fun Database.upsertManga(manga: Manga) {
 	withRetry {
 		insertOrUpdate(MangaTable) {
 			set(it.id, manga.id)
-			set(it.title, manga.title.truncated(84))
-			set(it.altTitle, manga.altTitle?.truncated(84))
+			set(it.title, manga.title.truncated(100))
+			set(it.altTitle, manga.altTitle?.truncated(100))
 			set(it.url, manga.url.truncated(255))
 			set(it.publicUrl, manga.publicUrl.truncated(255))
 			set(it.rating, manga.rating)
@@ -32,8 +32,8 @@ suspend fun Database.upsertManga(manga: Manga) {
 			set(it.author, manga.author?.truncated(64))
 			set(it.mangaSource, manga.source.truncated(32))
 			onDuplicateKey {
-				set(it.title, manga.title.truncated(84))
-				set(it.altTitle, manga.altTitle?.truncated(84))
+				set(it.title, manga.title.truncated(100))
+				set(it.altTitle, manga.altTitle?.truncated(100))
 				set(it.url, manga.url.truncated(255))
 				set(it.publicUrl, manga.publicUrl.truncated(255))
 				set(it.rating, manga.rating)

src/main/kotlin/org/kotatsu/resources/Manga.kt

@@ -14,23 +14,23 @@ suspend fun getOrCreateUser(request: AuthRequest, allowNewRegister: Boolean): Us
 	require(request.password.length in 2..24) {
 		"Password should be from 2 to 24 characters long"
 	}
-	require(request.email.length in 5..120 && '@' in request.email) {
+	require(request.email.length in 5..320 && '@' in request.email) {
 		"Invalid email address"
 	}
 	val passDigest = request.password.md5()
 	val user = database.users.find { (it.email eq request.email) }
 	when {
 		user == null && allowNewRegister -> registerUser(request, passDigest)
 		user == null -> null
-		user.password == passDigest -> user.toUserInfo()
+		user.passwordHash == passDigest -> user.toUserInfo()
 		else -> null
 	}
 }
 
 private fun registerUser(request: AuthRequest, passwordDigest: String): UserInfo? {
 	val userId = database.insertAndGenerateKey(UsersTable) {
 		set(it.email, request.email)
-		set(it.password, passwordDigest)
+		set(it.passwordHash, passwordDigest)
 		set(it.nickname, null)
 		set(it.favouritesSyncTimestamp, null)
 		set(it.historySyncTimestamp, null)