@lobehub/chat 0.161.2 → 0.161.3

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.161.3](https://github.com/lobehub/lobe-chat/compare/v0.161.2...v0.161.3)
+
+<sup>Released on **2024-05-22**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the langfuse env.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the langfuse env, closes [#2602](https://github.com/lobehub/lobe-chat/issues/2602) ([cbebfbc](https://github.com/lobehub/lobe-chat/commit/cbebfbc))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.161.2](https://github.com/lobehub/lobe-chat/compare/v0.161.1...v0.161.2)
 
 <sup>Released on **2024-05-22**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.161.2",
+  "version": "0.161.3",
   "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/langfuse.ts

@@ -0,0 +1,23 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
+import { createEnv } from '@t3-oss/env-nextjs';
+import { z } from 'zod';
+
+export const getLangfuseConfig = () => {
+  return createEnv({
+    runtimeEnv: {
+      ENABLE_LANGFUSE: process.env.ENABLE_LANGFUSE === '1',
+      LANGFUSE_SECRET_KEY: process.env.LANGFUSE_SECRET_KEY || '',
+      LANGFUSE_PUBLIC_KEY: process.env.LANGFUSE_PUBLIC_KEY || '',
+      LANGFUSE_HOST: process.env.LANGFUSE_HOST || 'https://cloud.langfuse.com',
+    },
+
+    server: {
+      ENABLE_LANGFUSE: z.boolean(),
+      LANGFUSE_SECRET_KEY: z.string().optional(),
+      LANGFUSE_PUBLIC_KEY: z.string().optional(),
+      LANGFUSE_HOST: z.string().url(),
+    },
+  });
+};
+
+export const langfuseEnv = getLangfuseConfig();

package/src/config/server/app.ts

@@ -14,11 +14,6 @@ declare global {
       PLUGIN_SETTINGS?: string;
 
       DEFAULT_AGENT_CONFIG?: string;
-
-      ENABLE_LANGFUSE?: string;
-      LANGFUSE_PUBLIC_KEY?: string;
-      LANGFUSE_SECRET_KEY?: string;
-      LANGFUSE_HOST?: string;
     }
   }
 }
@@ -35,8 +30,6 @@ export const getAppConfig = () => {
 
     DEFAULT_AGENT_CONFIG: process.env.DEFAULT_AGENT_CONFIG || '',
 
-    SHOW_ACCESS_CODE_CONFIG: !!ACCESS_CODES.length,
-
     SITE_URL: process.env.SITE_URL,
 
     AGENTS_INDEX_URL: !!process.env.AGENTS_INDEX_URL
@@ -48,10 +41,5 @@ export const getAppConfig = () => {
       : 'https://chat-plugins.lobehub.com',
 
     PLUGIN_SETTINGS: process.env.PLUGIN_SETTINGS,
-
-    ENABLE_LANGFUSE: process.env.ENABLE_LANGFUSE === '1',
-    LANGFUSE_SECRET_KEY: process.env.LANGFUSE_SECRET_KEY || '',
-    LANGFUSE_PUBLIC_KEY: process.env.LANGFUSE_PUBLIC_KEY || '',
-    LANGFUSE_HOST: process.env.LANGFUSE_HOST || 'https://cloud.langfuse.com',
   };
 };

package/src/libs/agent-runtime/AgentRuntime.test.ts

