Update CHANGELOG.md

0.3.1

CHANGELOG.md

@@ -1,5 +1,99 @@
 # Changelog
 
+## 0.3.2
+
+* `Versions`
+  * `kotlin`: `1.5.20` -> `1.5.31`
+  * `coroutines`: `1.5.0` -> `1.5.2`
+  * `serialization`: `1.2.1` -> `1.2.2`
+  * `exposed`: `0.32.1` -> `0.34.2`
+  * `tgbotapi`: `0.35.1` -> `0.35.9`
+  * `microutils`: `0.5.15` -> `0.5.28`
+
+## 0.3.1
+
+* `Versions`
+  * `kotlin`: `1.5.10` -> `1.5.20`
+  * `tgbotapi`: `0.35.0` -> `0.35.1`
+  * `microutils`: `0.5.7` -> `0.5.15`
+
+## 0.3.0
+
+* `Versions`
+  * `kotlin`: `1.4.32` -> `1.5.10`
+  * `coroutines`: `1.4.3` -> `1.5.0`
+  * `serialization`: `1.1.0` -> `1.2.1`
+  * `exposed`: `0.31.1` -> `0.32.1`
+  * `sdi`: `0.4.1` -> `0.5.0`
+  * `tgbotapi`: `0.34.1` -> `0.35.0`
+  * `microutils`: `0.4.36` -> `0.5.7`
+* `Bot`
+  * Add plugin `PluginsHolder`
+  * Rewrite mechanism of `Config` working
+  * `PlaguBot` now is correctly serializable/deserializable
+
+## 0.2.1
+
+* `Versions`
+  * `tgbotapi`: `0.33.4` -> `0.34.0`
+  * `sqlite`: `3.30.1` -> `3.34.0`
+
+## 0.2.0
+
+* `Versions`
+  * `tgbotapi`: `0.33.4` -> `0.34.0`
+  * `exposed`: `0.30.2` -> `0.31.1`
+
+## 0.1.9
+
+* `Versions`
+  * `tgbotapi`: `0.33.3` -> `0.33.4`
+  * `microutils`: `0.4.33` -> `0.4.36`
+  * `exposed`: `0.30.1` -> `0.30.2`
+
+## 0.1.8
+
+* `Versions`
+  * `tgbotapi`: `0.33.2` -> `0.33.3`
+  * `microutils`: `0.4.32` -> `0.4.33`
+
+## 0.1.7
+
+* `Versions`
+  * `exposed`: `0.29.1` -> `0.30.1`
+  * `tgbotapi`: `0.33.1` -> `0.33.2`
+  * `microutils`: `0.4.31` -> `0.4.32`
+* `PlaguBot`
+  * New class `PlaguBot` (😊)
+  * `initPlaguBot` is deprecated
+  * New shortcut for params - `plagubot`. `PlaguBot` class can be put inside other plagubot
+  for additional opportunities
+
+## 0.1.6
+
+* `Versions`
+  * `kotlin`: `1.4.31` -> `1.4.32`
+  * `tgbotapi`: `0.33.0` -> `0.33.1`
+  * `microutils`: `0.4.29` -> `0.4.31`
+
+## 0.1.5
+
+* `Versions`
+  * `kotlin`: `1.4.30` -> `1.4.31`
+  * `serialization`: `1.1.0-RC` -> `1.1.0`
+  * `coroutines`: `1.4.2` -> `1.4.3`
+  * `tgbotapi`: `0.32.8` -> `0.33.0`
+  * `microutils`: `0.4.26` -> `0.4.29`
+
+## 0.1.4
+
+* `Versions`
+  * `sdi`: `0.4.0-rc2` -> `0.4.1`
+  * `tgbotapi`: `0.32.7` -> `0.32.8`
+  * `microutils`: `0.4.25` -> `0.4.26`
+* `Bot`
+  * Fix of [#9](https://github.com/InsanusMokrassar/PlaguBot/issues/9)
+
 ## 0.1.3
 
 * `Versions`

bot/build.gradle

@@ -25,6 +25,8 @@ dependencies {
     kapt "com.github.matfax.klassindex:processor:$klassindex_version"
     api "org.xerial:sqlite-jdbc:$sqlite_version"
 
+    testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
+
     api project(":plagubot.plugin")
 }
 

bot/src/main/kotlin/dev/inmo/plagubot/App.kt

@@ -1,39 +1,21 @@
 package dev.inmo.plagubot
 
-import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
 import dev.inmo.plagubot.config.*
-import dev.inmo.plagubot.config.configSerialFormat
-import dev.inmo.tgbotapi.bot.Ktor.telegramBot
-import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
-import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
-import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.longPolling
-import dev.inmo.tgbotapi.types.botCommandsLimit
 import kotlinx.coroutines.*
 import kotlinx.serialization.InternalSerializationApi
 import java.io.File
 
+@Deprecated(
+    "This method is redundant due to new class PlaguBot",
+    ReplaceWith(
+        "PlaguBot(config).start(scope)",
+        "dev.inmo.plagubot.PlaguBot"
+    )
+)
 suspend inline fun initPlaguBot(
     config: Config,
     scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
-): Job {
-    val bot = telegramBot(config.botToken)
-
-    val paramsMap = config.params ?.toMap() ?: emptyMap()
-    val database = config.params ?.database ?: config.database.database
-    return bot.buildBehaviour(scope) {
-        val commands = config.plugins.flatMap {
-            it.apply { invoke(database, paramsMap) }
-            it.getCommands()
-        }.let {
-            val futureUnavailable = it.drop(botCommandsLimit.last)
-            if (futureUnavailable.isNotEmpty()) {
-                println("Next commands are out of range in setting command request and will be unavailable from autocompleting: ${futureUnavailable}")
-            }
-            it.take(botCommandsLimit.last)
-        }
-        safelyWithoutExceptions { setMyCommands(commands) }
-    }
-}
+): Job = PlaguBot(config).start(scope)
 
 /**
  * This method by default expects one argument in [args] field: path to config
@@ -42,8 +24,7 @@ suspend inline fun initPlaguBot(
 suspend fun main(args: Array<String>) {
     val (configPath) = args
     val file = File(configPath)
-    val config = configSerialFormat.decodeFromString(Config.serializer(), file.readText())
+    val config = configAndPluginsConfigJsonFormat.decodeFromString(PluginsConfigurationSerializer, file.readText()) as Config
 
-    val scope = CoroutineScope(Dispatchers.Default)
-    initPlaguBot(config, scope).join()
+    PlaguBot(config).start().join()
 }

bot/src/main/kotlin/dev/inmo/plagubot/PlaguBot.kt

@@ -0,0 +1,56 @@
+package dev.inmo.plagubot
+
+import dev.inmo.micro_utils.coroutines.safelyWithoutExceptions
+import dev.inmo.plagubot.config.*
+import dev.inmo.tgbotapi.bot.Ktor.telegramBot
+import dev.inmo.tgbotapi.extensions.api.bot.setMyCommands
+import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
+import dev.inmo.tgbotapi.extensions.behaviour_builder.buildBehaviour
+import dev.inmo.tgbotapi.types.BotCommand
+import dev.inmo.tgbotapi.types.botCommandsLimit
+import kotlinx.coroutines.*
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
+import org.jetbrains.exposed.sql.Database
+
+const val DefaultPlaguBotParamsKey = "plagubot"
+val Map<String, Any>.plagubot
+    get() = get(DefaultPlaguBotParamsKey) as? PlaguBot
+
+@Serializable
+data class PlaguBot(
+    @Serializable(PluginsConfigurationSerializer::class)
+    private val config: Config
+) : Plugin {
+    @Transient
+    private val bot = telegramBot(config.botToken)
+    @Transient
+    private val paramsMap = config.params ?.toMap() ?: emptyMap()
+    @Transient
+    private val database = config.params ?.database ?: config.database.database
+
+    override suspend fun getCommands(): List<BotCommand> = config.plugins.flatMap {
+        it.getCommands()
+    }
+
+    override suspend fun BehaviourContext.invoke(database: Database, params: Map<String, Any>) {
+        config.plugins.forEach {
+            it.apply { invoke(database, params) }
+        }
+        val commands = getCommands()
+        val futureUnavailable = commands.drop(botCommandsLimit.last)
+        if (futureUnavailable.isNotEmpty()) {
+            println("Next commands are out of range in setting command request and will be unavailable from autocompleting: $futureUnavailable")
+        }
+        safelyWithoutExceptions { setMyCommands(commands.take(botCommandsLimit.last)) }
+    }
+
+    /**
+     * This method will create an [Job] which will be the main [Job] of ran instance
+     */
+    suspend fun start(
+        scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
+    ): Job = bot.buildBehaviour(scope) {
+        invoke(database, paramsMap)
+    }
+}

