@lobehub/chat 0.156.1 → 0.157.0

package/src/migrations/FromV4ToV5/migrations.test.ts

@@ -0,0 +1,49 @@
+import { describe } from 'vitest';
+
+import { MigrationData, VersionController } from '@/migrations/VersionController';
+
+import { MigrationV1ToV2 } from '../FromV1ToV2';
+import inputV1Data from '../FromV1ToV2/fixtures/input-v1-session.json';
+import { MigrationV2ToV3 } from '../FromV2ToV3';
+import { MigrationV3ToV4 } from '../FromV3ToV4';
+import outputDataFromV1ToV5 from './fixtures/from-v1-to-v5-output.json';
+import functionInputV4 from './fixtures/function-input-v4.json';
+import functionOutputV5 from './fixtures/function-output-v5.json';
+import { MigrationV4ToV5 } from './index';
+
+describe('MigrationV4ToV5', () => {
+  let migrations;
+  let versionController: VersionController<any>;
+
+  beforeEach(() => {
+    migrations = [MigrationV4ToV5];
+    versionController = new VersionController(migrations, 5);
+  });
+
+  describe('should migrate data correctly from previous versions', () => {
+    it('role=function', () => {
+      const data: MigrationData = functionInputV4;
+
+      const migratedData = versionController.migrate(data);
+
+      expect(migratedData.version).toEqual(functionOutputV5.version);
+      expect(migratedData.state.messages).toEqual(functionOutputV5.state.messages);
+    });
+  });
+
+  it('should work correct from v1 to v5', () => {
+    const data: MigrationData = inputV1Data;
+
+    versionController = new VersionController(
+      [MigrationV4ToV5, MigrationV3ToV4, MigrationV2ToV3, MigrationV1ToV2],
+      5,
+    );
+
+    const migratedData = versionController.migrate(data);
+
+    expect(migratedData.version).toEqual(outputDataFromV1ToV5.version);
+    expect(migratedData.state.messages).toEqual(outputDataFromV1ToV5.state.messages);
+    expect(migratedData.state.sessions).toEqual(outputDataFromV1ToV5.state.sessions);
+    expect(migratedData.state.topics).toEqual(outputDataFromV1ToV5.state.topics);
+  });
+});

package/src/migrations/FromV4ToV5/types/v4.ts

@@ -0,0 +1,21 @@
+import { LobeToolRenderType } from '@/types/tool';
+
+export interface V4ChatPluginPayload {
+  apiName: string;
+  arguments: string;
+  identifier: string;
+  type: LobeToolRenderType;
+}
+
+export interface V4Message {
+  content: string;
+  createdAt: number;
+  id: string;
+  plugin?: V4ChatPluginPayload;
+  role: 'user' | 'system' | 'assistant' | 'function';
+  updatedAt: number;
+}
+
+export interface V4ConfigState {
+  messages: V4Message[];
+}

package/src/migrations/FromV4ToV5/types/v5.ts

@@ -0,0 +1,27 @@
+import { LobeToolRenderType } from '@/types/tool';
+
+import { V4ChatPluginPayload } from './v4';
+
+interface ChatToolPayload {
+  apiName: string;
+  arguments: string;
+  id: string;
+  identifier: string;
+  type: LobeToolRenderType;
+}
+
+export interface V5Message {
+  content: string;
+  createdAt: number;
+  id: string;
+  parentId?: string;
+  plugin?: V4ChatPluginPayload;
+  role: 'user' | 'system' | 'assistant' | 'tool';
+  tool_call_id?: string;
+  tools?: ChatToolPayload[];
+  updatedAt: number;
+}
+
+export interface V5ConfigState {
+  messages: V5Message[];
+}

package/src/migrations/index.ts

@@ -5,12 +5,19 @@ import { ConfigStateAll } from '@/types/exportConfig';
 import { MigrationV0ToV1 } from './FromV0ToV1';
 import { MigrationV1ToV2 } from './FromV1ToV2';
 import { MigrationV3ToV4 } from './FromV3ToV4';
+import { MigrationV4ToV5 } from './FromV4ToV5';
 
 // Current latest version
