fixes theopenconversationkit#1829 bot_engine: rename applicationId to…

… connectorId

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

@@ -54,7 +54,7 @@ class TockClientBus(
     constructor(botDefinition: ClientBotDefinition, data: RequestData, sendAnswer: (BotResponse) -> Unit) :
         this(botDefinition, data.requestId, data.botRequest!!, sendAnswer)
 
-    override val applicationId: String = request.context.applicationId
+    override val connectorId: String = request.context.applicationId
     override val userId: PlayerId = request.context.userId
     override val botId: PlayerId = request.context.botId
     override val intent: IntentAware? = request.intent?.let { Intent(it) }
@@ -191,7 +191,7 @@ class TockClientBus(
     }
 
     override fun withMessage(connectorType: ConnectorType, connectorId: String, messageProvider: () -> ConnectorMessage): ClientBus {
-        if (applicationId == connectorId && targetConnectorType == connectorType) {
+        if (this.connectorId == connectorId && targetConnectorType == connectorType) {
             context.connectorMessages[connectorType] = messageProvider()
         }
         return this

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

@@ -80,7 +80,7 @@ internal class BotApiHandler(
                 botDefinition.botId,
                 story.definition.id
             )
-            val endingStoryId = storySetting?.findEnabledEndWithStoryId(applicationId)
+            val endingStoryId = storySetting?.findEnabledEndWithStoryId(connectorId)
 
             val messages = response.messages
             if (messages.isEmpty()) {
@@ -143,7 +143,7 @@ internal class BotApiHandler(
                     userTimelineDAO.save(userTimeline, botDefinition, asynchronousProcess = false)
                 }
 
-                val targetStory = botDefinition.findStoryDefinitionById(endingStoryId, applicationId)
+                val targetStory = botDefinition.findStoryDefinitionById(endingStoryId, connectorId)
                 switchEndingStory(targetStory)
             }
         }
@@ -185,7 +185,7 @@ internal class BotApiHandler(
     private fun BotBus.toAction(message: CustomMessage): Action {
         return SendSentence(
             botId,
-            applicationId,
+            connectorId,
             userId,
             null,
             listOfNotNull(message.message.value).toMutableList()
@@ -201,7 +201,7 @@ internal class BotApiHandler(
             if (message != null) {
                 return SendSentence(
                     botId,
-                    applicationId,
+                    connectorId,
                     userId,
                     null,
                     mutableListOf(message)
@@ -210,7 +210,7 @@ internal class BotApiHandler(
         }
         return SendSentence(
             botId,
-            applicationId,
+            connectorId,
             userId,
             text
         )
@@ -219,7 +219,7 @@ internal class BotApiHandler(
     private fun BotBus.toAction(data: Debug): Action {
         return SendDebug(
             botId,
-            applicationId,
+            connectorId,
             userId,
             data.text,
             data.data
@@ -237,7 +237,7 @@ internal class BotApiHandler(
         return connectorMessages?.map {
             SendSentence(
                 botId,
-                applicationId,
+                connectorId,
                 userId,
                 null,
                 mutableListOf(it)
@@ -256,7 +256,7 @@ internal class BotApiHandler(
         return connectorMessages?.map {
             SendSentence(
                 botId,
-                applicationId,
+                connectorId,
                 userId,
                 null,
                 mutableListOf(it)

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

@@ -77,7 +77,7 @@ private fun BotBus.toRequestContext(): RequestContext =
         sourceConnectorType,
         targetConnectorType,
         userInterfaceType,
-        applicationId,
+        connectorId,
         userId,
         botId,
         userPreferences.toUserData(),

bot/connector-web/src/main/kotlin/WebConnector.kt

@@ -106,9 +106,11 @@ val webConnectorUseExtraHeadersAsMetadata: Boolean =
     booleanProperty("tock_web_connector_use_extra_header_as_metadata_request", false)
 
 class WebConnector internal constructor(
-    val applicationId: String,
+    val connectorId: String,
     val path: String
 ) : ConnectorBase(webConnectorType, setOf(CAROUSEL)), OrchestrationConnector {
+    @Deprecated("Use the more aptly named connectorId field", ReplaceWith("connectorId"))
+    val applicationId: String get() = connectorId
 
     companion object {
         private val logger = KotlinLogging.logger {}
@@ -186,7 +188,7 @@ class WebConnector internal constructor(
                             val timerId = vertx.setPeriodic(Duration.ofSeconds(sseKeepaliveDelay).toMillis()) {
                                 response.sendSsePing()
                             }
-                            val channelId = channels.register(applicationId, userId) { webConnectorResponse ->
+                            val channelId = channels.register(connectorId, userId) { webConnectorResponse ->
                                 response.sendSseResponse(webConnectorResponse)
                             }
                             response.closeHandler {
@@ -288,11 +290,11 @@ class WebConnector internal constructor(
             val applicationId =
                 if (request.connectorId?.isNotBlank() == true)
                     if (webConnectorBridgeEnabled)
-                        request.connectorId.also { logger.debug { "Web bridge: $applicationId -> $it" } }
+                        request.connectorId.also { logger.debug { "Web bridge: $connectorId -> $it" } }
                     else
-                        applicationId.also { logger.warn { "Web bridge disabled." } }
+                        connectorId.also { logger.warn { "Web bridge disabled." } }
                 else
-                    applicationId
+                    connectorId
 
             val event = request.toEvent(applicationId)
             val requestInfos = WebRequestInfos(context.request())
@@ -349,12 +351,12 @@ class WebConnector internal constructor(
             throw UnsupportedOperationException("Web Connector only supports notifications when SSE is enabled")
         }
         handleEvent(
-            applicationId = applicationId,
+            applicationId = connectorId,
             locale = defaultLocale,
             event = SendChoice(
                 recipientId,
-                applicationId,
-                PlayerId(applicationId, bot),
+                connectorId,
+                PlayerId(connectorId, bot),
                 intent.wrappedIntent().name,
                 step,
                 parameters
@@ -392,14 +394,14 @@ class WebConnector internal constructor(
             val request: ResumeOrchestrationRequest = mapper.readValue(context.body().asString())
             val callback = RestOrchestrationCallback(
                 webConnectorType,
-                applicationId = applicationId,
+                applicationId = connectorId,
                 context = context,
                 orchestrationMapper = webMapper
             )
 
             controller.handle(request.toAction(), ConnectorData(callback))
         } catch (t: Throwable) {
-            RestOrchestrationCallback(webConnectorType, applicationId, context = context).sendError()
+            RestOrchestrationCallback(webConnectorType, connectorId, context = context).sendError()
             BotRepository.requestTimer.throwable(t, timerData)
         } finally {
             BotRepository.requestTimer.end(timerData)
@@ -416,23 +418,23 @@ class WebConnector internal constructor(
             val request: AskEligibilityToOrchestratedBotRequest = mapper.readValue(context.body().asString())
             val callback = RestOrchestrationCallback(
                 webConnectorType,
-                applicationId,
+                connectorId,
                 context = context,
                 orchestrationMapper = webMapper
             )
 
-            val support = controller.support(request.toAction(applicationId), ConnectorData(callback))
+            val support = controller.support(request.toAction(connectorId), ConnectorData(callback))
             val sendEligibility = SecondaryBotEligibilityResponse(
                 support,
                 OrchestrationMetaData(
-                    playerId = PlayerId(applicationId, bot),
-                    applicationId = applicationId,
+                    playerId = PlayerId(connectorId, bot),
+                    applicationId = connectorId,
                     recipientId = request.metadata?.playerId ?: PlayerId(Dice.newId(), user)
                 )
             )
             callback.sendResponse(sendEligibility)
         } catch (t: Throwable) {
-            RestOrchestrationCallback(webConnectorType, applicationId, context = context).sendError()
+            RestOrchestrationCallback(webConnectorType, connectorId, context = context).sendError()
             BotRepository.requestTimer.throwable(t, timerData)
         } finally {
             BotRepository.requestTimer.end(timerData)

bot/engine/src/main/kotlin/admin/bot/BotApplicationConfiguration.kt

@@ -137,5 +137,5 @@ data class BotApplicationConfigurationKey(
         botDefinition.namespace
     )
 
-    constructor(bus: BotBus) : this(bus.applicationId, bus.botDefinition)
+    constructor(bus: BotBus) : this(bus.connectorId, bus.botDefinition)
 }

bot/engine/src/main/kotlin/admin/message/MessageConfiguration.kt

@@ -33,7 +33,7 @@ interface MessageConfiguration {
 
     fun toAction(bus: BotBus): Action = toAction(
         bus.userId,
-        bus.applicationId,
+        bus.connectorId,
         bus.botId,
         bus.userLocale,
         bus.userInterfaceType

bot/engine/src/main/kotlin/definition/StoryHandlerBase.kt

@@ -167,7 +167,7 @@ abstract class StoryHandlerBase<out T : StoryHandlerDefinition>(
      * Finds the story definition of this handler.
      */
     open fun findStoryDefinition(bus: BotBus): StoryDefinition? =
-        bus.botDefinition.findStoryByStoryHandler(this, bus.applicationId)
+        bus.botDefinition.findStoryByStoryHandler(this, bus.connectorId)
 
     /**
      * Handles the action and switches the context to the underlying story definition.

bot/engine/src/main/kotlin/definition/StoryHandlerDefinitionBase.kt

@@ -22,12 +22,12 @@ import ai.tock.bot.connector.ConnectorType
 import ai.tock.bot.engine.BotBus
 import ai.tock.shared.injector
 import ai.tock.shared.provide
-import mu.KotlinLogging
 import kotlin.LazyThreadSafetyMode.PUBLICATION
 import kotlin.reflect.KClass
 import kotlin.reflect.full.isSubtypeOf
 import kotlin.reflect.full.primaryConstructor
 import kotlin.reflect.full.starProjectedType
+import mu.KotlinLogging
 
 /**
  * Base implementation of [StoryHandlerDefinition].
@@ -95,8 +95,8 @@ abstract class StoryHandlerDefinitionBase<T : ConnectorStoryHandlerBase<*>>(val
         connectorProvider.provide(this, connectorId) as? T?
 
     private val cachedConnector: T? by lazy(PUBLICATION) {
-        (findConnector(applicationId) ?: findConnector(connectorType))
-            .also { if (it == null) logger.warn { "unsupported connector type $applicationId or $connectorType for ${this::class}" } }
+        (findConnector(connectorId) ?: findConnector(connectorType))
+            .also { if (it == null) logger.warn { "unsupported connector type $connectorId or $connectorType for ${this::class}" } }
     }
 
     /**

bot/engine/src/main/kotlin/engine/BotBus.kt

@@ -75,16 +75,13 @@ interface BotBus : Bus<BotBus> {
     }
 
     /**
-     * The current TOCK application id.
+     * The connector ID.
      *
      * This identifier matches the identifier of the [underlyingConnector], as defined in TOCK Studio.
      *
-     * *This identifier is not to be confused with the chat platform's application id (this is not a Messenger/Whatsapp
-     * application ID).*
-     *
      * @see ConnectorConfiguration.connectorId
      */
-    override val applicationId: String
+    override val connectorId: String
 
     /**
      * The bot definition of the current bot.
@@ -373,7 +370,7 @@ interface BotBus : Bus<BotBus> {
      * Sends text that should not be translated as last bot answer.
      */
     override fun endRawText(plainText: CharSequence?, delay: Long): BotBus {
-        return end(SendSentence(botId, applicationId, userId, plainText), delay)
+        return end(SendSentence(botId, connectorId, userId, plainText), delay)
     }
 
     /**
@@ -507,7 +504,7 @@ interface BotBus : Bus<BotBus> {
      */
     fun isFeatureEnabled(feature: FeatureType, default: Boolean = false) =
         injector.provide<FeatureDAO>()
-            .isEnabled(botDefinition.botId, botDefinition.namespace, feature, applicationId, default, userId.id)
+            .isEnabled(botDefinition.botId, botDefinition.namespace, feature, connectorId, default, userId.id)
 
     /**
      * Marks the current as not understood in the nlp model.

bot/engine/src/main/kotlin/engine/Bus.kt

@@ -29,10 +29,19 @@ import ai.tock.bot.engine.user.PlayerId
  */
 interface Bus<T : Bus<T>> : I18nTranslator {
 
+    /**
+     * The connector ID.
+     */
+    val connectorId: String
+
     /**
      * The current TOCK application id.
+     *
+     * *This identifier is not to be confused with the chat platform's application id (this is not a Messenger/Whatsapp
+     * application ID).*
      */
-    val applicationId: String
+    @Deprecated("Use more appropriately named connectorId", ReplaceWith("connectorId"))
+    val applicationId: String get() = connectorId
 
     /**
      * The current bot id.

bot/engine/src/main/kotlin/engine/TockBotBus.kt

@@ -61,7 +61,7 @@ internal class TockBotBus(
             currentDialog.stories.add(value)
         }
     override val botDefinition: BotDefinition = bot.botDefinition
-    override val applicationId = action.applicationId
+    override val connectorId = action.applicationId
     override val botId = action.recipientId
     override val userId = action.playerId
     override val userPreferences: UserPreferences = userTimeline.userPreferences
@@ -166,11 +166,11 @@ internal class TockBotBus(
     }
 
     override fun sendRawText(plainText: CharSequence?, delay: Long): BotBus {
-        return answer(SendSentence(botId, applicationId, userId, plainText), delay)
+        return answer(SendSentence(botId, connectorId, userId, plainText), delay)
     }
 
     override fun sendDebugData(title: String, data: Any?): BotBus {
-        return answer(SendDebug(botId, applicationId, userId, title, data), 0)
+        return answer(SendDebug(botId, connectorId, userId, title, data), 0)
     }
 
     override fun send(action: Action, delay: Long): BotBus {
@@ -200,7 +200,7 @@ internal class TockBotBus(
     }
 
     override fun withMessage(connectorType: ConnectorType, connectorId: String, messageProvider: () -> ConnectorMessage): BotBus {
-        if (applicationId == connectorId && isCompatibleWith(connectorType)) {
+        if (this.connectorId == connectorId && isCompatibleWith(connectorType)) {
             context.addMessage(messageProvider.invoke())
         }
         return this

bot/engine/src/main/kotlin/engine/action/Action.kt

@@ -25,21 +25,31 @@ import ai.tock.shared.jackson.mapper
 import com.fasterxml.jackson.module.kotlin.readValue
 import java.time.Instant
 import org.litote.kmongo.Id
+import org.litote.kmongo.newId
 
 /**
  * A user (or bot) action.
- *
- * @param applicationId the TOCK application id (matches the id of the connector)
  */
 abstract class Action(
     val playerId: PlayerId,
     val recipientId: PlayerId,
-    applicationId: String,
+    connectorId: String,
     id: Id<Action>,
     date: Instant,
     state: EventState,
     val metadata: ActionMetadata = ActionMetadata()
-) : Event(applicationId, id, date, state) {
+) : Event(connectorId, id, date, state) {
+    @Deprecated("Use constructor with connectorId", ReplaceWith("Action(playerId = playerId, recipientId = recipientId, connectorId = applicationId, id = id, date = date, state = state, metadata = metadata)"))
+    constructor(
+        playerId: PlayerId,
+        recipientId: PlayerId,
+        applicationId: String,
+        id: Id<Action> = newId(),
+        date: Instant = Instant.now(),
+        state: EventState = EventState(),
+        metadata: ActionMetadata = ActionMetadata(),
+        _deprecatedConstructor: Nothing? = null,
+    ): this(playerId, recipientId, applicationId, id, date, state, metadata)
 
     abstract fun toMessage(): Message