feat: update structure for new plugin API

Author: duruer

build.gradle.kts

@@ -12,6 +12,7 @@ version =
 val pf4jVersion: String by project
 val vertxVersion: String by project
 val gsonVersion: String by project
+val springContextVersion: String by project
 val handlebarsVersion: String by project
 val bootstrap = (project.findProperty("bootstrap") as String?)?.toBoolean() ?: false
 val pluginsDir: File? by rootProject.extra
@@ -50,6 +51,9 @@ dependencies {
 
     // https://mvnrepository.com/artifact/org.apache.httpcomponents.client5/httpclient5
     implementation("org.apache.httpcomponents.client5:httpclient5:5.3")
+
+    // https://mvnrepository.com/artifact/org.springframework/spring-context
+    compileOnly("org.springframework:spring-context:$springContextVersion")
 }
 
 tasks {

gradle.properties

@@ -5,4 +5,5 @@ pluginDependencies=
 pf4jVersion=3.10.0
 vertxVersion=4.5.1
 gsonVersion=2.10.1
-handlebarsVersion=4.3.1
+handlebarsVersion=4.3.1
+springContextVersion=5.3.33

src/main/kotlin/co/statu/rule/database/CoreEventHandler.kt

@@ -0,0 +1,52 @@
+package co.statu.rule.database
+
+import co.statu.parsek.PluginEventManager
+import co.statu.parsek.api.annotation.EventListener
+import co.statu.parsek.api.config.PluginConfigManager
+import co.statu.parsek.api.event.CoreEventListener
+import co.statu.parsek.config.ConfigManager
+import co.statu.rule.database.event.DatabaseEventListener
+import org.slf4j.Logger
+
+@EventListener
+class CoreEventHandler(
+    private val logger: Logger,
+    private val databasePlugin: DatabasePlugin,
+) : CoreEventListener {
+    private val databaseManager by lazy {
+        databasePlugin.pluginBeanContext.getBean(DatabaseManager::class.java)
+    }
+
+    override suspend fun onConfigManagerReady(configManager: ConfigManager) {
+        val pluginConfigManager = PluginConfigManager(
+            configManager,
+            databasePlugin,
+            DatabaseConfig::class.java,
+            exPluginIds = listOf("database")
+        )
+        databasePlugin.pluginBeanContext.beanFactory.registerSingleton(
+            pluginConfigManager.javaClass.name,
+            pluginConfigManager
+        )
+
+        logger.info("Initialized plugin config")
+
+        DatabasePlugin.databaseManager = databaseManager
+
+        databaseManager.migrateNewPluginId(
+            "database",
+            databasePlugin.pluginId,
+            databasePlugin
+        )
+
+        databaseManager.initialize(databasePlugin)
+
+        databasePlugin.registerSingletonGlobal(databaseManager)
+
+        val handlers = PluginEventManager.getEventListeners<DatabaseEventListener>()
+
+        handlers.forEach {
+            it.onReady(databaseManager)
+        }
+    }
+}

src/main/kotlin/co/statu/rule/database/DBEntity.kt

@@ -1,5 +1,6 @@
 package co.statu.rule.database
 
+import co.statu.parsek.PluginEventManager
 import co.statu.rule.database.deserializer.JsonObjectDeserializer
 import co.statu.rule.database.event.DatabaseEventListener
 import com.google.gson.GsonBuilder
@@ -15,10 +16,7 @@ abstract class DBEntity {
 
             gsonBuilder.registerTypeAdapter(JsonObject::class.java, JsonObjectDeserializer())
 
-            val context = DatabasePlugin.INSTANCE.context
-            val pluginEventManager = context.pluginEventManager
-
-            val databaseEventHandlers = pluginEventManager.getEventHandlers<DatabaseEventListener>()
+            val databaseEventHandlers = PluginEventManager.getEventListeners<DatabaseEventListener>()
 
             databaseEventHandlers.forEach { it.onGsonBuild(gsonBuilder) }
 

src/main/kotlin/co/statu/rule/database/Dao.kt

@@ -3,7 +3,6 @@ package co.statu.rule.database
 import co.statu.parsek.api.ParsekPlugin
 import co.statu.parsek.util.TextUtil.convertToSnakeCase
 import co.statu.rule.database.DBEntity.Companion.gson
-import co.statu.rule.database.DatabasePlugin.Companion.databaseManager
 import io.vertx.jdbcclient.JDBCPool
 import io.vertx.kotlin.coroutines.await
 import io.vertx.sqlclient.Row
@@ -36,7 +35,7 @@ abstract class Dao<T : DBEntity>(private val entityClass: KClass<T>) {
 
     abstract suspend fun init(jdbcPool: JDBCPool, plugin: ParsekPlugin)
 
-    fun getTablePrefix(): String = databaseManager.getTablePrefix()
+    fun getTablePrefix(): String = DatabasePlugin.databaseManager.getTablePrefix()
 
     suspend fun count(
         jdbcPool: JDBCPool

src/main/kotlin/co/statu/rule/database/DatabaseManager.kt

@@ -2,20 +2,30 @@ package co.statu.rule.database
 
 import co.statu.parsek.api.ParsekPlugin
 import co.statu.parsek.api.config.PluginConfigManager
+import co.statu.rule.database.api.DatabaseHelper
 import co.statu.rule.database.impl.SchemeVersionDaoImpl
 import co.statu.rule.database.model.SchemeVersion
 import io.vertx.core.Vertx
 import io.vertx.core.json.JsonObject
 import io.vertx.jdbcclient.JDBCPool
 import org.slf4j.Logger
+import org.springframework.beans.factory.config.ConfigurableBeanFactory
+import org.springframework.context.annotation.Scope
+import org.springframework.stereotype.Component
 import java.sql.BatchUpdateException
 import kotlin.system.exitProcess
 
+@Component
+@Scope(value = ConfigurableBeanFactory.SCOPE_SINGLETON)
 class DatabaseManager(
     private val vertx: Vertx,
-    private val pluginConfigManager: PluginConfigManager<DatabaseConfig>,
     private val logger: Logger,
+    private val databasePlugin: DatabasePlugin
 ) {
+    private val pluginConfigManager by lazy {
+        databasePlugin.pluginBeanContext.getBean(PluginConfigManager::class.java) as PluginConfigManager<DatabaseConfig>
+    }
+
     private lateinit var pool: JDBCPool
 
     private val tables = mutableMapOf<ParsekPlugin, MutableList<Dao<*>>>()
@@ -69,7 +79,7 @@ class DatabaseManager(
     }
 
     private suspend fun initSchemeVersion(plugin: ParsekPlugin, jdbcPool: JDBCPool) {
-        val lastSchemeVersion = schemeVersionDaoImpl.getLastSchemeVersion(plugin.context.pluginId, jdbcPool)
+        val lastSchemeVersion = schemeVersionDaoImpl.getLastSchemeVersion(plugin.pluginId, jdbcPool)
 
         val latestMigration = getLatestMigration(plugin)
 
@@ -80,9 +90,9 @@ class DatabaseManager(
         if (latestMigration == null) {
             schemeVersionDaoImpl.add(
                 SchemeVersion(
-                    pluginId = plugin.context.pluginId,
+                    pluginId = plugin.pluginId,
                     version = 1,
-                    extra = "Init ${plugin.context.pluginId}"
+                    extra = "Init ${plugin.pluginId}"
                 ),
                 jdbcPool
             )
@@ -92,7 +102,7 @@ class DatabaseManager(
 
         schemeVersionDaoImpl.add(
             SchemeVersion(
-                pluginId = plugin.context.pluginId,
+                pluginId = plugin.pluginId,
                 version = latestMigration.SCHEME_VERSION,
                 extra = latestMigration.SCHEME_VERSION_INFO
             ),
@@ -105,13 +115,12 @@ class DatabaseManager(
 
         initTables(plugin)
 
-        logger.info("\"${plugin.context.pluginId}\"'s database has been initialized")
+        logger.info("\"${plugin.pluginId}\"'s database has been initialized")
     }
 
     suspend fun initialize(
         plugin: ParsekPlugin,
-        tables: List<Dao<*>>,
-        migrations: List<DatabaseMigration>
+        databaseHelper: DatabaseHelper? = null
     ) {
         if (this.tables[plugin] == null) {
             this.tables[plugin] = mutableListOf()
@@ -121,14 +130,15 @@ class DatabaseManager(
             this.migrations[plugin] = mutableListOf()
         }
 
-        this.tables[plugin]!!.addAll(tables)
-        this.migrations[plugin]!!.addAll(migrations)
+        databaseHelper?.tables?.let { this.tables[plugin]!!.addAll(it) }
+        databaseHelper?.migrations?.let { this.migrations[plugin]!!.addAll(it) }
 
         val jdbcPool: JDBCPool
 
         try {
             jdbcPool = getConnectionPool()
         } catch (e: Exception) {
+            e.printStackTrace()
             logger.info("Connection to database failed! Shutting down...")
 
             exitProcess(1)
@@ -137,7 +147,7 @@ class DatabaseManager(
         val lastSchemeVersion: SchemeVersion?
 
         try {
-            lastSchemeVersion = schemeVersionDaoImpl.getLastSchemeVersion(plugin.context.pluginId, jdbcPool)
+            lastSchemeVersion = schemeVersionDaoImpl.getLastSchemeVersion(plugin.pluginId, jdbcPool)
         } catch (e: BatchUpdateException) {
             try {
                 if (plugin is DatabasePlugin) {
@@ -151,7 +161,7 @@ class DatabaseManager(
                 return
             } catch (e: Exception) {
                 logger.error(e.message)
-                logger.error("Database Error: Could not install plugin \"${plugin.context.pluginId}\". Shutting down...")
+                logger.error("Database Error: Could not install plugin \"${plugin.pluginId}\". Shutting down...")
 
                 exitProcess(1)
             }
@@ -180,7 +190,7 @@ class DatabaseManager(
     internal fun getLatestMigration(plugin: ParsekPlugin) = migrations[plugin]?.maxByOrNull { it.SCHEME_VERSION }
 
     suspend fun checkMigration(plugin: ParsekPlugin, jdbcPool: JDBCPool, lastSchemeVersion: SchemeVersion?) {
-        logger.info("Checking available database migrations for \"${plugin.context.pluginId}\"")
+        logger.info("Checking available database migrations for \"${plugin.pluginId}\"")
 
         val databaseVersion = lastSchemeVersion?.version ?: 0
 
@@ -196,7 +206,7 @@ class DatabaseManager(
     private suspend fun updateSchemeVersion(version: Int, info: String, plugin: ParsekPlugin, jdbcPool: JDBCPool) {
         schemeVersionDaoImpl.add(
             SchemeVersion(
-                pluginId = plugin.context.pluginId,
+                pluginId = plugin.pluginId,
                 version = version,
                 extra = info
             ),

src/main/kotlin/co/statu/rule/database/DatabasePlugin.kt

@@ -1,33 +1,9 @@
 package co.statu.rule.database
 
 import co.statu.parsek.api.ParsekPlugin
-import co.statu.parsek.api.PluginContext
-import co.statu.parsek.api.config.PluginConfigManager
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
 
-class DatabasePlugin(pluginContext: PluginContext) : ParsekPlugin(pluginContext) {
+class DatabasePlugin : ParsekPlugin() {
     companion object {
-        internal val logger: Logger = LoggerFactory.getLogger(DatabasePlugin::class.java)
-
-        internal lateinit var pluginConfigManager: PluginConfigManager<DatabaseConfig>
-
-        internal lateinit var INSTANCE: DatabasePlugin
-
-        internal val tables = listOf<Dao<*>>()
-        internal val migrations = listOf<DatabaseMigration>()
-
         internal lateinit var databaseManager: DatabaseManager
     }
-
-    init {
-        INSTANCE = this
-
-        logger.info("Initialized instance")
-
-        context.pluginEventManager.register(this, ParsekEventHandler())
-
-        logger.info("Registered event")
-    }
 }
-

src/main/kotlin/co/statu/rule/database/ParsekEventHandler.kt

@@ -0,0 +1,9 @@
+package co.statu.rule.database.api
+
+import co.statu.rule.database.Dao
+import co.statu.rule.database.DatabaseMigration
+
+interface DatabaseHelper {
+    val tables: List<Dao<*>>
+    val migrations: List<DatabaseMigration>
+}

src/main/kotlin/co/statu/rule/database/api/DatabaseHelper.kt

@@ -1,14 +1,14 @@
 package co.statu.rule.database.event
 
-import co.statu.parsek.api.PluginEvent
+import co.statu.parsek.api.event.PluginEventListener
 import co.statu.rule.database.DatabaseManager
 import com.google.gson.GsonBuilder
 
 /**
  * ParsekEventListener is an extension point for listening Parsek related events
  * such as when config manager has been initialized.
  */
-interface DatabaseEventListener : PluginEvent {
+interface DatabaseEventListener : PluginEventListener {
 
     suspend fun onReady(databaseManager: DatabaseManager) {}