@lobehub/chat 0.162.4 → 0.162.5

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.162.5](https://github.com/lobehub/lobe-chat/compare/v0.162.4...v0.162.5)
+
+<sup>Released on **2024-05-28**</sup>
+
+#### 💄 Styles
+
+- **misc**: Add `SYSTEM_AGENT` env.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Styles
+
+- **misc**: Add `SYSTEM_AGENT` env, closes [#2694](https://github.com/lobehub/lobe-chat/issues/2694) ([0dfcf8d](https://github.com/lobehub/lobe-chat/commit/0dfcf8d))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.162.4](https://github.com/lobehub/lobe-chat/compare/v0.162.3...v0.162.4)
 
 <sup>Released on **2024-05-28**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.162.4",
+  "version": "0.162.5",
   "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/config/app.ts

@@ -25,6 +25,7 @@ export const getAppConfig = () => {
       AGENTS_INDEX_URL: z.string().url(),
 
       DEFAULT_AGENT_CONFIG: z.string(),
+      SYSTEM_AGENT: z.string().optional(),
 
       PLUGINS_INDEX_URL: z.string().url(),
       PLUGIN_SETTINGS: z.string().optional(),
@@ -44,6 +45,7 @@ export const getAppConfig = () => {
         : 'https://chat-agents.lobehub.com',
 
       DEFAULT_AGENT_CONFIG: process.env.DEFAULT_AGENT_CONFIG || '',
+      SYSTEM_AGENT: process.env.SYSTEM_AGENT,
 
       PLUGINS_INDEX_URL: !!process.env.PLUGINS_INDEX_URL
         ? process.env.PLUGINS_INDEX_URL

package/src/server/globalConfig/index.ts

@@ -1,4 +1,4 @@
-import { getAppConfig } from '@/config/app';
+import { appEnv, getAppConfig } from '@/config/app';
 import { fileEnv } from '@/config/file';
 import { langfuseEnv } from '@/config/langfuse';
 import { getLLMConfig } from '@/config/llm';
@@ -9,6 +9,7 @@ import {
   TogetherAIProviderCard,
 } from '@/config/modelProviders';
 import { enableNextAuth } from '@/const/auth';
+import { parseSystemAgent } from '@/server/globalConfig/parseSystemAgent';
 import { GlobalServerConfig } from '@/types/serverConfig';
 import { extractEnabledModels, transformToChatModelCards } from '@/utils/parseModels';
 
@@ -51,7 +52,6 @@ export const getServerGlobalConfig = () => {
     defaultAgent: {
       config: parseAgentConfig(DEFAULT_AGENT_CONFIG),
     },
-
     enableUploadFileToServer: !!fileEnv.S3_SECRET_ACCESS_KEY,
     enabledAccessCode: ACCESS_CODES?.length > 0,
     enabledOAuthSSO: enableNextAuth,
@@ -114,6 +114,7 @@ export const getServerGlobalConfig = () => {
       zeroone: { enabled: ENABLED_ZEROONE },
       zhipu: { enabled: ENABLED_ZHIPU },
     },
+    systemAgent: parseSystemAgent(appEnv.SYSTEM_AGENT),
     telemetry: {
       langfuse: langfuseEnv.ENABLE_LANGFUSE,
     },

package/src/server/globalConfig/parseSystemAgent.test.ts

@@ -0,0 +1,95 @@
+import { describe, expect, it } from 'vitest';
+
+import { parseSystemAgent } from './parseSystemAgent';
+
+describe('parseSystemAgent', () => {
+  it('should parse a valid environment variable string correctly', () => {
+    const envValue = 'topic=openai/gpt-3.5-turbo,translation=anthropic/claude-1';
+    const expected = {
+      topic: { provider: 'openai', model: 'gpt-3.5-turbo' },
+      translation: { provider: 'anthropic', model: 'claude-1' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should handle empty environment variable string', () => {
+    const envValue = '';
+    const expected = {};
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should ignore unknown keys in environment variable string', () => {
+    const envValue = 'topic=openai/gpt-3.5-turbo,unknown=test/model';
+    const expected = {
+      topic: { provider: 'openai', model: 'gpt-3.5-turbo' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should throw an error for missing model or provider values', () => {
+    const envValue1 = 'topic=openai,translation=/claude-1';
+    const envValue2 = 'topic=/gpt-3.5-turbo,translation=anthropic/';
+
+    expect(() => parseSystemAgent(envValue1)).toThrowError(/Missing model or provider/);
+    expect(() => parseSystemAgent(envValue2)).toThrowError(/Missing model or provider/);
+  });
+
+  it('should throw an error for invalid environment variable format', () => {
+    const envValue = 'topic-openai/gpt-3.5-turbo';
+
+    expect(() => parseSystemAgent(envValue)).toThrowError(/Invalid environment variable format/);
+  });
+
+  it('should handle provider or model names with special characters', () => {
+    const envValue = 'topic=openrouter/mistralai/mistral-7b-instruct:free';
+    const expected = {
+      topic: { provider: 'openrouter', model: 'mistralai/mistral-7b-instruct:free' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should handle extra whitespace in environment variable string', () => {
+    const envValue = '  topic = openai/gpt-3.5-turbo , translation = anthropic/claude-1 ';
+    const expected = {
+      topic: { provider: 'openai', model: 'gpt-3.5-turbo' },
+      translation: { provider: 'anthropic', model: 'claude-1' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should handle full-width comma in environment variable string', () => {
+    const envValue = 'topic=openai/gpt-3.5-turbo，translation=anthropic/claude-1';
+    const expected = {
+      topic: { provider: 'openai', model: 'gpt-3.5-turbo' },
+      translation: { provider: 'anthropic', model: 'claude-1' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should handle extra whitespace around provider and model names', () => {
+    const envValue = 'topic= openai / gpt-3.5-turbo ,translation= anthropic / claude-1 ';
+    const expected = {
+      topic: { provider: 'openai', model: 'gpt-3.5-turbo' },
+      translation: { provider: 'anthropic', model: 'claude-1' },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+
+  it('should handle an excessively long environment variable string', () => {
+    const longProviderName = 'a'.repeat(100);
+    const longModelName = 'b'.repeat(100);
+    const envValue = `topic=${longProviderName}/${longModelName}`;
+    const expected = {
+      topic: { provider: longProviderName, model: longModelName },
+    };
+
+    expect(parseSystemAgent(envValue)).toEqual(expected);
+  });
+});

package/src/server/globalConfig/parseSystemAgent.ts

@@ -0,0 +1,39 @@
+import { DEFAULT_SYSTEM_AGENT_CONFIG } from '@/const/settings';
+import { UserSystemAgentConfig } from '@/types/user/settings';
+
+const protectedKeys = Object.keys(DEFAULT_SYSTEM_AGENT_CONFIG);
+
+export const parseSystemAgent = (envString: string = ''): Partial<UserSystemAgentConfig> => {
+  if (!envString) return {};
+
+  const config: Partial<UserSystemAgentConfig> = {};
+
+  // 处理全角逗号和多余空格
+  let envValue = envString.replaceAll('，', ',').trim();
+
+  const pairs = envValue.split(',');
+
+  for (const pair of pairs) {
+    const [key, value] = pair.split('=').map((s) => s.trim());
+
+    if (key && value) {
+      const [provider, ...modelParts] = value.split('/');
+      const model = modelParts.join('/');
+
+      if (!provider || !model) {
+        throw new Error('Missing model or provider value');
+      }
+
+      if (protectedKeys.includes(key)) {
+        config[key as keyof UserSystemAgentConfig] = {
+          model: model.trim(),
+          provider: provider.trim(),
+        };
+      }
+    } else {
+      throw new Error('Invalid environment variable format');
+    }
+  }
+
+  return config;
+};

package/src/store/user/slices/common/action.ts

@@ -81,7 +81,9 @@ export const createCommonSlice: StateCreator<
             const serverSettings: DeepPartial<UserSettings> = {
               defaultAgent: serverConfig.defaultAgent,
               languageModel: serverConfig.languageModel,
+              systemAgent: serverConfig.systemAgent,
             };
+
             const defaultSettings = merge(get().defaultSettings, serverSettings);
 
             // merge preference

package/src/types/serverConfig.ts

@@ -1,7 +1,11 @@
 import { DeepPartial } from 'utility-types';
 
 import { ChatModelCard } from '@/types/llm';
-import { UserDefaultAgent, GlobalLLMProviderKey } from '@/types/user/settings';
+import {
+  GlobalLLMProviderKey,
+  UserDefaultAgent,
+  UserSystemAgentConfig,
+} from '@/types/user/settings';
 
 export interface ServerModelProviderConfig {
   enabled?: boolean;
@@ -21,6 +25,7 @@ export interface GlobalServerConfig {
   enabledAccessCode?: boolean;
   enabledOAuthSSO?: boolean;
   languageModel?: ServerLanguageModel;
+  systemAgent?: DeepPartial<UserSystemAgentConfig>;
   telemetry: {
     langfuse?: boolean;
   };