Migrated to Kotlin Serialization (#135)

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

Author: ArnyminerZ

.gitignore

@@ -44,6 +44,7 @@ bin/
 
 ### Ignore testing database ###
 testing.db
+testing.db-journal
 
 ### Ignore secrets file ###
 local.properties

build.gradle.kts

@@ -4,8 +4,9 @@ import io.ktor.plugin.features.DockerPortMappingProtocol
 
 plugins {
     alias(libs.plugins.kotlin.jvm)
-    alias(libs.plugins.ktor)
+    alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.kotlinx.kover)
+    alias(libs.plugins.ktor)
     alias(libs.plugins.sentry)
 }
 
@@ -29,10 +30,8 @@ val tcnativeClassifier = when {
 }
 
 dependencies {
-    // JSON support
-    implementation(libs.json)
-
     // Ktor dependencies
+    implementation(libs.ktor.server.contentNegotiation)
     implementation(libs.ktor.server.core)
     implementation(libs.ktor.server.netty)
     implementation(libs.ktor.server.locations)
@@ -41,14 +40,20 @@ dependencies {
     implementation(libs.ktor.utils)
 
     // Ktor client for making requests
+    implementation(libs.ktor.client.contentNegotiation)
     implementation(libs.ktor.client.core)
     implementation(libs.ktor.client.cio)
 
+    // Kotlin Serialization & Ktor Serialization
+    implementation(libs.kotlin.serializationJson)
+    implementation(libs.ktor.serializationJson)
+
     // Exposed dependencies
     implementation(libs.exposed.core)
     implementation(libs.exposed.dao)
     implementation(libs.exposed.jdbc)
     implementation(libs.exposed.javaTime)
+    implementation(libs.exposed.json)
 
     // Database engines
     implementation(libs.postgresql)

gradle/libs.versions.toml

@@ -4,9 +4,9 @@ exposed = "0.51.1"
 firebase-admin = "9.3.0"
 foojay-resolver = "0.8.0"
 imageio-webp = "0.1.6"
-json = "20240303"
 kotlin = "2.0.0"
 kotlinx-kover = "0.8.0"
+kotlin-serialization = "1.6.3"
 ktor = "2.3.11"
 postgresql = "42.7.3"
 progressbar = "0.10.1"
@@ -17,10 +17,13 @@ sqlite = "3.46.0.0"
 crowdin = { module = "com.github.crowdin:crowdin-api-client-java", version.ref = "crowdin" }
 firebase-admin = { module = "com.google.firebase:firebase-admin", version.ref = "firebase-admin" }
 imageio-webp = { module = "org.sejda.imageio:webp-imageio", version.ref = "imageio-webp" }
-json = { module = "org.json:json", version.ref = "json" }
+kotlin-serializationJson = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlin-serialization" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+ktor-client-contentNegotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
 ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
+ktor-serializationJson = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
+ktor-server-contentNegotiation = { module = "io.ktor:ktor-server-content-negotiation", version.ref = "ktor" }
 ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" }
 ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor" }
 ktor-server-locations = { module = "io.ktor:ktor-server-locations", version.ref = "ktor" }
@@ -32,13 +35,14 @@ exposed-core = { module = "org.jetbrains.exposed:exposed-core", version.ref = "e
 exposed-dao = { module = "org.jetbrains.exposed:exposed-dao", version.ref = "exposed" }
 exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "exposed" }
 exposed-javaTime = { module = "org.jetbrains.exposed:exposed-java-time", version.ref = "exposed" }
+exposed-json = { module = "org.jetbrains.exposed:exposed-json", version.ref = "exposed" }
 postgresql = { module = "org.postgresql:postgresql", version.ref = "postgresql" }
 progressbar = { module = "me.tongfei:progressbar", version.ref = "progressbar" }
 sqlite = { module = "org.xerial:sqlite-jdbc", version.ref = "sqlite" }
 
 [plugins]
-gradle-toolchains-fooljayResolver = { id = "org.gradle.toolchains.foojay-resolver-convention", version.ref = "foojay-resolver" }
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 kotlinx-kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kotlinx-kover" }
 ktor = { id = "io.ktor.plugin", version.ref = "ktor" }
 sentry = { id = "io.sentry.jvm.gradle", version.ref = "sentry" }

src/main/kotlin/Main.kt

@@ -28,7 +28,7 @@ fun main() {
     ServerDatabase.configureFromEnvironment()
 
     Logger.info("Connecting to the database, and creating tables...")
-    ServerDatabase.instance.initialize()
+    runBlocking { ServerDatabase.instance.initialize() }
 
     Logger.info("Initializing Crowdin connection...")
     Localization.init()

src/main/kotlin/ServerDatabase.kt

@@ -1,3 +1,5 @@
+import database.entity.info.Version
+import database.migration.Migration
 import database.table.Areas
 import database.table.BlockingTable
 import database.table.InfoTable
@@ -46,6 +48,8 @@ class ServerDatabase private constructor() {
          */
         val instance by lazy { ServerDatabase() }
 
+        const val VERSION = 1
+
         /**
          * Configures the database connection parameters from the environment variables.
          *
@@ -78,13 +82,36 @@ class ServerDatabase private constructor() {
      * Creates all the missing tables and columns for the database.
      * Should be run as soon as possible in the program's lifecycle.
      */
-    fun initialize() = transaction(database) {
+    suspend fun initialize() = invoke {
         SchemaUtils.createMissingTablesAndColumns(Areas, Zones, Sectors, Paths, BlockingTable, InfoTable)
+
+        var loops = 0
+        while (Version.updateRequired()) {
+            check(loops++ <= VERSION) { "Version update loop detected" }
+            val version = Version.get()
+            val migration = Migration.all.find { it.from == version }
+                ?: error("No migration found for version $version")
+            Logger.info("Migrating database from version $version to ${migration.to}")
+            with(migration) { this@invoke() }
+        }
     }
 
+    suspend operator fun <T> invoke(block: suspend Transaction.() -> T): T = query(block)
+
     suspend fun <T> query(block: suspend Transaction.() -> T): T = newSuspendedTransaction(Dispatchers.IO, database) {
         logger?.let { addLogger(it) }
 
         block()
     }
+
+    /**
+     * Begins a transaction and runs the given block of code in it.
+     *
+     * @param block The block of code to run in the transaction.
+     */
+    fun <T> querySync(block: Transaction.() -> T) = transaction(database) {
+        logger?.let { addLogger(it) }
+
+        block()
+    }
 }

src/main/kotlin/data/BlockingRecurrenceYearly.kt

@@ -1,34 +1,15 @@
 package data
 
 import java.time.Month
-import org.json.JSONObject
-import utils.getUShort
-import utils.jsonOf
-import utils.serialization.JsonSerializable
-import utils.serialization.JsonSerializer
+import kotlinx.serialization.Serializable
 
+@Serializable
 data class BlockingRecurrenceYearly(
     val fromDay: UShort,
     val fromMonth: Month,
     val toDay: UShort,
     val toMonth: Month
-): JsonSerializable {
-    companion object: JsonSerializer<BlockingRecurrenceYearly> {
-        override fun fromJson(json: JSONObject): BlockingRecurrenceYearly = BlockingRecurrenceYearly(
-            json.getUShort("from_day"),
-            json.getEnum(Month::class.java, "from_month"),
-            json.getUShort("to_day"),
-            json.getEnum(Month::class.java, "to_month")
-        )
-    }
-
-    override fun toJson(): JSONObject = jsonOf(
-        "from_day" to fromDay,
-        "from_month" to fromMonth,
-        "to_day" to toDay,
-        "to_month" to toMonth
-    )
-
+) {
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false

src/main/kotlin/data/BlockingTypes.kt

@@ -1,8 +1,10 @@
 package data
 
 import KoverIgnore
+import kotlinx.serialization.Serializable
 
 @KoverIgnore
+@Serializable
 enum class BlockingTypes {
     DRY, BUILD, BIRD, OLD, PLANTS, ROPE_LENGTH
 }

src/main/kotlin/data/Builder.kt

@@ -1,21 +1,9 @@
 package data
 
-import org.json.JSONObject
-import utils.getStringOrNull
-import utils.jsonOf
-import utils.serialization.JsonSerializable
-import utils.serialization.JsonSerializer
+import kotlinx.serialization.Serializable
 
+@Serializable
 data class Builder(
     val name: String?,
     val date: String?
-): JsonSerializable {
-    companion object: JsonSerializer<Builder> {
-        override fun fromJson(json: JSONObject): Builder = Builder(
-            json.getStringOrNull("name"),
-            json.getStringOrNull("date")
-        )
-    }
-
-    override fun toJson(): JSONObject = jsonOf("name" to name, "date" to date)
-}
+)

src/main/kotlin/data/DataPoint.kt

@@ -1,9 +1,6 @@
 package data
 
-import org.json.JSONObject
-import utils.jsonOf
-import utils.serialization.JsonSerializable
-import utils.serialization.JsonSerializer
+import kotlinx.serialization.Serializable
 
 /**
  * Represents a data point with location, label, and icon information.
@@ -12,22 +9,9 @@ import utils.serialization.JsonSerializer
  * @property label The label associated with the data point.
  * @property icon The icon associated with the data point.
  */
+@Serializable
 data class DataPoint(
     val location: LatLng,
     val label: String,
     val icon: String
-): JsonSerializable {
-    companion object: JsonSerializer<DataPoint> {
-        override fun fromJson(json: JSONObject): DataPoint = DataPoint(
-            LatLng.fromJson(json.getJSONObject("location")),
-            json.getString("label"),
-            json.getString("icon")
-        )
-    }
-
-    override fun toJson(): JSONObject = jsonOf(
-        "location" to location,
-        "label" to label,
-        "icon" to icon
-    )
-}
+)

src/main/kotlin/data/Ending.kt

@@ -1,8 +1,10 @@
 package data
 
 import KoverIgnore
+import kotlinx.serialization.Serializable
 
 @KoverIgnore
+@Serializable
 enum class Ending {
     NONE,
     PLATE,