@lobehub/chat 1.36.2 → 1.36.3

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # 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>

package/changelog/v1.json

@@ -1,4 +1,13 @@
 [
+  {
+    "children": {
+      "fixes": [
+        "Support request headers for chat."
+      ]
+    },
+    "date": "2024-12-08",
+    "version": "1.36.3"
+  },
   {
     "children": {
       "improvements": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.36.2",
+  "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",

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 '';
+};