@lobehub/chat 1.0.12 → 1.0.14

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

@@ -112,7 +112,7 @@ describe('ChatPluginAction', () => {
 
       vi.spyOn(storeState, 'refreshMessages');
       vi.spyOn(storeState, 'triggerAIMessage').mockResolvedValue(undefined);
-      vi.spyOn(storeState, 'internal_toggleChatLoading').mockReturnValue(undefined);
+      vi.spyOn(storeState, 'internal_togglePluginApiCalling').mockReturnValue(undefined);
 
       const runSpy = vi.spyOn(chatService, 'runPluginApi').mockResolvedValue({
         text: pluginApiResponse,
@@ -125,7 +125,7 @@ describe('ChatPluginAction', () => {
         await result.current.invokeDefaultTypePlugin(messageId, pluginPayload);
       });
 
-      expect(storeState.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(storeState.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         true,
         messageId,
         expect.any(String),
@@ -135,7 +135,7 @@ describe('ChatPluginAction', () => {
         content: pluginApiResponse,
       });
       expect(storeState.refreshMessages).toHaveBeenCalled();
-      expect(storeState.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(storeState.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         false,
         'message-id',
         'plugin/fetchPlugin/end',
@@ -150,7 +150,7 @@ describe('ChatPluginAction', () => {
       const storeState = useChatStore.getState();
       vi.spyOn(storeState, 'refreshMessages');
       vi.spyOn(storeState, 'triggerAIMessage').mockResolvedValue(undefined);
-      vi.spyOn(storeState, 'internal_toggleChatLoading').mockReturnValue(undefined);
+      vi.spyOn(storeState, 'internal_togglePluginApiCalling').mockReturnValue(undefined);
 
       vi.spyOn(chatService, 'runPluginApi').mockRejectedValue(error);
 
@@ -159,7 +159,7 @@ describe('ChatPluginAction', () => {
         await result.current.invokeDefaultTypePlugin(messageId, pluginPayload);
       });
 
-      expect(storeState.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(storeState.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         true,
         messageId,
         expect.any(String),
@@ -167,7 +167,7 @@ describe('ChatPluginAction', () => {
       expect(chatService.runPluginApi).toHaveBeenCalledWith(pluginPayload, { trace: {} });
       expect(messageService.updateMessageError).toHaveBeenCalledWith(messageId, error);
       expect(storeState.refreshMessages).toHaveBeenCalled();
-      expect(storeState.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(storeState.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         false,
         'message-id',
         'plugin/fetchPlugin/end',
@@ -463,11 +463,11 @@ describe('ChatPluginAction', () => {
       const toolResponse = JSON.stringify({ abc: 'data' });
 
       useToolStore.setState({
-        invokeBuiltinTool: vi.fn().mockResolvedValue(toolResponse),
+        transformApiArgumentsToAiState: vi.fn().mockResolvedValue(toolResponse),
       });
 
       useChatStore.setState({
-        internal_toggleChatLoading: vi.fn(),
+        internal_togglePluginApiCalling: vi.fn(),
         internal_updateMessageContent: vi.fn(),
         text2image: vi.fn(),
       });
@@ -479,7 +479,7 @@ describe('ChatPluginAction', () => {
       });
 
       // Verify that the builtin tool was invoked with the correct arguments
-      expect(useToolStore.getState().invokeBuiltinTool).toHaveBeenCalledWith(
+      expect(useToolStore.getState().transformApiArgumentsToAiState).toHaveBeenCalledWith(
         payload.apiName,
         JSON.parse(payload.arguments),
       );
@@ -491,12 +491,12 @@ describe('ChatPluginAction', () => {
       );
 
       // Verify that loading was toggled correctly
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         true,
         messageId,
         expect.any(String),
       );
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(false);
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(false);
       expect(useChatStore.getState().text2image).toHaveBeenCalled();
     });
 
@@ -511,12 +511,12 @@ describe('ChatPluginAction', () => {
 
       act(() => {
         useToolStore.setState({
-          invokeBuiltinTool: vi.fn().mockResolvedValue(toolResponse),
+          transformApiArgumentsToAiState: vi.fn().mockResolvedValue(toolResponse),
           text2image: vi.fn(),
         });
 
         useChatStore.setState({
-          internal_toggleChatLoading: vi.fn(),
+          internal_togglePluginApiCalling: vi.fn(),
           text2image: vi.fn(),
           internal_updateMessageContent: vi.fn(),
         });
@@ -528,7 +528,7 @@ describe('ChatPluginAction', () => {
       });
 
       // Verify that the builtin tool was invoked with the correct arguments
-      expect(useToolStore.getState().invokeBuiltinTool).toHaveBeenCalledWith(
+      expect(useToolStore.getState().transformApiArgumentsToAiState).toHaveBeenCalledWith(
         payload.apiName,
         JSON.parse(payload.arguments),
       );
@@ -540,12 +540,12 @@ describe('ChatPluginAction', () => {
       );
 
       // Verify that loading was toggled correctly
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         true,
         messageId,
         expect.any(String),
       );
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(false);
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(false);
       expect(useChatStore.getState().text2image).not.toHaveBeenCalled();
     });
 
@@ -559,11 +559,11 @@ describe('ChatPluginAction', () => {
       const error = new Error('Builtin tool failed');
 
       useToolStore.setState({
-        invokeBuiltinTool: vi.fn().mockRejectedValue(error),
+        transformApiArgumentsToAiState: vi.fn().mockRejectedValue(error),
       });
 
       useChatStore.setState({
-        internal_toggleChatLoading: vi.fn(),
+        internal_togglePluginApiCalling: vi.fn(),
         internal_updateMessageContent: vi.fn(),
         text2image: vi.fn(),
         refreshMessages: vi.fn(),
@@ -576,12 +576,12 @@ describe('ChatPluginAction', () => {
       });
 
       // Verify that loading was toggled correctly
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(
         true,
         messageId,
         expect.any(String),
       );
-      expect(result.current.internal_toggleChatLoading).toHaveBeenCalledWith(false);
+      expect(result.current.internal_togglePluginApiCalling).toHaveBeenCalledWith(false);
 
       // Verify that the message content was not updated
       expect(result.current.internal_updateMessageContent).not.toHaveBeenCalled();

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

@@ -1,3 +1,4 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix, typescript-sort-keys/interface */
 import { PluginErrorType } from '@lobehub/chat-plugin-sdk';
 import { t } from 'i18next';
 import { Md5 } from 'ts-md5';
@@ -25,11 +26,6 @@ export interface ChatPluginAction {
     triggerAiMessage?: boolean,
   ) => Promise<void>;
 
-  internal_callPluginApi: (id: string, payload: ChatToolPayload) => Promise<string | undefined>;
-  internal_invokeDifferentTypePlugin: (id: string, payload: ChatToolPayload) => Promise<any>;
-  internal_transformToolCalls: (toolCalls: MessageToolCall[]) => ChatToolPayload[];
-  internal_updatePluginError: (id: string, error: any) => Promise<void>;
-
   invokeBuiltinTool: (id: string, payload: ChatToolPayload) => Promise<void>;
   invokeDefaultTypePlugin: (id: string, payload: any) => Promise<string | undefined>;
   invokeMarkdownTypePlugin: (id: string, payload: ChatToolPayload) => Promise<void>;
@@ -41,6 +37,16 @@ export interface ChatPluginAction {
 
   triggerToolCalls: (id: string) => Promise<void>;
   updatePluginState: (id: string, key: string, value: any) => Promise<void>;
+
+  internal_callPluginApi: (id: string, payload: ChatToolPayload) => Promise<string | undefined>;
+  internal_invokeDifferentTypePlugin: (id: string, payload: ChatToolPayload) => Promise<any>;
+  internal_togglePluginApiCalling: (
+    loading: boolean,
+    id?: string,
+    action?: string,
+  ) => AbortController | undefined;
+  internal_transformToolCalls: (toolCalls: MessageToolCall[]) => ChatToolPayload[];
+  internal_updatePluginError: (id: string, error: any) => Promise<void>;
 }
 
 export const chatPlugin: StateCreator<
@@ -69,129 +75,23 @@ export const chatPlugin: StateCreator<
 
     if (triggerAiMessage) await triggerAIMessage({ parentId: id });
   },
-  internal_callPluginApi: async (id, payload) => {
-    const { internal_updateMessageContent, refreshMessages, internal_toggleChatLoading } = get();
-    let data: string;
-
-    try {
-      const abortController = internal_toggleChatLoading(
-        true,
-        id,
-        n('fetchPlugin/start') as string,
-      );
-
-      const message = chatSelectors.getMessageById(id)(get());
-
-      const res = await chatService.runPluginApi(payload, {
-        signal: abortController?.signal,
-        trace: { observationId: message?.observationId, traceId: message?.traceId },
-      });
-      data = res.text;
-
-      // save traceId
-      if (res.traceId) {
-        await messageService.updateMessage(id, { traceId: res.traceId });
-      }
-    } catch (error) {
-      console.log(error);
-      const err = error as Error;
-
-      // ignore the aborted request error
-      if (!err.message.includes('The user aborted a request.')) {
-        await messageService.updateMessageError(id, error as any);
-        await refreshMessages();
-      }
-
-      data = '';
-    }
-
-    internal_toggleChatLoading(false, id, n('fetchPlugin/end') as string);
-    // 如果报错则结束了
-    if (!data) return;
-
-    await internal_updateMessageContent(id, data);
-
-    return data;
-  },
-
-  internal_invokeDifferentTypePlugin: async (id, payload) => {
-    switch (payload.type) {
-      case 'standalone': {
-        return await get().invokeStandaloneTypePlugin(id, payload);
-      }
-
-      case 'markdown': {
-        return await get().invokeMarkdownTypePlugin(id, payload);
-      }
-
-      case 'builtin': {
-        return await get().invokeBuiltinTool(id, payload);
-      }
-
-      default: {
-        return await get().invokeDefaultTypePlugin(id, payload);
-      }
-    }
-  },
-
-  internal_transformToolCalls: (toolCalls) => {
-    return toolCalls
-      .map((toolCall): ChatToolPayload | null => {
-        let payload: ChatToolPayload;
-
-        const [identifier, apiName, type] = toolCall.function.name.split(PLUGIN_SCHEMA_SEPARATOR);
-
-        if (!apiName) return null;
-
-        payload = {
-          apiName,
-          arguments: toolCall.function.arguments,
-          id: toolCall.id,
-          identifier,
-          type: (type ?? 'default') as any,
-        };
-
-        // if the apiName is md5, try to find the correct apiName in the plugins
-        if (apiName.startsWith(PLUGIN_SCHEMA_API_MD5_PREFIX)) {
-          const md5 = apiName.replace(PLUGIN_SCHEMA_API_MD5_PREFIX, '');
-          const manifest = pluginSelectors.getPluginManifestById(identifier)(
-            useToolStore.getState(),
-          );
-
-          const api = manifest?.api.find((api) => Md5.hashStr(api.name).toString() === md5);
-          if (api) {
-            payload.apiName = api.name;
-          }
-        }
-
-        return payload;
-      })
-      .filter(Boolean) as ChatToolPayload[];
-  },
-
-  internal_updatePluginError: async (id, error) => {
-    const { refreshMessages } = get();
-
-    await messageService.updateMessage(id, { pluginError: error });
-    await refreshMessages();
-  },
-
   invokeBuiltinTool: async (id, payload) => {
-    const { internal_toggleChatLoading, internal_updateMessageContent } = get();
+    const { internal_togglePluginApiCalling, internal_updateMessageContent } = get();
     const params = JSON.parse(payload.arguments);
-    internal_toggleChatLoading(true, id, n('invokeBuiltinTool') as string);
+    internal_togglePluginApiCalling(true, id, n('invokeBuiltinTool') as string);
     let data;
     try {
-      data = await useToolStore.getState().invokeBuiltinTool(payload.apiName, params);
+      data = await useToolStore.getState().transformApiArgumentsToAiState(payload.apiName, params);
     } catch (error) {
       console.log(error);
     }
-    internal_toggleChatLoading(false);
+    internal_togglePluginApiCalling(false);
 
     if (!data) return;
 
     await internal_updateMessageContent(id, data);
 
+    // run tool api call
     // postToolCalling
     // @ts-ignore
     const { [payload.apiName]: action } = get();
@@ -248,6 +148,11 @@ export const chatPlugin: StateCreator<
     const message = chatSelectors.getMessageById(id)(get());
     if (!message || message.role !== 'tool' || !message.plugin) return;
 
+    // if there is error content, then clear the error
+    if (!!message.error) {
+      get().internal_updateMessageError(id, null);
+    }
+
     const payload: ChatToolPayload = { ...message.plugin, id: message.tool_call_id! };
 
     await get().internal_invokeDifferentTypePlugin(id, payload);
@@ -301,4 +206,116 @@ export const chatPlugin: StateCreator<
     await messageService.updateMessagePluginState(id, { [key]: value });
     await refreshMessages();
   },
+
+  internal_callPluginApi: async (id, payload) => {
+    const { internal_updateMessageContent, refreshMessages, internal_togglePluginApiCalling } =
+      get();
+    let data: string;
+
+    try {
+      const abortController = internal_togglePluginApiCalling(
+        true,
+        id,
+        n('fetchPlugin/start') as string,
+      );
+
+      const message = chatSelectors.getMessageById(id)(get());
+
+      const res = await chatService.runPluginApi(payload, {
+        signal: abortController?.signal,
+        trace: { observationId: message?.observationId, traceId: message?.traceId },
+      });
+      data = res.text;
+
+      // save traceId
+      if (res.traceId) {
+        await messageService.updateMessage(id, { traceId: res.traceId });
+      }
+    } catch (error) {
+      console.log(error);
+      const err = error as Error;
+
+      // ignore the aborted request error
+      if (!err.message.includes('The user aborted a request.')) {
+        await messageService.updateMessageError(id, error as any);
+        await refreshMessages();
+      }
+
+      data = '';
+    }
+
+    internal_togglePluginApiCalling(false, id, n('fetchPlugin/end') as string);
+    // 如果报错则结束了
+    if (!data) return;
+
+    await internal_updateMessageContent(id, data);
+
+    return data;
+  },
+
+  internal_invokeDifferentTypePlugin: async (id, payload) => {
+    switch (payload.type) {
+      case 'standalone': {
+        return await get().invokeStandaloneTypePlugin(id, payload);
+      }
+
+      case 'markdown': {
+        return await get().invokeMarkdownTypePlugin(id, payload);
+      }
+
+      case 'builtin': {
+        return await get().invokeBuiltinTool(id, payload);
+      }
+
+      default: {
+        return await get().invokeDefaultTypePlugin(id, payload);
+      }
+    }
+  },
+
+  internal_togglePluginApiCalling: (loading, id, action) => {
+    return get().internal_toggleLoadingArrays('pluginApiLoadingIds', loading, id, action);
+  },
+
+  internal_transformToolCalls: (toolCalls) => {
+    return toolCalls
+      .map((toolCall): ChatToolPayload | null => {
+        let payload: ChatToolPayload;
+
+        const [identifier, apiName, type] = toolCall.function.name.split(PLUGIN_SCHEMA_SEPARATOR);
+
+        if (!apiName) return null;
+
+        payload = {
+          apiName,
+          arguments: toolCall.function.arguments,
+          id: toolCall.id,
+          identifier,
+          type: (type ?? 'default') as any,
+        };
+
+        // if the apiName is md5, try to find the correct apiName in the plugins
+        if (apiName.startsWith(PLUGIN_SCHEMA_API_MD5_PREFIX)) {
+          const md5 = apiName.replace(PLUGIN_SCHEMA_API_MD5_PREFIX, '');
+          const manifest = pluginSelectors.getPluginManifestById(identifier)(
+            useToolStore.getState(),
+          );
+
+          const api = manifest?.api.find((api) => Md5.hashStr(api.name).toString() === md5);
+          if (api) {
+            payload.apiName = api.name;
+          }
+        }
+
+        return payload;
+      })
+      .filter(Boolean) as ChatToolPayload[];
+  },
+  internal_updatePluginError: async (id, error) => {
+    const { refreshMessages } = get();
+
+    get().internal_dispatchMessage({ id, type: 'updateMessages', value: { error } });
+    await messageService.updateMessage(id, { pluginError: error });
+    await refreshMessages();
+  },
 });

package/src/store/chat/utils/index.ts

@@ -0,0 +1,19 @@
+import { produce } from 'immer';
+
+export const preventLeavingFn = (e: BeforeUnloadEvent) => {
+  // set returnValue to trigger alert modal
+  // Note: No matter what value is set, the browser will display the standard text
+  e.returnValue = '你有正在生成中的请求，确定要离开吗？';
+};
+
+export const toggleBooleanList = (ids: string[], id: string, loading: boolean) => {
+  return produce(ids, (draft) => {
+    if (loading) {
+      draft.push(id);
+    } else {
+      const index = draft.indexOf(id);
+
+      if (index >= 0) draft.splice(index, 1);
+    }
+  });
+};

package/src/store/tool/slices/builtin/action.test.ts

@@ -23,7 +23,7 @@ describe('createBuiltinToolSlice', () => {
 
       await act(async () => {
         // When
-        const data = await result.current.invokeBuiltinTool(key, params);
+        const data = await result.current.transformApiArgumentsToAiState(key, params);
         expect(data).toBeUndefined();
       });
 
@@ -53,7 +53,7 @@ describe('createBuiltinToolSlice', () => {
       });
       // When
       await act(async () => {
-        await result.current.invokeBuiltinTool(key, params);
+        await result.current.transformApiArgumentsToAiState(key, params);
       });
 
       expect(mockFn).toBeCalledWith({
@@ -70,15 +70,12 @@ describe('createBuiltinToolSlice', () => {
       // When
       const { result } = renderHook(() => useToolStore());
 
-      const data = result.current.text2image(
-        {
-          prompts: ['prompt1', 'prompt2'],
-          size: '1024x1024',
-          quality: 'standard',
-          style: 'vivid',
-        },
-        'a',
-      );
+      const data = result.current.text2image({
+        prompts: ['prompt1', 'prompt2'],
+        size: '1024x1024',
+        quality: 'standard',
+        style: 'vivid',
+      });
 
       // Then
       expect(data).toEqual([

package/src/store/tool/slices/builtin/action.ts

@@ -16,9 +16,9 @@ interface Text2ImageParams extends Pick<OpenAIImagePayload, 'quality' | 'style'
  * 代理行为接口
  */
 export interface BuiltinToolAction {
-  invokeBuiltinTool: (key: string, params: any) => Promise<string | undefined>;
-  text2image: (params: Text2ImageParams, messageId: string) => DallEImageItem[];
+  text2image: (params: Text2ImageParams) => DallEImageItem[];
   toggleBuiltinToolLoading: (key: string, value: boolean) => void;
+  transformApiArgumentsToAiState: (key: string, params: any) => Promise<string | undefined>;
 }
 
 export const createBuiltinToolSlice: StateCreator<
@@ -27,7 +27,13 @@ export const createBuiltinToolSlice: StateCreator<
   [],
   BuiltinToolAction
 > = (set, get) => ({
-  invokeBuiltinTool: async (key, params) => {
+  text2image: ({ prompts, size = '1024x1024' as const, quality = 'standard', style = 'vivid' }) =>
+    prompts.map((p) => ({ prompt: p, quality, size, style })),
+  toggleBuiltinToolLoading: (key, value) => {
+    set({ builtinToolLoading: { [key]: value } }, false, n('toggleBuiltinToolLoading'));
+  },
+
+  transformApiArgumentsToAiState: async (key, params) => {
     const { builtinToolLoading, toggleBuiltinToolLoading } = get();
 
     if (builtinToolLoading[key]) return;
@@ -45,10 +51,4 @@ export const createBuiltinToolSlice: StateCreator<
 
     return JSON.stringify(result);
   },
-  text2image: ({ prompts, size = '1024x1024' as const, quality = 'standard', style = 'vivid' }) =>
-    prompts.map((p) => ({ prompt: p, quality, size, style })),
-
-  toggleBuiltinToolLoading: (key, value) => {
-    set({ builtinToolLoading: { [key]: value } }, false, n('toggleBuiltinToolLoading'));
-  },
 });

package/src/types/message/index.ts

@@ -32,7 +32,7 @@ export * from './tools';
 
 export interface ChatMessage extends BaseDataModel {
   content: string;
-  error?: ChatMessageError;
+  error?: ChatMessageError | null;
   // 扩展字段
   extra?: {
     fromModel?: string;