@lobehub/chat 1.36.1 → 1.36.3

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 # Changelog
 
+### [Version 1.36.3](https://github.com/lobehub/lobe-chat/compare/v1.36.2...v1.36.3)
+
+<sup>Released on **2024-12-08**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Support request headers for chat.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Support request headers for chat, closes [#4934](https://github.com/lobehub/lobe-chat/issues/4934) ([8cdc062](https://github.com/lobehub/lobe-chat/commit/8cdc062))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 1.36.2](https://github.com/lobehub/lobe-chat/compare/v1.36.1...v1.36.2)
+
+<sup>Released on **2024-12-07**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor async params route to adapt next15 breaking change.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor async params route to adapt next15 breaking change, closes [#4905](https://github.com/lobehub/lobe-chat/issues/4905) ([5d61950](https://github.com/lobehub/lobe-chat/commit/5d61950))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.36.1](https://github.com/lobehub/lobe-chat/compare/v1.36.0...v1.36.1)
 
 <sup>Released on **2024-12-07**</sup>

package/changelog/v1.json

@@ -1,4 +1,22 @@
 [
+  {
+    "children": {
+      "fixes": [
+        "Support request headers for chat."
+      ]
+    },
+    "date": "2024-12-08",
+    "version": "1.36.3"
+  },
+  {
+    "children": {
+      "improvements": [
+        "Refactor async params route to adapt next15 breaking change."
+      ]
+    },
+    "date": "2024-12-07",
+    "version": "1.36.2"
+  },
   {
     "children": {
       "improvements": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.36.1",
+  "version": "1.36.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",
@@ -203,6 +203,7 @@
     "react-layout-kit": "^1.9.0",
     "react-lazy-load": "^4.0.1",
     "react-pdf": "^9.1.1",
+    "react-scan": "^0.0.40",
     "react-virtuoso": "^4.12.0",
     "react-wrap-balancer": "^1.1.1",
     "remark": "^14.0.3",

package/src/app/(backend)/middleware/auth/index.test.ts

@@ -27,7 +27,7 @@ vi.mock('@/utils/server/jwt', () => ({
 describe('checkAuth', () => {
   const mockHandler: RequestHandler = vi.fn();
   const mockRequest = new Request('https://example.com');
-  const mockOptions = { params: { provider: 'mock' } };
+  const mockOptions = { params: Promise.resolve({ provider: 'mock' }) };
 
   beforeEach(() => {
     vi.clearAllMocks();

package/src/app/(backend)/middleware/auth/index.ts

@@ -11,7 +11,7 @@ import { getJWTPayload } from '@/utils/server/jwt';
 import { checkAuthMethod } from './utils';
 
 type CreateRuntime = (jwtPayload: JWTPayload) => AgentRuntime;
-type RequestOptions = { createRuntime?: CreateRuntime; params: { provider: string } };
+type RequestOptions = { createRuntime?: CreateRuntime; params: Promise<{ provider: string }> };
 
 export type RequestHandler = (
   req: Request,
@@ -56,7 +56,8 @@ export const checkAuth =
 
       const error = errorContent || e;
 
-      return createErrorResponse(errorType, { error, ...res, provider: options.params?.provider });
+      const params = await options.params;
+      return createErrorResponse(errorType, { error, ...res, provider: params?.provider });
     }
 
     return handler(req, { ...options, jwtPayload });

package/src/app/(backend)/webapi/assistant/[id]/route.ts

@@ -3,7 +3,11 @@ import { AssistantStore } from '@/server/modules/AssistantStore';
 
 export const runtime = 'edge';
 
-export const GET = async (req: Request, { params }: { params: { id: string } }) => {
+type Params = Promise<{ id: string }>;
+
+export const GET = async (req: Request, segmentData: { params: Params }) => {
+  const params = await segmentData.params;
+
   const { searchParams } = new URL(req.url);
 
   const locale = searchParams.get('locale');

package/src/app/(backend)/webapi/chat/[provider]/route.test.ts

@@ -58,7 +58,7 @@ afterEach(() => {
 describe('POST handler', () => {
   describe('init chat model', () => {
     it('should initialize AgentRuntime correctly with valid authorization', async () => {
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
 
       // 设置 getJWTPayload 和 initAgentRuntimeWithUserPayload 的模拟返回值
       vi.mocked(getJWTPayload).mockResolvedValueOnce({
@@ -83,7 +83,7 @@ describe('POST handler', () => {
     });
 
     it('should return Unauthorized error when LOBE_CHAT_AUTH_HEADER is missing', async () => {
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
       const requestWithoutAuthHeader = new Request(new URL('https://test.com'), {
         method: 'POST',
         body: JSON.stringify({ model: 'test-model' }),
@@ -110,7 +110,7 @@ describe('POST handler', () => {
         azureApiVersion: 'v1',
       });
 
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
       // 设置 initAgentRuntimeWithUserPayload 的模拟返回值
       vi.mocked(getAuth).mockReturnValue({} as any);
       vi.mocked(checkAuthMethod).mockReset();
@@ -141,7 +141,7 @@ describe('POST handler', () => {
     });
 
     it('should return InternalServerError error when throw a unknown error', async () => {
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
       vi.mocked(getJWTPayload).mockRejectedValueOnce(new Error('unknown error'));
 
       const response = await POST(request, { params: mockParams });
@@ -166,7 +166,7 @@ describe('POST handler', () => {
         userId: 'abc',
       });
 
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
       const mockChatPayload = { message: 'Hello, world!' };
       request = new Request(new URL('https://test.com'), {
         headers: { [LOBE_CHAT_AUTH_HEADER]: 'Bearer some-valid-token' },
@@ -192,7 +192,7 @@ describe('POST handler', () => {
         azureApiVersion: 'v1',
       });
 
-      const mockParams = { provider: 'test-provider' };
+      const mockParams = Promise.resolve({ provider: 'test-provider' });
       const mockChatPayload = { message: 'Hello, world!' };
       request = new Request(new URL('https://test.com'), {
         headers: { [LOBE_CHAT_AUTH_HEADER]: 'Bearer some-valid-token' },

package/src/app/(backend)/webapi/chat/[provider]/route.ts

@@ -13,7 +13,7 @@ import { getTracePayload } from '@/utils/trace';
 export const runtime = 'edge';
 
 export const POST = checkAuth(async (req: Request, { params, jwtPayload, createRuntime }) => {
-  const { provider } = params;
+  const { provider } = await params;
 
   try {
     // ============  1. init chat model   ============ //

package/src/app/(backend)/webapi/chat/anthropic/route.test.ts

@@ -23,6 +23,8 @@ describe('Anthropic POST function tests', () => {
   it('should call UniverseRoute with correct parameters', async () => {
     const mockRequest = new Request('https://example.com', { method: 'POST' });
     await POST(mockRequest);
-    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, { params: { provider: 'anthropic' } });
+    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, {
+      params: Promise.resolve({ provider: 'anthropic' }),
+    });
   });
 });

package/src/app/(backend)/webapi/chat/anthropic/route.ts

@@ -18,4 +18,4 @@ export const preferredRegion = [
 ];
 
 export const POST = async (req: Request) =>
-  UniverseRoute(req, { params: { provider: 'anthropic' } });
+  UniverseRoute(req, { params: Promise.resolve({ provider: 'anthropic' }) });

package/src/app/(backend)/webapi/chat/google/route.test.ts

@@ -28,6 +28,8 @@ describe('Google POST function tests', () => {
   it('should call UniverseRoute with correct parameters', async () => {
     const mockRequest = new Request('https://example.com', { method: 'POST' });
     await POST(mockRequest);
-    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, { params: { provider: 'google' } });
+    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, {
+      params: Promise.resolve({ provider: 'google' }),
+    });
   });
 });

package/src/app/(backend)/webapi/chat/google/route.ts

@@ -21,4 +21,5 @@ export const preferredRegion = [
   'gru1',
 ];
 
-export const POST = async (req: Request) => UniverseRoute(req, { params: { provider: 'google' } });
+export const POST = async (req: Request) =>
+  UniverseRoute(req, { params: Promise.resolve({ provider: 'google' }) });

package/src/app/(backend)/webapi/chat/minimax/route.test.ts

@@ -19,6 +19,8 @@ describe('Minimax POST function tests', () => {
   it('should call UniverseRoute with correct parameters', async () => {
     const mockRequest = new Request('https://example.com', { method: 'POST' });
     await POST(mockRequest);
-    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, { params: { provider: 'minimax' } });
+    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, {
+      params: Promise.resolve({ provider: 'minimax' }),
+    });
   });
 });

package/src/app/(backend)/webapi/chat/minimax/route.ts

@@ -2,4 +2,5 @@ import { POST as UniverseRoute } from '../[provider]/route';
 
 export const runtime = 'nodejs';
 
-export const POST = async (req: Request) => UniverseRoute(req, { params: { provider: 'minimax' } });
+export const POST = async (req: Request) =>
+  UniverseRoute(req, { params: Promise.resolve({ provider: 'minimax' }) });

package/src/app/(backend)/webapi/chat/models/[provider]/route.ts

@@ -12,7 +12,7 @@ const noNeedAPIKey = (provider: string) =>
   [ModelProvider.OpenRouter, ModelProvider.TogetherAI].includes(provider as any);
 
 export const GET = checkAuth(async (req, { params, jwtPayload }) => {
-  const { provider } = params;
+  const { provider } = await params;
 
   try {
     const hasDefaultApiKey = jwtPayload.apiKey || 'dont-need-api-key-for-model-list';

package/src/app/(backend)/webapi/chat/openai/route.test.ts

@@ -23,6 +23,8 @@ describe('OpenAI POST function tests', () => {
   it('should call UniverseRoute with correct parameters', async () => {
     const mockRequest = new Request('https://example.com', { method: 'POST' });
     await POST(mockRequest);
-    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, { params: { provider: 'openai' } });
+    expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, {
+      params: Promise.resolve({ provider: 'openai' }),
+    });
   });
 });

package/src/app/(backend)/webapi/chat/openai/route.ts

@@ -22,4 +22,5 @@ export const preferredRegion = [
   'syd1',
 ];
 
-export const POST = async (req: Request) => UniverseRoute(req, { params: { provider: 'openai' } });
+export const POST = async (req: Request) =>
+  UniverseRoute(req, { params: Promise.resolve({ provider: 'openai' }) });

package/src/app/(backend)/webapi/chat/wenxin/route.test.ts

@@ -21,7 +21,7 @@ describe('Wenxin POST function tests', () => {
     await POST(mockRequest);
     expect(UniverseRoute).toHaveBeenCalledWith(mockRequest, {
       createRuntime: expect.anything(),
-      params: { provider: 'wenxin' },
+      params: Promise.resolve({ provider: 'wenxin' }),
     });
   });
 });

package/src/app/(backend)/webapi/chat/wenxin/route.ts

@@ -26,5 +26,5 @@ export const POST = async (req: Request) =>
 
       return new AgentRuntime(instance);
     },
-    params: { provider: ModelProvider.Wenxin },
+    params: Promise.resolve({ provider: ModelProvider.Wenxin }),
   });

package/src/app/(backend)/webapi/text-to-image/[provider]/route.ts

@@ -48,7 +48,7 @@ export const preferredRegion = [
 // );
 
 export const POST = checkAuth(async (req: Request, { params, jwtPayload }) => {
-  const { provider } = params;
+  const { provider } = await params;
 
   try {
     // ============  1. init chat model   ============ //

package/src/components/Analytics/ReactScan.tsx

@@ -0,0 +1,11 @@
+import { Monitoring } from 'react-scan/dist/core/monitor/params/next';
+
+interface ReactScanProps {
+  apiKey: string;
+}
+
+const ReactScan = ({ apiKey }: ReactScanProps) => (
+  <Monitoring apiKey={apiKey} url="https://monitoring.react-scan.com/api/v1/ingest" />
+);
+
+export default ReactScan;

package/src/components/Analytics/index.tsx

@@ -9,6 +9,7 @@ const Plausible = dynamic(() => import('./Plausible'));
 const Posthog = dynamic(() => import('./Posthog'));
 const Umami = dynamic(() => import('./Umami'));
 const Clarity = dynamic(() => import('./Clarity'));
+const ReactScan = dynamic(() => import('./ReactScan'));
 
 const Analytics = () => {
   return (
@@ -37,6 +38,9 @@ const Analytics = () => {
       {analyticsEnv.ENABLED_CLARITY_ANALYTICS && (
         <Clarity projectId={analyticsEnv.CLARITY_PROJECT_ID} />
       )}
+      {!!analyticsEnv.REACT_SCAN_MONITOR_API_KEY && (
+        <ReactScan apiKey={analyticsEnv.REACT_SCAN_MONITOR_API_KEY} />
+      )}
     </>
   );
 };

package/src/config/analytics.ts

@@ -26,6 +26,8 @@ export const getAnalyticsConfig = () => {
 
       ENABLE_GOOGLE_ANALYTICS: z.boolean(),
       GOOGLE_ANALYTICS_MEASUREMENT_ID: z.string().optional(),
+
+      REACT_SCAN_MONITOR_API_KEY: z.string().optional(),
     },
     runtimeEnv: {
       // Plausible Analytics
@@ -55,6 +57,10 @@ export const getAnalyticsConfig = () => {
       // Google Analytics
       ENABLE_GOOGLE_ANALYTICS: !!process.env.GOOGLE_ANALYTICS_MEASUREMENT_ID,
       GOOGLE_ANALYTICS_MEASUREMENT_ID: process.env.GOOGLE_ANALYTICS_MEASUREMENT_ID,
+
+      // React Scan Monitor
+      // https://dashboard.react-scan.com
+      REACT_SCAN_MONITOR_API_KEY: process.env.REACT_SCAN_MONITOR_API_KEY,
     },
   });
 };

package/src/libs/agent-runtime/types/chat.ts

@@ -96,7 +96,14 @@ export interface ChatStreamPayload {
 
 export interface ChatCompetitionOptions {
   callback?: ChatStreamCallbacks;
+  /**
+   * response headers
+   */
   headers?: Record<string, any>;
+  /**
+   * send the request to the ai api endpoint
+   */
+  requestHeaders?: Record<string, any>;
   signal?: AbortSignal;
   /**
    * userId for the chat completion

package/src/libs/agent-runtime/utils/openaiCompatibleFactory/index.ts

@@ -211,7 +211,7 @@ export const LobeOpenAICompatibleFactory = <T extends Record<string, any> = any>
             },
             {
               // https://github.com/lobehub/lobe-chat/pull/318
-              headers: { Accept: '*/*' },
+              headers: { Accept: '*/*', ...options?.requestHeaders },
               signal: options?.signal,
             },
           );

package/src/utils/clientIP.test.ts

@@ -0,0 +1,54 @@
+import { describe, expect, it } from 'vitest';
+
+import { getClientIP } from './clientIP';
+
+describe('getClientIP', () => {
+  // Helper function to create Headers object
+  const createHeaders = (entries: [string, string][]) => {
+    return new Headers(entries);
+  };
+
+  it('should return null when no IP headers are present', () => {
+    const headers = createHeaders([]);
+    expect(getClientIP(headers)).toBe('');
+  });
+
+  it('should handle Cloudflare IP header', () => {
+    const headers = createHeaders([['cf-connecting-ip', '1.2.3.4']]);
+    expect(getClientIP(headers)).toBe('1.2.3.4');
+  });
+
+  it('should handle x-forwarded-for with single IP', () => {
+    const headers = createHeaders([['x-forwarded-for', '5.6.7.8']]);
+    expect(getClientIP(headers)).toBe('5.6.7.8');
+  });
+
+  it('should handle x-forwarded-for with multiple IPs and return the first one', () => {
+    const headers = createHeaders([['x-forwarded-for', '9.10.11.12, 13.14.15.16, 17.18.19.20']]);
+    expect(getClientIP(headers)).toBe('9.10.11.12');
+  });
+
+  it('should handle x-real-ip header', () => {
+    const headers = createHeaders([['x-real-ip', '21.22.23.24']]);
+    expect(getClientIP(headers)).toBe('21.22.23.24');
+  });
+
+  it('should trim whitespace from IP addresses', () => {
+    const headers = createHeaders([['x-client-ip', '  25.26.27.28  ']]);
+    expect(getClientIP(headers)).toBe('25.26.27.28');
+  });
+
+  it('should respect header priority order', () => {
+    const headers = createHeaders([
+      ['x-forwarded-for', '1.1.1.1'],
+      ['cf-connecting-ip', '2.2.2.2'], // Should take precedence
+      ['x-real-ip', '3.3.3.3'],
+    ]);
+    expect(getClientIP(headers)).toBe('2.2.2.2');
+  });
+
+  it('should handle empty x-forwarded-for value', () => {
+    const headers = createHeaders([['x-forwarded-for', '']]);
+    expect(getClientIP(headers)).toBe('');
+  });
+});

package/src/utils/clientIP.ts

@@ -0,0 +1,34 @@
+/**
+ * 获取客户端 IP
+ * @param headers HTTP 请求头
+ */
+export const getClientIP = (headers: Headers): string => {
+  // 按优先级顺序检查各种 IP 头
+  const ipHeaders = [
+    'cf-connecting-ip', // Cloudflare
+    'x-real-ip', // Nginx proxy
+    'x-forwarded-for', // 标准代理头
+    'x-client-ip', // Apache
+    'true-client-ip', // Akamai and Cloudflare
+    'x-cluster-client-ip', // 负载均衡
+    'forwarded', // RFC 7239
+    'fastly-client-ip', // Fastly CDN
+    'x-forwarded', // General forward
+    'x-original-forwarded-for', // Original forwarded
+  ];
+
+  for (const header of ipHeaders) {
+    const value = headers.get(header);
+    if (!value) continue;
+
+    // 处理可能包含多个 IP 的情况（比如 x-forwarded-for）
+    if (header.toLowerCase() === 'x-forwarded-for') {
+      const firstIP = value.split(',')[0].trim();
+      if (firstIP) return firstIP;
+    }
+
+    return value.trim();
+  }
+
+  return '';
+};