feat: add support for Flyway configuration overrides and standalone application customization

- Introduced `FlywayDisabler` to handle dynamic Flyway configuration based on `StandaloneConfigHolder`.
- Enhanced `StandaloneConfigHolder` to include Flyway-specific settings and a global configuration accessor.
- Updated `PluginFlywayConfigurationCustomizer` with Flyway-related application customization.
- Added `CloudSpringApplicationConfiguration` interface for modular Spring application configuration.
- Centralized Flyway configuration logic with caching mechanisms for improved performance and reuse.
- Refactored database configuration to include additional Flyway options.

Author: twisti-dev

surf-cloud-api/surf-cloud-api-common/build.gradle.kts

@@ -1,8 +1,4 @@
 import dev.slne.surf.surfapi.gradle.util.slneReleases
-import gradle.kotlin.dsl.accessors._2c95f20277cbe6143532f6e8d67e36cc.processResources
-import org.gradle.internal.impldep.org.junit.experimental.categories.Categories.CategoryFilter.exclude
-import org.jetbrains.kotlin.gradle.idea.proto.com.google.protobuf.api
-import org.jetbrains.kotlin.gradle.internal.config.AnalysisFlags.optIn
 
 plugins {
     `exclude-kotlin`
@@ -56,4 +52,4 @@ publishing {
     repositories {
         slneReleases()
     }
-}
+}

surf-cloud-core/surf-cloud-core-common/src/main/kotlin/dev/slne/surf/cloud/core/common/CloudCoreInstance.kt

@@ -16,10 +16,7 @@ import dev.slne.surf.cloud.core.common.player.punishment.CloudPlayerPunishmentMa
 import dev.slne.surf.cloud.core.common.player.task.PrePlayerJoinTaskAutoRegistrationHandler
 import dev.slne.surf.cloud.core.common.plugin.task.CloudBeforeStartTaskHandler
 import dev.slne.surf.cloud.core.common.processors.NettyPacketProcessor
-import dev.slne.surf.cloud.core.common.spring.CloudChildSpringApplicationConfiguration
-import dev.slne.surf.cloud.core.common.spring.CloudLifecycleAware
-import dev.slne.surf.cloud.core.common.spring.CloudUncaughtExceptionHandler
-import dev.slne.surf.cloud.core.common.spring.SurfSpringBanner
+import dev.slne.surf.cloud.core.common.spring.*
 import dev.slne.surf.cloud.core.common.spring.event.RootSpringContextInitialized
 import dev.slne.surf.cloud.core.common.util.getCallerClass
 import dev.slne.surf.cloud.core.common.util.tempChangeSystemClassLoader
@@ -154,6 +151,11 @@ class CloudCoreInstance : CloudInstance {
             .profiles(springProfile)
             .initializers(NettyPacketProcessor())
             .web(WebApplicationType.NONE)
+            .apply {
+                for (configuration in CloudSpringApplicationConfiguration.configurations) {
+                    configuration.configureApplication(this)
+                }
+            }
             .run()
     }
 
