resolves #1907 bot_engine: implement coroutine-based stories

bot/api/service/src/main/kotlin/BotApiHandler.kt

@@ -33,6 +33,7 @@ import ai.tock.bot.connector.media.MediaCard
 import ai.tock.bot.connector.media.MediaCarousel
 import ai.tock.bot.connector.media.MediaFile
 import ai.tock.bot.definition.StoryDefinition
+import ai.tock.bot.definition.StoryStep
 import ai.tock.bot.engine.BotBus
 import ai.tock.bot.engine.action.Action
 import ai.tock.bot.engine.action.SendAttachment.AttachmentType
@@ -134,7 +135,7 @@ internal class BotApiHandler(
             }
             // set step
             if (response.step != null) {
-                step = story.definition.allSteps().find { it.name == response.step }
+                step = story.definition.allSteps().find { it.name == response.step } as? StoryStep<*>
             }
 
             //Handle current story and switch to ending story

bot/api/service/src/test/kotlin/BotApiHandlerTest.kt

@@ -25,17 +25,17 @@ import ai.tock.bot.api.model.websocket.ResponseData
 import ai.tock.bot.api.service.BotApiClientController
 import ai.tock.bot.api.service.BotApiDefinitionProvider
 import ai.tock.bot.api.service.BotApiHandler
-import ai.tock.bot.definition.BotDefinition
 import ai.tock.bot.api.service.toUserRequest
+import ai.tock.bot.definition.BotDefinition
 import ai.tock.bot.definition.StoryDefinition
 import ai.tock.bot.engine.BotBus
 import ai.tock.bot.engine.action.ActionMetadata
 import ai.tock.bot.engine.action.SendSentence
 import ai.tock.bot.engine.dialog.Dialog
 import ai.tock.bot.engine.dialog.DialogState
 import ai.tock.bot.engine.dialog.NextUserActionState
-import ai.tock.bot.engine.user.UserTimelineDAO
 import ai.tock.bot.engine.user.PlayerId
+import ai.tock.bot.engine.user.UserTimelineDAO
 import ai.tock.nlp.api.client.model.NlpIntentQualifier
 import ai.tock.shared.tockInternalInjector
 import com.github.salomonbrys.kodein.Kodein
