complete with including of FSM

2.0.0

.gitignore

@@ -10,5 +10,7 @@ build/
 out/
 
 local.properties
+local.*
+local.*/
 config.json
 secret.gradle

CHANGELOG.md

@@ -1,5 +1,92 @@
 # Changelog
 
+## 2.1.0
+
+* `Versions`:
+  * `tgbotapi`: `3.1.1`
+  * `ktor`: `2.1.0`
+  * `microutils`: `0.12.1`
+* `Plugins`:
+  * New fum of `Plugin` with `BehaviourContextWithFSM` receiver
+* `Bot`:
+  * Now bot uses `buildBehaviourWithFSM` to be able to setup bot with FSM
+
+## 2.0.0
+
+* `Versions`:
+  * `kotlin`: `1.7.10`
+  * `serialization`: `1.4.0-RC`
+  * `tgbotapi`: `3.0.2`
+  * `kslog`: `0.5.0`
+  * `uuid`: `0.5.0`
+  * `exposed`: `0.39.2`
+  * `microutils`: `0.12.0`
+
+## 1.4.1
+
+* `Versions`:
+  * `tgbotapi`: `2.2.2`
+  * `kslog`: `0.4.2`
+
+## 1.4.0
+
+* `Versions`:
+  * `kslog`: `0.4.1`
+
+## 1.3.1
+
+* `Versions`:
+  * `tgbotapi`: `2.2.1`
+  * `microutils`: `0.11.13`
+
+## 1.3.0
+
+* `Versions`
+  * `tgbotapi`: `2.2.0`
+
+## 1.2.3
+
+* `Versions`
+  * `tgbotapi`: `2.1.3`
+
+## 1.2.2
+
+* `Versions`
+  * `tgbotapi`: `2.1.2`
+  * `microutils`: `0.11.12`
+  * `coroutines`: `1.6.3`
+  * `ktor`: `2.0.3`
+
+## 1.2.1
+
+* `Versions`
+  * `tgbotapi`: `2.1.1`
+  * `microutils`: `0.11.6`
+  * `kslog`: `0.3.2`
+
+## 1.2.0
+
+* `Versions`
+  * `tgbotapi`: `2.1.0`
+
+## 1.1.2
+
+* `Versions`
+  * `tgbotapi`: `2.0.3`
+  * `microutils`: `0.11.3`
+  * `kslog`: `0.3.1`
+* `Plugin`:
+  * Now it is possible to use `object`s of plugins instead of classes
+
+## 1.1.1
+
+* `Versions`
+  * `coroutines`: `1.6.2`
+  * `tgbotapi`: `2.0.2`
+  * `microutils`: `0.11.0`
+  * `ktor`: `2.0.2`
+  * `uuid`: `0.4.1`
+
 ## 1.1.0
 
 * `Versions`

README.md