bot/src/main/kotlin/dev/inmo/plagubot/PluginsHolder.kt

@@ -0,0 +1,25 @@
+package dev.inmo.plagubot
+
+import dev.inmo.plagubot.config.PluginsConfigurationSerializer
+import dev.inmo.plagubot.config.SimplePluginsConfiguration
+import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
+import dev.inmo.tgbotapi.types.BotCommand
+import kotlinx.serialization.Serializable
+import org.jetbrains.exposed.sql.Database
+
+@Serializable
+data class PluginsHolder(
+    @Serializable(PluginsConfigurationSerializer::class)
+    private val pluginsConfiguration: SimplePluginsConfiguration
+) : Plugin {
+    override suspend fun getCommands(): List<BotCommand> = pluginsConfiguration.plugins.flatMap {
+        it.getCommands()
+    }
+
+    override suspend fun BehaviourContext.invoke(database: Database, params: Map<String, Any>) {
+        val finalParams = pluginsConfiguration.params ?.plus(params) ?: params
+        pluginsConfiguration.plugins.forEach {
+            it.apply { invoke(database, finalParams) }
+        }
+    }
+}

bot/src/main/kotlin/dev/inmo/plagubot/config/Config.kt

@@ -1,44 +1,15 @@
 package dev.inmo.plagubot.config
 
