@lobehub/chat 0.107.14 → 0.107.16

package/src/store/chat/selectors/__tests__/chat.test.ts

@@ -0,0 +1,251 @@
+import { describe, expect, it } from 'vitest';
+
+import { DEFAULT_INBOX_AVATAR } from '@/const/meta';
+import { INBOX_SESSION_ID } from '@/const/session';
+import { ChatStore } from '@/store/chat';
+import { initialState } from '@/store/chat/initialState';
+import { useSessionStore } from '@/store/session';
+import { ChatMessage } from '@/types/chatMessage';
+import { MetaData } from '@/types/meta';
+import { merge } from '@/utils/merge';
+
+import { chatSelectors } from '../chat';
+
+vi.mock('i18next', () => ({
+  t: vi.fn((key) => key), // Simplified mock return value
+}));
+
+const initialStore = initialState as ChatStore;
+
+const mockMessages = [
+  {
+    id: 'msg1',
+    content: 'Hello World',
+    role: 'user',
+  },
+  {
+    id: 'msg2',
+    content: 'Goodbye World',
+    role: 'user',
+  },
+  {
+    id: 'msg3',
+    content: 'Function Message',
+    role: 'function',
+    plugin: {
+      arguments: ['arg1', 'arg2'],
+      identifier: 'func1',
+      type: 'pluginType',
+    },
+  },
+] as ChatMessage[];
+
+const mockedChats = [
+  {
+    id: 'msg1',
+    content: 'Hello World',
+    role: 'user',
+    meta: {
+      avatar: '😀',
+    },
+  },
+  {
+    id: 'msg2',
+    content: 'Goodbye World',
+    role: 'user',
+    meta: {
+      avatar: '😀',
+    },
+  },
+  {
+    id: 'msg3',
+    content: 'Function Message',
+    role: 'function',
+    meta: {
+      avatar: '🧩',
+      title: 'plugin-unknown',
+    },
+    plugin: {
+      arguments: ['arg1', 'arg2'],
+      identifier: 'func1',
+      type: 'pluginType',
+    },
+  },
+] as ChatMessage[];
+
+const mockChatStore = { messages: mockMessages } as ChatStore;
+
+describe('chatSelectors', () => {
+  describe('getMessageById', () => {
+    it('should return undefined if the message with the given id does not exist', () => {
+      const message = chatSelectors.getMessageById('non-existent-id')(initialStore);
+      expect(message).toBeUndefined();
+    });
+
+    it('should return the message object with the matching id', () => {
+      const state = merge(initialStore, { messages: mockMessages });
+      const message = chatSelectors.getMessageById('msg1')(state);
+      expect(message).toEqual(mockMessages[0]);
+    });
+
+    it('should return the message with the matching id', () => {
+      const message = chatSelectors.getMessageById('msg1')(mockChatStore);
+      expect(message).toEqual(mockMessages[0]);
+    });
+
+    it('should return undefined if no message matches the id', () => {
+      const message = chatSelectors.getMessageById('nonexistent')(mockChatStore);
+      expect(message).toBeUndefined();
+    });
+  });
+
+  describe('getFunctionMessageProps', () => {
+    it('should return the properties of a function message', () => {
+      const state = merge(initialStore, {
+        messages: mockMessages,
+        chatLoadingId: 'msg3', // Assuming this id represents a loading state
+      });
+      const props = chatSelectors.getFunctionMessageProps(mockMessages[2])(state);
+      expect(props).toEqual({
+        arguments: ['arg1', 'arg2'],
+        command: mockMessages[2].plugin,
+        content: 'Function Message',
+        id: 'func1',
+        loading: true,
+        type: 'pluginType',
+      });
+    });
+
+    it('should return loading as false if the message id is not the current loading id', () => {
+      const state = merge(initialStore, { messages: mockMessages, chatLoadingId: 'msg1' });
+      const props = chatSelectors.getFunctionMessageProps(mockMessages[2])(state);
+      expect(props.loading).toBe(false);
+    });
+
+    it('should return correct properties when no plugin is present', () => {
+      const messageWithoutPlugin = {
+        id: 'msg4',
+        content: 'No Plugin Message',
+        role: 'function',
+        // No plugin property
+      };
+      const state = merge(initialStore, {
+        messages: [...mockMessages, messageWithoutPlugin],
+        chatLoadingId: 'msg1',
+      });
+      const props = chatSelectors.getFunctionMessageProps(messageWithoutPlugin)(state);
+      expect(props).toEqual({
+        arguments: undefined,
+        command: undefined,
+        content: 'No Plugin Message',
+        id: undefined,
+        loading: false,
+        type: undefined,
+      });
+    });
+  });
+
+  describe('currentChatsWithHistoryConfig', () => {
+    it('should slice the messages according to the current agent config', () => {
+      const state = merge(initialStore, { messages: mockMessages });
+
+      const chats = chatSelectors.currentChatsWithHistoryConfig(state);
+      expect(chats).toHaveLength(3);
+      expect(chats).toEqual(mockedChats);
+    });
+    it('should slice the messages according to config, assuming historyCount is mocked to 2', async () => {
+      const state = merge(initialStore, { messages: mockMessages });
+
+      useSessionStore.getState().updateAgentConfig({ historyCount: 2, enableHistoryCount: true });
+
+      const chats = chatSelectors.currentChatsWithHistoryConfig(state);
+
+      expect(chats).toHaveLength(2);
+      expect(chats).toEqual([
+        {
+          id: 'msg2',
+          content: 'Goodbye World',
+          role: 'user',
+          meta: {
+            avatar: '😀',
+          },
+        },
+        {
+          id: 'msg3',
+          content: 'Function Message',
+          role: 'function',
+          meta: {
+            avatar: '🧩',
+            title: 'plugin-unknown',
+          },
+          plugin: {
+            arguments: ['arg1', 'arg2'],
+            identifier: 'func1',
+            type: 'pluginType',
+          },
+        },
+      ]);
+    });
+  });
+
+  describe('currentChatsWithGuideMessage', () => {
+    it('should return existing messages if there are any', () => {
+      const state = merge(initialStore, { messages: mockMessages, activeId: 'someActiveId' });
+      const chats = chatSelectors.currentChatsWithGuideMessage({} as MetaData)(state);
+      expect(chats).toEqual(mockedChats);
+    });
+
+    it('should add a guide message if the chat is brand new', () => {
+      const state = merge(initialStore, { messages: [], activeId: 'someActiveId' });
+      const metaData = { title: 'Mock Agent', description: 'Mock Description' };
+
+      const chats = chatSelectors.currentChatsWithGuideMessage(metaData)(state);
+
+      expect(chats).toHaveLength(1);
+      expect(chats[0].content).toBeDefined();
+      expect(chats[0].meta.avatar).toEqual(DEFAULT_INBOX_AVATAR);
+      expect(chats[0].meta).toEqual(expect.objectContaining(metaData));
+    });
+
+    it('should use inbox message for INBOX_SESSION_ID', () => {
+      const state = merge(initialStore, { messages: [], activeId: INBOX_SESSION_ID });
+      const metaData = { title: 'Mock Agent', description: 'Mock Description' };
+
+      const chats = chatSelectors.currentChatsWithGuideMessage(metaData)(state);
+
+      expect(chats[0].content).toEqual('inbox.defaultMessage'); // Assuming translation returns a string containing this
+    });
+
+    it('should use agent default message for non-inbox sessions', () => {
+      const state = merge(initialStore, { messages: [], activeId: 'someActiveId' });
+      const metaData = { title: 'Mock Agent' };
+
+      const chats = chatSelectors.currentChatsWithGuideMessage(metaData)(state);
+
+      expect(chats[0].content).toMatch('agentDefaultMessage'); // Assuming translation returns a string containing this
+    });
+  });
+
+  describe('chatsMessageString', () => {
+    it('should concatenate the contents of all messages returned by currentChatsWithHistoryConfig', () => {
+      // Prepare a state with a few messages
+      const state = merge(initialStore, {
+        messages: mockMessages,
+        activeId: 'active-session',
+      });
+
+      // Assume that the currentChatsWithHistoryConfig will return the last two messages
+      const expectedString = mockMessages
+        .slice(-2)
+        .map((m) => m.content)
+        .join('');
+
+      // Call the selector and verify the result
+      const concatenatedString = chatSelectors.chatsMessageString(state);
+      expect(concatenatedString).toBe(expectedString);
+
+      // Restore the mocks after the test
+      vi.restoreAllMocks();
+    });
+  });
+});

