@lobehub/chat 1.97.17 → 1.98.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+## [Version 1.98.0](https://github.com/lobehub/lobe-chat/compare/v1.97.17...v1.98.0)
+
+<sup>Released on **2025-07-13**</sup>
+
+#### ✨ Features
+
+- **misc**: Add network proxy for desktop.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Add network proxy for desktop, closes [#7848](https://github.com/lobehub/lobe-chat/issues/7848) ([46d2509](https://github.com/lobehub/lobe-chat/commit/46d2509))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.97.17](https://github.com/lobehub/lobe-chat/compare/v1.97.16...v1.97.17)
 
 <sup>Released on **2025-07-13**</sup>

package/apps/desktop/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lobehub-desktop-dev",
-  "version": "0.0.10",
+  "version": "0.0.0",
   "description": "LobeHub Desktop Application",
   "homepage": "https://lobehub.com",
   "repository": {
@@ -24,6 +24,7 @@
     "lint": "eslint --cache ",
     "pg-server": "bun run scripts/pglite-server.ts",
     "start": "electron-vite preview",
+    "test": "vite --run",
     "typecheck": "tsgo --noEmit -p tsconfig.json"
   },
   "dependencies": {
@@ -45,10 +46,10 @@
     "@types/resolve": "^1.20.6",
     "@types/semver": "^7.7.0",
     "@types/set-cookie-parser": "^2.4.10",
-    "@typescript/native-preview": "latest",
+    "@typescript/native-preview": "7.0.0-dev.20250711.1",
     "consola": "^3.1.0",
     "cookie": "^1.0.2",
-    "electron": "^37.2.0",
+    "electron": "~37.1.0",
     "electron-builder": "^26.0.12",
     "electron-is": "^3.0.0",
     "electron-log": "^5.3.3",
@@ -58,17 +59,19 @@
     "fix-path": "^4.0.0",
     "just-diff": "^6.0.2",
     "lodash": "^4.17.21",
-    "pglite-server": "^0.1.4",
+    "lodash-es": "^4.17.21",
     "resolve": "^1.22.8",
     "semver": "^7.5.4",
     "set-cookie-parser": "^2.7.1",
     "tsx": "^4.19.3",
     "typescript": "^5.7.3",
+    "undici": "^7.9.0",
     "vite": "^6.2.5"
   },
   "pnpm": {
     "onlyBuiltDependencies": [
-      "electron"
+      "electron",
+      "electron-builder"
     ]
   }
 }

package/apps/desktop/src/main/const/store.ts

@@ -1,6 +1,8 @@
 /**
  * 应用设置存储相关常量
  */
+import { NetworkProxySettings } from '@lobechat/electron-client-ipc';
+
 import { appStorageDir } from '@/const/dir';
 import { DEFAULT_SHORTCUTS_CONFIG } from '@/shortcuts';
 import { ElectronMainStore } from '@/types/store';
@@ -10,6 +12,15 @@ import { ElectronMainStore } from '@/types/store';
  */
 export const STORE_NAME = 'lobehub-settings';
 
+export const defaultProxySettings: NetworkProxySettings = {
+  enableProxy: false,
+  proxyBypass: 'localhost, 127.0.0.1, ::1',
+  proxyPort: '',
+  proxyRequireAuth: false,
+  proxyServer: '',
+  proxyType: 'http',
+};
+
 /**
  * 存储默认值
  */
@@ -17,6 +28,7 @@ export const STORE_DEFAULTS: ElectronMainStore = {
   dataSyncConfig: { storageMode: 'local' },
   encryptedTokens: {},
   locale: 'auto',
+  networkProxy: defaultProxySettings,
   shortcuts: DEFAULT_SHORTCUTS_CONFIG,
   storagePath: appStorageDir,
 };

package/apps/desktop/src/main/controllers/NetworkProxyCtr.ts

