@magmamath/students-features 0.4.4 → 0.5.0-rc.0

package/src/features/chatbot/model/ChatBotModel.ts

@@ -1,18 +1,18 @@
 import {
   attach,
+  combine,
+  createEffect,
   createEvent,
+  createStore,
   restore,
   sample,
   type Store,
-  createStore,
-  createEffect,
-  combine,
 } from 'effector'
-import { createControllerEffect, createEntityFieldStore } from '../../../lib/effector'
+import { createControllerEffect } from '../../../lib/effector'
 import {
   ChatbotContext,
   ChatbotModelProps,
-  ConversationMessage,
+  IChatDrawBoardAdapter,
   SendHelpParams,
   SendHelpProps,
   SetHintMessageProps,
@@ -20,20 +20,32 @@ import {
   StartConversationProps,
 } from '../types/model.types'
 import { GetAlternativesResponse } from '../types/api.types'
-import { ChatbotAPI } from './api'
+import { ChatbotAPI } from './ChatbotApi'
 import { ChatbotTranslation } from './translation'
-import { ChatTextToSpeechModel } from './t2s'
-import { AudioProvider } from '../types/t2s.types'
+import { ChatTextToSpeechModel, T2SConfig } from './t2s'
 import { messagesHelper } from './messagesHelper'
+import { ChatBotThreadManager } from './ChatBotThreadManager'
+import { ChatsCacheModel, defaultChatData } from './ChatsCacheModel'
+import { ErrorSpottingModel } from '../errorSpotting/ErrorSpottingModel'
+import { withEvent } from '../../../lib/effector/withEvent'
+import { ChatBotTextManager } from './ChatBoxTextManager'
 
 type ReinitConversationProps = {
   key: string
 }
 
 export class ChatbotModel {
-  readonly api: ChatbotAPI
-  readonly translation: ChatbotTranslation
-  readonly t2s: ChatTextToSpeechModel
+  public readonly textManager = new ChatBotTextManager()
+  private readonly defaultMessages = this.textManager.messages
+
+  public readonly threadManager = new ChatBotThreadManager({
+    messages: this.defaultMessages,
+  })
+  public readonly api: ChatbotAPI
+
+  public readonly translation: ChatbotTranslation
+  public readonly t2s: ChatTextToSpeechModel
+  public readonly errorSpotting: ErrorSpottingModel
 
   public readonly $currentKey = createStore('')
 
@@ -55,92 +67,81 @@ export class ChatbotModel {
   readonly setScrollActive = createEvent<boolean>()
   readonly $isScrollActive = restore(this.setScrollActive, false)
 
-  readonly sendHelpRequestFx
-
-  readonly defaultMessages: ChatbotModelProps['messages']
-
-  readonly messages = createEntityFieldStore<ConversationMessage[]>()
-  readonly threadIds = createEntityFieldStore<string>()
-  readonly availableChats = createEntityFieldStore<boolean>()
+  private readonly cache = new ChatsCacheModel()
 
   public readonly $currentChatData = combine(
-    {
-      messages: this.messages.$state,
-      threadIds: this.threadIds.$state,
-      availableChats: this.availableChats.$state,
-      key: this.$currentKey,
-    },
-    ({ messages, threadIds, availableChats, key }) => {
-      return {
-        messages: messages[key] ?? [],
-        threadId: threadIds[key] ?? null,
-        isAvailable: availableChats[key] ?? false,
-        key,
-      }
-    },
+    { data: this.cache.$data, key: this.$currentKey },
+    ({ data, key }) => (data[key] ? { ...data[key], key } : { ...defaultChatData(), key }),
   )
 
-  constructor({ api, messages, $key }: ChatbotModelProps) {
-    this.api = new ChatbotAPI(api)
+  constructor({ api, $key, threadMessagesLimit }: ChatbotModelProps) {
+    this.api = new ChatbotAPI({ ...api, postMessage: this.threadManager.postMessage })
 
-    this.defaultMessages = messages
-    if ($key) sample({ source: $key, target: this.$currentKey })
+    this.threadManager.setApi({ getHint: api.requestHint })
+    if (threadMessagesLimit) {
+      this.threadManager.setMessagesLimit(threadMessagesLimit)
+    }
 
     this.$alternatives = restore(this.api.getAlternativesFx.doneData, null)
       .on(this.setAlternatives, (_, payload) => payload)
       .reset(this.resetAlternatives)
 
+    this.t2s = new ChatTextToSpeechModel({ api: this.api })
     this.translation = new ChatbotTranslation({
       $context: this.$context,
-      defaultMessages: messages,
+      defaultMessages: this.defaultMessages,
       $key: this.$currentKey,
       api: this.api,
-      messagesModel: this.messages,
       alternativesModel: {
         $store: this.$alternatives,
         set: this.setAlternatives,
       },
+      chats: this.cache,
+    })
+
+    this.errorSpotting = new ErrorSpottingModel({
+      api: this.api,
+      $currentChatData: this.$currentChatData,
     })
 
-    this.t2s = new ChatTextToSpeechModel({ $isOpen: this.$isOpen, api: this.api })
+    if ($key) this.bindKey($key)
 
-    this.sendHelpRequestFx = this.createSendHelpRequestFx()
-    this.initChatReplyWatcher()
+    sample({
+      source: this.$isOpen.updates,
+      filter: (isOpen) => !isOpen,
+      target: this.t2s.reset,
+    })
+
+    sample({
+      clock: this.removeLastMessage,
+      source: [this.$lastMessageKey, this.cache.$data] as const,
+      fn: ([lastMessageKey, chatsData]) => {
+        const chat = chatsData[lastMessageKey ?? '']
+        if (!chat) return { key: '', data: {} }
+        const updatedMessages = [...chat.messages]
+        updatedMessages.pop()
+        return { key: lastMessageKey ?? '', data: { messages: updatedMessages } }
+      },
+      filter: ([lastMessageKey]) => !!lastMessageKey,
+      target: this.cache.update,
+    })
   }
 
   private createSendHelpRequestFx() {
     const effect = attach({
-      source: [
-        this.$currentKey,
-        this.translation.$isTranslated,
-        this.$currentChatData,
-        this.$context,
-      ],
-      mapParams: (params: SendHelpParams, [key, isTranslated, currentData, context]) => ({
+      source: [this.$currentKey, this.$context],
+      mapParams: (params: SendHelpParams, [key, context]) => ({
         message: params.message,
         translatedMessage: params.translatedMessage,
         context,
         key,
-        isTranslated,
-        threadId: currentData.threadId,
       }),
       effect: createControllerEffect(
-        async ({
-          message,
-          translatedMessage,
-          key,
-          isTranslated,
-          threadId,
-          context,
-        }: SendHelpProps) => {
+        async ({ message, translatedMessage, key, context }: SendHelpProps) => {
           if (!context) throw new Error('Context is required')
           this.setLastMessageKey(key)
-          this.messages.setField({
-            key,
-            fn: (currentMessages) => [
-              ...(currentMessages || []),
-              messagesHelper.createOwn({ message, translatedMessage, threadId }),
-            ],
+          this.cache.addMessages(key, {
+            messages: [messagesHelper.createOwn({ message, translatedMessage })],
           })
 
           const response = await this.api.postMessageFx({
@@ -148,25 +149,21 @@ export class ChatbotModel {
             language: context.language,
             problemAnswer: context.problemAnswer,
             answer: context.answer,
-            threadId,
             imageAltText: context.imageDescription,
           })
-          let messages = [messagesHelper.createAnswer(response)]
+          const thread = this.threadManager.get(key)
+          let messages = [
+            messagesHelper.createAnswer(response, { isInitial: thread?.history.length === 1 }),
+          ]
           if (response.endMessage) {
             messages.push(messagesHelper.createLast(this.defaultMessages.endMessage))
           }
-          if (isTranslated) {
-            messages = await this.translation.translateMessagesFx({
-              targetLanguage: context.translationTargetLanguage,
-              messages,
-            })
-          }
-
-          this.messages.setField({
-            key,
-            fn: (currentMessages) => [...(currentMessages || []), ...messages],
+          messages = await this.translation.applyTranslationFx({
+            targetLanguage: context.translationTargetLanguage,
+            messages,
           })
-          this.threadIds.setField({ key, data: response.threadId })
+
+          this.cache.addMessages(key, { messages, thread })
         },
       ),
     })
@@ -174,29 +171,39 @@ export class ChatbotModel {
     sample({
       clock: effect.fail,
       source: this.$currentChatData,
-      fn: ({ key, messages }) => ({ key, data: [...messages, this.defaultMessages.error] }),
+      fn: ({ key, messages }) => ({
+        key,
+        data: { messages: [...messages, this.defaultMessages.error] },
+      }),
       filter: (_, { error }) => error.message !== 'Request aborted manually',
-      target: this.messages.setField,
+      target: this.cache.update,
     })
 
     return effect
   }
 
-  private initChatReplyWatcher() {
+  public bindKey($store: Store<string>) {
     sample({
-      clock: this.removeLastMessage,
-      source: [this.$lastMessageKey, this.messages.$state] as const,
-      fn: ([lastMessageKey, messages]) => {
-        if (!lastMessageKey) return { key: '', data: [] }
-        const updatedMessages = [...messages[lastMessageKey]]
-        updatedMessages.pop()
-        return { key: lastMessageKey, data: updatedMessages }
-      },
-      filter: ([lastMessageKey]) => !!lastMessageKey,
-      target: this.messages.setField,
+      source: $store,
+      target: this.$currentKey,
     })
+    this.threadManager.bindKeyStore($store)
+    return this
+  }
+
+  public setUpT2S(config: T2SConfig) {
+    this.t2s.setConfig(config)
+    return this
   }
 
+  public setDrawBoardAdapter(adapter: IChatDrawBoardAdapter) {
+    this.threadManager.setDrawBoardAdapter(adapter)
+    this.errorSpotting.bindStrokesValidation(adapter.$strokesValidationKey)
+    return this
+  }
+
+  public readonly sendHelpRequestFx = this.createSendHelpRequestFx()
+
   public readonly startConversation = attach({
     source: this.$currentChatData,
     mapParams: (props: StartConversationProps | void, source) => ({
@@ -208,54 +215,54 @@ export class ChatbotModel {
         if (initOnly) return
         return this.reinitConversation({ key })
       }
-      this.messages.setField({ key, data: [this.defaultMessages.start] })
-      this.availableChats.setField({ key, data: true })
+      this.cache.add(key, {
+        messages: [this.defaultMessages.start],
+        isAvailable: true,
+        currentThread: null,
+      })
     }),
   })
 
   public setHintMessage({ key, ...message }: SetHintMessageProps) {
     const options = this.$alternatives.getState()?.options.hints ?? message.options
-    this.messages.setField({
-      key,
-      fn: (messages) => {
-        if (!messages || messages.length > 1) return
-        return [{ ...message, options }]
-      },
-    })
+    this.cache.setSingleMessage(key, { ...message, options })
   }
 
-  public readonly reinitConversation = createEffect(({ key }: ReinitConversationProps) => {
-    this.messages.setField({
-      key,
-      fn: (messages) => {
-        if (!messages?.length || messages.length === 1) return
-        const copy = [...messages]
-        while (copy.at(-1)?.endMessage) {
-          copy.pop()
-        }
-
-        const lastMessage = copy.at(-1)
-        if (!lastMessage) return
-
-        copy.splice(copy.length - 1, 1, {
-          ...lastMessage,
-          options: [this.defaultMessages.anotherHintOption],
-        })
-        return copy
-      },
-    })
-  })
-
-  public bindKey($store: Store<string>) {
-    sample({
-      source: $store,
-      target: this.$currentKey,
-    })
-    return this
+  public readonly reinitConversation = ({ key }: ReinitConversationProps) => {
+    this.cache.reinitChatThread(key, { initialOption: this.defaultMessages.anotherHintOption })
+    this.threadManager.reset(key)
   }
 
-  public setT2SAudioProvider(audioProvider: AudioProvider) {
-    this.t2s.setAudioProvider(audioProvider)
-    return this
+  public disableChat(key: string) {
+    this.t2s.stop()
+    void this.t2s.reset()
+    this.cache.disableChat(key)
   }
+
+  public softReset = attach({
+    source: {
+      isLoading: this.sendHelpRequestFx.pending,
+      lastMessageKey: this.$lastMessageKey,
+    },
+    mapParams: (_: void, { isLoading, lastMessageKey }) => !!(isLoading && lastMessageKey),
+    effect: createEffect((hasPendingMessage: boolean) => {
+      if (hasPendingMessage) {
+        this.api.postMessageFx.controller.abort()
+        this.removeLastMessage()
+      }
+      this.errorSpotting.abortPendingRequest()
+
+      this.t2s.stop()
+      void this.t2s.reset()
+      this.translation.reset()
+      this.setScrollActive(false)
+    }),
+  })
+
+  public readonly reset = withEvent(() => {
+    this.cache.reset()
+    this.resetAlternatives()
+    this.threadManager.reset()
+    this.errorSpotting.reset()
+  })
 }

package/src/features/chatbot/model/{ChatBotMessageHandler.ts → ChatBotThreadManager.ts}

@@ -1,6 +1,5 @@
 import { ThreadItem } from './ThreadItem'
 import { Store } from 'effector'
-import { createEffect } from 'effector/effector.umd'
 import {
   ChatHintPayload,
   ChatHintResponse,
@@ -10,25 +9,23 @@ import {
 import { ChatbotMessages, IChatDrawBoardAdapter } from '../types/model.types'
 import { CHAT_BOT_MODEL_DEFAULTS } from './constants'
 
-type ChatMessageHandlerProps = {
-  messagesLimit?: number
-  messages: ChatbotMessages
-  drawBoardAdapter: IChatDrawBoardAdapter
-  api: {
-    getHint: (props: ChatHintPayload) => Promise<ChatHintResponse>
-  }
+type ThreadManagerApi = {
+  getHint: (props: ChatHintPayload) => Promise<ChatHintResponse>
 }
 
-type ResetCacheProps = {
-  key: string
+type ChatBotThreadManagerProps = {
+  messagesLimit?: number
+  drawBoardAdapter?: IChatDrawBoardAdapter
+  messages: ChatbotMessages
+  api?: ThreadManagerApi
 }
 
-export class ChatMessageHandler {
-  private readonly api
-  private readonly drawBoardAdapter: IChatDrawBoardAdapter
+export class ChatBotThreadManager {
+  private api: ThreadManagerApi | null = null
+  private drawBoardAdapter: IChatDrawBoardAdapter | null = null
   private readonly threads = new Map<string, ThreadItem>()
 
-  private readonly messagesLimit
+  private messagesLimit
   private currentKey = ''
   private currentBinding: null | (() => void) = null
 
@@ -39,9 +36,9 @@ export class ChatMessageHandler {
     api,
     messagesLimit = CHAT_BOT_MODEL_DEFAULTS.THREAD_MESSAGES_LIMIT,
     messages,
-  }: ChatMessageHandlerProps) {
-    this.api = api
-    this.drawBoardAdapter = drawBoardAdapter
+  }: ChatBotThreadManagerProps) {
+    if (api) this.api = api
+    this.drawBoardAdapter = drawBoardAdapter ?? null
     this.messagesLimit = messagesLimit
     this.defaultMessages = messages
   }
@@ -58,9 +55,16 @@ export class ChatMessageHandler {
     const key = this.currentKey
     let threadItem = this.threads.get(key)
     if (threadItem) return threadItem
+    if (!this.drawBoardAdapter) {
+      threadItem = new ThreadItem()
+      this.threads.set(key, threadItem)
+      return threadItem
+    }
     try {
-      const strokes = await this.drawBoardAdapter.getVisibleStrokes()
-      threadItem = new ThreadItem({ strokes })
+      const result = await this.drawBoardAdapter.getVisibleStrokes()
+      threadItem = new ThreadItem(
+        result ? { strokes: result.strokes, key: result.validationKey } : null,
+      )
     } catch {
       threadItem = new ThreadItem()
     }
@@ -68,13 +72,22 @@ export class ChatMessageHandler {
     return threadItem
   }
 
-  public readonly postMessageFx = async ({
+  public setDrawBoardAdapter(adapter: IChatDrawBoardAdapter) {
+    this.drawBoardAdapter = adapter
+  }
+
+  public readonly postMessage = async ({
     problemAnswer,
     problem,
     answer,
     language,
     imageAltText,
   }: PostMessagePayload): Promise<PostMessageResponse> => {
+    if (!this.api) {
+      throw new Error(
+        'API is not set in ThreadManagersApi, pls provide API before sending requests',
+      )
+    }
     const threadItem = await this.getThreadItem()
 
     const result = await this.api.getHint({
@@ -86,23 +99,36 @@ export class ChatMessageHandler {
       imageAltText,
     })
 
-    threadItem.hints.push(result.message)
+    threadItem.history.push(result.message)
     const nextOptions =
-      threadItem.hints.length < this.messagesLimit ? [this.defaultMessages.anotherHintOption] : []
+      threadItem.history.length < this.messagesLimit ? [this.defaultMessages.anotherHintOption] : []
 
     return {
       message: result.message,
       options: nextOptions,
-      threadId: '',
       endMessage: !nextOptions.length,
+      threadId: threadItem.id,
     }
   }
 
-  public resetThread = createEffect(({ key }: ResetCacheProps) => {
-    this.threads.delete(key)
-  })
+  public get(key: string) {
+    return this.threads.get(key)
+  }
 
-  public resetAll() {
+  public reset(key?: string) {
+    if (typeof key === 'string') {
+      this.threads.delete(key)
+      return
+    }
     this.threads.clear()
   }
+
+  public setMessagesLimit(limit: number) {
+    this.messagesLimit = limit
+  }
+
+  public setApi(api: ThreadManagerApi) {
+    this.api = api
+    return this
+  }
 }

package/src/features/chatbot/model/ChatBoxTextManager.ts

@@ -0,0 +1,18 @@
+import { DefaultMessagesCreator } from './DefaultMessageCreator'
+import { TranslationKeys } from '../../../shared/translation/types'
+import { getText } from '../../../shared/translation/helpers'
+import { ChatbotMessages } from '../types/model.types'
+import { $localization } from '../../../shared/translation'
+
+export class ChatBotTextManager {
+  private readonly messagesCreator = new DefaultMessagesCreator<TranslationKeys>({
+    textGetter: getText,
+  }).bindToLanguageChanged($localization.updates)
+
+  public readonly messages: ChatbotMessages = {
+    error: this.messagesCreator.createMessage('chat.errorMessage'),
+    start: this.messagesCreator.createMessage('chat.howCanIHelp'),
+    endMessage: this.messagesCreator.createMessage('chat.answerAgain'),
+    anotherHintOption: this.messagesCreator.createOption('chat.anotherHint'),
+  }
+}

package/src/features/chatbot/model/{api.ts → ChatbotApi.ts}

@@ -1,8 +1,9 @@
 import { createEffect } from 'effector'
 import { createControllerEffect } from '../../../lib/effector'
-import { ChatbotModelProps } from '../types/model.types'
+import { ChatbotApiRequests, SpotErrorPayload, SpotErrorResponse } from '../types/model.types'
 import { GoogleTranslatePayload, GoogleTranslateResponse } from '../types/api.types'
 import { replaceKatexSyntax } from '../helpers'
+import { getRandomElements } from '../../../lib/helpers/randomElements'
 
 export class ChatbotAPI {
   public readonly postMessageFx
@@ -10,7 +11,23 @@ export class ChatbotAPI {
   public readonly translateTextFx
   public readonly textToSpeechTextFx
 
-  constructor(api: ChatbotModelProps['api']) {
+  public readonly spotErrorFx
+
+  constructor(api: ChatbotApiRequests) {
+    this.spotErrorFx = createControllerEffect(
+      (props: SpotErrorPayload): Promise<SpotErrorResponse> => {
+        return new Promise<SpotErrorResponse>((res) => {
+          if (props.strokes.length <= 3) return res({ strokesIds: [] })
+          setTimeout(() => {
+            const randomStrokes = getRandomElements(props.strokes, 4)
+            res({
+              strokesIds: randomStrokes.map((stroke) => stroke.id ?? ''),
+            })
+          }, 1000)
+        })
+      },
+    )
+    // this.spotErrorFx = createControllerEffect(api.spotError)
     this.postMessageFx = createControllerEffect(api.postMessage)
     this.getAlternativesFx = createEffect(api.getAlternatives)
     this.translateTextFx = createEffect(

package/src/features/chatbot/model/ChatsCacheModel.ts

@@ -0,0 +1,95 @@
+import { createEvent } from 'effector'
+import { createEntityFieldStore } from '../../../lib/effector'
+import { ChatAnswer, ChatItem, ConversationMessage } from '../types/units.types'
+import { ThreadItem } from './ThreadItem'
+
+type ReinitChatThreadSettings = {
+  initialOption: ChatAnswer
+}
+
+type UpdateProps = {
+  key: string
+  data: Partial<ChatItem>
+}
+
+type AddMessagesProps = {
+  messages: ConversationMessage[]
+  thread?: ThreadItem | null
+}
+
+export function defaultChatData(props: Partial<ChatItem> = {}): ChatItem {
+  return {
+    messages: [],
+    isAvailable: false,
+    currentThread: null,
+    ...props,
+  }
+}
+
+export class ChatsCacheModel {
+  public readonly update = createEvent<UpdateProps>()
+  private readonly cache = createEntityFieldStore<ChatItem>().on(
+    this.update,
+    (state, { key, data }) => {
+      const currentData = state[key] ?? defaultChatData()
+      return { ...state, [key]: { ...currentData, ...data } }
+    },
+  )
+
+  public readonly $data = this.cache.$state
+  public readonly reset = this.cache.reset
+
+  public disableChat(key: string) {
+    this.cache.setField({
+      key,
+      fn: (current) =>
+        current ? { ...current, isAvailable: false } : defaultChatData({ isAvailable: false }),
+    })
+  }
+
+  public reinitChatThread(key: string, { initialOption }: ReinitChatThreadSettings) {
+    this.cache.setField({
+      key,
+      fn: (current) => {
+        if (!current || current.messages.length <= 1) return
+        const copy = [...current.messages]
+        while (copy.at(-1)?.endMessage) {
+          copy.pop()
+        }
+        const lastMessage = copy.at(-1)
+        if (!lastMessage) return
+        copy.splice(copy.length - 1, 1, {
+          ...lastMessage,
+          options: [initialOption],
+        })
+        return { ...current, messages: copy }
+      },
+    })
+  }
+
+  public setSingleMessage(key: string, message: ConversationMessage) {
+    this.cache.setField({
+      key,
+      fn: (current) => {
+        if (!current || current.messages.length > 1) return
+        return { ...current, messages: [message] }
+      },
+    })
+  }
+
+  public addMessages(key: string, { messages, thread = null }: AddMessagesProps) {
+    this.cache.setField({
+      key,
+      fn: (current) => {
+        if (!current) return defaultChatData({ messages, currentThread: thread })
+        const result = { ...current, messages: [...current.messages, ...messages] }
+        if (thread) result.currentThread = thread
+        return result
+      },
+    })
+  }
+
+  public add(key: string, data: ChatItem) {
+    this.cache.setField({ key, data })
+  }
+}