-import com.github.matfax.klassindex.KlassIndex
 import dev.inmo.plagubot.Plugin
 import dev.inmo.sdi.Module
-import kotlinx.serialization.*
-import kotlinx.serialization.json.Json
-import kotlinx.serialization.modules.*
-import kotlin.reflect.KClass
-
-@InternalSerializationApi
-internal inline fun <T : Plugin> KClass<T>.includeIn(builder: PolymorphicModuleBuilder<Plugin>) = builder.subclass(this, serializer())
-
-@InternalSerializationApi
-internal val configSerialFormat: StringFormat
-    get() = Json {
-        ignoreUnknownKeys = true
-        serializersModule = SerializersModule {
-            polymorphic(Plugin::class) {
-                KlassIndex.getSubclasses(Plugin::class).flatMap { kclass ->
-                    kclass.includeIn(this)
-                    kclass.annotations.mapNotNull { it as? SerialName }.map {
-                        it.value to kclass.serializer()
-                    } + listOfNotNull(
-                        kclass.simpleName ?.let {
-                            it to kclass.serializer()
-                        }
-                    )
-                }.toMap().let {
-                    default { requiredType ->
-                        it[requiredType]
-                    }
-                }
-            }
-        }
-    }
+import kotlinx.serialization.Contextual
+import kotlinx.serialization.Serializable
 
 @Serializable
 data class Config(
-    val plugins: List<Plugin>,
+    override val plugins: List<@Contextual Plugin>,
     val database: DatabaseConfig = DatabaseConfig(),
     val botToken: String,
-    val params: Module? = null
-)
+    @Contextual
+    override val params: Module? = null
+) : PluginsConfiguration

bot/src/main/kotlin/dev/inmo/plagubot/config/PluginsConfiguration.kt

