refactor: migrate to platform CloudApi and remove ControllerApi usage

Author: FllipEis

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 val baseVersion = "0.0.1"
 val commitHash = System.getenv("COMMIT_HASH")
 val timestamp = System.currentTimeMillis() // Temporary to be able to build and publish directly out of fix branch with same commit hash
-val snapshotVersion = "${baseVersion}-dev.${timestamp}-${commitHash}"
+val snapshotVersion = "${baseVersion}-platform.${timestamp}-${commitHash}"
 
 allprojects {
     group = "app.simplecloud.plugin"
@@ -19,7 +19,6 @@ allprojects {
         maven("https://libraries.minecraft.net")
         maven("https://buf.build/gen/maven")
         maven("https://repo.simplecloud.app/snapshots")
-        maven("https://buf.build/gen/maven")
         maven("https://repo.papermc.io/repository/maven-public")
     }
 }
@@ -31,8 +30,11 @@ subprojects {
     dependencies {
         testImplementation(rootProject.libs.kotlin.test)
         compileOnly(rootProject.libs.kotlin.jvm)
-        compileOnly(rootProject.libs.bundles.simpleCloudController)
+        compileOnly(rootProject.libs.kotlin.coroutines)
+        compileOnly(rootProject.libs.simplecloud.api)
         compileOnly(rootProject.libs.bundles.adventure)
+        compileOnly(rootProject.libs.bundles.configurate)
+        compileOnly(rootProject.libs.slf4j.api)
     }
 
     kotlin {

gradle/libs.versions.toml

@@ -1,22 +1,31 @@
 [versions]
-kotlin = "2.0.20"
-simpleCloudController = "0.0.30-dev.e3e27fc"
+kotlin = "2.1.0"
+kotlin-coroutines = "1.10.2"
+simplecloud-api = "0.1.0-platform.5-dev.1765910097897-3d59340"
 sonatype-central-portal-publisher = "1.2.3"
 adventure = "4.18.0"
+configurate = "4.2.0"
+slf4j = "2.0.17"
 
 [libraries]
 kotlin-jvm = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+kotlin-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlin-coroutines" }
 
-simpleCloudControllerApi = { module = "app.simplecloud.controller:controller-api", version.ref = "simpleCloudController" }
-simpleCloudControllerShared = { module = "app.simplecloud.controller:controller-shared", version.ref = "simpleCloudController" }
+simplecloud-api = { module = "app.simplecloud.api:api", version.ref = "simplecloud-api" }
 
 adventure = { module = "net.kyori:adventure-api", version.ref = "adventure" }
-adventureMiniMessage = { module = "net.kyori:adventure-text-minimessage", version.ref = "adventure" }
+adventure-minimessage = { module = "net.kyori:adventure-text-minimessage", version.ref = "adventure" }
+
+configurate-yaml = { module = "org.spongepowered:configurate-yaml", version.ref = "configurate" }
+configurate-gson = { module = "org.spongepowered:configurate-gson", version.ref = "configurate" }
+configurate-extra-kotlin = { module = "org.spongepowered:configurate-extra-kotlin", version.ref = "configurate" }
+
+slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
 
 [bundles]
-simpleCloudController = ["simpleCloudControllerApi", "simpleCloudControllerShared"]
-adventure = ["adventure", "adventureMiniMessage"]
+adventure = ["adventure", "adventure-minimessage"]
+configurate = ["configurate-yaml", "configurate-gson", "configurate-extra-kotlin"]
 
 [plugins]
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/extension/Extension.kt

@@ -1,7 +1,7 @@
 package app.simplecloud.plugin.api.shared.extension
 
-import app.simplecloud.controller.shared.group.Group
-import app.simplecloud.controller.shared.server.Server
+import app.simplecloud.api.group.Group
+import app.simplecloud.api.server.Server
 import app.simplecloud.plugin.api.shared.placeholder.PlaceholderProvider
 import app.simplecloud.plugin.api.shared.placeholder.argument.ArgumentsResolver
 import net.kyori.adventure.text.Component

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/pattern/ServerPatternIdentifier.kt

@@ -1,29 +1,21 @@
 package app.simplecloud.plugin.api.shared.pattern
 
-import app.simplecloud.controller.api.ControllerApi
-import app.simplecloud.controller.shared.group.Group
-import app.simplecloud.controller.shared.server.Server
+import app.simplecloud.api.CloudApi
+import app.simplecloud.api.group.Group
+import app.simplecloud.api.server.Server
 import app.simplecloud.plugin.api.shared.pretty.StringPrettifier
-
-/**
- * @author Niklas Nieberler
- */
+import kotlinx.coroutines.future.await
 
 class ServerPatternIdentifier(
     private val pattern: String = "<group_name>-<numerical_id>",
     regexPattern: String = pattern
         .replace("<group_name>", "(?<groupName>[a-zA-Z]+)")
         .replace("<numerical_id>", "(?<numericalId>\\d+)"),
-    private val controllerApi: ControllerApi.Coroutine = ControllerApi.createCoroutineApi()
+    private val cloudApi: CloudApi = CloudApi.create()
 ) {
 
     private val regex = Regex(regexPattern)
 
-    /**
-     * Gets the group and numerical id matching the [pattern] in a [Pair]
-     * @param name the server name
-     * @param customRegex custom regex pattern
-     */
     fun parse(name: String, customRegex: Regex? = null): Pair<String, Int> {
         val matchResult = customRegex?.matchEntire(name) ?: this.regex.matchEntire(name)
         if (matchResult == null)
@@ -36,34 +28,26 @@ class ServerPatternIdentifier(
         return Pair(groupName, numericalId)
     }
 
-    /**
-     * Gets a server string as a set in the pattern
-     * @param server replaces it to pattern
-     */
     fun parseServerToPattern(server: Server): String {
         return this.pattern
-            .replace("<group_name>", server.group)
-            .replace("<group_pretty_name>", server.properties["pretty-name"] ?: StringPrettifier.prettify(server.group))
-            .replace("<id>", server.uniqueId)
-            .replace("<unique_id>", server.uniqueId)
+            .replace("<group_name>", server.serverBase.name)
+            .replace("<group_pretty_name>", server.properties["pretty-name"]?.toString() ?: StringPrettifier.prettify(server.serverBase.name))
+            .replace("<id>", server.serverId)
+            .replace("<unique_id>", server.serverId)
             .replace("<numerical_id>", server.numericalId.toString())
     }
 
-    /**
-     * Gets the [Group] by the matching [pattern]
-     * @param name the server name
-     */
     suspend fun getGroup(name: String): Group? {
         val groupName = parse(name).first
-        return this.controllerApi.getGroups().getGroupByName(groupName)
+        return try {
+            this.cloudApi.group().getGroupByName(groupName).await()
+        } catch (e: Exception) {
+            null
+        }
     }
 
-    /**
-     * Gets the numerical id by the matching [pattern]
-     * @param name the server name
-     */
     fun getNumericalId(name: String): Int {
         return parse(name).second
     }
 
-}
+}

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/argument/PropertiesArgumentsResolver.kt

@@ -8,7 +8,7 @@ import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue
  */
 
 class PropertiesArgumentsResolver(
-    private val properties: Map<String, String>
+    private val properties: Map<String, Any>
 ) : ArgumentsResolver {
 
     override fun getKey() = "property"
@@ -17,7 +17,7 @@ class PropertiesArgumentsResolver(
         val argumentName = arguments.popOr("property expected").value()
         val defaultArgument = arguments.peek()?.value() ?: ""
         val string = this.properties[argumentName] ?: defaultArgument
-        return Tag.preProcessParsed(string)
+        return Tag.preProcessParsed(string.toString())
     }
 
 }

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/argument/group/PlayerCountArgumentsResolver.kt

@@ -1,21 +1,15 @@
 package app.simplecloud.plugin.api.shared.placeholder.argument.group
 
-import app.simplecloud.controller.api.ControllerApi
-import app.simplecloud.controller.shared.group.Group
+import app.simplecloud.api.CloudApi
+import app.simplecloud.api.group.Group
+import app.simplecloud.api.server.ServerState
 import app.simplecloud.plugin.api.shared.placeholder.argument.ArgumentsResolver
-import build.buf.gen.simplecloud.controller.v1.ServerState
+import kotlinx.coroutines.future.await
 import net.kyori.adventure.text.minimessage.tag.Tag
 import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue
-import kotlin.collections.filter
-import kotlin.collections.firstOrNull
-import kotlin.collections.sumOf
-
-/**
- * @author Niklas Nieberler
- */
 
 class PlayerCountArgumentsResolver(
-    private val controllerApi: ControllerApi.Coroutine,
+    private val cloudApi: CloudApi,
     private val group: Group,
 ) : ArgumentsResolver {
 
@@ -27,10 +21,13 @@ class PlayerCountArgumentsResolver(
         return Tag.preProcessParsed(findPlayerCount(this.group, serverState).toString())
     }
 
-    private suspend fun findPlayerCount(group: Group, state: ServerState?): Long {
-        return this.controllerApi.getServers().getServersByGroup(group)
-            .filter { it.state == state }
-            .sumOf { it.playerCount }
+    private suspend fun findPlayerCount(group: Group, state: ServerState?): Int {
+        val servers = this.cloudApi.server().getServersByGroup(group.name).await()
+        return if (state != null) {
+            servers.filter { it.state == state }.sumOf { it.playerCount }
+        } else {
+            servers.sumOf { it.playerCount }
+        }
     }
 
-}
+}

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/argument/group/ServerCountArgumentsResolver.kt

@@ -1,20 +1,15 @@
 package app.simplecloud.plugin.api.shared.placeholder.argument.group
 
-import app.simplecloud.controller.api.ControllerApi
-import app.simplecloud.controller.shared.group.Group
+import app.simplecloud.api.CloudApi
+import app.simplecloud.api.group.Group
+import app.simplecloud.api.server.ServerState
 import app.simplecloud.plugin.api.shared.placeholder.argument.ArgumentsResolver
-import build.buf.gen.simplecloud.controller.v1.ServerState
+import kotlinx.coroutines.future.await
 import net.kyori.adventure.text.minimessage.tag.Tag
 import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue
-import kotlin.collections.filter
-import kotlin.collections.firstOrNull
-
-/**
- * @author Niklas Nieberler
- */
 
 class ServerCountArgumentsResolver(
-    private val controllerApi: ControllerApi.Coroutine,
+    private val cloudApi: CloudApi,
     private val group: Group,
 ) : ArgumentsResolver {
 
@@ -23,13 +18,16 @@ class ServerCountArgumentsResolver(
     override suspend fun resolve(arguments: ArgumentQueue): Tag? {
         val text = arguments.popOr("all").value()
         val serverState = ServerState.entries.firstOrNull { it.name.equals(text, true) }
-        return Tag.preProcessParsed(findPlayerCount(this.group, serverState).toString())
+        return Tag.preProcessParsed(findServerCount(this.group, serverState).toString())
     }
 
-    private suspend fun findPlayerCount(group: Group, state: ServerState?): Int {
-        return this.controllerApi.getServers().getServersByGroup(group)
-            .filter { it.state == state }
-            .size
+    private suspend fun findServerCount(group: Group, state: ServerState?): Int {
+        val servers = this.cloudApi.server().getServersByGroup(group.name).await()
+        return if (state != null) {
+            servers.filter { it.state == state }.size
+        } else {
+            servers.size
+        }
     }
 
-}
+}

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/provider/AbstractPlaceholderProvider.kt

@@ -1,6 +1,6 @@
 package app.simplecloud.plugin.api.shared.placeholder.provider
 
-import app.simplecloud.controller.api.ControllerApi
+import app.simplecloud.api.CloudApi
 import app.simplecloud.plugin.api.shared.extension.text
 import app.simplecloud.plugin.api.shared.placeholder.argument.ArgumentsResolver
 import app.simplecloud.plugin.api.shared.placeholder.single.SinglePlaceholderExecutor
@@ -16,15 +16,15 @@ abstract class AbstractPlaceholderProvider<T>(
     private val executor: SinglePlaceholderExecutor<T>,
 ) {
 
-    private val controllerApi = ControllerApi.createCoroutineApi()
+    private val cloudApi = CloudApi.create()
 
     /**
      * Gets the list of all available [ArgumentsResolver]
-     * @param controllerApi the instance of [ControllerApi.Coroutine]
+     * @param cloudApi the instance of [CloudApi]
      * @param value for the placeholder
      */
     abstract suspend fun getArgumentsResolvers(
-        controllerApi: ControllerApi.Coroutine,
+        cloudApi: CloudApi,
         value: T,
     ): List<ArgumentsResolver>
 
@@ -39,10 +39,10 @@ abstract class AbstractPlaceholderProvider<T>(
         vararg argumentsResolver: ArgumentsResolver,
     ): TagResolver {
         val availableArgumentsResolver = listOf(
-            *getArgumentsResolvers(this.controllerApi, value).toTypedArray(),
+            *getArgumentsResolvers(this.cloudApi, value).toTypedArray(),
             *argumentsResolver
         )
-        val singleTagResolver = this.executor.getTagResolver(this.controllerApi, value, prefix)
+        val singleTagResolver = this.executor.getTagResolver(this.cloudApi, value, prefix)
         return TagResolver.resolver(
             singleTagResolver,
             *availableArgumentsResolver

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/provider/GroupPlaceholderProvider.kt

@@ -1,24 +1,20 @@
 package app.simplecloud.plugin.api.shared.placeholder.provider
 
-import app.simplecloud.controller.api.ControllerApi
-import app.simplecloud.controller.shared.group.Group
+import app.simplecloud.api.CloudApi
+import app.simplecloud.api.group.Group
 import app.simplecloud.plugin.api.shared.placeholder.argument.PropertiesArgumentsResolver
 import app.simplecloud.plugin.api.shared.placeholder.argument.group.PlayerCountArgumentsResolver
 import app.simplecloud.plugin.api.shared.placeholder.argument.group.ServerCountArgumentsResolver
 import app.simplecloud.plugin.api.shared.placeholder.single.SingleGroupPlaceholderExecutor
 
-/**
- * @author Niklas Nieberler
- */
-
 class GroupPlaceholderProvider : AbstractPlaceholderProvider<Group>(
     SingleGroupPlaceholderExecutor()
 ) {
 
-    override suspend fun getArgumentsResolvers(controllerApi: ControllerApi.Coroutine, value: Group) = listOf(
+    override suspend fun getArgumentsResolvers(cloudApi: CloudApi, value: Group) = listOf(
         PropertiesArgumentsResolver(value.properties),
-        PlayerCountArgumentsResolver(controllerApi, value),
-        ServerCountArgumentsResolver(controllerApi, value)
+        PlayerCountArgumentsResolver(cloudApi, value),
+        ServerCountArgumentsResolver(cloudApi, value)
     )
 
-}
+}

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/provider/ServerPlaceholderProvider.kt

@@ -1,7 +1,7 @@
 package app.simplecloud.plugin.api.shared.placeholder.provider
 
-import app.simplecloud.controller.api.ControllerApi
-import app.simplecloud.controller.shared.server.Server
+import app.simplecloud.api.CloudApi
+import app.simplecloud.api.server.Server
 import app.simplecloud.plugin.api.shared.placeholder.argument.*
 import app.simplecloud.plugin.api.shared.placeholder.single.SingleServerPlaceholderExecutor
 
@@ -13,7 +13,7 @@ class ServerPlaceholderProvider : AbstractPlaceholderProvider<Server>(
     SingleServerPlaceholderExecutor()
 ) {
 
-    override suspend fun getArgumentsResolvers(controllerApi: ControllerApi.Coroutine, value: Server) = listOf(
+    override suspend fun getArgumentsResolvers(cloudApi: CloudApi, value: Server) = listOf(
         PropertiesArgumentsResolver(value.properties)
     )