package/src/store/chat/selectors/__tests__/topic.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 
-import { ChatStore, ChatStoreState } from '@/store/chat';
+import { ChatStore } from '@/store/chat';
 import { initialState } from '@/store/chat/initialState';
 import { merge } from '@/utils/merge';
 

package/src/store/chat/selectors/chat.ts

@@ -3,13 +3,14 @@ import { t } from 'i18next';
 
 import { DEFAULT_INBOX_AVATAR, DEFAULT_USER_AVATAR } from '@/const/meta';
 import { INBOX_SESSION_ID } from '@/const/session';
-import { chatHelpers } from '@/store/chat/helpers';
 import { useGlobalStore } from '@/store/global';
 import { useSessionStore } from '@/store/session';
 import { agentSelectors } from '@/store/session/selectors';
 import { ChatMessage } from '@/types/chatMessage';
+import { MetaData } from '@/types/meta';
 import { merge } from '@/utils/merge';
 
+import { chatHelpers } from '../helpers';
 import type { ChatStore } from '../store';
 
 const getMeta = (message: ChatMessage) => {
@@ -47,40 +48,41 @@ const currentChats = (s: ChatStore): ChatMessage[] => {
 
 const initTime = Date.now();
 // 针对新助手添加初始化时的自定义消息
-const currentChatsWithGuideMessage = (s: ChatStore): ChatMessage[] => {
-  const data = currentChats(s);
-
-  const isBrandNewChat = data.length === 0;
-
-  if (!isBrandNewChat) return data;
-
-  const [activeId, isInbox] = [s.activeId, s.activeId === INBOX_SESSION_ID];
-  const meta = agentSelectors.currentAgentMeta(useSessionStore.getState());
-
-  const inboxMsg = t('inbox.defaultMessage', { ns: 'chat' });
-  const agentSystemRoleMsg = t('agentDefaultMessageWithSystemRole', {
-    name: meta.title || t('defaultAgent'),
-    ns: 'chat',
-    systemRole: meta.description,
-  });
-  const agentMsg = t('agentDefaultMessage', {
-    id: activeId,
-    name: meta.title || t('defaultAgent'),
-    ns: 'chat',
-  });
-
-  const emptyInboxGuideMessage = {
-    content: isInbox ? inboxMsg : !!meta.description ? agentSystemRoleMsg : agentMsg,
-    createdAt: initTime,
-    extra: {},
-    id: 'default',
-    meta: merge({ avatar: DEFAULT_INBOX_AVATAR }, meta),
-    role: 'assistant',
-    updatedAt: initTime,
-  } as ChatMessage;
-
-  return [emptyInboxGuideMessage];
-};
+const currentChatsWithGuideMessage =
+  (meta: MetaData) =>
+  (s: ChatStore): ChatMessage[] => {
+    const data = currentChats(s);
+
+    const isBrandNewChat = data.length === 0;
+
+    if (!isBrandNewChat) return data;
+
+    const [activeId, isInbox] = [s.activeId, s.activeId === INBOX_SESSION_ID];
+
+    const inboxMsg = t('inbox.defaultMessage', { ns: 'chat' });
+    const agentSystemRoleMsg = t('agentDefaultMessageWithSystemRole', {
+      name: meta.title || t('defaultAgent'),
+      ns: 'chat',
+      systemRole: meta.description,
+    });
+    const agentMsg = t('agentDefaultMessage', {
+      id: activeId,
+      name: meta.title || t('defaultAgent'),
+      ns: 'chat',
+    });
+
+    const emptyInboxGuideMessage = {
+      content: isInbox ? inboxMsg : !!meta.description ? agentSystemRoleMsg : agentMsg,
+      createdAt: initTime,
+      extra: {},
+      id: 'default',
+      meta: merge({ avatar: DEFAULT_INBOX_AVATAR }, meta),
+      role: 'assistant',
+      updatedAt: initTime,
+    } as ChatMessage;
+
+    return [emptyInboxGuideMessage];
+  };
 
 const currentChatsWithHistoryConfig = (s: ChatStore): ChatMessage[] => {
   const chats = currentChats(s);
@@ -105,9 +107,7 @@ const getFunctionMessageProps =
     type: plugin?.type as LobePluginType,
   });
 
-const getMessageById = (id: string) => (s: ChatStore) => {
-  return s.messages.find((m) => m.id === id);
-};
+const getMessageById = (id: string) => (s: ChatStore) => chatHelpers.getMessageById(s.messages, id);
 
 export const chatSelectors = {
   chatsMessageString,

package/src/store/file/slices/images/action.ts

@@ -8,7 +8,7 @@ import { setNamespace } from '@/utils/storeDebug';
 
 import { FileStore } from '../../store';
 
-const t = setNamespace('image');
+const n = setNamespace('image');
 
 export interface FileAction {
   clearImageList: () => void;
@@ -28,7 +28,7 @@ export const createFileSlice: StateCreator<
   FileAction
 > = (set, get) => ({
   clearImageList: () => {
-    set({ inputFilesList: [] }, false, t('clearImageList'));
+    set({ inputFilesList: [] }, false, n('clearImageList'));
   },
   removeAllFiles: async () => {
     await fileService.removeAllFiles();
@@ -39,7 +39,7 @@ export const createFileSlice: StateCreator<
     set(
       ({ inputFilesList }) => ({ inputFilesList: inputFilesList.filter((i) => i !== id) }),
       false,
-      t('removeFile'),
+      n('removeFile'),
     );
   },
   setImageMapItem: (id, item) => {
@@ -50,7 +50,7 @@ export const createFileSlice: StateCreator<
         draft.imagesMap[id] = item;
       }),
       false,
-      t('setImageMapItem'),
+      n('setImageMapItem'),
     );
   },
   uploadFile: async (file) => {
@@ -67,7 +67,7 @@ export const createFileSlice: StateCreator<
       set(
         ({ inputFilesList }) => ({ inputFilesList: [...inputFilesList, data.id] }),
         false,
-        t('uploadFile'),
+        n('uploadFile'),
       );
     } catch (error) {
       // 提示用户上传失败

package/src/store/global/slices/agent.ts

@@ -9,7 +9,7 @@ import { setNamespace } from '@/utils/storeDebug';
 
 import type { GlobalStore } from '../store';
 
-const t = setNamespace('settings');
+const n = setNamespace('settings');
 
 /**
  * 设置操作
@@ -29,6 +29,6 @@ export const createAgentSlice: StateCreator<
       draft.defaultAgent = merge(draft.defaultAgent, agent);
     });
 
-    set({ settings }, false, t('updateDefaultAgent', agent));
+    set({ settings }, false, n('updateDefaultAgent', agent));
   },
 });

package/src/store/global/slices/common.ts

@@ -11,7 +11,7 @@ import { setNamespace } from '@/utils/storeDebug';
 import type { GlobalPreference, GlobalState, Guide, SidebarTabKey } from '../initialState';
 import type { GlobalStore } from '../store';
 
-const t = setNamespace('settings');
+const n = setNamespace('settings');
 
 /**
  * 设置操作
@@ -37,25 +37,25 @@ export const createCommonSlice: StateCreator<
   CommonAction
 > = (set, get) => ({
   switchSideBar: (key) => {
-    set({ sidebarKey: key }, false, t('switchSideBar', key));
+    set({ sidebarKey: key }, false, n('switchSideBar', key));
   },
   toggleChatSideBar: (newValue) => {
     const showChatSideBar =
       typeof newValue === 'boolean' ? newValue : !get().preference.showChatSideBar;
 
-    get().updatePreference({ showChatSideBar }, t('toggleAgentPanel', newValue) as string);
+    get().updatePreference({ showChatSideBar }, n('toggleAgentPanel', newValue) as string);
   },
   toggleMobileTopic: (newValue) => {
     const mobileShowTopic =
       typeof newValue === 'boolean' ? newValue : !get().preference.mobileShowTopic;
 
-    get().updatePreference({ mobileShowTopic }, t('toggleMobileTopic', newValue) as string);
+    get().updatePreference({ mobileShowTopic }, n('toggleMobileTopic', newValue) as string);
   },
   toggleSystemRole: (newValue) => {
     const showSystemRole =
       typeof newValue === 'boolean' ? newValue : !get().preference.mobileShowTopic;
 
-    get().updatePreference({ showSystemRole }, t('toggleMobileTopic', newValue) as string);
+    get().updatePreference({ showSystemRole }, n('toggleMobileTopic', newValue) as string);
   },
   updateGuideState: (guide) => {
     const { updatePreference } = get();
@@ -75,7 +75,7 @@ export const createCommonSlice: StateCreator<
     useSWR('checkLatestVersion', featLatestVersion, {
       onSuccess: (data: string) => {
         if (gt(data, CURRENT_VERSION))
-          set({ hasNewVersion: true, latestVersion: data }, false, t('checkLatestVersion'));
+          set({ hasNewVersion: true, latestVersion: data }, false, n('checkLatestVersion'));
       },
     }),
 });

package/src/store/global/slices/settings.ts

@@ -12,7 +12,7 @@ import { setNamespace } from '@/utils/storeDebug';
 
 import type { GlobalStore } from '../store';
 
-const t = setNamespace('settings');
+const n = setNamespace('settings');
 
 /**
  * 设置操作
@@ -58,10 +58,10 @@ export const createSettingsSlice: StateCreator<
     const settings = produce(get().settings, (draft: GlobalSettings) => {
       draft.defaultAgent = DEFAULT_AGENT;
     });
-    set({ settings }, false, t('resetDefaultAgent'));
+    set({ settings }, false, n('resetDefaultAgent'));
   },
   resetSettings: () => {
-    set({ settings: DEFAULT_SETTINGS }, false, t('resetSettings'));
+    set({ settings: DEFAULT_SETTINGS }, false, n('resetSettings'));
   },
   setOpenAIConfig: (config) => {
     get().setSettings({ languageModel: { openAI: config } });
@@ -73,7 +73,7 @@ export const createSettingsSlice: StateCreator<
 
     if (isEqual(prevSetting, nextSettings)) return;
 
-    set({ settings: merge(prevSetting, settings) }, false, t('setSettings', settings));
+    set({ settings: merge(prevSetting, settings) }, false, n('setSettings', settings));
   },
   switchSettingTabs: (tab) => {
     set({ settingsTab: tab });

package/src/store/plugin/slices/customPlugin/action.ts

@@ -8,7 +8,7 @@ import { PluginStore } from '../../store';
 import { defaultCustomPlugin } from './initialState';
 import { CustomPluginListDispatch, devPluginListReducer } from './reducers/customPluginList';
 
-const t = setNamespace('customPlugin');
+const n = setNamespace('customPlugin');
 
 /**
  * 代理行为接口
@@ -40,11 +40,11 @@ export const createCustomPluginSlice: StateCreator<
     const { customPluginList } = get();
 
     const nextList = devPluginListReducer(customPluginList, payload);
-    set({ customPluginList: nextList }, false, t('dispatchCustomPluginList', payload));
+    set({ customPluginList: nextList }, false, n('dispatchCustomPluginList', payload));
   },
   saveToCustomPluginList: (value) => {
     get().dispatchCustomPluginList({ plugin: value, type: 'addItem' });
-    set({ newCustomPlugin: defaultCustomPlugin }, false, t('saveToCustomPluginList'));
+    set({ newCustomPlugin: defaultCustomPlugin }, false, n('saveToCustomPluginList'));
   },
   updateCustomPlugin: (id, value) => {
     const { dispatchCustomPluginList, installPlugin } = get();
@@ -58,7 +58,7 @@ export const createCustomPluginSlice: StateCreator<
     set(
       { newCustomPlugin: merge({}, get().newCustomPlugin, newCustomPlugin) },
       false,
-      t('updateNewDevPlugin'),
+      n('updateNewDevPlugin'),
     );
   },
 });

package/src/store/plugin/slices/plugin/action.ts

@@ -17,7 +17,7 @@ import { setNamespace } from '@/utils/storeDebug';
 import { PluginStore } from '../../store';
 import { PluginDispatch, pluginManifestReducer } from './reducers/manifest';
 
-const t = setNamespace('plugin');
+const n = setNamespace('plugin');
 
 /**
  * 插件接口
@@ -73,7 +73,7 @@ export const createPluginSlice: StateCreator<
 
     await installPlugins(plugins);
 
-    set({ manifestPrepared: true }, false, t('checkPluginsIsInstalled'));
+    set({ manifestPrepared: true }, false, n('checkPluginsIsInstalled'));
   },
   deletePluginSettings: (id) => {
     set(
@@ -81,14 +81,14 @@ export const createPluginSlice: StateCreator<
         draft.pluginsSettings[id] = undefined;
       }),
       false,
-      t('deletePluginSettings'),
+      n('deletePluginSettings'),
     );
   },
   dispatchPluginManifest: (payload) => {
     const { pluginManifestMap } = get();
     const nextManifest = pluginManifestReducer(pluginManifestMap, payload);
 
-    set({ pluginManifestMap: nextManifest }, false, t('dispatchPluginManifest', payload));
+    set({ pluginManifestMap: nextManifest }, false, n('dispatchPluginManifest', payload));
   },
   installPlugin: async (name) => {
     const plugin = pluginSelectors.getPluginMetaById(name)(get());
@@ -140,12 +140,12 @@ export const createPluginSlice: StateCreator<
   loadPluginStore: async () => {
     const pluginMarketIndex = await pluginService.getPluginList();
 
-    set({ pluginList: pluginMarketIndex.plugins }, false, t('loadPluginList'));
+    set({ pluginList: pluginMarketIndex.plugins }, false, n('loadPluginList'));
 
     return pluginMarketIndex;
   },
   resetPluginSettings: () => {
-    set({ pluginsSettings: {} }, false, t('resetPluginSettings'));
+    set({ pluginsSettings: {} }, false, n('resetPluginSettings'));
   },
   updateManifestLoadingState: (key, value) => {
     set(
@@ -153,7 +153,7 @@ export const createPluginSlice: StateCreator<
         draft.pluginManifestLoading[key] = value;
       }),
       false,
-      t('updateManifestLoadingState'),
+      n('updateManifestLoadingState'),
     );
   },
   updatePluginSettings: (id, settings) => {
@@ -162,7 +162,7 @@ export const createPluginSlice: StateCreator<
         draft.pluginsSettings[id] = merge({}, draft.pluginsSettings[id], settings);
       }),
       false,
-      t('updatePluginSettings'),
+      n('updatePluginSettings'),
     );
   },
 

package/src/store/session/slices/session/action.ts

@@ -18,7 +18,7 @@ import { setNamespace } from '@/utils/storeDebug';
 
 import { initLobeSession } from './initialState';
 
-const t = setNamespace('session');
+const n = setNamespace('session');
 
 const FETCH_SESSIONS_KEY = 'fetchSessions';
 
@@ -80,7 +80,7 @@ export const createSessionSlice: StateCreator<
   SessionAction
 > = (set, get) => ({
   activeSession: (sessionId) => {
-    set({ activeId: sessionId }, false, t('activeSession'));
+    set({ activeId: sessionId }, false, n('activeSession'));
   },
 
   clearSessions: async () => {
@@ -153,7 +153,7 @@ export const createSessionSlice: StateCreator<
             sessions: data,
           },
           false,
-          t('useFetchSessions/onSuccess', data),
+          n('useFetchSessions/onSuccess', data),
         );
       },
     }),
@@ -161,7 +161,7 @@ export const createSessionSlice: StateCreator<
   useSearchSessions: (keyword) =>
     useSWR<LobeSessions>(keyword, sessionService.searchSessions, {
       onSuccess: (data) => {
-        set({ searchSessions: data }, false, t('useSearchSessions(success)', data));
+        set({ searchSessions: data }, false, n('useSearchSessions(success)', data));
       },
       revalidateOnFocus: false,
     }),