- resolves #1935 [Bot API] Enable web streaming mode

- resolves #1936 [Bot API] Story definition should use suspend/coroutine mode
- fixes #1934 [Bot API] websocket mode is broken

Author: vsct-jburet

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 To submit a feature or bugfix:
 
 1. [Create an _issue_](https://github.com/theopenconversationkit/tock/issues/new):
-    - Reccommended format for the title:
+    - Recommended format for the title:
         - `[Component] Title` where component might be 
     _Studio_, _Core_, _Doc_, etc. and title usually is like _Do or fix something_
 2. [Create a _pull request_](https://github.com/theopenconversationkit/tock/pulls) and link it to the issue(s):
@@ -30,4 +30,4 @@ Every new feature or fix should embed its unit test(s).
 
 More about [sources and contrib](https://doc.tock.ai/tock/master/about/contribute.html).
 
-Feel free to [contact us](https://doc.tock.ai/tock/master/about/contact.html).
+Feel free to [contact us](https://doc.tock.ai/tock/master/about/contact.html).

bot/admin/web/src/app/configuration/bot-configurations/bot-configurations.component.ts

@@ -76,7 +76,7 @@ export class BotConfigurationsComponent implements OnInit, OnDestroy {
   }
 
   isFirstLevelConfiguration(bot: BotConfiguration, conf: BotApplicationConfiguration): boolean {
-    return conf.targetConfigurationId === null;
+    return conf.targetConfigurationId === null || conf.targetConfigurationId == undefined;
   }
 
   prepareCreate(): void {

bot/api/client/src/main/kotlin/ClientBus.kt

@@ -69,30 +69,34 @@ interface ClientBus : Bus<ClientBus> {
 
     override fun isCompatibleWith(connectorType: ConnectorType) = targetConnectorType == connectorType
 
+    suspend fun enableStreaming()
+
+    suspend fun disableStreaming()
+
     /**
      * Sends a [Card].
      */
-    fun send(card: Card): ClientBus
+    suspend fun send(card: Card): ClientBus
 
     /**
      * Sends a [Card] as last bot answer.
      */
-    fun end(card: Card): ClientBus
+    suspend fun end(card: Card): ClientBus
 
     /**
      * Sends a [Carousel].
      */
-    fun send(carousel: Carousel): ClientBus
+    suspend fun send(carousel: Carousel): ClientBus
 
     /**
      * Sends a [Carousel as last bot answer.
      */
-    fun end(carousel: Carousel): ClientBus
+    suspend fun end(carousel: Carousel): ClientBus
 
     /**
      * Sends a text with suggestions.
      */
-    fun send(
+    suspend fun send(
         i18nText: CharSequence,
         suggestions: List<Suggestion>,
         delay: Long = defaultDelay(currentAnswerIndex),
@@ -102,15 +106,15 @@ interface ClientBus : Bus<ClientBus> {
     /**
      * Sends a text with suggestions.
      */
-    fun send(
+    suspend fun send(
         i18nText: CharSequence,
         suggestions: List<CharSequence>
     ): ClientBus = send(i18nText, suggestions.map { Suggestion(translate(it)) })
 
     /**
      * Sends a text with suggestions as last bot answer.
      */
-    fun end(
+    suspend fun end(
         i18nText: CharSequence,
         suggestions: List<Suggestion>,
         delay: Long = defaultDelay(currentAnswerIndex),
@@ -120,7 +124,7 @@ interface ClientBus : Bus<ClientBus> {
     /**
      * Sends a text with suggestions as last bot answer.
      */
-    fun end(
+    suspend fun end(
         i18nText: CharSequence,
         suggestions: List<CharSequence>
     ): ClientBus = end(i18nText, suggestions.map { Suggestion(translate(it)) })

bot/api/client/src/main/kotlin/ClientDefinitionBuilders.kt

@@ -26,7 +26,7 @@ private fun defaultUnknownStory() = unknownStory { end("Sorry I didn't understan
  * @param handler The handler for the story.
  */
 fun unknownStory(
-    handler: (ClientBus).() -> Unit
+    handler: suspend (ClientBus).() -> Unit
 ) = ClientStoryDefinition(Intent.unknown, handler = newStoryHandler(handler))
 
 /**
@@ -71,7 +71,7 @@ fun newStory(
     secondaryIntents: Set<IntentAware> = emptySet(),
     steps: List<ClientStep> = emptyList(),
     storyId: String = mainIntent,
-    handler: (ClientBus).() -> Unit
+    handler: suspend (ClientBus).() -> Unit
 ): ClientStoryDefinition =
     ClientStoryDefinition(
         Intent(mainIntent),
@@ -97,7 +97,7 @@ fun newStory(
     secondaryIntents: Set<IntentAware> = emptySet(),
     steps: List<ClientStep> = emptyList(),
     storyId: String = mainIntent.wrappedIntent().name,
-    handler: (ClientBus).() -> Unit
+    handler: suspend (ClientBus).() -> Unit
 ): ClientStoryDefinition =
     ClientStoryDefinition(
         mainIntent,
@@ -112,9 +112,9 @@ fun newStory(
  * Creates a new [ClientStoryHandler].
  * @param handler lamdba handler for the story
  */
-fun newStoryHandler(handler: (ClientBus).() -> Unit): ClientStoryHandler =
+fun newStoryHandler(handler: suspend (ClientBus).() -> Unit): ClientStoryHandler =
     object : ClientStoryHandler {
-        override fun handle(bus: ClientBus) {
+        override suspend fun handle(bus: ClientBus) {
             handler(bus)
         }
     }

bot/api/client/src/main/kotlin/ClientStoryHandler.kt

@@ -23,5 +23,5 @@ interface ClientStoryHandler {
      *
      * @param bus the bus used to get the message and send the answer
      */
-    fun handle(bus: ClientBus)
+    suspend fun handle(bus: ClientBus)
 }

bot/api/client/src/main/kotlin/TockClientBus.kt

@@ -25,6 +25,8 @@ import ai.tock.bot.api.model.message.bot.Card
 import ai.tock.bot.api.model.message.bot.Carousel
 import ai.tock.bot.api.model.message.bot.CustomMessage
 import ai.tock.bot.api.model.message.bot.Debug
+import ai.tock.bot.api.model.message.bot.Event
+import ai.tock.bot.api.model.message.bot.EventCategory
 import ai.tock.bot.api.model.message.bot.I18nText
 import ai.tock.bot.api.model.message.bot.Sentence
 import ai.tock.bot.api.model.message.bot.Suggestion
@@ -41,8 +43,8 @@ import ai.tock.translator.I18nLabelValue
 import ai.tock.translator.TranslatedSequence
 import ai.tock.translator.UserInterfaceType
 import ai.tock.translator.raw
+import kotlinx.coroutines.runBlocking
 import java.util.Locale
-import java.util.concurrent.CopyOnWriteArrayList
 
 class TockClientBus(
     override val botDefinition: ClientBotDefinition,
@@ -68,7 +70,7 @@ class TockClientBus(
     // Target connector : is the connector for which the message is produced
     override val targetConnectorType: ConnectorType = request.context.targetConnectorType
 
-    override val contextId: String? = request.context.userId.id
+    override val contextId: String = request.context.userId.id
     private var _currentAnswerIndex: Int = 0
     override val currentAnswerIndex: Int get() = _currentAnswerIndex
     override val entities: MutableList<Entity> = request.entities.toMutableList()
@@ -81,6 +83,12 @@ class TockClientBus(
 
     override val stepName: String? = null
 
+    @Volatile
+    private var streaming: Boolean = false
+
+    @Volatile
+    private var streamedData: String = ""
+
     override fun handle() {
         story =
             if (request.storyId == botDefinition.unknownStory.storyId) {
@@ -91,11 +99,25 @@ class TockClientBus(
                     ?: botDefinition.unknownStory
             }
         step = story.steps.find { it.name == request.step }
-        story.handler.handle(this)
+        runBlocking {
+            story.handler.handle(this@TockClientBus)
+        }
     }
 
     override fun defaultDelay(answerIndex: Int): Long = 0
 
+    override suspend fun enableStreaming() {
+        streaming = true
+        streamedData = ""
+        addMessage(Event(EventCategory.METADATA, "TOCK_STREAM_RESPONSE", "true"))
+    }
+
+    override suspend fun disableStreaming() {
+        streaming = false
+        streamedData = ""
+        addMessage(Event(EventCategory.METADATA, "TOCK_STREAM_RESPONSE", "false"))
+    }
+
     private fun addMessage(message: BotMessage?, lastResponse: Boolean = false) {
         if (message != null) {
             answer(message, lastResponse)
@@ -112,17 +134,33 @@ class TockClientBus(
             answer(CustomMessage(ConstrainedValueWrapper(it), delay), lastResponse && plainText == null)
         }
         if (plainText != null) {
+            val text : CharSequence = if (streaming) {
+                streamedData += plainText
+                streamedData
+            } else {
+                plainText
+            }
+
             answer(
-                when (plainText) {
-                    is String -> Sentence(I18nText(plainText), delay = delay, suggestions = suggestions)
+                when (text) {
+                    is String -> Sentence(
+                        I18nText(text = text, toBeTranslated = !streaming),
+                        delay = delay,
+                        suggestions = suggestions
+                    )
+
+                    is I18nText -> Sentence(text, delay = delay, suggestions = suggestions)
                     is TranslatedSequence -> Sentence(
-                        I18nText(plainText.toString(), toBeTranslated = false),
+                        I18nText(text.toString(), toBeTranslated = false),
                         delay = delay,
                         suggestions = suggestions
                     )
 
-                    is I18nText -> Sentence(plainText, delay = delay, suggestions = suggestions)
-                    else -> Sentence(I18nText(plainText.toString()), delay = delay, suggestions = suggestions)
+                    else -> Sentence(
+                        I18nText(text.toString(), toBeTranslated = !streaming),
+                        delay = delay,
+                        suggestions = suggestions
+                    )
                 },
                 lastResponse
             )
@@ -154,7 +192,7 @@ class TockClientBus(
         return this
     }
 
-    override fun send(
+    override suspend fun send(
         i18nText: CharSequence,
         suggestions: List<Suggestion>,
         delay: Long,
@@ -164,7 +202,7 @@ class TockClientBus(
         return this
     }
 
-    override fun end(
+    override suspend fun end(
         i18nText: CharSequence,
         suggestions: List<Suggestion>,
         delay: Long,
@@ -174,12 +212,12 @@ class TockClientBus(
         return this
     }
 
-    override fun end(card: Card): ClientBus {
+    override suspend fun end(card: Card): ClientBus {
         addMessage(card, lastResponse = true)
         return this
     }
 
-    override fun end(carousel: Carousel): ClientBus {
+    override suspend fun end(carousel: Carousel): ClientBus {
         addMessage(carousel, lastResponse = true)
         return this
     }
@@ -202,12 +240,12 @@ class TockClientBus(
         )
     }
 
-    override fun send(carousel: Carousel): ClientBus {
+    override suspend fun send(carousel: Carousel): ClientBus {
         addMessage(carousel)
         return this
     }
 
-    override fun send(card: Card): ClientBus {
+    override suspend fun send(card: Card): ClientBus {
         addMessage(card)
         return this
     }

bot/api/model/src/main/kotlin/message/bot/BotMessage.kt

@@ -29,7 +29,8 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo
     JsonSubTypes.Type(value = Card::class, name = "card"),
     JsonSubTypes.Type(value = CustomMessage::class, name = "custom"),
     JsonSubTypes.Type(value = Carousel::class, name = "carousel"),
-    JsonSubTypes.Type(value = Debug::class, name = "debug")
+    JsonSubTypes.Type(value = Debug::class, name = "debug"),
+    JsonSubTypes.Type(value = Event::class, name = "event")
 )
 interface BotMessage {
     /**

bot/api/model/src/main/kotlin/message/bot/Event.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2017/2025 SNCF Connect & Tech
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ai.tock.bot.api.model.message.bot
+
+enum class EventCategory {
+    METADATA
+}
+
+data class Event(
+    val category: EventCategory,
+    val key: String? = null,
+    val value: String? = null,
+    override val delay: Long = 0
+) : BotMessage