@lobehub/chat 1.29.6 → 1.31.0

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

@@ -0,0 +1,255 @@
+// @vitest-environment node
+import OpenAI from 'openai';
+import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import {
+  ChatStreamCallbacks,
+  LobeOpenAICompatibleRuntime,
+  ModelProvider,
+} from '@/libs/agent-runtime';
+
+import * as debugStreamModule from '../utils/debugStream';
+import { LobeXAI } from './index';
+
+const provider = ModelProvider.XAI;
+const defaultBaseURL = 'https://api.x.ai/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 LobeXAI({ apiKey: 'test' });
+
+  // 使用 vi.spyOn 来模拟 chat.completions.create 方法
+  vi.spyOn(instance['client'].chat.completions, 'create').mockResolvedValue(
+    new ReadableStream() as any,
+  );
+});
+
+afterEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('LobeXAI', () => {
+  describe('init', () => {
+    it('should correctly initialize with an API key', async () => {
+      const instance = new LobeXAI({ apiKey: 'test_api_key' });
+      expect(instance).toBeInstanceOf(LobeXAI);
+      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: 'grok-beta',
+            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 LobeXAI({});
+        } 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: 'grok-beta',
+            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 LobeXAI({
+          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: 'grok-beta',
+            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 InvalidXAIAPIKey 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: 'grok-beta',
+            temperature: 0,
+          });
+        } catch (e) {
+          // Expect the chat method to throw an error with InvalidXAIAPIKey
+          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: 'grok-beta',
+            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_XAI_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_XAI_CHAT_COMPLETION;
+
+        // 模拟环境变量
+        process.env.DEBUG_XAI_CHAT_COMPLETION = '1';
+        vi.spyOn(debugStreamModule, 'debugStream').mockImplementation(() => Promise.resolve());
+
+        // 执行测试
+        // 运行你的测试函数，确保它会在条件满足时调用 debugStream
+        // 假设的测试函数调用，你可能需要根据实际情况调整
+        await instance.chat({
+          messages: [{ content: 'Hello', role: 'user' }],
+          model: 'grok-beta',
+          stream: true,
+          temperature: 0,
+        });
+
+        // 验证 debugStream 被调用
+        expect(debugStreamModule.debugStream).toHaveBeenCalled();
+
+        // 恢复原始环境变量值
+        process.env.DEBUG_XAI_CHAT_COMPLETION = originalDebugValue;
+      });
+    });
+  });
+});

package/src/libs/agent-runtime/xai/index.ts

@@ -0,0 +1,10 @@
+import { ModelProvider } from '../types';
+import { LobeOpenAICompatibleFactory } from '../utils/openaiCompatibleFactory';
+
+export const LobeXAI = LobeOpenAICompatibleFactory({
+  baseURL: 'https://api.x.ai/v1',
+  debug: {
+    chatCompletion: () => process.env.DEBUG_XAI_CHAT_COMPLETION === '1',
+  },
+  provider: ModelProvider.XAI,
+});

package/src/locales/default/modelProvider.ts

@@ -21,7 +21,7 @@ export default {
   },
   bedrock: {
     accessKeyId: {
-      desc: '填入AWS Access Key Id',
+      desc: '填入 AWS Access Key Id',
       placeholder: 'AWS Access Key Id',
       title: 'AWS Access Key Id',
     },
@@ -52,6 +52,18 @@ export default {
       title: '使用自定义 Bedrock 鉴权信息',
     },
   },
+  cloudflare: {
+    apiKey: {
+      desc: '请填写 Cloudflare API Key',
+      placeholder: 'Cloudflare API Key',
+      title: 'Cloudflare API Key',
+    },
+    baseURLOrAccountID: {
+      desc: '填入 Cloudflare 账户 ID 或 自定义 API 地址',
+      placeholder: 'Cloudflare Account ID / custom API URL',
+      title: 'Cloudflare 账户 ID / API 地址',
+    }
+  },
   github: {
     personalAccessToken: {
       desc: '填入你的 Github PAT，点击 [这里](https://github.com/settings/tokens) 创建',

package/src/server/globalConfig/index.ts

@@ -33,6 +33,7 @@ import {
   TogetherAIProviderCard,
   UpstageProviderCard,
   WenxinProviderCard,
+  XAIProviderCard,
   ZeroOneProviderCard,
   ZhiPuProviderCard,
 } from '@/config/modelProviders';
@@ -99,6 +100,9 @@ export const getServerGlobalConfig = () => {
     BAICHUAN_MODEL_LIST,
 
     ENABLED_TAICHU,
+
+    ENABLED_CLOUDFLARE,
+
     TAICHU_MODEL_LIST,
 
     ENABLED_AI21,
@@ -143,6 +147,9 @@ export const getServerGlobalConfig = () => {
 
     ENABLED_HUGGINGFACE,
     HUGGINGFACE_MODEL_LIST,
+
+    ENABLED_XAI,
+    XAI_MODEL_LIST,
   } = getLLMConfig();
 
   const config: GlobalServerConfig = {
@@ -202,6 +209,7 @@ export const getServerGlobalConfig = () => {
           modelString: AWS_BEDROCK_MODEL_LIST,
         }),
       },
+      cloudflare: { enabled: ENABLED_CLOUDFLARE },
       deepseek: {
         enabled: ENABLED_DEEPSEEK,
         enabledModels: extractEnabledModels(DEEPSEEK_MODEL_LIST),
@@ -395,6 +403,14 @@ export const getServerGlobalConfig = () => {
           modelString: WENXIN_MODEL_LIST,
         }),
       },
+      xai: {
+        enabled: ENABLED_XAI,
+        enabledModels: extractEnabledModels(XAI_MODEL_LIST),
+        serverModelCards: transformToChatModelCards({
+          defaultChatModels: XAIProviderCard.chatModels,
+          modelString: XAI_MODEL_LIST,
+        }),
+      },
       zeroone: {
         enabled: ENABLED_ZEROONE,
         enabledModels: extractEnabledModels(ZEROONE_MODEL_LIST),

package/src/server/modules/AgentRuntime/index.ts

@@ -210,6 +210,17 @@ const getLlmOptionsFromPayload = (provider: string, payload: JWTPayload) => {
 
       return { apiKey };
     }
+    case ModelProvider.Cloudflare: {
+      const { CLOUDFLARE_API_KEY, CLOUDFLARE_BASE_URL_OR_ACCOUNT_ID } = getLLMConfig();
+
+      const apiKey = apiKeyManager.pick(payload?.apiKey || CLOUDFLARE_API_KEY);
+      const baseURLOrAccountID =
+        payload.apiKey && payload.cloudflareBaseURLOrAccountID
+          ? payload.cloudflareBaseURLOrAccountID
+          : CLOUDFLARE_BASE_URL_OR_ACCOUNT_ID;
+
+      return { apiKey, baseURLOrAccountID };
+    }
     case ModelProvider.Ai360: {
       const { AI360_API_KEY } = getLLMConfig();
 
@@ -275,6 +286,13 @@ const getLlmOptionsFromPayload = (provider: string, payload: JWTPayload) => {
 
       const apiKey = sensenovaAccessKeyID + ':' + sensenovaAccessKeySecret;
 
+      return { apiKey };
+    }
+    case ModelProvider.XAI: {
+      const { XAI_API_KEY } = getLLMConfig();
+
+      const apiKey = apiKeyManager.pick(payload?.apiKey || XAI_API_KEY);
+
       return { apiKey };
     }
   }

package/src/services/_auth.ts

@@ -69,6 +69,15 @@ export const getProviderAuthPayload = (provider: string) => {
       return { endpoint: config?.baseURL };
     }
 
+    case ModelProvider.Cloudflare: {
+      const config = keyVaultsConfigSelectors.cloudflareConfig(useUserStore.getState());
+
+      return {
+        apiKey: config?.apiKey,
+        cloudflareBaseURLOrAccountID: config?.baseURLOrAccountID,
+      };
+    }
+
     default: {
       const config = keyVaultsConfigSelectors.getVaultByProvider(provider as GlobalLLMProviderKey)(
         useUserStore.getState(),

package/src/services/chat.ts

@@ -175,6 +175,13 @@ export function initializeWithClientStore(provider: string, payload: any) {
     case ModelProvider.ZeroOne: {
       break;
     }
+    case ModelProvider.Cloudflare: {
+      providerOptions = {
+        apikey: providerAuthPayload?.apiKey,
+        baseURLOrAccountID: providerAuthPayload?.cloudflareBaseURLOrAccountID,
+      };
+      break;
+    }
   }
 
   /**

package/src/store/user/slices/modelList/selectors/keyVaults.ts

@@ -18,6 +18,7 @@ const wenxinConfig = (s: UserStore) => keyVaultsSettings(s).wenxin || {};
 const ollamaConfig = (s: UserStore) => keyVaultsSettings(s).ollama || {};
 const sensenovaConfig = (s: UserStore) => keyVaultsSettings(s).sensenova || {};
 const azureConfig = (s: UserStore) => keyVaultsSettings(s).azure || {};
+const cloudflareConfig = (s: UserStore) => keyVaultsSettings(s).cloudflare || {};
 const getVaultByProvider = (provider: GlobalLLMProviderKey) => (s: UserStore) =>
   (keyVaultsSettings(s)[provider] || {}) as OpenAICompatibleKeyVault &
     AzureOpenAIKeyVault &
@@ -38,6 +39,7 @@ const password = (s: UserStore) => keyVaultsSettings(s).password || '';
 export const keyVaultsConfigSelectors = {
   azureConfig,
   bedrockConfig,
+  cloudflareConfig,
   getVaultByProvider,
   isProviderApiKeyNotEmpty,
   isProviderEndpointNotEmpty,

package/src/store/user/slices/modelList/selectors/modelConfig.ts

@@ -69,6 +69,7 @@ const openAIConfig = (s: UserStore) => currentLLMSettings(s).openai;
 const bedrockConfig = (s: UserStore) => currentLLMSettings(s).bedrock;
 const ollamaConfig = (s: UserStore) => currentLLMSettings(s).ollama;
 const azureConfig = (s: UserStore) => currentLLMSettings(s).azure;
+const cloudflareConfig = (s: UserStore) => currentLLMSettings(s).cloudflare;
 const sensenovaConfig = (s: UserStore) => currentLLMSettings(s).sensenova;
 
 const isAzureEnabled = (s: UserStore) => currentLLMSettings(s).azure.enabled;
@@ -76,6 +77,7 @@ const isAzureEnabled = (s: UserStore) => currentLLMSettings(s).azure.enabled;
 export const modelConfigSelectors = {
   azureConfig,
   bedrockConfig,
+  cloudflareConfig,
 
   currentEditingCustomModelCard,
   getCustomModelCard,

package/src/types/user/settings/keyVaults.ts

@@ -16,6 +16,11 @@ export interface AWSBedrockKeyVault {
   sessionToken?: string;
 }
 
+export interface CloudflareKeyVault {
+  apiKey?: string;
+  baseURLOrAccountID?: string;
+}
+
 export interface SenseNovaKeyVault {
   sensenovaAccessKeyID?: string;
   sensenovaAccessKeySecret?: string;
@@ -33,6 +38,7 @@ export interface UserKeyVaults {
   azure?: AzureOpenAIKeyVault;
   baichuan?: OpenAICompatibleKeyVault;
   bedrock?: AWSBedrockKeyVault;
+  cloudflare?: CloudflareKeyVault;
   deepseek?: OpenAICompatibleKeyVault;
   fireworksai?: OpenAICompatibleKeyVault;
   github?: OpenAICompatibleKeyVault;
@@ -59,6 +65,7 @@ export interface UserKeyVaults {
   togetherai?: OpenAICompatibleKeyVault;
   upstage?: OpenAICompatibleKeyVault;
   wenxin?: WenxinKeyVault;
+  xai?: OpenAICompatibleKeyVault;
   zeroone?: OpenAICompatibleKeyVault;
   zhipu?: OpenAICompatibleKeyVault;
 }