@@ -0,0 +1,190 @@
+package dev.inmo.plagubot.config
+
+import com.github.matfax.klassindex.KlassIndex
+import dev.inmo.plagubot.Plugin
+import dev.inmo.plagubot.PluginSerializer
+import dev.inmo.sdi.Module
+import dev.inmo.sdi.ModuleSerializer
+import kotlinx.serialization.*
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import kotlinx.serialization.json.*
+import kotlinx.serialization.modules.*
+import kotlin.reflect.KClass
+
+@InternalSerializationApi
+internal inline fun <T : Plugin> KClass<T>.includeIn(builder: PolymorphicModuleBuilder<Plugin>) = builder.subclass(this, serializer())
+
+@InternalSerializationApi
+internal val configAndPluginsConfigJsonFormat: Json
+    get() = Json {
+        ignoreUnknownKeys = true
+        serializersModule = SerializersModule {
+            polymorphic(Plugin::class) {
+                KlassIndex.getSubclasses(Plugin::class).flatMap { kclass ->
+                    kclass.includeIn(this)
+                    kclass.annotations.mapNotNull { it as? SerialName }.map {
+                        it.value to kclass.serializer()
+                    } + listOfNotNull(
+                        kclass.simpleName ?.let {
+                            it to kclass.serializer()
+                        }
+                    )
+                }.toMap().let {
+                    default { requiredType ->
+                        it[requiredType]
+                    }
+                }
+            }
+        }
+    }
+
+internal interface PluginsConfiguration {
+    val plugins: List<Plugin>
+    val params: Module?
+}
+
+@Serializable
+data class SimplePluginsConfiguration(
+    override val plugins: List<@Contextual Plugin>,
+    @Contextual
+    override val params: Module? = null
+) : PluginsConfiguration
+
+
+internal val DefaultModuleSerializer = ModuleSerializer(emptyList()) {
+
+}
+
+@Serializer(Plugin::class)
+internal class InternalPluginSerializer(
+    private val params: Module
+) : KSerializer<Plugin> {
+    override val descriptor: SerialDescriptor = PluginSerializer.descriptor
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): Plugin {
+        val asJson = JsonElement.serializer().deserialize(decoder)
+
+        return if (asJson is JsonPrimitive) {
+            params[asJson.jsonPrimitive.content] as Plugin
+        } else {
+            val jsonFormat = ((decoder as? JsonDecoder)?.json ?: configAndPluginsConfigJsonFormat)
+            jsonFormat.decodeFromJsonElement(PluginSerializer, asJson)
+        }
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: Plugin) {
+        params.keys.firstOrNull { params[it] === value } ?.also {
+            encoder.encodeString(it)
+        } ?: PluginSerializer.serialize(encoder, value)
+    }
+}
+
+@Serializer(Module::class)
+internal class InternalModuleSerializer(
+    private val original: JsonElement?,
+    private val params: Module
+) : KSerializer<Module> {
+    override val descriptor: SerialDescriptor = PluginSerializer.descriptor
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): Module {
+        val asJson = JsonElement.serializer().deserialize(decoder)
+
+        return if (asJson == original) {
+            params
+        } else {
+            configAndPluginsConfigJsonFormat.decodeFromJsonElement(DefaultModuleSerializer, asJson)
+        }
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: Module) = DefaultModuleSerializer.serialize(encoder, value)
+}
+
+internal fun internalPluginSerializerSerializersModule(
+    internalPluginSerializer: InternalPluginSerializer,
+    internalModuleSerializer: InternalModuleSerializer?
+) = SerializersModule {
+    contextual(internalPluginSerializer)
+    contextual(internalModuleSerializer ?: return@SerializersModule)
+}
+
+@Serializer(PluginsConfiguration::class)
+internal object PluginsConfigurationSerializer : KSerializer<PluginsConfiguration> {
+    private val jsonSerializer = JsonObject.serializer()
+    private val moduleSerializer = ModuleSerializer()
+    override val descriptor: SerialDescriptor = jsonSerializer.descriptor
+
+    @InternalSerializationApi
+    override fun deserialize(decoder: Decoder): PluginsConfiguration {
+        val json = jsonSerializer.deserialize(decoder)
+        val jsonFormat = (decoder as? JsonDecoder) ?.json ?: configAndPluginsConfigJsonFormat
+        val paramsRow = json["params"]
+
+        val resultJsonFormat = if (paramsRow != null && paramsRow != JsonNull) {
+            val params = jsonFormat.decodeFromJsonElement(
+                moduleSerializer,
+                paramsRow
+            )
+
+            val pluginsSerializer = InternalPluginSerializer(params)
+            val moduleSerializer = InternalModuleSerializer(paramsRow, params)
+            Json(jsonFormat) {
+                serializersModule = decoder.serializersModule.overwriteWith(
+                    internalPluginSerializerSerializersModule(pluginsSerializer, moduleSerializer)
+                )
+            }
+        } else {
+            jsonFormat
+        }
+        return try {
+            resultJsonFormat.decodeFromJsonElement(
+                Config.serializer(),
+                json
+            )
+        } catch (e: SerializationException) {
+            resultJsonFormat.decodeFromJsonElement(
+                SimplePluginsConfiguration.serializer(),
+                json
+            )
+        }
+    }
+
+    @InternalSerializationApi
+    override fun serialize(encoder: Encoder, value: PluginsConfiguration) {
+        val params = value.params
+        val serializer = when (value) {
+            is Config -> Config.serializer()
+            is SimplePluginsConfiguration -> SimplePluginsConfiguration.serializer()
+            else -> return
+        }
+        if (params != null) {
+            val pluginsSerializer = InternalPluginSerializer(params)
+
+            val jsonFormat = Json(configAndPluginsConfigJsonFormat) {
+                serializersModule = encoder.serializersModule.overwriteWith(
+                    internalPluginSerializerSerializersModule(pluginsSerializer, null)
+                )
+            }
+
+            jsonSerializer.serialize(
+                encoder,
+                when (value) {
+                    is Config -> jsonFormat.encodeToJsonElement(Config.serializer(), value)
+                    is SimplePluginsConfiguration -> jsonFormat.encodeToJsonElement(SimplePluginsConfiguration.serializer(), value)
+                    else -> return
+                } as JsonObject
+            )
+        } else {
+            when (value) {
+                is Config -> Config.serializer().serialize(encoder, value)
+                is SimplePluginsConfiguration -> SimplePluginsConfiguration.serializer().serialize(encoder, value)
+                else -> return
+            }
+        }
+    }
+}