@@ -47,11 +47,11 @@ import io.mockk.justRun
 import io.mockk.mockk
 import io.mockk.slot
 import io.mockk.verify
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
 
 
 class BotApiHandlerTest {
@@ -140,7 +140,7 @@ class BotApiHandlerTest {
         handler.send(bus)
 
         verify { bus.setBusContextValue("_viewed_stories_tock_switch", any()) }
-        verify { bus.handleAndSwitchStory(any(), any()) }
+        verify { bus.handleAndSwitchStory(any<StoryDefinition>(), any()) }
     }
 
     @Test

bot/connector-alcmeon/src/main/kotlin/AlcmeonHandler.kt

@@ -16,6 +16,7 @@
 package ai.tock.bot.connector.alcmeon
 
 import ai.tock.bot.connector.ConnectorHandler
+import ai.tock.bot.definition.ConnectorSpecificHandling
 import ai.tock.bot.definition.ConnectorStoryHandler
 import ai.tock.bot.definition.StoryHandlerDefinition
 import kotlin.reflect.KClass
@@ -28,4 +29,4 @@ import kotlin.reflect.KClass
 @ConnectorHandler(connectorTypeId = ALCMEON_CONNECTOR_TYPE_ID)
 @Target(AnnotationTarget.CLASS)
 @MustBeDocumented
-annotation class AlcmeonHandler(val value: KClass<out ConnectorStoryHandler<*>>)
+annotation class AlcmeonHandler(val value: KClass<out ConnectorSpecificHandling>)

bot/connector-alexa/src/main/kotlin/AlexaHandler.kt

@@ -17,15 +17,18 @@
 package ai.tock.bot.connector.alexa
 
 import ai.tock.bot.connector.ConnectorHandler
+import ai.tock.bot.definition.AsyncStoryHandling
+import ai.tock.bot.definition.ConnectorSpecificHandling
 import ai.tock.bot.definition.ConnectorStoryHandler
+import ai.tock.bot.definition.StoryHandlerDefinitionBase
 import kotlin.reflect.KClass
 
 /**
  * To specify [ConnectorStoryHandler] for Alexa connector.
  * [KClass] passed as [value] of this annotation must have a primary constructor
- * with a single not optional [StoryHandlerDefinitionBase] argument.
+ * with a single not optional [StoryHandlerDefinitionBase] or [AsyncStoryHandling] argument.
  */
 @ConnectorHandler(connectorTypeId = ALEXA_CONNECTOR_TYPE_ID)
 @Target(AnnotationTarget.CLASS)
 @MustBeDocumented
-annotation class AlexaHandler(val value: KClass<out ConnectorStoryHandler<*>>)
+annotation class AlexaHandler(val value: KClass<out ConnectorSpecificHandling>)

bot/connector-businesschat/src/main/kotlin/BusinessChatHandler.kt

@@ -17,18 +17,18 @@
 package ai.tock.bot.connector.businesschat
 
 import ai.tock.bot.connector.ConnectorHandler
+import ai.tock.bot.definition.AsyncStoryHandling
+import ai.tock.bot.definition.ConnectorSpecificHandling
 import ai.tock.bot.definition.ConnectorStoryHandler
-import kotlin.annotation.AnnotationTarget
-import kotlin.annotation.MustBeDocumented
-import kotlin.annotation.Target
+import ai.tock.bot.definition.StoryHandlerDefinitionBase
 import kotlin.reflect.KClass
 
 /**
  * To specify [ConnectorStoryHandler] for BusinessChat connector.
  * [KClass] passed as [value] of this annotation must have a primary constructor
- * with a single not optional [StoryHandlerDefinitionBase] argument.
+ * with a single not optional [StoryHandlerDefinitionBase] or [AsyncStoryHandling] argument.
  */
 @ConnectorHandler(connectorTypeId = BUSINESS_CHAT_CONNECTOR_TYPE_ID)
 @Target(AnnotationTarget.CLASS)
 @MustBeDocumented
-annotation class BusinessChatHandler(val value: KClass<out ConnectorStoryHandler<*>>)
+annotation class BusinessChatHandler(val value: KClass<out ConnectorSpecificHandling>)

bot/connector-ga/src/main/kotlin/GABuilders.kt

@@ -41,8 +41,7 @@ import ai.tock.bot.connector.ga.model.response.GASimpleSelect
 import ai.tock.bot.connector.ga.model.response.GAStructuredResponse
 import ai.tock.bot.connector.ga.model.response.GAUpdatePermissionValueSpec
 import ai.tock.bot.definition.IntentAware
-import ai.tock.bot.definition.StoryHandlerDefinition
-import ai.tock.bot.definition.StoryStep
+import ai.tock.bot.definition.StoryStepDef
 import ai.tock.bot.engine.Bus
 import ai.tock.bot.engine.I18nTranslator
 import ai.tock.bot.engine.action.SendChoice
@@ -305,7 +304,7 @@ fun I18nTranslator.gaButton(title: CharSequence, url: String): GAButton {
 fun <T : Bus<T>> T.optionInfo(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     vararg parameters: Pair<String, String>
 ): GAOptionInfo {
     val t = translate(title)

bot/connector-ga/src/main/kotlin/GACarouselBuilders.kt

@@ -24,8 +24,8 @@ import ai.tock.bot.connector.ga.model.response.GAExpectedIntent
 import ai.tock.bot.connector.ga.model.response.GAImage
 import ai.tock.bot.definition.IntentAware
 import ai.tock.bot.definition.Parameters
-import ai.tock.bot.definition.StoryHandlerDefinition
 import ai.tock.bot.definition.StoryStep
+import ai.tock.bot.definition.StoryStepDef
 import ai.tock.bot.engine.Bus
 import ai.tock.bot.engine.I18nTranslator
 import ai.tock.translator.raw
@@ -163,7 +163,7 @@ fun <T : Bus<T>> T.carouselItem(
  */
 fun <T : Bus<T>> T.carouselItem(
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     title: CharSequence,
     description: CharSequence? = null,
     image: GAImage? = null,
@@ -176,7 +176,7 @@ fun <T : Bus<T>> T.carouselItem(
  */
 fun <T : Bus<T>> T.carouselItem(
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     title: CharSequence,
     description: CharSequence? = null,
     image: GAImage? = null,

bot/connector-ga/src/main/kotlin/GAHandler.kt

@@ -17,6 +17,7 @@
 package ai.tock.bot.connector.ga
 
 import ai.tock.bot.connector.ConnectorHandler
+import ai.tock.bot.definition.ConnectorSpecificHandling
 import ai.tock.bot.definition.ConnectorStoryHandler
 import kotlin.reflect.KClass
 
@@ -28,4 +29,4 @@ import kotlin.reflect.KClass
 @ConnectorHandler(connectorTypeId = GA_CONNECTOR_TYPE_ID)
 @Target(AnnotationTarget.CLASS)
 @MustBeDocumented
-annotation class GAHandler(val value: KClass<out ConnectorStoryHandler<*>>)
+annotation class GAHandler(val value: KClass<out ConnectorSpecificHandling>)

bot/connector-ga/src/main/kotlin/GAListBuilders.kt

@@ -25,8 +25,8 @@ import ai.tock.bot.connector.ga.model.response.GARichResponse
 import ai.tock.bot.connector.ga.model.response.GASuggestion
 import ai.tock.bot.definition.IntentAware
 import ai.tock.bot.definition.Parameters
-import ai.tock.bot.definition.StoryHandlerDefinition
 import ai.tock.bot.definition.StoryStep
+import ai.tock.bot.definition.StoryStepDef
 import ai.tock.bot.engine.Bus
 import ai.tock.bot.engine.I18nTranslator
 import ai.tock.translator.raw
@@ -169,7 +169,7 @@ fun <T : Bus<T>> T.listItem(
 fun <T : Bus<T>> T.listItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     parameters: Parameters
 ): GAListItem = listItem(title, targetIntent, step, null, null, parameters)
 
@@ -179,7 +179,7 @@ fun <T : Bus<T>> T.listItem(
 fun <T : Bus<T>> T.listItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     vararg parameters: Pair<String, String>
 ): GAListItem = listItem<T>(title, targetIntent, step, null, null, *parameters)
 
@@ -189,7 +189,7 @@ fun <T : Bus<T>> T.listItem(
 fun <T : Bus<T>> T.listItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     description: CharSequence? = null,
     imageUrl: String? = null,
     parameters: Parameters
@@ -201,7 +201,7 @@ fun <T : Bus<T>> T.listItem(
 fun <T : Bus<T>> T.listItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>?,
+    step: StoryStepDef?,
     description: CharSequence? = null,
     imageUrl: String? = null,
     vararg parameters: Pair<String, String>

bot/connector-ga/src/main/kotlin/GASelectBuilders.kt

@@ -22,8 +22,8 @@ import ai.tock.bot.connector.ga.model.response.GASelectItem
 import ai.tock.bot.connector.ga.model.response.GASimpleSelect
 import ai.tock.bot.definition.IntentAware
 import ai.tock.bot.definition.Parameters
-import ai.tock.bot.definition.StoryHandlerDefinition
 import ai.tock.bot.definition.StoryStep
+import ai.tock.bot.definition.StoryStepDef
 import ai.tock.bot.engine.Bus
 import ai.tock.bot.engine.I18nTranslator
 
@@ -64,7 +64,7 @@ fun <T : Bus<T>> T.selectItem(
 fun <T : Bus<T>> T.selectItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>,
+    step: StoryStepDef,
     optionTitle: CharSequence? = null,
     parameters: Parameters
 ): GASelectItem = selectItem(title, targetIntent, step, optionTitle, *parameters.toArray())
@@ -75,7 +75,7 @@ fun <T : Bus<T>> T.selectItem(
 fun <T : Bus<T>> T.selectItem(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     optionTitle: CharSequence? = null,
     vararg parameters: Pair<String, String>
 ): GASelectItem {

bot/connector-google-chat/src/main/kotlin/GoogleChatHandler.kt

@@ -17,6 +17,7 @@ package ai.tock.bot.connector.googlechat
 
 import ai.tock.bot.connector.ConnectorHandler
 import ai.tock.bot.connector.googlechat.builder.GOOGLE_CHAT_CONNECTOR_TYPE_ID
+import ai.tock.bot.definition.ConnectorSpecificHandling
 import ai.tock.bot.definition.ConnectorStoryHandler
 import ai.tock.bot.definition.StoryHandlerDefinition
 import kotlin.reflect.KClass
@@ -29,4 +30,4 @@ import kotlin.reflect.KClass
 @ConnectorHandler(connectorTypeId = GOOGLE_CHAT_CONNECTOR_TYPE_ID)
 @Target(AnnotationTarget.CLASS)
 @MustBeDocumented
-annotation class GoogleChatHandler(val value: KClass<out ConnectorStoryHandler<*>>)
+annotation class GoogleChatHandler(val value: KClass<out ConnectorSpecificHandling>)

bot/connector-messenger/src/main/kotlin/MessengerBuilders.kt

@@ -45,8 +45,7 @@ import ai.tock.bot.connector.messenger.model.send.UserAction.Companion.extractQu
 import ai.tock.bot.definition.Intent
 import ai.tock.bot.definition.IntentAware
 import ai.tock.bot.definition.Parameters
-import ai.tock.bot.definition.StoryHandlerDefinition
-import ai.tock.bot.definition.StoryStep
+import ai.tock.bot.definition.StoryStepDef
 import ai.tock.bot.engine.Bus
 import ai.tock.bot.engine.I18nTranslator
 import ai.tock.bot.engine.action.ActionMetadata
@@ -373,15 +372,15 @@ fun I18nTranslator.standaloneQuickReply(
     /**
      * The target step.
      */
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     /**
      * The image url of the quick reply.
      */
     imageUrl: String? = null,
     /**
      * The current step of the Bus<T>.
      */
-    busStep: StoryStep<out StoryHandlerDefinition>? = null,
+    busStep: StoryStepDef? = null,
     /**
      * The current intent of the Bus<T>.
      */
@@ -412,7 +411,7 @@ fun <T : Bus<T>> T.quickReply(
     title: CharSequence,
     targetIntent: IntentAware,
     imageUrl: String? = null,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     parameters: Parameters
 ): QuickReply =
     quickReply(title, targetIntent, imageUrl, step, parameters.toMap())
@@ -424,7 +423,7 @@ fun <T : Bus<T>> T.quickReply(
     title: CharSequence,
     targetIntent: IntentAware,
     imageUrl: String? = null,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     vararg parameters: Pair<String, String>
 ): QuickReply =
     quickReply(title, targetIntent.wrappedIntent(), imageUrl, step, parameters.toMap())
@@ -436,7 +435,7 @@ fun <T : Bus<T>> T.quickReply(
     title: CharSequence,
     targetIntent: IntentAware,
     imageUrl: String? = null,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     parameters: Collection<Pair<String, String>>
 ): QuickReply =
     quickReply(title, targetIntent, imageUrl, step, parameters.toMap())
@@ -448,7 +447,7 @@ fun <T : Bus<T>> T.quickReply(
     title: CharSequence,
     targetIntent: IntentAware,
     imageUrl: String? = null,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     parameters: Map<String, String>
 ): QuickReply =
     quickReply(title, targetIntent, imageUrl, step?.name, parameters)
@@ -515,7 +514,7 @@ fun <T : Bus<T>> T.postbackButton(
 fun <T : Bus<T>> T.postbackButton(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     parameters: Parameters
 ): PostbackButton =
     postbackButton(title, targetIntent, step, *parameters.toArray())
@@ -526,7 +525,7 @@ fun <T : Bus<T>> T.postbackButton(
 fun <T : Bus<T>> T.postbackButton(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     vararg parameters: Pair<String, String>
 ): PostbackButton =
     postbackButton(
@@ -541,9 +540,9 @@ fun <T : Bus<T>> T.postbackButton(
 private fun I18nTranslator.postbackButton(
     title: CharSequence,
     targetIntent: IntentAware,
-    step: StoryStep<out StoryHandlerDefinition>? = null,
+    step: StoryStepDef? = null,
     parameters: Map<String, String>,
-    payloadEncoder: (IntentAware, StoryStep<out StoryHandlerDefinition>?, Map<String, String>) -> String
+    payloadEncoder: (IntentAware, StoryStepDef?, Map<String, String>) -> String
 ): PostbackButton {
     val t = translate(title)
     if (t.length > 20) {