Use object mapper to allow plugin specific type safe config

rabobank · Sep 11, 2023 · 38193f8 · 38193f8
1 parent 24cf855
commit 38193f8
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 10 deletions.
diff --git a/ret-core/src/main/kotlin/io/rabobank/ret/configuration/BasePluginConfig.kt b/ret-core/src/main/kotlin/io/rabobank/ret/configuration/BasePluginConfig.kt
@@ -1,8 +1,10 @@
 package io.rabobank.ret.configuration
 
 import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.module.kotlin.convertValue
 import com.fasterxml.jackson.module.kotlin.readValue
 import io.quarkus.logging.Log
+import io.rabobank.ret.RetConsole
 import io.rabobank.ret.util.OsUtils
 import jakarta.annotation.PostConstruct
 import jakarta.enterprise.context.Dependent
@@ -29,23 +31,31 @@ open class BasePluginConfig : Configurable {
     @Inject
     lateinit var retConfig: RetConfig
 
-    val config by lazy { PluginConfig(pluginName, objectMapper, osUtils) }
+    @Inject
+    lateinit var retConsole: RetConsole
+
+    val pluginConfig by lazy { PluginConfig(pluginName, objectMapper, osUtils) }
 
     @PostConstruct
     fun migrateOldConfig() {
+        val configCopy = pluginConfig.config.toMap()
+
         val keysToMigrate = keysToMigrate()
+
         if (keysToMigrate.isNotEmpty()) {
-            Log.info("Migrating old configuration to plugin specific configuration")
+            Log.debug("Migrating old configuration to plugin specific configuration")
             keysToMigrate.forEach { (oldKey, newKey) ->
                 val oldValue = retConfig[oldKey]
                 if (oldValue != null) {
-                    config[newKey] = oldValue
+                    pluginConfig[newKey] = oldValue
 
                     retConfig.remove(oldKey)
                 }
             }
+        }
 
-            config.save()
+        if (configCopy != pluginConfig.config) {
+            pluginConfig.save()
             retConfig.save()
         }
     }
@@ -58,6 +68,8 @@ open class BasePluginConfig : Configurable {
      * The left should be the name of the old key and the right the name of the new key
      */
     open fun keysToMigrate() = emptyList<Pair<String, String>>()
+
+    inline fun <reified T> convertTo() = objectMapper.convertValue<T>(pluginConfig.config)
 }
 
 class PluginConfig(pluginName: String, private val objectMapper: ObjectMapper, osUtils: OsUtils) {
@@ -68,14 +80,20 @@ class PluginConfig(pluginName: String, private val objectMapper: ObjectMapper, o
 
     inline operator fun <reified T> get(key: String): T? {
         val value = config[key]
-        return if (value is T?) value else error("The config value cannot be cast to ${T::class.java}")
+        return if (value is T?) {
+            value
+        } else {
+            error(
+                "The config value '$key' cannot be cast to ${T::class.java}, because it's of type ${value?.javaClass}",
+            )
+        }
     }
 
     operator fun set(key: String, value: Any?) {
         config[key] = value
     }
 
     fun save() {
-        objectMapper.writeValue(pluginFile, config)
+        objectMapper.writerWithDefaultPrettyPrinter().writeValue(pluginFile, config)
     }
 }
diff --git a/ret-core/src/main/kotlin/io/rabobank/ret/configuration/version/VersionProperties.kt b/ret-core/src/main/kotlin/io/rabobank/ret/configuration/version/VersionProperties.kt
@@ -50,6 +50,6 @@ class VersionProperties {
     private fun loadGitProperties() {
         VersionProperties::class.java.classLoader.getResourceAsStream(GIT_PROPERTIES)
             ?.run { properties.load(this) }
-            ?: Log.info("No Git information available: cannot load git.properties file.")
+            ?: Log.debug("No Git information available: cannot load git.properties file.")
     }
 }
diff --git a/ret-plugin/src/main/kotlin/io/rabobank/ret/commands/PluginConfigureCommand.kt b/ret-plugin/src/main/kotlin/io/rabobank/ret/commands/PluginConfigureCommand.kt
@@ -51,8 +51,7 @@ class PluginConfigureCommand(
         var hasPluginSpecificConfig = false
         val pluginConfigFile = config.pluginConfigDirectory().resolve("$pluginName.json").toFile()
         val pluginConfig = if (pluginConfigFile.exists()) objectMapper.readValue<Map<String, Any?>>(pluginConfigFile) else emptyMap()
-
-        val answers = mutableMapOf<String, Any>()
+        val answers = pluginConfig.toMutableMap()
 
         config.configure {
             hasPluginSpecificConfig = true

diff --git a/ret-plugin/src/main/kotlin/io/rabobank/ret/commands/PluginInitializeCommand.kt b/ret-plugin/src/main/kotlin/io/rabobank/ret/commands/PluginInitializeCommand.kt
@@ -86,6 +86,7 @@ class PluginInitializeCommand(
 
     private fun createPluginInformationFile(pluginName: String) {
         val pluginDefinition = IntrospectionUtil.introspect(commandSpec.root(), pluginName)
-        objectMapper.writeValue(pluginDirectory.resolve("$pluginName.plugin").toFile(), pluginDefinition)
+        objectMapper.writerWithDefaultPrettyPrinter()
+            .writeValue(pluginDirectory.resolve("$pluginName.plugin").toFile(), pluginDefinition)
     }
 }