@@ -166,7 +168,12 @@ class CloudCoreInstance : CloudInstance {
         val joinClassLoader = JoinClassLoader(classLoader, parentClassLoader)
         return tempChangeSystemClassLoader(joinClassLoader) {
             val parentContext = internalContext ?: error("Parent context is not initialized yet.")
-            val resourceLoader = DefaultResourceLoader(JoinClassLoader(joinClassLoader, listOf(javaClass.classLoader)))
+            val resourceLoader = DefaultResourceLoader(
+                JoinClassLoader(
+                    joinClassLoader,
+                    listOf(javaClass.classLoader)
+                )
+            )
             val childConfigurations =
                 parentContext.getBeansOfType(CloudChildSpringApplicationConfiguration::class.java)
 

surf-cloud-core/surf-cloud-core-common/src/main/kotlin/dev/slne/surf/cloud/core/common/config/AbstractSurfCloudConfig.kt

@@ -30,12 +30,7 @@ abstract class AbstractSurfCloudConfigHolder<C : AbstractSurfCloudConfig>(
     private val manager: SpongeConfigManager<C>
 
     init {
-        surfConfigApi.createSpongeYmlConfig(
-            configClass,
-            coreCloudInstance.dataFolder,
-            "config.yml"
-        )
-
+        createConfig(configClass)
         manager = surfConfigApi.getSpongeConfigManagerForConfig(configClass)
     }
 
@@ -53,4 +48,12 @@ abstract class AbstractSurfCloudConfigHolder<C : AbstractSurfCloudConfig>(
         reloadAware.forEachAnnotationOrdered { it.beforeSave() }
         manager.save()
     }
+
+    companion object {
+        fun <C> createConfig(configClass: Class<C>) = surfConfigApi.createSpongeYmlConfig(
+            configClass,
+            coreCloudInstance.dataFolder,
+            "config.yml"
+        )
+    }
 }

surf-cloud-core/surf-cloud-core-common/src/main/kotlin/dev/slne/surf/cloud/core/common/config/connection/db/DatabaseConfig.kt

@@ -20,8 +20,18 @@ data class DatabaseConfig(
 
     @Comment("Type of database to connect to")
     @Setting("type")
-    val type: DatabaseType = DatabaseType.MARIADB
+    val type: DatabaseType = DatabaseType.MARIADB,
+
+    val flyway: FlywayConfig = FlywayConfig()
 ) {
+
+    @ConfigSerializable
+    data class FlywayConfig(
+        val enabled: Boolean = true,
+        val baselineOnMigrate: Boolean = false,
+    )
+
+
     enum class DatabaseType(val driver: String) {
         MYSQL("com.mysql.cj.jdbc.Driver"),
         MARIADB("org.mariadb.jdbc.Driver"),

surf-cloud-core/surf-cloud-core-common/src/main/kotlin/dev/slne/surf/cloud/core/common/spring/CloudSpringApplicationConfiguration.kt

@@ -0,0 +1,16 @@
+package dev.slne.surf.cloud.core.common.spring
+
+import net.kyori.adventure.util.Services
+import org.springframework.boot.builder.SpringApplicationBuilder
+
+interface CloudSpringApplicationConfiguration {
+
+    fun configureApplication(
+        builder: SpringApplicationBuilder
+    )
+
+    companion object {
+        val configurations: Set<CloudSpringApplicationConfiguration> =
+            Services.services(CloudSpringApplicationConfiguration::class.java)
+    }
+}

surf-cloud-standalone/src/main/kotlin/dev/slne/surf/cloud/standalone/config/StandaloneConfigHolder.kt

@@ -1,10 +1,24 @@
 package dev.slne.surf.cloud.standalone.config
 
+import dev.slne.surf.cloud.core.common.CloudCoreInstance
 import dev.slne.surf.cloud.core.common.config.AbstractSurfCloudConfigHolder
 import dev.slne.surf.cloud.core.common.config.ConfigReloadAware
 import org.springframework.beans.factory.ObjectProvider
+import org.springframework.beans.factory.getBean
 import org.springframework.stereotype.Component
 
 @Component
 class StandaloneConfigHolder(reloadAware: ObjectProvider<ConfigReloadAware>) :
-    AbstractSurfCloudConfigHolder<StandaloneConfig>(reloadAware, StandaloneConfig::class.java)
+    AbstractSurfCloudConfigHolder<StandaloneConfig>(reloadAware, StandaloneConfig::class.java) {
+
+    companion object {
+        val holder
+            get() = CloudCoreInstance.internalContext?.getBean<StandaloneConfigHolder>()
+                ?: error("StandaloneConfigHolder is not initialized yet")
+
+        fun isFlywayEnabled(): Boolean = createConfig(StandaloneConfig::class.java)
+            .connectionConfig
+            .databaseConfig
+            .flyway.enabled
+    }
+}

surf-cloud-standalone/src/main/kotlin/dev/slne/surf/cloud/standalone/plugin/spring/PluginSpringConfig.kt

@@ -16,7 +16,8 @@ import org.springframework.boot.builder.SpringApplicationBuilder
 import org.springframework.stereotype.Component
 
 @Component
-class PluginSpringConfig : CloudChildSpringApplicationConfiguration {
+class PluginSpringConfig() :
+    CloudChildSpringApplicationConfiguration {
 
     override fun configureChildApplication(
         builder: SpringApplicationBuilder,

surf-cloud-standalone/src/main/kotlin/dev/slne/surf/cloud/standalone/plugin/spring/config/DatabaseConfig.kt

@@ -1,9 +1,11 @@
 package dev.slne.surf.cloud.standalone.plugin.spring.config
 
+import com.github.benmanes.caffeine.cache.Caffeine
 import dev.slne.surf.cloud.api.server.plugin.configuration.PluginMeta
 import dev.slne.surf.cloud.standalone.plugin.PluginInitializerManager
 import dev.slne.surf.surfapi.core.api.config.createSpongeYmlConfig
 import dev.slne.surf.surfapi.core.api.config.surfConfigApi
+import net.kyori.adventure.util.TriState
 import org.spongepowered.configurate.objectmapping.ConfigSerializable
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
@@ -21,6 +23,7 @@ data class DatabaseConfig(
 ) {
     @ConfigSerializable
     data class FlywayConfig(
+        val enabled: TriState = TriState.NOT_SET,
         val baselineOnMigrate: Boolean = false,
     )
 
@@ -38,10 +41,21 @@ data class DatabaseConfig(
 @Profile("plugin")
 class DatabaseConfigConfiguration {
 
+    companion object {
+        private val configurations = Caffeine.newBuilder()
+            .build<String, DatabaseConfig>()
+
+
+        fun getOrCreate(meta: PluginMeta) = configurations.get(meta.name) {
+            createDatabaseConfig(PluginInitializerManager.pluginDirectoryPath / meta.name)
+        }
+    }
+
+
     @Suppress("SpringJavaInjectionPointsAutowiringInspection")
     @Bean
     fun pluginDatabaseConfig(meta: PluginMeta): DatabaseConfig {
-        return createDatabaseConfig(PluginInitializerManager.pluginDirectoryPath / meta.name)
+        return getOrCreate(meta)
     }
 }
 

surf-cloud-standalone/src/main/kotlin/dev/slne/surf/cloud/standalone/plugin/spring/config/PluginFlywayConfigurationCustomizer.kt

@@ -1,13 +1,16 @@
 package dev.slne.surf.cloud.standalone.plugin.spring.config
 
 import dev.slne.surf.cloud.api.server.plugin.provider.classloader.SpringPluginClassloader
+import dev.slne.surf.cloud.core.common.spring.CloudChildSpringApplicationConfiguration
+import dev.slne.surf.cloud.standalone.config.StandaloneConfigHolder
 import dev.slne.surf.surfapi.core.api.reflection.Field
 import dev.slne.surf.surfapi.core.api.reflection.SurfProxy
 import dev.slne.surf.surfapi.core.api.reflection.createProxy
 import dev.slne.surf.surfapi.core.api.reflection.surfReflection
 import org.flywaydb.core.api.configuration.ClassicConfiguration
 import org.flywaydb.core.api.configuration.FluentConfiguration
 import org.springframework.boot.autoconfigure.flyway.FlywayConfigurationCustomizer
+import org.springframework.boot.builder.SpringApplicationBuilder
 import org.springframework.context.annotation.Configuration
 import org.springframework.context.annotation.Profile
 import java.net.URLClassLoader
@@ -17,8 +20,8 @@ import java.net.URLClassLoader
 @Suppress("SpringJavaInjectionPointsAutowiringInspection")
 class PluginFlywayConfigurationCustomizer(
     private val pluginClassloader: SpringPluginClassloader,
-    private val databaseConfig: DatabaseConfig
-) : FlywayConfigurationCustomizer {
+    private val databaseConfig: DatabaseConfig,
+) : FlywayConfigurationCustomizer, CloudChildSpringApplicationConfiguration {
 
     override fun customize(configuration: FluentConfiguration) {
         configuration.table(pluginClassloader.meta.flywayTableName)
@@ -30,6 +33,20 @@ class PluginFlywayConfigurationCustomizer(
             URLClassLoader("${source.fileName}-flyway", arrayOf(source.toUri().toURL()), null)
     }
 
+    override fun configureChildApplication(
+        builder: SpringApplicationBuilder,
+        classLoader: ClassLoader,
+        vararg parentClassLoader: ClassLoader
+    ) {
+        require(classLoader is SpringPluginClassloader)
+        val flywayEnabled = DatabaseConfigConfiguration.getOrCreate(classLoader.meta).flyway.enabled
+            .toBooleanOrElseGet { StandaloneConfigHolder.holder.config.connectionConfig.databaseConfig.flyway.enabled }
+
+        if (!flywayEnabled) {
+            builder.properties("spring.flyway.enabled=false")
+        }
+    }
+
     companion object {
 
         val fluentConfigurationProxy = surfReflection.createProxy<FluentConfigurationProxy>()

surf-cloud-standalone/src/main/kotlin/dev/slne/surf/cloud/standalone/spring/FlywayDisabler.kt

@@ -0,0 +1,15 @@
+package dev.slne.surf.cloud.standalone.spring
+
+import com.google.auto.service.AutoService
+import dev.slne.surf.cloud.core.common.spring.CloudSpringApplicationConfiguration
+import dev.slne.surf.cloud.standalone.config.StandaloneConfigHolder
+import org.springframework.boot.builder.SpringApplicationBuilder
+
+@AutoService(CloudSpringApplicationConfiguration::class)
+class FlywayDisabler : CloudSpringApplicationConfiguration {
+    override fun configureApplication(builder: SpringApplicationBuilder) {
+        if (!StandaloneConfigHolder.isFlywayEnabled()) {
+            builder.properties("spring.flyway.enabled=false")
+        }
+    }
+}