@@ -0,0 +1,172 @@
+import { NetworkProxySettings } from '@lobechat/electron-client-ipc';
+import { merge } from 'lodash';
+import { isEqual } from 'lodash-es';
+
+import { defaultProxySettings } from '@/const/store';
+import { createLogger } from '@/utils/logger';
+
+import {
+  ProxyConfigValidator,
+  ProxyConnectionTester,
+  ProxyDispatcherManager,
+  ProxyTestResult,
+} from '../modules/networkProxy';
+import { ControllerModule, ipcClientEvent } from './index';
+
+// Create logger
+const logger = createLogger('controllers:NetworkProxyCtr');
+
+/**
+ * 网络代理控制器
+ * 处理桌面应用的网络代理相关功能
+ */
+export default class NetworkProxyCtr extends ControllerModule {
+  /**
+   * 获取代理设置
+   */
+  @ipcClientEvent('getProxySettings')
+  async getDesktopSettings(): Promise<NetworkProxySettings> {
+    try {
+      const settings = this.app.storeManager.get(
+        'networkProxy',
+        defaultProxySettings,
+      ) as NetworkProxySettings;
+      logger.debug('Retrieved proxy settings:', {
+        enableProxy: settings.enableProxy,
+        proxyType: settings.proxyType,
+      });
+      return settings;
+    } catch (error) {
+      logger.error('Failed to get proxy settings:', error);
+      return defaultProxySettings;
+    }
+  }
+
+  /**
+   * 设置代理配置
+   */
+  @ipcClientEvent('setProxySettings')
+  async setProxySettings(config: NetworkProxySettings): Promise<void> {
+    try {
+      // 验证配置
+      const validation = ProxyConfigValidator.validate(config);
+      if (!validation.isValid) {
+        const errorMessage = `Invalid proxy configuration: ${validation.errors.join(', ')}`;
+        logger.error(errorMessage);
+        throw new Error(errorMessage);
+      }
+
+      // 获取当前配置
+      const currentConfig = this.app.storeManager.get(
+        'networkProxy',
+        defaultProxySettings,
+      ) as NetworkProxySettings;
+
+      // 检查是否有变化
+      if (isEqual(currentConfig, config)) {
+        logger.debug('Proxy settings unchanged, skipping update');
+        return;
+      }
+
+      // 合并配置
+      const newConfig = merge({}, currentConfig, config);
+
+      // 应用代理设置
+      await ProxyDispatcherManager.applyProxySettings(newConfig);
+
+      // 保存到存储
+      this.app.storeManager.set('networkProxy', newConfig);
+
+      logger.info('Proxy settings updated successfully', {
+        enableProxy: newConfig.enableProxy,
+        proxyPort: newConfig.proxyPort,
+        proxyServer: newConfig.proxyServer,
+        proxyType: newConfig.proxyType,
+      });
+    } catch (error) {
+      logger.error('Failed to update proxy settings:', error);
+      throw error;
+    }
+  }
+
+  /**
+   * 测试代理连接
+   */
+  @ipcClientEvent('testProxyConnection')
+  async testProxyConnection(url: string): Promise<{ message?: string; success: boolean }> {
+    try {
+      const result = await ProxyConnectionTester.testConnection(url);
+
+      if (result.success) {
+        return { success: true };
+      } else {
+        throw new Error(result.message || 'Connection test failed');
+      }
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      logger.error('Proxy connection test failed:', errorMessage);
+      throw new Error(`Connection failed: ${errorMessage}`);
+    }
+  }
+
+  /**
+   * 测试指定代理配置
+   */
+  @ipcClientEvent('testProxyConfig')
+  async testProxyConfig({
+    config,
+    testUrl,
+  }: {
+    config: NetworkProxySettings;
+    testUrl?: string;
+  }): Promise<ProxyTestResult> {
+    try {
+      return await ProxyConnectionTester.testProxyConfig(config, testUrl);
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      logger.error('Proxy config test failed:', errorMessage);
+      return {
+        message: `Proxy config test failed: ${errorMessage}`,
+        success: false,
+      };
+    }
+  }
+
+  /**
+   * 应用初始代理设置
+   */
+  async afterAppReady(): Promise<void> {
+    try {
+      // 获取存储的代理设置
+      const networkProxy = this.app.storeManager.get(
+        'networkProxy',
+        defaultProxySettings,
+      ) as NetworkProxySettings;
+
+      // 验证配置
+      const validation = ProxyConfigValidator.validate(networkProxy);
+      if (!validation.isValid) {
+        logger.warn('Invalid stored proxy configuration, using defaults:', validation.errors);
+        await ProxyDispatcherManager.applyProxySettings(defaultProxySettings);
+        return;
+      }
+
+      // 应用代理设置
+      await ProxyDispatcherManager.applyProxySettings(networkProxy);
+
+      logger.info('Initial proxy settings applied successfully', {
+        enableProxy: networkProxy.enableProxy,
+        proxyType: networkProxy.proxyType,
+      });
+    } catch (error) {
+      logger.error('Failed to apply initial proxy settings:', error);
+      // 出错时使用默认设置
+      try {
+        await ProxyDispatcherManager.applyProxySettings(defaultProxySettings);
+        logger.info('Fallback to default proxy settings');
+      } catch (fallbackError) {
+        logger.error('Failed to apply fallback proxy settings:', fallbackError);
+      }
+    }
+  }
+}

