@lobehub/chat 1.52.18 → 1.52.19

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 1.52.19](https://github.com/lobehub/lobe-chat/compare/v1.52.18...v1.52.19)
+
+<sup>Released on **2025-02-11**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the agent runtime test case.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the agent runtime test case, closes [#6025](https://github.com/lobehub/lobe-chat/issues/6025) ([3414fdd](https://github.com/lobehub/lobe-chat/commit/3414fdd))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.52.18](https://github.com/lobehub/lobe-chat/compare/v1.52.17...v1.52.18)
 
 <sup>Released on **2025-02-11**</sup>

package/changelog/v1.json

@@ -1,4 +1,13 @@
 [
+  {
+    "children": {
+      "improvements": [
+        "Refactor the agent runtime test case."
+      ]
+    },
+    "date": "2025-02-11",
+    "version": "1.52.19"
+  },
   {
     "children": {},
     "date": "2025-02-11",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.52.18",
+  "version": "1.52.19",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",

package/src/libs/agent-runtime/hunyuan/index.test.ts

@@ -1,255 +1,13 @@
 // @vitest-environment node
-import OpenAI from 'openai';
-import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { ModelProvider } from '@/libs/agent-runtime';
 
-import {
-  ChatStreamCallbacks,
-  LobeOpenAICompatibleRuntime,
-  ModelProvider,
-} from '@/libs/agent-runtime';
-
-import * as debugStreamModule from '../utils/debugStream';
+import { testProvider } from '../providerTestUtils';
 import { LobeHunyuanAI } from './index';
 
-const provider = ModelProvider.Hunyuan;
-const defaultBaseURL = 'https://api.hunyuan.cloud.tencent.com/v1';
-
-const bizErrorType = 'ProviderBizError';
-const invalidErrorType = 'InvalidProviderAPIKey';
-
-// Mock the console.error to avoid polluting test output
-vi.spyOn(console, 'error').mockImplementation(() => {});
-
-let instance: LobeOpenAICompatibleRuntime;
-
-beforeEach(() => {
-  instance = new LobeHunyuanAI({ apiKey: 'test' });
-
-  // 使用 vi.spyOn 来模拟 chat.completions.create 方法
-  vi.spyOn(instance['client'].chat.completions, 'create').mockResolvedValue(
-    new ReadableStream() as any,
-  );
-});
-
-afterEach(() => {
-  vi.clearAllMocks();
-});
-
-describe('LobeHunyuanAI', () => {
-  describe('init', () => {
-    it('should correctly initialize with an API key', async () => {
-      const instance = new LobeHunyuanAI({ apiKey: 'test_api_key' });
-      expect(instance).toBeInstanceOf(LobeHunyuanAI);
-      expect(instance.baseURL).toEqual(defaultBaseURL);
-    });
-  });
-
-  describe('chat', () => {
-    describe('Error', () => {
-      it('should return OpenAIBizError with an openai error response when OpenAI.APIError is thrown', async () => {
-        // Arrange
-        const apiError = new OpenAI.APIError(
-          400,
-          {
-            status: 400,
-            error: {
-              message: 'Bad Request',
-            },
-          },
-          'Error message',
-          {},
-        );
-
-        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
-
-        // Act
-        try {
-          await instance.chat({
-            messages: [{ content: 'Hello', role: 'user' }],
-            model: 'hunyuan-lite',
-            temperature: 0,
-          });
-        } catch (e) {
-          expect(e).toEqual({
-            endpoint: defaultBaseURL,
-            error: {
-              error: { message: 'Bad Request' },
-              status: 400,
-            },
-            errorType: bizErrorType,
-            provider,
-          });
-        }
-      });
-
-      it('should throw AgentRuntimeError with NoOpenAIAPIKey if no apiKey is provided', async () => {
-        try {
-          new LobeHunyuanAI({});
-        } catch (e) {
-          expect(e).toEqual({ errorType: invalidErrorType });
-        }
-      });
-
-      it('should return OpenAIBizError with the cause when OpenAI.APIError is thrown with cause', async () => {
-        // Arrange
-        const errorInfo = {
-          stack: 'abc',
-          cause: {
-            message: 'api is undefined',
-          },
-        };
-        const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
-
-        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
-
-        // Act
-        try {
-          await instance.chat({
-            messages: [{ content: 'Hello', role: 'user' }],
-            model: 'hunyuan-lite',
-            temperature: 0,
-          });
-        } catch (e) {
-          expect(e).toEqual({
-            endpoint: defaultBaseURL,
-            error: {
-              cause: { message: 'api is undefined' },
-              stack: 'abc',
-            },
-            errorType: bizErrorType,
-            provider,
-          });
-        }
-      });
-
-      it('should return OpenAIBizError with an cause response with desensitize Url', async () => {
-        // Arrange
-        const errorInfo = {
-          stack: 'abc',
-          cause: { message: 'api is undefined' },
-        };
-        const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
-
-        instance = new LobeHunyuanAI({
-          apiKey: 'test',
-
-          baseURL: 'https://api.abc.com/v1',
-        });
-
-        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
-
-        // Act
-        try {
-          await instance.chat({
-            messages: [{ content: 'Hello', role: 'user' }],
-            model: 'hunyuan-lite',
-            temperature: 0,
-          });
-        } catch (e) {
-          expect(e).toEqual({
-            endpoint: 'https://api.***.com/v1',
-            error: {
-              cause: { message: 'api is undefined' },
-              stack: 'abc',
-            },
-            errorType: bizErrorType,
-            provider,
-          });
-        }
-      });
-
-      it('should throw an InvalidHunyuanAPIKey error type on 401 status code', async () => {
-        // Mock the API call to simulate a 401 error
-        const error = new Error('Unauthorized') as any;
-        error.status = 401;
-        vi.mocked(instance['client'].chat.completions.create).mockRejectedValue(error);
-
-        try {
-          await instance.chat({
-            messages: [{ content: 'Hello', role: 'user' }],
-            model: 'hunyuan-lite',
-            temperature: 0,
-          });
-        } catch (e) {
-          // Expect the chat method to throw an error with InvalidHunyuanAPIKey
-          expect(e).toEqual({
-            endpoint: defaultBaseURL,
-            error: new Error('Unauthorized'),
-            errorType: invalidErrorType,
-            provider,
-          });
-        }
-      });
-
-      it('should return AgentRuntimeError for non-OpenAI errors', async () => {
-        // Arrange
-        const genericError = new Error('Generic Error');
-
-        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(genericError);
-
-        // Act
-        try {
-          await instance.chat({
-            messages: [{ content: 'Hello', role: 'user' }],
-            model: 'hunyuan-lite',
-            temperature: 0,
-          });
-        } catch (e) {
-          expect(e).toEqual({
-            endpoint: defaultBaseURL,
-            errorType: 'AgentRuntimeError',
-            provider,
-            error: {
-              name: genericError.name,
-              cause: genericError.cause,
-              message: genericError.message,
-              stack: genericError.stack,
-            },
-          });
-        }
-      });
-    });
-
-    describe('DEBUG', () => {
-      it('should call debugStream and return StreamingTextResponse when DEBUG_HUNYUAN_CHAT_COMPLETION is 1', async () => {
-        // Arrange
-        const mockProdStream = new ReadableStream() as any; // 模拟的 prod 流
-        const mockDebugStream = new ReadableStream({
-          start(controller) {
-            controller.enqueue('Debug stream content');
-            controller.close();
-          },
-        }) as any;
-        mockDebugStream.toReadableStream = () => mockDebugStream; // 添加 toReadableStream 方法
-
-        // 模拟 chat.completions.create 返回值，包括模拟的 tee 方法
-        (instance['client'].chat.completions.create as Mock).mockResolvedValue({
-          tee: () => [mockProdStream, { toReadableStream: () => mockDebugStream }],
-        });
-
-        // 保存原始环境变量值
-        const originalDebugValue = process.env.DEBUG_HUNYUAN_CHAT_COMPLETION;
-
-        // 模拟环境变量
-        process.env.DEBUG_HUNYUAN_CHAT_COMPLETION = '1';
-        vi.spyOn(debugStreamModule, 'debugStream').mockImplementation(() => Promise.resolve());
-
-        // 执行测试
-        // 运行你的测试函数，确保它会在条件满足时调用 debugStream
-        // 假设的测试函数调用，你可能需要根据实际情况调整
-        await instance.chat({
-          messages: [{ content: 'Hello', role: 'user' }],
-          model: 'hunyuan-lite',
-          stream: true,
-          temperature: 0,
-        });
-
-        // 验证 debugStream 被调用
-        expect(debugStreamModule.debugStream).toHaveBeenCalled();
-
-        // 恢复原始环境变量值
-        process.env.DEBUG_HUNYUAN_CHAT_COMPLETION = originalDebugValue;
-      });
-    });
-  });
+testProvider({
+  Runtime: LobeHunyuanAI,
+  provider: ModelProvider.Hunyuan,
+  defaultBaseURL: 'https://api.hunyuan.cloud.tencent.com/v1',
+  chatDebugEnv: 'DEBUG_HUNYUAN_CHAT_COMPLETION',
+  chatModel: 'hunyuan-lite',
 });

package/src/libs/agent-runtime/providerTestUtils.ts

@@ -0,0 +1,263 @@
+import OpenAI from 'openai';
+import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { LobeOpenAICompatibleRuntime } from '@/libs/agent-runtime';
+
+import * as debugStreamModule from './utils/debugStream';
+
+interface TesstProviderParams {
+  Runtime: any;
+  bizErrorType?: string;
+  chatDebugEnv: string;
+  chatModel: string;
+  defaultBaseURL: string;
+  invalidErrorType?: string;
+  provider: string;
+}
+
+export const testProvider = ({
+  provider,
+  invalidErrorType = 'InvalidProviderAPIKey',
+  bizErrorType = 'ProviderBizError',
+  defaultBaseURL,
+  Runtime,
+  chatDebugEnv,
+  chatModel,
+}: TesstProviderParams) => {
+  // Mock the console.error to avoid polluting test output
+  vi.spyOn(console, 'error').mockImplementation(() => {});
+
+  let instance: LobeOpenAICompatibleRuntime;
+
+  beforeEach(() => {
+    instance = new Runtime({ apiKey: 'test' });
+
+    // 使用 vi.spyOn 来模拟 chat.completions.create 方法
+    vi.spyOn(instance['client'].chat.completions, 'create').mockResolvedValue(
+      new ReadableStream() as any,
+    );
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe(`${provider} Runtime`, () => {
+    describe('init', () => {
+      it('should correctly initialize with an API key', async () => {
+        const instance = new Runtime({ apiKey: 'test_api_key' });
+        expect(instance).toBeInstanceOf(Runtime);
+        expect(instance.baseURL).toEqual(defaultBaseURL);
+      });
+    });
+
+    describe('chat', () => {
+      describe('Error', () => {
+        it('should return OpenAIBizError with an openai error response when OpenAI.APIError is thrown', async () => {
+          // Arrange
+          const apiError = new OpenAI.APIError(
+            400,
+            {
+              error: {
+                message: 'Bad Request',
+              },
+              status: 400,
+            },
+            'Error message',
+            {},
+          );
+
+          vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+          // Act
+          try {
+            await instance.chat({
+              messages: [{ content: 'Hello', role: 'user' }],
+              model: chatModel,
+              temperature: 0,
+            });
+          } catch (e) {
+            expect(e).toEqual({
+              endpoint: defaultBaseURL,
+              error: {
+                error: { message: 'Bad Request' },
+                status: 400,
+              },
+              errorType: bizErrorType,
+              provider,
+            });
+          }
+        });
+
+        it('should throw AgentRuntimeError with NoOpenAIAPIKey if no apiKey is provided', async () => {
+          try {
+            new Runtime({});
+          } catch (e) {
+            expect(e).toEqual({ errorType: invalidErrorType });
+          }
+        });
+
+        it('should return OpenAIBizError with the cause when OpenAI.APIError is thrown with cause', async () => {
+          // Arrange
+          const errorInfo = {
+            cause: {
+              message: 'api is undefined',
+            },
+            stack: 'abc',
+          };
+          const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
+
+          vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+          // Act
+          try {
+            await instance.chat({
+              messages: [{ content: 'Hello', role: 'user' }],
+              model: chatModel,
+              temperature: 0,
+            });
+          } catch (e) {
+            expect(e).toEqual({
+              endpoint: defaultBaseURL,
+              error: {
+                cause: { message: 'api is undefined' },
+                stack: 'abc',
+              },
+              errorType: bizErrorType,
+              provider,
+            });
+          }
+        });
+
+        it('should return OpenAIBizError with an cause response with desensitize Url', async () => {
+          // Arrange
+          const errorInfo = {
+            cause: { message: 'api is undefined' },
+            stack: 'abc',
+          };
+          const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
+
+          instance = new Runtime({
+            apiKey: 'test',
+
+            baseURL: 'https://api.abc.com/v1',
+          });
+
+          vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+          // Act
+          try {
+            await instance.chat({
+              messages: [{ content: 'Hello', role: 'user' }],
+              model: chatModel,
+              temperature: 0,
+            });
+          } catch (e) {
+            expect(e).toEqual({
+              endpoint: 'https://api.***.com/v1',
+              error: {
+                cause: { message: 'api is undefined' },
+                stack: 'abc',
+              },
+              errorType: bizErrorType,
+              provider,
+            });
+          }
+        });
+
+        it('should throw an InvalidHunyuanAPIKey error type on 401 status code', async () => {
+          // Mock the API call to simulate a 401 error
+          const error = new Error('Unauthorized') as any;
+          error.status = 401;
+          vi.mocked(instance['client'].chat.completions.create).mockRejectedValue(error);
+
+          try {
+            await instance.chat({
+              messages: [{ content: 'Hello', role: 'user' }],
+              model: chatModel,
+              temperature: 0,
+            });
+          } catch (e) {
+            // Expect the chat method to throw an error with InvalidHunyuanAPIKey
+            expect(e).toEqual({
+              endpoint: defaultBaseURL,
+              error: new Error('Unauthorized'),
+              errorType: invalidErrorType,
+              provider,
+            });
+          }
+        });
+
+        it('should return AgentRuntimeError for non-OpenAI errors', async () => {
+          // Arrange
+          const genericError = new Error('Generic Error');
+
+          vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(genericError);
+
+          // Act
+          try {
+            await instance.chat({
+              messages: [{ content: 'Hello', role: 'user' }],
+              model: chatModel,
+              temperature: 0,
+            });
+          } catch (e) {
+            expect(e).toEqual({
+              endpoint: defaultBaseURL,
+              error: {
+                cause: genericError.cause,
+                message: genericError.message,
+                name: genericError.name,
+                stack: genericError.stack,
+              },
+              errorType: 'AgentRuntimeError',
+              provider,
+            });
+          }
+        });
+      });
+
+      describe('DEBUG', () => {
+        it(`should call debugStream and return StreamingTextResponse when ${chatDebugEnv} is 1`, async () => {
+          // Arrange
+          const mockProdStream = new ReadableStream() as any; // 模拟的 prod 流
+          const mockDebugStream = new ReadableStream({
+            start(controller) {
+              controller.enqueue('Debug stream content');
+              controller.close();
+            },
+          }) as any;
+          mockDebugStream.toReadableStream = () => mockDebugStream; // 添加 toReadableStream 方法
+
+          // 模拟 chat.completions.create 返回值，包括模拟的 tee 方法
+          (instance['client'].chat.completions.create as Mock).mockResolvedValue({
+            tee: () => [mockProdStream, { toReadableStream: () => mockDebugStream }],
+          });
+
+          // 保存原始环境变量值
+          const originalDebugValue = process.env[chatDebugEnv];
+
+          // 模拟环境变量
+          process.env[chatDebugEnv] = '1';
+          vi.spyOn(debugStreamModule, 'debugStream').mockImplementation(() => Promise.resolve());
+
+          // 执行测试
+          // 运行你的测试函数，确保它会在条件满足时调用 debugStream
+          // 假设的测试函数调用，你可能需要根据实际情况调整
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: chatModel,
+            stream: true,
+            temperature: 0,
+          });
+
+          // 验证 debugStream 被调用
+          expect(debugStreamModule.debugStream).toHaveBeenCalled();
+
+          // 恢复原始环境变量值
+          process.env[chatDebugEnv] = originalDebugValue;
+        });
+      });
+    });
+  });
+};