bot/src/test/kotlin/dev/inmo/plagubot/config/ConfigTest.kt

@@ -0,0 +1,40 @@
+package dev.inmo.plagubot.config
+
+import dev.inmo.plagubot.HelloPlugin
+import kotlinx.serialization.InternalSerializationApi
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class ConfigTest {
+    @InternalSerializationApi
+    @Test
+    fun testThatPluginPassedToParamsWillBeCorrectlyUsedInPlugins() {
+        val rawConfig = """
+            {
+              "database": {
+              },
+              "botToken": "",
+              "plugins": [
+                "helloPlugin"
+              ],
+              "params": {
+                "helloPlugin": {"type": "dev.inmo.plagubot.HelloPlugin", "parameter": "Example"}
+              }
+            }
+        """.trimIndent()
+        val config = configAndPluginsConfigJsonFormat.decodeFromString(PluginsConfigurationSerializer, rawConfig) as Config
+
+        assert(config.plugins.size == 1)
+        assert(config.plugins.first() is HelloPlugin)
+        assert((config.plugins.first() as HelloPlugin).parameter == "Example")
+
+        val redecoded = configAndPluginsConfigJsonFormat.decodeFromString(
+            PluginsConfigurationSerializer,
+            configAndPluginsConfigJsonFormat.encodeToString(PluginsConfigurationSerializer, config)
+        ) as Config
+        assertEquals(config.database, redecoded.database)
+        assertEquals(config.plugins, redecoded.plugins)
+        assertEquals(config.botToken, redecoded.botToken)
+        assertEquals(config.params ?.toMap(), redecoded.params ?.toMap())
+    }
+}

gradle.properties

@@ -4,19 +4,19 @@ org.gradle.parallel=true
 kotlin.js.generate.externals=true
 kotlin.incremental=true
 
-kotlin_version=1.4.30
-kotlin_coroutines_version=1.4.2
-kotlin_serialisation_runtime_version=1.1.0-RC
-kotlin_exposed_version=0.29.1
+kotlin_version=1.5.31
+kotlin_coroutines_version=1.5.2
+kotlin_serialisation_runtime_version=1.2.2
+kotlin_exposed_version=0.34.2
 
-sdi_version=0.4.0-rc2
-tgbotapi_version=0.32.7
-microutils_version=0.4.25
+sdi_version=0.5.0
+tgbotapi_version=0.35.9
+microutils_version=0.5.28
 klassindex_version=4.1.0-rc.1
 
-sqlite_version=3.30.1
+sqlite_version=3.34.0
 
 github_release_plugin_version=2.2.12
 
 group=dev.inmo
-version=0.1.3
+version=0.3.2

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists