Merge pull request #578 from InsanusMokrassar/0.38.18

0.38.18

CHANGELOG.md

@@ -1,5 +1,12 @@
 # TelegramBotAPI changelog
 
+## 0.38.18
+
+* `Core`:
+    * Add support of test servers (fix of [#577](https://github.com/InsanusMokrassar/TelegramBotAPI/issues/577))
+* `BehaviourBuilder`:
+    * Fixes in extension `BehaviourContext#doInSubContextWithUpdatesFilter` (thanks to [xzima](https://github.com/xzima))
+
 ## 0.38.17
 
 * `Core`:

gradle.properties

@@ -20,6 +20,6 @@ javax_activation_version=1.1.1
 dokka_version=1.6.10
 
 library_group=dev.inmo
-library_version=0.38.17
+library_version=0.38.18
 
 github_release_plugin_version=2.3.7

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/BotBuilder.kt

@@ -40,8 +40,9 @@ data class BotBuilder internal constructor(
 fun buildBot(
     token: String,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     block: BotBuilder.() -> Unit
 ) = telegramBot(
-    TelegramAPIUrlsKeeper(token, apiUrl),
+    TelegramAPIUrlsKeeper(token, testServer, apiUrl),
     BotBuilder().apply(block).createHttpClient()
 )

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/BotExtensions.kt

@@ -66,17 +66,19 @@ inline fun telegramBot(
 inline fun telegramBot(
     token: String,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     client: HttpClient = HttpClient()
-): TelegramBot = telegramBot(TelegramAPIUrlsKeeper(token, apiUrl), client)
+): TelegramBot = telegramBot(TelegramAPIUrlsKeeper(token, testServer, apiUrl), client)
 
 @Suppress("NOTHING_TO_INLINE")
 inline fun <T: HttpClientEngineConfig> telegramBot(
     token: String,
     clientFactory: HttpClientEngineFactory<T>,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     noinline clientConfig: HttpClientConfig<T>.() -> Unit = {}
 ) = telegramBot(
-    TelegramAPIUrlsKeeper(token, apiUrl),
+    TelegramAPIUrlsKeeper(token, testServer, apiUrl),
     clientFactory,
     clientConfig
 )
@@ -90,9 +92,10 @@ inline fun telegramBot(
     token: String,
     clientEngine: HttpClientEngine,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     noinline clientConfig: HttpClientConfig<*>.() -> Unit = {}
 ) = telegramBot(
-    TelegramAPIUrlsKeeper(token, apiUrl),
+    TelegramAPIUrlsKeeper(token, testServer, apiUrl),
     clientEngine,
     clientConfig
 )
@@ -105,8 +108,9 @@ inline fun telegramBot(
 inline fun telegramBot(
     token: String,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     noinline clientConfig: HttpClientConfig<*>.() -> Unit
 ) = telegramBot(
-    TelegramAPIUrlsKeeper(token, apiUrl),
+    TelegramAPIUrlsKeeper(token, testServer, apiUrl),
     clientConfig
 )

tgbotapi.behaviour_builder.fsm/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/TelegramBotWithFSM.kt

@@ -38,10 +38,12 @@ suspend fun <T : State> telegramBotWithBehaviourAndFSM(
     defaultExceptionsHandler: ExceptionHandler<Unit>? = null,
     statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()),
     presetHandlers: MutableList<BehaviourWithFSMStateHandlerHolder<*, T>> = mutableListOf(),
+    testServer: Boolean = false,
     block: CustomBehaviourContextReceiver<BehaviourContextWithFSMBuilder<T>, Unit>
 ): TelegramBot = telegramBot(
     token,
     apiUrl,
+    testServer,
     builder
 ).apply {
     buildBehaviourWithFSMAndStartLongPolling(
@@ -73,11 +75,13 @@ suspend fun <T : State> telegramBotWithBehaviourAndFSMAndStartLongPolling(
     defaultExceptionsHandler: ExceptionHandler<Unit>? = null,
     statesManager: StatesManager<T> = DefaultStatesManager(InMemoryDefaultStatesManagerRepo()),
     presetHandlers: MutableList<BehaviourWithFSMStateHandlerHolder<*, T>> = mutableListOf(),
+    testServer: Boolean = false,
     block: CustomBehaviourContextReceiver<BehaviourContextWithFSMBuilder<T>, Unit>
 ): Pair<TelegramBot, Job> {
     return telegramBot(
         token,
         apiUrl,
+        testServer,
         builder
     ).let {
         it to it.buildBehaviourWithFSMAndStartLongPolling (

tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/BehaviourContext.kt

@@ -90,7 +90,7 @@ class DefaultBehaviourContext(
         onBufferOverflow: BufferOverflow,
         upstreamUpdatesFlow: Flow<Update>?,
         updatesFilter: BehaviourContextAndTypeReceiver<Boolean, Update>?
-    ): BehaviourContext = DefaultBehaviourContext(bot, scope, broadcastChannelsSize, onBufferOverflow, upstreamUpdatesFlow, updatesFilter)
+    ): DefaultBehaviourContext = DefaultBehaviourContext(bot, scope, broadcastChannelsSize, onBufferOverflow, upstreamUpdatesFlow, updatesFilter)
 }
 
 fun BehaviourContext(
@@ -116,7 +116,8 @@ suspend fun <T, BC : BehaviourContext> BC.doInSubContextWithUpdatesFilter(
     updatesUpstreamFlow: Flow<Update> = allUpdatesFlow,
     scope: CoroutineScope = LinkedSupervisorScope(),
     behaviourContextReceiver: CustomBehaviourContextReceiver<BC, T>
-): T = copy(
+): T {
+    val newContext = copy(
         scope = scope,
         updatesFilter = updatesFilter ?.let { _ ->
             {
@@ -126,9 +127,9 @@ suspend fun <T, BC : BehaviourContext> BC.doInSubContextWithUpdatesFilter(
             }
         },
         upstreamUpdatesFlow = updatesUpstreamFlow
-).run {
+    ) as BC
-    withContext(coroutineContext) {
+    return withContext(currentCoroutineContext()) {
-        behaviourContextReceiver().also { if (stopOnCompletion) stop() }
+        newContext.behaviourContextReceiver().also { if (stopOnCompletion) newContext.stop() }
     }
 }
 

tgbotapi.behaviour_builder/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/behaviour_builder/TelegramBot.kt

@@ -30,10 +30,12 @@ suspend fun telegramBotWithBehaviour(
     apiUrl: String = telegramBotAPIDefaultUrl,
     builder: KtorRequestsExecutorBuilder.() -> Unit = {},
     defaultExceptionsHandler: ExceptionHandler<Unit>? = null,
+    testServer: Boolean = false,
     block: BehaviourContextReceiver<Unit>
 ): TelegramBot = telegramBot(
     token,
     apiUrl,
+    testServer,
     builder
 ).apply {
     buildBehaviour(
@@ -63,11 +65,13 @@ suspend fun telegramBotWithBehaviourAndLongPolling(
     apiUrl: String = telegramBotAPIDefaultUrl,
     builder: KtorRequestsExecutorBuilder.() -> Unit = {},
     defaultExceptionsHandler: ExceptionHandler<Unit>? = null,
+    testServer: Boolean = false,
     block: BehaviourContextReceiver<Unit>
 ): Pair<TelegramBot, Job> {
     return telegramBot(
         token,
         apiUrl,
+        testServer,
         builder
     ).let {
         it to it.buildBehaviourWithLongPolling(

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/bot/Ktor/KtorRequestsExecutor.kt

@@ -125,5 +125,6 @@ inline fun telegramBot(
 inline fun telegramBot(
     token: String,
     apiUrl: String = telegramBotAPIDefaultUrl,
+    testServer: Boolean = false,
     builder: KtorRequestsExecutorBuilder.() -> Unit = {}
-): TelegramBot = telegramBot(TelegramAPIUrlsKeeper(token, apiUrl), builder)
+): TelegramBot = telegramBot(TelegramAPIUrlsKeeper(token, testServer, apiUrl), builder)

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/utils/TelegramAPIUrlsKeeper.kt

@@ -16,7 +16,8 @@ private inline val String.withoutLastSlash: String
 
 class TelegramAPIUrlsKeeper(
     token: String,
-    hostUrl: String = telegramBotAPIDefaultUrl
+    hostUrl: String = telegramBotAPIDefaultUrl,
+    urlsSuffixes: String = ""
 ) {
     val webAppDataSecretKey by lazy {
         token.hmacSha256("WebAppData")
@@ -25,10 +26,16 @@ class TelegramAPIUrlsKeeper(
     val commonAPIUrl: String
     val fileBaseUrl: String
 
+    constructor(token: String, testServer: Boolean, hostUrl: String = telegramBotAPIDefaultUrl) : this(
+        token,
+        hostUrl,
+        "/test".takeIf { testServer } ?: ""
+    )
+
     init {
         val correctedHost = hostUrl.withoutLastSlash
-        commonAPIUrl = "$correctedHost/bot$token"
+        commonAPIUrl = "$correctedHost/bot$token$urlsSuffixes"
-        fileBaseUrl = "$correctedHost/file/bot$token"
+        fileBaseUrl = "$correctedHost/file/bot$token$urlsSuffixes"
     }
 
     fun createFileLinkUrl(filePath: String) = "${fileBaseUrl}/$filePath"