plugin-hubtype-analytics: Add target bot_interaction_id on feedback k…

…nowledge base events (#2877)

## Description

**@botonic/core**
Add a new bot_interaction_id attribute in request.input.
Add bot_interaction_id in HandoffBuilder.withBotEvent

**@botonic/react**
Be able to store in a Text message the value of botInteractionId. Use
the value of botInteractionId when creating a feedback_knowledge_base
event

**@botonic/plugin-flow-builder**
When create a Text message using a knowledge base, add the attribute of
botInteractionId

**@botonic/plugin-hubtype-analytics**
Add in feedback_knowledge_base event the attribute
feedback_target_bot_interaction_id
Refactor and split Webviews events in 2 classes and also add optionals
attributes

## Context

This new attribute is needed in the knowledge base feedback events.

## Testing

Fix tests of @botonic/core, @botonic/plugin-flow-builder,
@botnic/plugin-flow-builder adding bot_interaction_id in Input tests
Add feedback_target_bot_interaction_id in feedback_knowledge_base test

packages/botonic-core/src/handoff.ts

@@ -32,6 +32,7 @@ export type HandoffExtraData = {
 interface BotEventData {
   language: string
   country: string
+  bot_interaction_id?: string
 }
 
 function contextDefaults(context: any): BackendContext {

packages/botonic-core/src/models/legacy-types.ts

@@ -147,7 +147,8 @@ export interface Input extends Partial<NluResult> {
   context?: {
     campaign?: Campaign
   }
-  message_id?: string
+  message_id: string
+  bot_interaction_id: string
 }
 
 export interface Campaign {

packages/botonic-core/tests/routing/router.match-route.test.ts

@@ -2,29 +2,61 @@ import { BotRequest, INPUT, Input } from '../../src'
 import { Router } from '../../src/routing'
 import { testRoute, testSession } from '../helpers/routing'
 
-const textInput: Input = { type: INPUT.TEXT, text: 'hi' }
+const textInput: Input = {
+  type: INPUT.TEXT,
+  text: 'hi',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
+}
+
 const textInputComplex: Input = {
   type: INPUT.TEXT,
   text: 'Cömplêx input &% 🚀',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
+}
+
+const textPayloadInput: Input = {
+  type: INPUT.TEXT,
+  text: 'hi',
+  payload: 'foo',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
+}
+
+const postbackInput: Input = {
+  type: INPUT.POSTBACK,
+  payload: 'foo',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
 }
-const textPayloadInput: Input = { type: INPUT.TEXT, text: 'hi', payload: 'foo' }
-const postbackInput: Input = { type: INPUT.POSTBACK, payload: 'foo' }
 
 const audioInput: Input = {
   type: INPUT.AUDIO,
   src: 'data:audio/mpeg;base64,iVBORw0KG',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
 }
+
 const documentInput: Input = {
   type: INPUT.DOCUMENT,
   src: 'data:application/pdf;base64,iVBORw0KG',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
 }
+
 const imageInput: Input = {
   type: INPUT.IMAGE,
   src: 'data:image/png;base64,iVBORw0KG',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
 }
+
 const videoInput: Input = {
   type: INPUT.VIDEO,
   src: 'data:video/mp4;base64,iVBORw0KG',
+  bot_interaction_id: 'testInteractionId',
+  message_id: 'testMessageId',
 }
 
 const requestInput: BotRequest = {

packages/botonic-plugin-flow-builder/src/content-fields/flow-handoff.tsx

@@ -56,6 +56,7 @@ export class FlowHandoff extends ContentFieldsBase {
       handOffBuilder.withBotEvent({
         language: request.session.user.extra_data.language,
         country: request.session.user.extra_data.country,
+        bot_interaction_id: request.input.bot_interaction_id,
       })
       this.isTestIntegration = request.session.is_test_integration
       await handOffBuilder.handOff()

packages/botonic-plugin-flow-builder/src/content-fields/flow-knowledge-base.tsx

@@ -1,4 +1,4 @@
-import { Text } from '@botonic/react'
+import { ActionRequest, Text } from '@botonic/react'
 import React from 'react'
 
 import { ContentFieldsBase } from './content-fields-base'
@@ -20,12 +20,13 @@ export class FlowKnowledgeBase extends ContentFieldsBase {
     return newKnowledgeBase
   }
 
-  toBotonic(id: string): JSX.Element {
+  toBotonic(id: string, request: ActionRequest): JSX.Element {
     return (
       <Text
         key={id}
         feedbackEnabled={this.feedbackEnabled}
         inferenceId={this.inferenceId}
+        botInteractionId={request.input.bot_interaction_id}
       >
         {this.text}
       </Text>

packages/botonic-plugin-flow-builder/tests/helpers/utils.ts

@@ -7,7 +7,6 @@ import {
   ResolvedPlugins,
 } from '@botonic/core'
 import { ActionRequest } from '@botonic/react'
-import { v4 as uuid } from 'uuid'
 
 import BotonicPluginFlowBuilder, {
   FlowBuilderAction,
@@ -48,7 +47,7 @@ export function createFlowBuilderPlugin({
 }
 
 interface RequestArgs {
-  input: Input
+  input: Omit<Input, 'bot_interaction_id' | 'message_id'>
   plugins?: ResolvedPlugins
   provider?: ProviderType
   isFirstInteraction?: boolean
@@ -74,7 +73,11 @@ export function createRequest({
       _hubtype_api: 'https://api.hubtype.com',
       is_test_integration: false,
     },
-    input: { ...input, message_id: uuid() },
+    input: {
+      bot_interaction_id: 'testInteractionId',
+      message_id: 'testMessageId',
+      ...input,
+    },
     lastRoutePath: '',
     plugins,
   }

packages/botonic-plugin-hubtype-analytics/src/event-models/ht-event-feedback-knowledgebase.ts

@@ -9,6 +9,7 @@ import { HtEvent } from './ht-event'
 export class HtEventFeedbackKnowledgebase extends HtEvent {
   action: EventAction.FeedbackKnowledgebase
   knowledgebase_inference_id: string
+  feedback_target_bot_interaction_id: string
   feedback_target_id: string
   feedback_group_id: string
   possible_options: string[]
@@ -22,6 +23,7 @@ export class HtEventFeedbackKnowledgebase extends HtEvent {
     this.type = EventType.WebEvent
     this.action = event.action
     this.knowledgebase_inference_id = event.knowledgebaseInferenceId
+    this.feedback_target_bot_interaction_id = event.feedbackBotInteractionId
     this.feedback_target_id = event.feedbackTargetId
     this.feedback_group_id = event.feedbackGroupId
     this.possible_options = event.possibleOptions

packages/botonic-plugin-hubtype-analytics/src/event-models/ht-event-webview.ts → packages/botonic-plugin-hubtype-analytics/src/event-models/ht-event-webview-end.ts

@@ -1,21 +1,25 @@
-import { EventAction, EventType, EventWebview, RequestData } from '../types'
+import { EventAction, EventType, EventWebviewEnd, RequestData } from '../types'
 import { HtEvent } from './ht-event'
 
-export class HtEventWebview extends HtEvent {
-  action: EventAction.WebviewStep | EventAction.WebviewEnd
+export class HtEventWebviewEnd extends HtEvent {
+  action: EventAction.WebviewEnd
+  flow_thread_id?: string
   webview_thread_id: string
   webview_name: string
-  webview_step_name?: string
+  webview_end_step_name?: string
+  webview_end_step_n?: number
   webview_end_fail_type?: string
   webview_end_fail_message?: string
 
-  constructor(event: EventWebview, requestData: RequestData) {
+  constructor(event: EventWebviewEnd, requestData: RequestData) {
     super(event, requestData)
     this.type = EventType.WebEvent
     this.action = event.action
+    this.flow_thread_id = event.flowThreadId
     this.webview_thread_id = event.webviewThreadId
     this.webview_name = event.webviewName
-    this.webview_step_name = event.webviewStepName
+    this.webview_end_step_name = event.webviewStepName
+    this.webview_end_step_n = event.webviewStepNumber
     this.webview_end_fail_type = event.webviewEndFailType
     this.webview_end_fail_message = event.webviewEndFailMessage
   }

packages/botonic-plugin-hubtype-analytics/src/event-models/ht-event-webview-step.ts

@@ -0,0 +1,22 @@
+import { EventAction, EventType, EventWebviewStep, RequestData } from '../types'
+import { HtEvent } from './ht-event'
+
+export class HtEventWebviewStep extends HtEvent {
+  action: EventAction.WebviewStep
+  flow_thread_id?: string
+  webview_thread_id: string
+  webview_name: string
+  webview_step_name?: string
+  webview_step_n?: number
+
+  constructor(event: EventWebviewStep, requestData: RequestData) {
+    super(event, requestData)
+    this.type = EventType.WebEvent
+    this.action = event.action
+    this.flow_thread_id = event.flowThreadId
+    this.webview_thread_id = event.webviewThreadId
+    this.webview_name = event.webviewName
+    this.webview_step_name = event.webviewStepName
+    this.webview_step_n = event.webviewStepNumber
+  }
+}

packages/botonic-plugin-hubtype-analytics/src/event-models/ht-event.ts

@@ -1,5 +1,14 @@
 import { EventAction, EventType, HtEventProps, RequestData } from '../types'
 
+const excludedEvents = [
+  EventAction.FeedbackCase,
+  EventAction.FeedbackConversation,
+  EventAction.FeedbackKnowledgebase,
+  EventAction.FeedbackWebview,
+  EventAction.WebviewStep,
+  EventAction.WebviewEnd,
+]
+
 export class HtEvent {
   chat_id: string
   type: EventType
@@ -9,12 +18,17 @@ export class HtEvent {
   bot_version?: string
   flow_version?: string
   action: EventAction
+  bot_interaction_id?: string
 
   constructor(event: HtEventProps, requestData: RequestData) {
     this.chat_id = requestData.userId
     this.chat_language = requestData.language
     this.chat_country = requestData.country
     this.format_version = 2
     this.action = event.action
+
+    if (!excludedEvents.includes(event.action)) {
+      this.bot_interaction_id = requestData.botInteractionId
+    }
   }
 }

packages/botonic-plugin-hubtype-analytics/src/event-models/index.ts

@@ -10,4 +10,5 @@ export { HtEventIntent } from './ht-event-intent'
 export { HtEventIntentSmart } from './ht-event-intent-smart'
 export { HtEventKeyword } from './ht-event-keyword'
 export { HtEventKnowledgeBase } from './ht-event-knowledge-base'
-export { HtEventWebview } from './ht-event-webview'
+export { HtEventWebviewEnd } from './ht-event-webview-end'
+export { HtEventWebviewStep } from './ht-event-webview-step'

packages/botonic-plugin-hubtype-analytics/src/index.ts

@@ -1,5 +1,5 @@
 import { BotRequest, Plugin } from '@botonic/core'
-import axios, { AxiosError } from 'axios'
+import axios from 'axios'
 
 import { HtEvent } from './event-models'
 import { EventType, HtEventProps, RequestData } from './types'
@@ -44,6 +44,7 @@ export default class BotonicPluginHubtypeAnalytics implements Plugin {
       language: this.getLanguage(request),
       country: this.getCountry(request),
       userId: request.session.user.id,
+      botInteractionId: request.input?.bot_interaction_id,
     }
   }
 

packages/botonic-plugin-hubtype-analytics/src/types.ts

@@ -45,6 +45,7 @@ export interface EventFeedback extends HtBaseEventProps {
 export interface EventFeedbackKnowledgebase extends HtBaseEventProps {
   action: EventAction.FeedbackKnowledgebase
   knowledgebaseInferenceId: string
+  feedbackBotInteractionId: string
   feedbackTargetId: string
   feedbackGroupId: string
   possibleOptions: string[]
@@ -130,11 +131,22 @@ export interface EventFallback extends HtBaseEventProps {
   fallbackMessageId: string
 }
 
-export interface EventWebview extends HtBaseEventProps {
-  action: EventAction.WebviewStep | EventAction.WebviewEnd
+export interface EventWebviewStep extends HtBaseEventProps {
+  action: EventAction.WebviewStep
+  flowThreadId?: string
+  webviewThreadId: string
+  webviewName: string
+  webviewStepName: string
+  webviewStepNumber?: number
+}
+
+export interface EventWebviewEnd extends HtBaseEventProps {
+  action: EventAction.WebviewEnd
+  flowThreadId?: string
   webviewThreadId: string
   webviewName: string
   webviewStepName?: string
+  webviewStepNumber?: number
   webviewEndFailType?: string
   webviewEndFailMessage?: string
 }
@@ -156,11 +168,13 @@ export type HtEventProps =
   | EventIntentSmart
   | EventKnowledgeBase
   | EventFallback
-  | EventWebview
+  | EventWebviewStep
+  | EventWebviewEnd
   | EventCustom
 
 export interface RequestData {
   language: string
   country: string
   userId: string
+  botInteractionId: string
 }

packages/botonic-plugin-hubtype-analytics/src/utils.ts

@@ -11,7 +11,8 @@ import {
   HtEventIntentSmart,
   HtEventKeyword,
   HtEventKnowledgeBase,
-  HtEventWebview,
+  HtEventWebviewEnd,
+  HtEventWebviewStep,
 } from './event-models'
 import { EventAction, HtEventProps, RequestData } from './types'
 
@@ -55,8 +56,10 @@ export function createHtEvent(
       return new HtEventFallback(htEventProps, requestData)
 
     case EventAction.WebviewStep:
+      return new HtEventWebviewStep(htEventProps, requestData)
+
     case EventAction.WebviewEnd:
-      return new HtEventWebview(htEventProps, requestData)
+      return new HtEventWebviewEnd(htEventProps, requestData)
 
     case EventAction.Custom:
       return new HtEventCustom(htEventProps, requestData)

packages/botonic-plugin-hubtype-analytics/tests/event-custom.test.ts

@@ -26,6 +26,7 @@ describe('Create custom events', () => {
         value: '12345',
       },
       custom_sensitive_fields: { bank_account: '1234567890' },
+      bot_interaction_id: 'testInteractionId',
       type: EventType.WebEvent,
     })
   })

packages/botonic-plugin-hubtype-analytics/tests/event-fallback.test.ts

@@ -20,6 +20,7 @@ describe('Create fallback events', () => {
       user_input: 'userInputTest',
       fallback_out: 1,
       fallback_message_id: 'fallbackMessageIdTest',
+      bot_interaction_id: 'testInteractionId',
       type: EventType.BotEvent,
     })
   })
@@ -41,6 +42,7 @@ describe('Create fallback events', () => {
       user_input: 'userInputTest',
       fallback_out: 2,
       fallback_message_id: 'fallbackMessageIdTest',
+      bot_interaction_id: 'testInteractionId',
       type: EventType.BotEvent,
     })
   })
@@ -62,6 +64,7 @@ describe('Create fallback events', () => {
       user_input: 'userInputTest',
       fallback_out: 1,
       fallback_message_id: 'fallbackMessageIdTest',
+      bot_interaction_id: 'testInteractionId',
       type: EventType.BotEvent,
     })
   })

packages/botonic-plugin-hubtype-analytics/tests/event-feedback-knowledgebase.test.ts

@@ -8,6 +8,7 @@ describe('Create feedback knowledgebase event', () => {
       action: EventAction.FeedbackKnowledgebase,
       feedbackTargetId: 'messageIdTest',
       feedbackGroupId: 'groupIdTest',
+      feedbackBotInteractionId: 'testInteractionId',
       knowledgebaseInferenceId: 'knowledgebaseInferenceIdTest',
       possibleOptions: ['thumbs_down', 'thumbs_up'],
       possibleValues: [0, 1],
@@ -23,6 +24,7 @@ describe('Create feedback knowledgebase event', () => {
       action: EventAction.FeedbackKnowledgebase,
       feedback_target_id: 'messageIdTest',
       feedback_group_id: 'groupIdTest',
+      feedback_target_bot_interaction_id: 'testInteractionId',
       knowledgebase_inference_id: 'knowledgebaseInferenceIdTest',
       possible_options: ['thumbs_down', 'thumbs_up'],
       possible_values: [0, 1],

packages/botonic-plugin-hubtype-analytics/tests/event-flow.test.ts

@@ -26,6 +26,7 @@ describe('Create flow event', () => {
       flow_node_id: 'flowNodeIdTest',
       flow_node_content_id: 'flowNodeContentIdTest',
       flow_node_is_meaningful: false,
+      bot_interaction_id: 'testInteractionId',
       type: EventType.BotEvent,
     })
   })