@@ -16,3 +16,28 @@ You can create your bot using
 
 That is a set of libraries for plagubots. Look at the
 [PlaguBot Plugin template](https://insanusmokrassar.github.io/PlaguBotPluginTemplate/) to find how to create your bot.
+
+### Technical help
+
+In this bot has been used variant with FSM. That means that you may use all the [Behaviour Builder with FSM](https://bookstack.inmo.dev/books/telegrambotapi/page/behaviour-builder-with-fsm) functionality. In case you wish to setup states repo, you should use the next code in the `setupDI` of your plugin:
+
+```kotlin
+single<StatesManager<State>> {
+    // setup your manager and return here
+    // Default is:
+    DefaultStatesManager(
+        InMemoryDefaultStatesManagerRepo()
+    )
+}
+```
+
+Besides, you may setup handling errors lambda in the same function:
+
+```kotlin
+single<StateHandlingErrorHandler<State>> {
+    { state, e ->
+        logger.eS(e) { "Unable to handle state $state" } // logging by default
+        null // you should return new state or null, default callback will return null
+    }
+}
+```

bot/build.gradle

@@ -16,7 +16,9 @@ dependencies {
     api libs.jb.exposed.jdbc
 
     api libs.tgbotapi
+    api libs.tgbotapi.behaviourBuilder.fsm
     api libs.microutils.repos.exposed
+    api libs.kslog
 
     api libs.sqlite
 

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

@@ -1,7 +1,9 @@
 package dev.inmo.plagubot
 
-import dev.inmo.plagubot.config.*
-import kotlinx.coroutines.*
+import dev.inmo.kslog.common.KSLog
+import dev.inmo.kslog.common.i
+import dev.inmo.plagubot.config.Config
+import dev.inmo.plagubot.config.defaultJsonFormat
 import kotlinx.serialization.InternalSerializationApi
 import kotlinx.serialization.json.jsonObject
 import java.io.File
@@ -11,10 +13,13 @@ import java.io.File
  */
 @InternalSerializationApi
 suspend fun main(args: Array<String>) {
+    KSLog.default = KSLog("PlaguBot")
     val (configPath) = args
     val file = File(configPath)
+    KSLog.i("Start read config from ${file.absolutePath}")
     val json = defaultJsonFormat.parseToJsonElement(file.readText()).jsonObject
     val config = defaultJsonFormat.decodeFromJsonElement(Config.serializer(), json)
+    KSLog.i("Config has been read")
 
     PlaguBot(json, config).start().join()
 }

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

@@ -1,23 +1,29 @@
 package dev.inmo.plagubot
 
+import dev.inmo.kslog.common.*
+import dev.inmo.micro_utils.fsm.common.State
+import dev.inmo.plagubot.HelloPlugin.setupBotPlugin
 import dev.inmo.tgbotapi.extensions.api.bot.getMe
 import dev.inmo.tgbotapi.extensions.api.send.reply
-import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
+import dev.inmo.tgbotapi.extensions.api.send.sendMessage
+import dev.inmo.tgbotapi.extensions.behaviour_builder.*
+import dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitText
+import dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitTextMessage
 import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onCommand
-import kotlinx.serialization.*
+import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onUnhandledCommand
+import dev.inmo.tgbotapi.types.ChatId
+import kotlinx.coroutines.flow.first
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.JsonObject
 import org.jetbrains.exposed.sql.Database
 import org.koin.core.Koin
-import org.koin.core.KoinApplication
-import org.koin.core.component.KoinComponent
-import org.koin.core.component.get
 import org.koin.core.module.Module
-import org.koin.dsl.module
 
 @Serializable
 @SerialName("Hello")
-class HelloPlugin : Plugin {
+object HelloPlugin : Plugin {
     @Serializable
     data class HelloPluginConfig(
         val print: String
@@ -26,14 +32,34 @@ class HelloPlugin : Plugin {
     override fun Module.setupDI(database: Database, params: JsonObject) {
         single {
             get<Json>().decodeFromJsonElement(HelloPluginConfig.serializer(), params["helloPlugin"] ?: return@single null)
+
+
         }
     }
 
-    override suspend fun BehaviourContext.setupBotPlugin(koin: Koin) {
-        println(koin.get<HelloPluginConfig>().print)
-        println(getMe())
+    private sealed interface InternalFSMState : State {
+        override val context: ChatId
+        data class DidntSaidHello(override val context: ChatId) : InternalFSMState
+        data class SaidHelloOnce(override val context: ChatId) : InternalFSMState
+    }
+
+    override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
+        val toPrint = koin.getOrNull<HelloPluginConfig>() ?.print ?: "Hello :)"
+        logger.d { toPrint }
+        logger.dS { getMe().toString() }
         onCommand("hello_world") {
-            reply(it, "Hello :)")
+            startChain(InternalFSMState.DidntSaidHello(it.chat.id))
+        }
+
+        strictlyOn { state: InternalFSMState.DidntSaidHello ->
+            sendMessage(state.context, toPrint)
+            InternalFSMState.SaidHelloOnce(state.context)
+        }
+
+        strictlyOn { state: InternalFSMState.SaidHelloOnce ->
+            val message = waitTextMessage().first()
+            reply(message, "Sorry, I can answer only this: $toPrint")
+            InternalFSMState.SaidHelloOnce(state.context)
         }
     }
 }

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

@@ -1,6 +1,11 @@
 package dev.inmo.plagubot
 
+import dev.inmo.kslog.common.*
+import dev.inmo.micro_utils.common.Warning
 import dev.inmo.micro_utils.coroutines.runCatchingSafely
+import dev.inmo.micro_utils.fsm.common.State
+import dev.inmo.micro_utils.fsm.common.StatesManager
+import dev.inmo.micro_utils.fsm.common.managers.*
 import dev.inmo.plagubot.config.*
 import dev.inmo.tgbotapi.bot.ktor.telegramBot
 import dev.inmo.tgbotapi.extensions.api.webhook.deleteWebhook
@@ -17,19 +22,19 @@ import org.koin.core.context.GlobalContext
 import org.koin.core.module.Module
 import org.koin.core.scope.Scope
 import org.koin.dsl.module
-import java.util.logging.Level
-import java.util.logging.Logger
 
 val Scope.plagubot: PlaguBot
     get() = get()
 
+val Koin.plagubot: PlaguBot
+    get() = get()
+
+@OptIn(Warning::class)
 @Serializable
 data class PlaguBot(
     private val json: JsonObject,
     private val config: Config
 ) : Plugin {
-    @Transient
-    private val logger = Logger.getLogger("PlaguBot")
     @Transient
     private val bot = telegramBot(config.botToken)
 
@@ -50,24 +55,24 @@ data class PlaguBot(
                         }
                     }
                 }.onFailure { e ->
-                    logger.log(Level.WARNING, "Unable to load DI part of $it", e)
+                    logger.w("Unable to load DI part of $it", e)
                 }.getOrNull()
             }
         )
     }
 
-    override suspend fun BehaviourContext.setupBotPlugin(koin: Koin) {
-        config.plugins.map {
+    override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
+        config.plugins.map { plugin ->
             launch {
                 runCatchingSafely {
-                    logger.info("Start loading of $it")
-                    with(it) {
+                    logger.i("Start loading of $plugin")
+                    with(plugin) {
                         setupBotPlugin(koin)
                     }
                 }.onFailure { e ->
-                    logger.log(Level.WARNING, "Unable to load bot part of $it", e)
+                    logger.w("Unable to load bot part of $plugin", e)
                 }.onSuccess {
-                    logger.info("Complete loading of $it")
+                    logger.i("Complete loading of $plugin")
                 }
             }
         }.joinAll()
@@ -79,26 +84,39 @@ data class PlaguBot(
     suspend fun start(
         scope: CoroutineScope = CoroutineScope(Dispatchers.IO)
     ): Job {
-        logger.info("Start initialization")
+        logger.i("Start initialization")
         val koinApp = KoinApplication.init()
         koinApp.modules(
             module {
                 setupDI(config.databaseConfig.database, json)
             }
         )
-        logger.info("Modules loaded")
+        logger.i("Modules loaded")
         GlobalContext.startKoin(koinApp)
-        logger.info("Koin started")
+        logger.i("Koin started")
         lateinit var behaviourContext: BehaviourContext
-        bot.buildBehaviour(scope = scope) {
-            logger.info("Start setup of bot part")
+        bot.buildBehaviourWithFSM(
+            scope = scope,
+            defaultExceptionsHandler = {
+                logger.e("Something went wrong", it)
+            },
+            statesManager = koinApp.koin.getOrNull<StatesManager<State>>() ?: DefaultStatesManager(
+                koinApp.koin.getOrNull<DefaultStatesManagerRepo<State>>() ?: InMemoryDefaultStatesManagerRepo<State>(),
+                onStartContextsConflictResolver = { _, _ -> false }
+            ),
+            onStateHandlingErrorHandler = koinApp.koin.getOrNull<StateHandlingErrorHandler<State>>() ?: { state, e ->
+                logger.eS(e) { "Unable to handle state $state" }
+                null
+            }
+        ) {
+            logger.i("Start setup of bot part")
             behaviourContext = this
             setupBotPlugin(koinApp.koin)
             deleteWebhook()
-        }
-        logger.info("Behaviour builder has been setup")
+        }.start()
+        logger.i("Behaviour builder has been setup")
         return bot.startGettingOfUpdatesByLongPolling(scope = behaviourContext, updatesFilter = behaviourContext).also {
-            logger.info("Long polling has been started")
+            logger.i("Long polling has been started")
         }
     }
 }

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

@@ -1,9 +1,11 @@
 package dev.inmo.plagubot.config
 
+import dev.inmo.micro_utils.common.Warning
 import dev.inmo.plagubot.Plugin
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
+@Warning("This API is internal and can be changed without notifications of mentions of changes")
 @Serializable
 data class Config(
     val botToken: String,

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

@@ -0,0 +1,3 @@
+package dev.inmo.plagubot.config
+
+typealias StateHandlingErrorHandler<T> = suspend (T, Throwable) -> T?

github_release.gradle

@@ -23,7 +23,7 @@ if (new File(projectDir, "secret.gradle").exists()) {
         owner "InsanusMokrassar"
         repo "PlaguBot"
 
-        tagName "${project.version}"
+        tagName "v${project.version}"
         releaseName "${project.version}"
         targetCommitish "${project.version}"
 

gradle.properties

@@ -5,4 +5,4 @@ kotlin.js.generate.externals=true
 kotlin.incremental=true
 
 group=dev.inmo
-version=1.1.0
+version=2.1.0

gradle/libs.versions.toml

@@ -1,25 +1,26 @@
 [versions]
 
-kt = "1.6.21"
-kt-serialization = "1.3.3"
-kt-coroutines = "1.6.1"
+kt = "1.7.10"
+kt-serialization = "1.4.0-RC"
+kt-coroutines = "1.6.4"
 
-microutils = "0.10.5"
-tgbotapi = "2.0.0"
+microutils = "0.12.1"
+tgbotapi = "3.1.1"
+kslog = "0.5.0"
 
-jb-exposed = "0.38.2"
-jb-dokka = "1.6.21"
+jb-exposed = "0.39.2"
+jb-dokka = "1.7.10"
 
 sqlite = "3.36.0.3"
 
-klock = "2.7.0"
-uuid = "0.4.0"
+klock = "3.0.0"
+uuid = "0.5.0"
 
-ktor = "2.0.1"
+ktor = "2.1.0"
 
-gh-release = "2.3.7"
+gh-release = "2.4.1"
 
-android-gradle = "7.0.4"
+android-gradle = "7.2.2"
 dexcount = "3.1.0"
 koin = "3.2.0"
 
@@ -31,7 +32,9 @@ kt-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", vers
 kt-serialization = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kt-serialization" }
 
 tgbotapi = { module = "dev.inmo:tgbotapi", version.ref = "tgbotapi" }
+tgbotapi-behaviourBuilder-fsm = { module = "dev.inmo:tgbotapi.behaviour_builder.fsm", version.ref = "tgbotapi" }
 microutils-repos-exposed = { module = "dev.inmo:micro_utils.repos.exposed", version.ref = "microutils" }
+kslog = { module = "dev.inmo:kslog", version.ref = "kslog" }
 
 koin = { module = "io.insert-koin:koin-core", version.ref = "koin" }
 

gradle/wrapper/gradle-wrapper.properties

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

plugin/src/main/kotlin/dev/inmo/plagubot/Plugin.kt

@@ -1,6 +1,8 @@
 package dev.inmo.plagubot
 
+import dev.inmo.micro_utils.fsm.common.State
 import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
+import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContextWithFSM
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.JsonObject
 import org.jetbrains.exposed.sql.Database
@@ -23,7 +25,20 @@ interface Plugin {
         database: Database,
         params: JsonObject
     ) {}
+
+    /**
+     * Override this method in cases when you want to declare common bot behaviour. In case you wish to use FSM, you
+     * should override the method with receiver [BehaviourContextWithFSM]
+     */
     suspend fun BehaviourContext.setupBotPlugin(
         koin: Koin
     ) {}
+    /**
+     * Override this method in cases when you want to declare full behaviour of the plugin. It is recommended to declare
+     * common logic of plugin in the [setupBotPlugin] with [BehaviourContext] receiver and use override this one
+     * for the FSM configuration
+     */
+    suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
+        (this as BehaviourContext).setupBotPlugin(koin)
+    }
 }

plugin/src/main/kotlin/dev/inmo/plagubot/PluginSerializer.kt

@@ -13,7 +13,8 @@ class PluginSerializer : KSerializer<Plugin> {
         get() = String.serializer().descriptor
 
     override fun deserialize(decoder: Decoder): Plugin {
-        return Class.forName(decoder.decodeString()).getDeclaredConstructor().newInstance() as Plugin
+        val kclass = Class.forName(decoder.decodeString()).kotlin
+        return (kclass.objectInstance ?: kclass.constructors.first { it.parameters.isEmpty() }.call()) as Plugin
     }
 
     override fun serialize(encoder: Encoder, value: Plugin) {

settings.gradle

@@ -2,7 +2,12 @@ String[] toInclude = [":bot", ":plugin"]
 
 rootProject.name = 'plagubot'
 
-toInclude.each {
-    include (it)
-    project(it).name = "${rootProject.name}${it.replace(":", ".")}"
+toInclude.each { originalName ->
+    String projectDirectory = "${rootProject.projectDir.getAbsolutePath()}${originalName.replace(":", File.separator)}"
+    String projectName = "${rootProject.name}${originalName.replace(":", ".")}"
+    String projectIdentifier = ":${projectName}"
+    include projectIdentifier
+    ProjectDescriptor project = project(projectIdentifier)
+    project.name = projectName
+    project.projectDir = new File(projectDirectory)
 }