Added Database version migration (#29)

Signed-off-by: Arnau Mora <[email protected]>

Author: ArnyminerZ

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "com.arnyminerz.escalaralcoiaicomtat.backend"
-version = "1.0.20"
+version = "1.0.21"
 
 repositories {
     mavenCentral()

src/main/kotlin/Main.kt

@@ -1,5 +1,6 @@
 import com.arnyminerz.escalaralcoiaicomtat.backend.Logger
 import com.arnyminerz.escalaralcoiaicomtat.backend.ServerDatabase
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.migration.Migrations
 import com.arnyminerz.escalaralcoiaicomtat.backend.localization.Localization
 import com.arnyminerz.escalaralcoiaicomtat.backend.server.plugins.configureEndpoints
 import com.arnyminerz.escalaralcoiaicomtat.backend.server.plugins.installPlugins
@@ -24,6 +25,11 @@ fun main() {
     Logger.info("Connecting to the database, and creating tables...")
     ServerDatabase.instance
 
+    Logger.info("Running database migration if required...")
+    runBlocking {
+        Migrations.runMigrations()
+    }
+
     Logger.info("Initializing Crowdin connection...")
     Localization.init()
 

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/ServerDatabase.kt

@@ -1,5 +1,7 @@
 package com.arnyminerz.escalaralcoiaicomtat.backend
 
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.entity.info.DatabaseVersion
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.migration.Migrations
 import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.Areas
 import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.BlockingTable
 import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.InfoTable
@@ -11,6 +13,7 @@ import kotlinx.coroutines.Dispatchers
 import org.jetbrains.exposed.sql.Database
 import org.jetbrains.exposed.sql.SchemaUtils
 import org.jetbrains.exposed.sql.SqlLogger
+import org.jetbrains.exposed.sql.Transaction
 import org.jetbrains.exposed.sql.addLogger
 import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
 
@@ -74,9 +77,15 @@ class ServerDatabase private constructor() {
         Database.connect(url, driver, username, password)
     }
 
-    suspend fun <T> query(block: suspend () -> T): T = newSuspendedTransaction(Dispatchers.IO, database) {
+    suspend fun <T> query(block: suspend Transaction.() -> T): T = newSuspendedTransaction(Dispatchers.IO, database) {
+        val isFirstRun = SchemaUtils.listDatabases().isEmpty()
+
         SchemaUtils.create(Areas, Zones, Sectors, Paths, BlockingTable, InfoTable)
 
+        if (isFirstRun) {
+            DatabaseVersion.update(Migrations.DATABASE_VERSION)
+        }
+
         logger?.let { addLogger(it) }
 
         block()

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/entity/info/DatabaseVersion.kt

@@ -0,0 +1,28 @@
+package com.arnyminerz.escalaralcoiaicomtat.backend.database.entity.info
+
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.InfoTable
+import org.jetbrains.exposed.dao.EntityClass
+import org.jetbrains.exposed.dao.id.EntityID
+import org.jetbrains.exposed.sql.Transaction
+
+class DatabaseVersion(id: EntityID<String>): InfoEntry(id) {
+    companion object: EntityClass<String, LastUpdate>(InfoTable), InfoEntryCompanion<Int> {
+        private const val ID = "database_version"
+
+        context(Transaction)
+        override fun get(): Int? = findById(ID)?.value?.toIntOrNull()
+
+        context(Transaction)
+        override fun update(value: Int) {
+            val entry = findById(ID)
+            if (entry != null) {
+                // Already exists, update
+                entry.value = value.toString()
+            } else {
+                new(ID) {
+                    this.value = value.toString()
+                }
+            }
+        }
+    }
+}

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/entity/info/InfoEntryCompanion.kt

@@ -0,0 +1,11 @@
+package com.arnyminerz.escalaralcoiaicomtat.backend.database.entity.info
+
+import org.jetbrains.exposed.sql.Transaction
+
+interface InfoEntryCompanion<Type: Any> {
+    context(Transaction)
+    fun get(): Type?
+
+    context(Transaction)
+    fun update(value: Type)
+}

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/entity/info/LastUpdate.kt

@@ -4,24 +4,30 @@ import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.InfoTable
 import java.time.Instant
 import org.jetbrains.exposed.dao.EntityClass
 import org.jetbrains.exposed.dao.id.EntityID
+import org.jetbrains.exposed.sql.Transaction
 
 class LastUpdate(id: EntityID<String>): InfoEntry(id) {
 
-    companion object: EntityClass<String, LastUpdate>(InfoTable) {
+    companion object: EntityClass<String, LastUpdate>(InfoTable), InfoEntryCompanion<Instant> {
         private const val ID = "last_update"
 
-        fun get(): Instant? = findById(ID)?.value?.toLong()?.let(Instant::ofEpochMilli)
+        context(Transaction)
+        override fun get(): Instant? = findById(ID)?.value?.toLong()?.let(Instant::ofEpochMilli)
 
-        fun set(timestamp: Instant = Instant.now()) {
+        context(Transaction)
+        override fun update(value: Instant) {
             val entry = findById(ID)
             if (entry != null) {
                 // Already exists, update
-                entry.value = timestamp.toEpochMilli().toString()
+                entry.value = value.toEpochMilli().toString()
             } else {
                 LastUpdate.new(ID) {
-                    value = timestamp.toEpochMilli().toString()
+                    this.value = value.toEpochMilli().toString()
                 }
             }
         }
+
+        context(Transaction)
+        fun set(value: Instant = Instant.now()) = update(value)
     }
 }

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/migration/Migration.kt

@@ -0,0 +1,18 @@
+package com.arnyminerz.escalaralcoiaicomtat.backend.database.migration
+
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.entity.info.DatabaseVersion
+import org.jetbrains.exposed.sql.Transaction
+
+abstract class Migration(
+    val from: Int?,
+    val to: Int
+) {
+    context (Transaction)
+    suspend fun performMigration() {
+        migrate()
+
+        DatabaseVersion.update(to)
+    }
+
+    protected abstract suspend fun Transaction.migrate()
+}

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/migration/Migrations.kt

@@ -0,0 +1,27 @@
+package com.arnyminerz.escalaralcoiaicomtat.backend.database.migration
+
+import com.arnyminerz.escalaralcoiaicomtat.backend.Logger
+import com.arnyminerz.escalaralcoiaicomtat.backend.ServerDatabase
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.entity.info.DatabaseVersion
+
+object Migrations {
+    const val DATABASE_VERSION = 1
+
+    private val values = arrayOf<Migration>(To1)
+
+    suspend fun runMigrations() {
+        ServerDatabase.instance.query {
+            var currentVersion = DatabaseVersion.get()
+            while (currentVersion != DATABASE_VERSION) {
+                val migration = values.find { it.from == currentVersion }
+                require(migration != null) {
+                    "Could not find migration from version $currentVersion. Database version: $DATABASE_VERSION"
+                }
+                migration.performMigration()
+
+                currentVersion = DatabaseVersion.get()
+            }
+            Logger.info("Database is up to date.")
+        }
+    }
+}

src/main/kotlin/com/arnyminerz/escalaralcoiaicomtat/backend/database/migration/To1.kt

@@ -0,0 +1,11 @@
+package com.arnyminerz.escalaralcoiaicomtat.backend.database.migration
+
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.SqlConsts
+import com.arnyminerz.escalaralcoiaicomtat.backend.database.table.Paths
+import org.jetbrains.exposed.sql.Transaction
+
+object To1: Migration(null, 1) {
+    override suspend fun Transaction.migrate() {
+        this.exec("ALTER TABLE Paths ADD images varchar(${SqlConsts.FILE_LENGTH * Paths.MAX_IMAGES});")
+    }
+}