@@ -5,7 +5,7 @@ import { ClientOptions } from 'openai';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { createTraceOptions } from '@/app/api/chat/agentRuntime';
-import { getServerConfig } from '@/config/server';
+import * as langfuseCfg from '@/config/langfuse';
 import { JWTPayload } from '@/const/auth';
 import { TraceNameMap } from '@/const/trace';
 import {
@@ -312,15 +312,14 @@ describe('AgentRuntime', () => {
       };
 
       const updateMock = vi.fn();
-      beforeEach(() => {
-        vi.mocked(getServerConfig).mockReturnValue({
+
+      it('should call experimental_onToolCall correctly', async () => {
+        vi.spyOn(langfuseCfg, 'getLangfuseConfig').mockReturnValue({
           ENABLE_LANGFUSE: true,
           LANGFUSE_PUBLIC_KEY: 'abc',
           LANGFUSE_SECRET_KEY: 'DDD',
         } as any);
-      });
 
-      it('should call experimental_onToolCall correctly', async () => {
         // 使用 spyOn 模拟 chat 方法
         vi.spyOn(LobeOpenAI.prototype, 'chat').mockImplementation(
           async (payload, { callback }: any) => {
@@ -338,6 +337,12 @@ describe('AgentRuntime', () => {
         expect(updateMock).toHaveBeenCalledWith({ tags: ['Tools Call'] });
       });
       it('should call onStart correctly', async () => {
+        vi.spyOn(langfuseCfg, 'getLangfuseConfig').mockReturnValue({
+          ENABLE_LANGFUSE: true,
+          LANGFUSE_PUBLIC_KEY: 'abc',
+          LANGFUSE_SECRET_KEY: 'DDD',
+        } as any);
+
         vi.spyOn(LangfuseGenerationClient.prototype, 'update').mockImplementation(updateMock);
         vi.spyOn(LobeOpenAI.prototype, 'chat').mockImplementation(
           async (payload, { callback }: any) => {
@@ -355,6 +360,11 @@ describe('AgentRuntime', () => {
       });
 
       it('should call onCompletion correctly', async () => {
+        vi.spyOn(langfuseCfg, 'getLangfuseConfig').mockReturnValue({
+          ENABLE_LANGFUSE: true,
+          LANGFUSE_PUBLIC_KEY: 'abc',
+          LANGFUSE_SECRET_KEY: 'DDD',
+        } as any);
         // Spy on the chat method and trigger onCompletion callback
         vi.spyOn(LangfuseGenerationClient.prototype, 'update').mockImplementation(updateMock);
         vi.spyOn(LobeOpenAI.prototype, 'chat').mockImplementation(
@@ -379,6 +389,12 @@ describe('AgentRuntime', () => {
         });
       });
       it('should call onFinal correctly', async () => {
+        vi.spyOn(langfuseCfg, 'getLangfuseConfig').mockReturnValue({
+          ENABLE_LANGFUSE: true,
+          LANGFUSE_PUBLIC_KEY: 'abc',
+          LANGFUSE_SECRET_KEY: 'DDD',
+        } as any);
+
         vi.spyOn(LobeOpenAI.prototype, 'chat').mockImplementation(
           async (payload, { callback }: any) => {
             if (callback?.onFinal) {

package/src/libs/traces/index.test.ts

@@ -1,14 +1,15 @@
+// @vitest-environment node
 import { Langfuse } from 'langfuse';
 import { CreateLangfuseTraceBody } from 'langfuse-core';
 import { describe, expect, it, vi } from 'vitest';
 
-import * as server from '@/config/server';
+import * as server from '@/config/langfuse';
 
 import { TraceClient } from './index';
 
 describe('TraceClient', () => {
   it('should not initialize Langfuse client when ENABLE_LANGFUSE is false', () => {
-    vi.spyOn(server, 'getServerConfig').mockReturnValue({
+    vi.spyOn(server, 'getLangfuseConfig').mockReturnValue({
       ENABLE_LANGFUSE: false,
     } as any);
     const client = new TraceClient();
@@ -16,7 +17,7 @@ describe('TraceClient', () => {
   });
 
   it('should throw error if LANGFUSE keys are missing', () => {
-    vi.spyOn(server, 'getServerConfig').mockReturnValue({
+    vi.spyOn(server, 'getLangfuseConfig').mockReturnValue({
       ENABLE_LANGFUSE: true,
     } as any);
     expect(() => new TraceClient()).toThrow('NO_LANGFUSE_KEY_ERROR');
@@ -27,7 +28,7 @@ describe('TraceClient', () => {
 
     vi.spyOn(Langfuse.prototype, 'trace').mockImplementation(mockTrace);
 
-    vi.spyOn(server, 'getServerConfig').mockReturnValue({
+    vi.spyOn(server, 'getLangfuseConfig').mockReturnValue({
       ENABLE_LANGFUSE: true,
       LANGFUSE_PUBLIC_KEY: 'public-key',
       LANGFUSE_SECRET_KEY: 'secret-key',
@@ -45,7 +46,7 @@ describe('TraceClient', () => {
     const mockShutdownAsync = vi.fn();
 
     vi.spyOn(Langfuse.prototype, 'shutdownAsync').mockImplementation(mockShutdownAsync);
-    vi.spyOn(server, 'getServerConfig').mockReturnValue({
+    vi.spyOn(server, 'getLangfuseConfig').mockReturnValue({
       ENABLE_LANGFUSE: true,
       LANGFUSE_PUBLIC_KEY: 'public-key',
       LANGFUSE_SECRET_KEY: 'secret-key',

package/src/libs/traces/index.ts

@@ -1,7 +1,7 @@
 import { Langfuse } from 'langfuse';
 import { CreateLangfuseTraceBody } from 'langfuse-core';
 
-import { getServerConfig } from '@/config/server';
+import { getLangfuseConfig } from '@/config/langfuse';
 import { CURRENT_VERSION } from '@/const/version';
 import { TraceEventClient } from '@/libs/traces/event';
 
@@ -13,7 +13,7 @@ export class TraceClient {
 
   constructor() {
     const { ENABLE_LANGFUSE, LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, LANGFUSE_HOST } =
-      getServerConfig();
+      getLangfuseConfig();
 
     if (!ENABLE_LANGFUSE) return;
 

package/src/server/globalConfig/index.ts

@@ -1,4 +1,5 @@
 import { fileEnv } from '@/config/file';
+import { langfuseEnv } from '@/config/langfuse';
 import { getLLMConfig } from '@/config/llm';
 import {
   OllamaProviderCard,
@@ -14,7 +15,7 @@ import { extractEnabledModels, transformToChatModelCards } from '@/utils/parseMo
 import { parseAgentConfig } from './parseDefaultAgent';
 
 export const getServerGlobalConfig = () => {
-  const { ACCESS_CODES, ENABLE_LANGFUSE, DEFAULT_AGENT_CONFIG } = getServerConfig();
+  const { ACCESS_CODES, DEFAULT_AGENT_CONFIG } = getServerConfig();
 
   const {
     ENABLED_OPENAI,
@@ -114,7 +115,7 @@ export const getServerGlobalConfig = () => {
       zhipu: { enabled: ENABLED_ZHIPU },
     },
     telemetry: {
-      langfuse: ENABLE_LANGFUSE,
+      langfuse: langfuseEnv.ENABLE_LANGFUSE,
     },
   };