-export const CURRENT_CONFIG_VERSION = 4;
+export const CURRENT_CONFIG_VERSION = 5;
 
 // Version migrations module
 const ConfigMigrations = [
+  /**
+   * 2024.05.11
+   *
+   * role=function to role=tool
+   */
+  MigrationV4ToV5,
   /**
    * 2024.04.09
    * settings migrate the `languageModel`

package/src/services/__tests__/chat.test.ts

@@ -126,7 +126,7 @@ describe('ChatService', () => {
       it('should include image content when with vision model', async () => {
         const messages = [
           { content: 'Hello', role: 'user', files: ['file1'] }, // Message with files
-          { content: 'Hi', role: 'function', plugin: { identifier: 'plugin1' } }, // Message with function role
+          { content: 'Hi', role: 'tool', plugin: { identifier: 'plugin1', apiName: 'api1' } }, // Message with tool role
           { content: 'Hey', role: 'assistant' }, // Regular user message
         ] as ChatMessage[];
 
@@ -166,8 +166,8 @@ describe('ChatService', () => {
               },
               {
                 content: 'Hi',
-                name: 'plugin1',
-                role: 'function',
+                name: 'plugin1____api1',
+                role: 'tool',
               },
               {
                 content: 'Hey',
@@ -183,7 +183,7 @@ describe('ChatService', () => {
       it('should not include image content when default model', async () => {
         const messages = [
           { content: 'Hello', role: 'user', files: ['file1'] }, // Message with files
-          { content: 'Hi', role: 'function', plugin: { identifier: 'plugin1' } }, // Message with function role
+          { content: 'Hi', role: 'tool', plugin: { identifier: 'plugin1', apiName: 'api1' } }, // Message with function role
           { content: 'Hey', role: 'assistant' }, // Regular user message
         ] as ChatMessage[];
 
@@ -212,7 +212,7 @@ describe('ChatService', () => {
           {
             messages: [
               { content: 'Hello', role: 'user' },
-              { content: 'Hi', name: 'plugin1', role: 'function' },
+              { content: 'Hi', name: 'plugin1____api1', role: 'tool' },
               { content: 'Hey', role: 'assistant' },
             ],
             model: 'gpt-3.5-turbo',
@@ -224,7 +224,7 @@ describe('ChatService', () => {
       it('should not include image with vision models when can not find the image', async () => {
         const messages = [
           { content: 'Hello', role: 'user', files: ['file2'] }, // Message with files
-          { content: 'Hi', role: 'function', plugin: { identifier: 'plugin1' } }, // Message with function role
+          { content: 'Hi', role: 'tool', plugin: { identifier: 'plugin1', apiName: 'api1' } }, // Message with function role
           { content: 'Hey', role: 'assistant' }, // Regular user message
         ] as ChatMessage[];
 
@@ -248,19 +248,9 @@ describe('ChatService', () => {
         expect(getChatCompletionSpy).toHaveBeenCalledWith(
           {
             messages: [
-              {
-                content: 'Hello',
-                role: 'user',
-              },
-              {
-                content: 'Hi',
-                name: 'plugin1',
-                role: 'function',
-              },
-              {
-                content: 'Hey',
-                role: 'assistant',
-              },
+              { content: 'Hello', role: 'user' },
+              { content: 'Hi', name: 'plugin1____api1', role: 'tool' },
+              { content: 'Hey', role: 'assistant' },
             ],
           },
           undefined,
@@ -580,7 +570,7 @@ Get data from users`,
         body: JSON.stringify(expectedPayload),
         headers: expect.any(Object),
         method: 'POST',
-        signal: undefined,
+        signal: expect.any(AbortSignal),
       });
     });
 

package/src/services/chat.ts

@@ -21,16 +21,17 @@ import {
   userProfileSelectors,
 } from '@/store/user/selectors';
 import { ChatErrorType } from '@/types/fetch';
-import { ChatMessage } from '@/types/message';
+import { ChatMessage, MessageToolCall } from '@/types/message';
 import type { ChatStreamPayload, OpenAIChatMessage } from '@/types/openai/chat';
 import { UserMessageContentPart } from '@/types/openai/chat';
-import { FetchSSEOptions, OnFinishHandler, fetchSSE, getMessageError } from '@/utils/fetch';
+import { FetchSSEOptions, fetchSSE, getMessageError } from '@/utils/fetch';
+import { genToolCallingName } from '@/utils/toolCall';
 import { createTraceHeader, getTraceId } from '@/utils/trace';
 
 import { createHeaderWithAuth, getProviderAuthPayload } from './_auth';
 import { API_ENDPOINTS } from './_url';
 
-interface FetchOptions {
+interface FetchOptions extends FetchSSEOptions {
   isWelcomeQuestion?: boolean;
   signal?: AbortSignal | undefined;
   trace?: TracePayload;
@@ -40,23 +41,14 @@ interface GetChatCompletionPayload extends Partial<Omit<ChatStreamPayload, 'mess
   messages: ChatMessage[];
 }
 
-interface FetchAITaskResultParams {
+interface FetchAITaskResultParams extends FetchSSEOptions {
   abortController?: AbortController;
-  /**
-   * 错误处理函数
-   */
   onError?: (e: Error, rawError?: any) => void;
-  onFinish?: OnFinishHandler;
   /**
    * 加载状态变化处理函数
    * @param loading - 是否处于加载状态
    */
   onLoadingChange?: (loading: boolean) => void;
-  /**
-   * 消息处理函数
-   * @param text - 消息内容
-   */
-  onMessageHandle?: (text: string) => void;
   /**
    * 请求对象
    */
@@ -224,20 +216,15 @@ class ChatService {
     trace,
     isWelcomeQuestion,
   }: CreateAssistantMessageStream) => {
-    await fetchSSE(
-      () =>
-        this.createAssistantMessage(params, {
-          isWelcomeQuestion,
-          signal: abortController?.signal,
-          trace: this.mapTrace(trace, TraceTagMap.Chat),
-        }),
-      {
-        onAbort,
-        onErrorHandle,
-        onFinish,
-        onMessageHandle,
-      },
-    );
+    await this.createAssistantMessage(params, {
+      isWelcomeQuestion,
+      onAbort,
+      onErrorHandle,
+      onFinish,
+      onMessageHandle,
+      signal: abortController?.signal,
+      trace: this.mapTrace(trace, TraceTagMap.Chat),
+    });
   };
 
   getChatCompletion = async (params: Partial<ChatStreamPayload>, options?: FetchOptions) => {
@@ -268,28 +255,33 @@ class ChatService {
     const enableFetchOnClient = modelConfigSelectors.isProviderFetchOnClient(provider)(
       useUserStore.getState(),
     );
-    /**
-     * Notes:
-     * 1. Broswer agent runtime will skip auth check if a key and endpoint provided by
-     *    user which will cause abuse of plugins services
-     * 2. This feature will disabled by default
-     */
+
+    let fetcher: typeof fetch | undefined = undefined;
+
     if (enableFetchOnClient) {
-      try {
-        return await this.fetchOnClient({ payload, provider, signal });
-      } catch (e) {
-        const {
-          errorType = ChatErrorType.BadRequest,
-          error: errorContent,
-          ...res
-        } = e as ChatCompletionErrorPayload;
-
-        const error = errorContent || e;
-        // track the error at server side
-        console.error(`Route: [${provider}] ${errorType}:`, error);
-
-        return createErrorResponse(errorType, { error, ...res, provider });
-      }
+      /**
+       * Notes:
+       * 1. Browser agent runtime will skip auth check if a key and endpoint provided by
+       *    user which will cause abuse of plugins services
+       * 2. This feature will be disabled by default
+       */
+      fetcher = async () => {
+        try {
+          return await this.fetchOnClient({ payload, provider, signal });
+        } catch (e) {
+          const {
+            errorType = ChatErrorType.BadRequest,
+            error: errorContent,
+            ...res
+          } = e as ChatCompletionErrorPayload;
+
+          const error = errorContent || e;
+          // track the error at server side
+          console.error(`Route: [${provider}] ${errorType}:`, error);
+
+          return createErrorResponse(errorType, { error, ...res, provider });
+        }
+      };
     }
 
     const traceHeader = createTraceHeader({ ...options?.trace });
@@ -299,10 +291,15 @@ class ChatService {
       provider,
     });
 
-    return fetch(API_ENDPOINTS.chat(provider), {
+    return fetchSSE(API_ENDPOINTS.chat(provider), {
       body: JSON.stringify(payload),
+      fetcher: fetcher,
       headers,
       method: 'POST',
+      onAbort: options?.onAbort,
+      onErrorHandle: options?.onErrorHandle,
+      onFinish: options?.onFinish,
+      onMessageHandle: options?.onMessageHandle,
       signal,
     });
   };
@@ -360,20 +357,15 @@ class ChatService {
 
     onLoadingChange?.(true);
 
-    const data = await fetchSSE(
-      () =>
-        this.getChatCompletion(params, {
-          signal: abortController?.signal,
-          trace: this.mapTrace(trace, TraceTagMap.SystemChain),
-        }),
-      {
-        onErrorHandle: (error) => {
-          errorHandle(new Error(error.message), error);
-        },
-        onFinish,
-        onMessageHandle,
+    const data = await this.getChatCompletion(params, {
+      onErrorHandle: (error) => {
+        errorHandle(new Error(error.message), error);
       },
-    ).catch(errorHandle);
+      onFinish,
+      onMessageHandle,
+      signal: abortController?.signal,
+      trace: this.mapTrace(trace, TraceTagMap.SystemChain),
+    }).catch(errorHandle);
 
     onLoadingChange?.(false);
 
@@ -424,9 +416,30 @@ class ChatService {
           return { content: getContent(m), role: m.role };
         }
 
-        case 'function': {
-          const name = m.plugin?.identifier as string;
-          return { content: m.content, name, role: m.role };
+        case 'assistant': {
+          return {
+            content: m.content,
+            role: m.role,
+            tool_calls: m.tools?.map(
+              (tool): MessageToolCall => ({
+                function: {
+                  arguments: tool.arguments,
+                  name: genToolCallingName(tool.identifier, tool.apiName, tool.type),
+                },
+                id: tool.id,
+                type: 'function',
+              }),
+            ),
+          };
+        }
+
+        case 'tool': {
+          return {
+            content: m.content,
+            name: genToolCallingName(m.plugin!.identifier, m.plugin!.apiName, m.plugin?.type),
+            role: m.role,
+            tool_call_id: m.tool_call_id,
+          };
         }
 
         default: {

package/src/store/chat/slices/enchance/action.ts

@@ -76,16 +76,21 @@ export const chatEnhance: StateCreator<
 
     // translate to target language
     await chatService.fetchPresetTaskResult({
-      onMessageHandle: (text) => {
-        internal_dispatchMessage({
-          id,
-          key: 'translate',
-          type: 'updateMessageExtra',
-          value: produce({ content: '', from, to: targetLang }, (draft) => {
-            content += text;
-            draft.content += content;
-          }),
-        });
+      onMessageHandle: (chunk) => {
+        switch (chunk.type) {
+          case 'text': {
+            internal_dispatchMessage({
+              id,
+              key: 'translate',
+              type: 'updateMessageExtra',
+              value: produce({ content: '', from, to: targetLang }, (draft) => {
+                content += chunk.text;
+                draft.content += content;
+              }),
+            });
+            break;
+          }
+        }
       },
       params: chainTranslate(message.content, targetLang),
       trace: get().getCurrentTracePayload({ traceName: TraceNameMap.Translator }),

package/src/store/chat/slices/message/action.test.ts

@@ -19,6 +19,7 @@ vi.stubGlobal(
   vi.fn(() => Promise.resolve(new Response('mock'))),
 );
 
+vi.mock('zustand/traditional');
 // Mock service
 vi.mock('@/services/message', () => ({
   messageService: {
@@ -47,12 +48,6 @@ vi.mock('@/services/chat', async (importOriginal) => {
   };
 });
 
-vi.mock('@/store/chat/selectors', () => ({
-  chatSelectors: {
-    currentChats: vi.fn(),
-  },
-}));
-
 const realCoreProcessMessage = useChatStore.getState().internal_coreProcessMessage;
 const realRefreshMessages = useChatStore.getState().refreshMessages;
 // Mock state
@@ -86,6 +81,9 @@ describe('chatMessage actions', () => {
       const messageId = 'message-id';
       const deleteSpy = vi.spyOn(result.current, 'deleteMessage');
 
+      act(() => {
+        useChatStore.setState({ messages: [{ id: messageId } as ChatMessage] });
+      });
       await act(async () => {
         await result.current.deleteMessage(messageId);
       });
@@ -259,11 +257,6 @@ describe('chatMessage actions', () => {
           enableAutoCreateTopic,
         }));
 
-        // Mock the currentChats selector to return a list that does not reach the threshold
-        (chatSelectors.currentChats as Mock).mockReturnValue(
-          Array.from({ length: autoCreateTopicThreshold + 1 }, (_, i) => ({ id: `msg-${i}` })),
-        );
-
         // Mock saveToTopic and switchTopic to simulate not being called
         const saveToTopicMock = vi.fn();
         const switchTopicMock = vi.fn();
@@ -271,6 +264,10 @@ describe('chatMessage actions', () => {
         await act(async () => {
           useChatStore.setState({
             ...mockState,
+            // Mock the currentChats selector to return a list that does not reach the threshold
+            messages: Array.from({ length: autoCreateTopicThreshold + 1 }, (_, i) => ({
+              id: `msg-${i}`,
+            })) as any,
             activeTopicId: undefined,
             saveToTopic: saveToTopicMock,
             switchTopic: switchTopicMock,
@@ -298,11 +295,6 @@ describe('chatMessage actions', () => {
         // Mock messageService.create to resolve with a message id
         (messageService.createMessage as Mock).mockResolvedValue('new-message-id');
 
-        // Mock the currentChats selector to return a list that reaches the threshold
-        (chatSelectors.currentChats as Mock).mockReturnValue(
-          Array.from({ length: autoCreateTopicThreshold }, (_, i) => ({ id: `msg-${i}` })),
-        );
-
         // Mock saveToTopic to resolve with a topic id and switchTopic to switch to the new topic
         const saveToTopicMock = vi.fn(() => Promise.resolve('new-topic-id'));
         const switchTopicMock = vi.fn();
@@ -310,6 +302,9 @@ describe('chatMessage actions', () => {
         act(() => {
           useChatStore.setState({
             ...mockState,
+            messages: Array.from({ length: autoCreateTopicThreshold }, (_, i) => ({
+              id: `msg-${i}`,
+            })) as any,
             activeTopicId: undefined,
             saveToTopic: saveToTopicMock,
             switchTopic: switchTopicMock,
@@ -339,11 +334,6 @@ describe('chatMessage actions', () => {
           enableAutoCreateTopic,
         }));
 
-        // Mock the currentChats selector to return a list that does not reach the threshold
-        (chatSelectors.currentChats as Mock).mockReturnValue(
-          Array.from({ length: autoCreateTopicThreshold - 1 }, (_, i) => ({ id: `msg-${i}` })),
-        );
-
         // Mock saveToTopic and switchTopic to simulate not being called
         const saveToTopicMock = vi.fn();
         const switchTopicMock = vi.fn();
@@ -351,6 +341,10 @@ describe('chatMessage actions', () => {
         await act(async () => {
           useChatStore.setState({
             ...mockState,
+            // Mock the currentChats selector to return a list that does not reach the threshold
+            messages: Array.from({ length: autoCreateTopicThreshold - 2 }, (_, i) => ({
+              id: `msg-${i}`,
+            })) as any,
             activeTopicId: undefined,
             saveToTopic: saveToTopicMock,
             switchTopic: switchTopicMock,
@@ -395,12 +389,14 @@ describe('chatMessage actions', () => {
       const { result } = renderHook(() => useChatStore());
       const messageId = 'message-id';
 
-      // Mock the currentChats selector to return a list that includes the message to be resent
-      (chatSelectors.currentChats as Mock).mockReturnValue([
-        // ... other messages
-        { id: messageId, role: 'user', content: 'Resend this message' },
-        // ... other messages
-      ]);
+      act(() => {
+        useChatStore.setState({
+          // Mock the currentChats selector to return a list that includes the message to be resent
+          messages: [
+            { id: messageId, role: 'user', content: 'Resend this message' } as ChatMessage,
+          ],
+        });
+      });
 
       // Mock the internal_coreProcessMessage function to resolve immediately
       mockState.internal_coreProcessMessage.mockResolvedValue(undefined);
@@ -421,10 +417,12 @@ describe('chatMessage actions', () => {
       const { result } = renderHook(() => useChatStore());
       const messageId = 'non-existing-message-id';
 
-      // Mock the currentChats selector to return a list that does not include the message to be resent
-      (chatSelectors.currentChats as Mock).mockReturnValue([
-        // ... other messages
-      ]);
+      act(() => {
+        useChatStore.setState({
+          // Mock the currentChats selector to return a list that does not include the message to be resent
+          messages: [],
+        });
+      });
 
       await act(async () => {
         await result.current.internal_resendMessage(messageId);
@@ -461,9 +459,8 @@ describe('chatMessage actions', () => {
 
       expect(internal_dispatchMessageSpy).toHaveBeenCalledWith({
         id: messageId,
-        key: 'content',
-        type: 'updateMessage',
-        value: newContent,
+        type: 'updateMessages',
+        value: { content: newContent },
       });
     });
 
@@ -645,56 +642,7 @@ describe('chatMessage actions', () => {
           messages,
           assistantMessageId,
         );
-        expect(response.content).toEqual(aiResponse);
         expect(response.isFunctionCall).toEqual(false);
-        expect(response.functionCallAtEnd).toEqual(false);
-        expect(response.functionCallContent).toEqual('');
-      });
-    });
-
-    it('should handle function call message at start of AI response', async () => {
-      const { result } = renderHook(() => useChatStore());
-      const messages = [{ id: 'message-id', content: 'Hello', role: 'user' }] as ChatMessage[];
-      const assistantMessageId = 'assistant-message-id';
-      const aiResponse =
-        '{"tool_calls":[{"id":"call_sbca","type":"function","function":{"name":"pluginName____apiName","arguments":{"key":"value"}}}]}';
-
-      // Mock fetch to resolve with AI response containing function call
-      vi.mocked(fetch).mockResolvedValueOnce(new Response(aiResponse));
-
-      await act(async () => {
-        const response = await result.current.internal_fetchAIChatMessage(
-          messages,
-          assistantMessageId,
-        );
-        expect(response.content).toEqual(aiResponse);
-        expect(response.isFunctionCall).toEqual(true);
-        expect(response.functionCallAtEnd).toEqual(false);
-        expect(response.functionCallContent).toEqual('');
-      });
-    });
-
-    it('should handle function message at end of AI response', async () => {
-      const { result } = renderHook(() => useChatStore());
-      const messages = [{ id: 'message-id', content: 'Hello', role: 'user' }] as ChatMessage[];
-      const assistantMessageId = 'assistant-message-id';
-      const aiResponse =
-        'Hello, human! {"tool_calls":[{"id":"call_sbca","type":"function","function":{"name":"pluginName____apiName","arguments":{"key":"value"}}}]}';
-
-      // Mock fetch to resolve with AI response containing function call at end
-      vi.mocked(fetch).mockResolvedValue(new Response(aiResponse));
-
-      await act(async () => {
-        const response = await result.current.internal_fetchAIChatMessage(
-          messages,
-          assistantMessageId,
-        );
-        expect(response.content).toEqual(aiResponse);
-        expect(response.isFunctionCall).toEqual(true);
-        expect(response.functionCallAtEnd).toEqual(true);
-        expect(response.functionCallContent).toEqual(
-          '{"tool_calls":[{"id":"call_sbca","type":"function","function":{"name":"pluginName____apiName","arguments":{"key":"value"}}}]}',
-        );
       });
     });
 
@@ -708,9 +656,11 @@ describe('chatMessage actions', () => {
       vi.mocked(fetch).mockRejectedValue(new Error(errorMessage));
 
       await act(async () => {
-        await expect(
-          result.current.internal_fetchAIChatMessage(messages, assistantMessageId),
-        ).rejects.toThrow(errorMessage);
+        expect(
+          await result.current.internal_fetchAIChatMessage(messages, assistantMessageId),
+        ).toEqual({
+          isFunctionCall: false,
+        });
       });
     });
   });