package/apps/desktop/src/main/controllers/__tests__/NetworkProxyCtr.test.ts

@@ -0,0 +1,401 @@
+import { NetworkProxySettings } from '@lobechat/electron-client-ipc';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import type { App } from '@/core/App';
+
+import NetworkProxyCtr from '../NetworkProxyCtr';
+
+// 模拟 logger
+vi.mock('@/utils/logger', () => ({
+  createLogger: () => ({
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  }),
+}));
+
+// 模拟 undici
+vi.mock('undici', () => ({
+  fetch: vi.fn(),
+  getGlobalDispatcher: vi.fn(),
+  setGlobalDispatcher: vi.fn(),
+  ProxyAgent: vi.fn(),
+}));
+
+// 模拟 defaultProxySettings
+vi.mock('@/const/store', () => ({
+  defaultProxySettings: {
+    enableProxy: false,
+    proxyBypass: 'localhost,127.0.0.1,::1',
+    proxyPort: '',
+    proxyRequireAuth: false,
+    proxyServer: '',
+    proxyType: 'http',
+  },
+}));
+
+// 模拟 fetch
+global.fetch = vi.fn();
+
+// 模拟 App 及其依赖项
+const mockStoreManager = {
+  get: vi.fn(),
+  set: vi.fn(),
+};
+
+const mockApp = {
+  storeManager: mockStoreManager,
+} as unknown as App;
+
+describe('NetworkProxyCtr', () => {
+  let networkProxyCtr: NetworkProxyCtr;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    networkProxyCtr = new NetworkProxyCtr(mockApp);
+
+    // 重置全局 fetch mock
+    (global.fetch as any).mockReset();
+  });
+
+  describe('ProxyConfigValidator', () => {
+    const validConfig: NetworkProxySettings = {
+      enableProxy: true,
+      proxyType: 'http',
+      proxyServer: 'proxy.example.com',
+      proxyPort: '8080',
+      proxyRequireAuth: false,
+      proxyBypass: 'localhost,127.0.0.1,::1',
+    };
+
+    it('should validate enabled proxy config with all required fields', () => {
+      // 通过测试公共方法来间接测试验证逻辑
+      expect(() => networkProxyCtr.setProxySettings(validConfig)).not.toThrow();
+    });
+
+    it('should validate disabled proxy config', () => {
+      const disabledConfig: NetworkProxySettings = {
+        ...validConfig,
+        enableProxy: false,
+      };
+
+      expect(() => networkProxyCtr.setProxySettings(disabledConfig)).not.toThrow();
+    });
+
+    it('should reject invalid proxy type', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyType: 'invalid' as any,
+      };
+
+      await expect(networkProxyCtr.setProxySettings(invalidConfig)).rejects.toThrow();
+    });
+
+    it('should reject missing proxy server', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyServer: '',
+      };
+
+      await expect(networkProxyCtr.setProxySettings(invalidConfig)).rejects.toThrow();
+    });
+
+    it('should reject invalid proxy port', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyPort: 'invalid',
+      };
+
+      await expect(networkProxyCtr.setProxySettings(invalidConfig)).rejects.toThrow();
+    });
+
+    it('should reject missing auth credentials when auth is required', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyRequireAuth: true,
+        proxyUsername: '',
+        proxyPassword: '',
+      };
+
+      await expect(networkProxyCtr.setProxySettings(invalidConfig)).rejects.toThrow();
+    });
+  });
+
+  describe('getDesktopSettings', () => {
+    it('should return stored proxy settings', async () => {
+      const expectedSettings: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: 'proxy.example.com',
+        proxyPort: '8080',
+        proxyRequireAuth: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      mockStoreManager.get.mockReturnValue(expectedSettings);
+
+      const result = await networkProxyCtr.getDesktopSettings();
+
+      expect(result).toEqual(expectedSettings);
+      expect(mockStoreManager.get).toHaveBeenCalledWith('networkProxy', expect.any(Object));
+    });
+
+    it('should return default settings when store fails', async () => {
+      mockStoreManager.get.mockImplementation(() => {
+        throw new Error('Store error');
+      });
+
+      const result = await networkProxyCtr.getDesktopSettings();
+
+      expect(result).toEqual({
+        enableProxy: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+        proxyPort: '',
+        proxyRequireAuth: false,
+        proxyServer: '',
+        proxyType: 'http',
+      });
+    });
+  });
+
+  describe('setProxySettings', () => {
+    const validConfig: NetworkProxySettings = {
+      enableProxy: true,
+      proxyType: 'http',
+      proxyServer: 'proxy.example.com',
+      proxyPort: '8080',
+      proxyRequireAuth: false,
+      proxyBypass: 'localhost,127.0.0.1,::1',
+    };
+
+    it('should save valid proxy settings', async () => {
+      mockStoreManager.get.mockReturnValue({
+        enableProxy: false,
+        proxyType: 'http',
+        proxyServer: '',
+        proxyPort: '',
+        proxyRequireAuth: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      });
+
+      await networkProxyCtr.setProxySettings(validConfig);
+
+      expect(mockStoreManager.set).toHaveBeenCalledWith(
+        'networkProxy',
+        expect.objectContaining(validConfig),
+      );
+    });
+
+    it('should skip update if settings are unchanged', async () => {
+      mockStoreManager.get.mockReturnValue(validConfig);
+
+      await networkProxyCtr.setProxySettings(validConfig);
+
+      expect(mockStoreManager.set).not.toHaveBeenCalled();
+    });
+
+    it('should throw error for invalid configuration', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyServer: '',
+      };
+
+      await expect(networkProxyCtr.setProxySettings(invalidConfig)).rejects.toThrow();
+    });
+  });
+
+  describe('testProxyConnection', () => {
+    it('should return success for successful connection', async () => {
+      const mockResponse = {
+        ok: true,
+        status: 200,
+        statusText: 'OK',
+      };
+
+      (global.fetch as any).mockResolvedValueOnce(mockResponse);
+
+      const result = await networkProxyCtr.testProxyConnection('https://www.google.com');
+
+      expect(result).toEqual({ success: true });
+      expect(global.fetch).toHaveBeenCalledWith('https://www.google.com', expect.any(Object));
+    });
+
+    it('should throw error for failed connection', async () => {
+      const mockResponse = {
+        ok: false,
+        status: 404,
+        statusText: 'Not Found',
+      };
+
+      (global.fetch as any).mockResolvedValueOnce(mockResponse);
+
+      await expect(networkProxyCtr.testProxyConnection('https://www.google.com')).rejects.toThrow();
+    });
+
+    it('should throw error for network error', async () => {
+      (global.fetch as any).mockRejectedValueOnce(new Error('Network error'));
+
+      await expect(networkProxyCtr.testProxyConnection('https://www.google.com')).rejects.toThrow();
+    });
+  });
+
+  describe('testProxyConfig', () => {
+    const validConfig: NetworkProxySettings = {
+      enableProxy: true,
+      proxyType: 'http',
+      proxyServer: 'proxy.example.com',
+      proxyPort: '8080',
+      proxyRequireAuth: false,
+      proxyBypass: 'localhost,127.0.0.1,::1',
+    };
+
+    it('should return success for valid config and successful connection', async () => {
+      const mockResponse = {
+        ok: true,
+        status: 200,
+        statusText: 'OK',
+      };
+
+      (global.fetch as any).mockResolvedValueOnce(mockResponse);
+
+      const result = await networkProxyCtr.testProxyConfig({ config: validConfig });
+
+      expect(result.success).toBe(true);
+      expect(result.responseTime).toBeGreaterThanOrEqual(0);
+    });
+
+    it('should return failure for invalid config', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        ...validConfig,
+        proxyServer: '',
+      };
+
+      const result = await networkProxyCtr.testProxyConfig({ config: invalidConfig });
+
+      expect(result.success).toBe(false);
+      expect(result.message).toContain('Invalid proxy configuration');
+    });
+
+    it('should test direct connection for disabled proxy', async () => {
+      const disabledConfig: NetworkProxySettings = {
+        ...validConfig,
+        enableProxy: false,
+      };
+
+      const mockResponse = {
+        ok: true,
+        status: 200,
+        statusText: 'OK',
+      };
+
+      (global.fetch as any).mockResolvedValueOnce(mockResponse);
+
+      const result = await networkProxyCtr.testProxyConfig({ config: disabledConfig });
+
+      expect(result.success).toBe(true);
+    });
+
+    it('should return failure for connection error', async () => {
+      (global.fetch as any).mockRejectedValueOnce(new Error('Connection failed'));
+
+      const result = await networkProxyCtr.testProxyConfig({ config: validConfig });
+
+      expect(result.success).toBe(false);
+      expect(result.message).toContain('Connection failed');
+    });
+  });
+
+  describe('afterAppReady', () => {
+    it('should apply stored proxy settings on app ready', async () => {
+      const storedConfig: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: 'proxy.example.com',
+        proxyPort: '8080',
+        proxyRequireAuth: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      mockStoreManager.get.mockReturnValue(storedConfig);
+
+      await networkProxyCtr.afterAppReady();
+
+      expect(mockStoreManager.get).toHaveBeenCalledWith('networkProxy', expect.any(Object));
+    });
+
+    it('should use default settings if stored config is invalid', async () => {
+      const invalidConfig: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: '', // 无效的服务器
+        proxyPort: '8080',
+        proxyRequireAuth: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      mockStoreManager.get.mockReturnValue(invalidConfig);
+
+      await networkProxyCtr.afterAppReady();
+
+      expect(mockStoreManager.get).toHaveBeenCalledWith('networkProxy', expect.any(Object));
+    });
+
+    it('should handle errors gracefully', async () => {
+      mockStoreManager.get.mockImplementation(() => {
+        throw new Error('Store error');
+      });
+
+      // 不应该抛出错误
+      await expect(networkProxyCtr.afterAppReady()).resolves.not.toThrow();
+    });
+  });
+
+  describe('ProxyUrlBuilder', () => {
+    it('should build URL without authentication', () => {
+      const config: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: 'proxy.example.com',
+        proxyPort: '8080',
+        proxyRequireAuth: false,
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      // 通过测试代理设置来间接测试 URL 构建
+      expect(() => networkProxyCtr.setProxySettings(config)).not.toThrow();
+    });
+
+    it('should build URL with authentication', () => {
+      const config: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: 'proxy.example.com',
+        proxyPort: '8080',
+        proxyRequireAuth: true,
+        proxyUsername: 'user',
+        proxyPassword: 'pass',
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      // 通过测试代理设置来间接测试 URL 构建
+      expect(() => networkProxyCtr.setProxySettings(config)).not.toThrow();
+    });
+
+    it('should handle special characters in credentials', () => {
+      const config: NetworkProxySettings = {
+        enableProxy: true,
+        proxyType: 'http',
+        proxyServer: 'proxy.example.com',
+        proxyPort: '8080',
+        proxyRequireAuth: true,
+        proxyUsername: 'user@domain',
+        proxyPassword: 'pass:word',
+        proxyBypass: 'localhost,127.0.0.1,::1',
+      };
+
+      // 通过测试代理设置来间接测试 URL 构建
+      expect(() => networkProxyCtr.setProxySettings(config)).not.toThrow();
+    });
+  });
+});

package/apps/desktop/src/main/core/Browser.ts

@@ -381,6 +381,8 @@ export default class Browser {
   }
 
   broadcast = <T extends MainBroadcastEventKey>(channel: T, data?: MainBroadcastParams<T>) => {
+    if (this._browserWindow.isDestroyed()) return;
+
     logger.debug(`Broadcasting to window ${this.identifier}, channel: ${channel}`);
     this._browserWindow.webContents.send(channel, data);
   };