@lobehub/chat 1.84.23 → 1.84.25

package/packages/electron-server-ipc/src/ipcServer.test.ts

@@ -0,0 +1,417 @@
+import fs from 'node:fs';
+import net from 'node:net';
+import os from 'node:os';
+import path from 'node:path';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { ElectronIPCServer } from './ipcServer';
+
+// Mock node modules
+vi.mock('node:fs');
+vi.mock('node:net');
+vi.mock('node:os');
+vi.mock('node:path');
+
+const appId = 'lobehub';
+
+describe('ElectronIPCServer', () => {
+  // Mock data
+  const mockTempDir = '/mock/temp/dir';
+  const mockSocketPath = '/mock/temp/dir/lobehub-electron-ipc.sock';
+  const mockSocketInfoPath = '/mock/temp/dir/lobehub-electron-ipc-info.json';
+
+  // Mock server and socket
+  const mockServer = {
+    on: vi.fn(),
+    listen: vi.fn(),
+    close: vi.fn(),
+  };
+
+  const mockSocket = {
+    on: vi.fn(),
+    write: vi.fn(),
+  };
+
+  // Mock event handler
+  const mockEventHandler = {
+    testMethod: vi.fn(),
+    getStaticFilePath: vi.fn(),
+  };
+
+  beforeEach(() => {
+    // Reset all mocks
+    vi.resetAllMocks();
+
+    // 使用模拟定时器
+    vi.useFakeTimers();
+
+    // Setup common mocks
+    vi.mocked(os.tmpdir).mockReturnValue(mockTempDir);
+    vi.mocked(path.join).mockImplementation((...args) => args.join('/'));
+    vi.mocked(net.createServer).mockReturnValue(mockServer as unknown as net.Server);
+
+    // Mock socket path for different platforms
+    const originalPlatform = process.platform;
+    Object.defineProperty(process, 'platform', { value: 'darwin' });
+
+    // Mock fs functions
+    vi.mocked(fs.existsSync).mockReturnValue(false);
+    vi.mocked(fs.unlinkSync).mockReturnValue(undefined);
+    vi.mocked(fs.writeFileSync).mockReturnValue(undefined);
+
+    // Mock console methods
+    vi.spyOn(console, 'error').mockImplementation(() => {});
+    vi.spyOn(console, 'log').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+    vi.useRealTimers();
+  });
+
+  describe('server initialization and start', () => {
+    it('should create server and start listening', async () => {
+      // Setup
+      mockServer.listen.mockImplementation((path, callback) => {
+        callback?.();
+        return mockServer;
+      });
+
+      // Execute
+      const server = new ElectronIPCServer(appId, mockEventHandler as any);
+      await server.start();
+
+      // Verify
+      expect(net.createServer).toHaveBeenCalled();
+      expect(mockServer.listen).toHaveBeenCalledWith(mockSocketPath, expect.any(Function));
+      expect(fs.writeFileSync).toHaveBeenCalledWith(
+        mockSocketInfoPath,
+        JSON.stringify({ socketPath: mockSocketPath }),
+        'utf8',
+      );
+    });
+
+    it('should remove existing socket file if it exists', async () => {
+      // Setup
+      vi.mocked(fs.existsSync).mockReturnValue(true);
+      mockServer.listen.mockImplementation((path, callback) => {
+        callback?.();
+        return mockServer;
+      });
+
+      // Execute
+      const server = new ElectronIPCServer(appId, mockEventHandler as any);
+
+      // Verify
+      expect(fs.existsSync).toHaveBeenCalledWith(mockSocketPath);
+      expect(fs.unlinkSync).toHaveBeenCalledWith(mockSocketPath);
+    });
+
+    it('should handle server start error', async () => {
+      // Setup
+      const mockError = new Error('Server start error');
+      mockServer.on.mockImplementation((event, callback) => {
+        if (event === 'error') {
+          callback(mockError);
+        }
+        return mockServer;
+      });
+
+      // Execute and verify
+      const server = new ElectronIPCServer(appId, mockEventHandler as any);
+      await expect(server.start()).rejects.toThrow('Server start error');
+    });
+  });
+
+  describe('connection and message handling', () => {
+    let server: ElectronIPCServer;
+    let connectionHandler: Function;
+
+    beforeEach(() => {
+      // Setup connection handler capture
+      mockServer.on.mockReset();
+      mockSocket.on.mockReset();
+      mockSocket.write.mockReset();
+
+      vi.mocked(net.createServer).mockImplementation((handler) => {
+        connectionHandler = handler as any;
+        return mockServer as unknown as net.Server;
+      });
+
+      mockServer.listen.mockImplementation((path, callback) => {
+        callback?.();
+        return mockServer;
+      });
+
+      // Create server
+      server = new ElectronIPCServer(appId, mockEventHandler as any);
+    });
+
+    it('should handle client connection and setup data listeners', async () => {
+      // Start server
+      await server.start();
+
+      // Simulate connection
+      connectionHandler(mockSocket);
+
+      // Verify socket listeners setup
+      expect(mockSocket.on).toHaveBeenCalledWith('data', expect.any(Function));
+      expect(mockSocket.on).toHaveBeenCalledWith('error', expect.any(Function));
+      expect(mockSocket.on).toHaveBeenCalledWith('close', expect.any(Function));
+    });
+
+    it('should parse messages with \n separator and execute handler', async () => {
+      // Setup mock handler
+      mockEventHandler.testMethod.mockResolvedValue('success');
+
+      // Start server
+      await server.start();
+
+      // Simulate connection
+      connectionHandler(mockSocket);
+
+      // Get data handler
+      const dataHandlerCall = mockSocket.on.mock.calls.find((call) => call[0] === 'data');
+      expect(dataHandlerCall).toBeDefined();
+      const dataHandler = dataHandlerCall![1];
+
+      // Create test message
+      const message =
+        JSON.stringify({
+          id: 'test-id',
+          method: 'testMethod',
+          params: { key: 'value' },
+        }) + '\n';
+
+      // Send message
+      await dataHandler(Buffer.from(message));
+
+      // 确保异步处理完成
+      await vi.runAllTimersAsync();
+
+      // Verify handler execution
+      expect(mockEventHandler.testMethod).toHaveBeenCalledWith(
+        { key: 'value' },
+        expect.objectContaining({
+          id: 'test-id',
+          method: 'testMethod',
+          socket: mockSocket,
+        }),
+      );
+
+      // 触发服务器端处理程序执行
+      const pendingHandlerPromise = mockEventHandler.testMethod.mock.results[0].value;
+      await pendingHandlerPromise;
+
+      // Verify response format with \n\n separator
+      expect(mockSocket.write).toHaveBeenCalledWith(
+        JSON.stringify({ id: 'test-id', result: 'success' }) + '\n\n',
+      );
+    });
+
+    it('should handle multiple messages in single data chunk', async () => {
+      // Setup mock handlers with resolved values
+      mockEventHandler.testMethod.mockResolvedValue('success1');
+      mockEventHandler.getStaticFilePath.mockResolvedValue('path/to/file');
+
+      // Start server
+      await server.start();
+
+      // Simulate connection
+      connectionHandler(mockSocket);
+
+      // Get data handler
+      const dataHandlerCall = mockSocket.on.mock.calls.find((call) => call[0] === 'data');
+      expect(dataHandlerCall).toBeDefined();
+      const dataHandler = dataHandlerCall![1];
+
+      // Create multiple messages in one chunk
+      const message1 =
+        JSON.stringify({
+          id: 'id1',
+          method: 'testMethod',
+          params: { key1: 'value1' },
+        }) + '\n\n';
+
+      const message2 =
+        JSON.stringify({
+          id: 'id2',
+          method: 'getStaticFilePath',
+          params: 'path/param',
+        }) + '\n\n';
+
+      // Send combined message
+      await dataHandler(Buffer.from(message1 + message2));
+
+      // 确保异步处理完成
+      await vi.runAllTimersAsync();
+
+      // Verify both handlers were executed
+      expect(mockEventHandler.testMethod).toHaveBeenCalledWith(
+        { key1: 'value1' },
+        expect.objectContaining({ id: 'id1', method: 'testMethod' }),
+      );
+
+      expect(mockEventHandler.getStaticFilePath).toHaveBeenCalledWith(
+        'path/param',
+        expect.objectContaining({ id: 'id2', method: 'getStaticFilePath' }),
+      );
+
+      // 等待处理程序完成
+      const promise1 = mockEventHandler.testMethod.mock.results[0].value;
+      const promise2 = mockEventHandler.getStaticFilePath.mock.results[0].value;
+      await Promise.all([promise1, promise2]);
+
+      // Verify responses
+      expect(mockSocket.write).toHaveBeenCalledTimes(2);
+      expect(mockSocket.write).toHaveBeenCalledWith(
+        JSON.stringify({ id: 'id1', result: 'success1' }) + '\n\n',
+      );
+      expect(mockSocket.write).toHaveBeenCalledWith(
+        JSON.stringify({ id: 'id2', result: 'path/to/file' }) + '\n\n',
+      );
+    });
+
+    it('should handle partial messages and buffer them', async () => {
+      // Setup mock handler
+      mockEventHandler.testMethod.mockResolvedValue('success');
+
+      // Start server
+      await server.start();
+
+      // Simulate connection
+      connectionHandler(mockSocket);
+
+      // Get data handler
+      const dataHandlerCall = mockSocket.on.mock.calls.find((call) => call[0] === 'data');
+      expect(dataHandlerCall).toBeDefined();
+      const dataHandler = dataHandlerCall![1];
+
+      // Create partial message (first half)
+      const fullMessage =
+        JSON.stringify({
+          id: 'test-id',
+          method: 'testMethod',
+          params: { data: 'test' },
+        }) + '\n\n';
+
+      const firstHalf = fullMessage.substring(0, 20);
+      await dataHandler(Buffer.from(firstHalf));
+
+      // 确保异步处理完成
+      await vi.runAllTimersAsync();
+
+      // Verify no handler calls yet
+      expect(mockEventHandler.testMethod).not.toHaveBeenCalled();
+
+      // Send second half
+      const secondHalf = fullMessage.substring(20);
+      await dataHandler(Buffer.from(secondHalf));
+
+      // 确保异步处理完成
+      await vi.runAllTimersAsync();
+
+      // Now handler should be called
+      expect(mockEventHandler.testMethod).toHaveBeenCalledWith(
+        { data: 'test' },
+        expect.objectContaining({ id: 'test-id' }),
+      );
+
+      // 等待处理程序完成
+      const pendingHandlerPromise = mockEventHandler.testMethod.mock.results[0].value;
+      await pendingHandlerPromise;
+
+      // 验证响应发送
+      expect(mockSocket.write).toHaveBeenCalledWith(
+        JSON.stringify({ id: 'test-id', result: 'success' }) + '\n\n',
+      );
+    });
+
+    it('should handle errors from method handlers', async () => {
+      // Setup mock handler to throw error
+      const mockError = new Error('Handler error');
+      mockEventHandler.testMethod.mockRejectedValue(mockError);
+
+      // Start server
+      await server.start();
+
+      // Simulate connection
+      connectionHandler(mockSocket);
+
+      // Get data handler
+      const dataHandlerCall = mockSocket.on.mock.calls.find((call) => call[0] === 'data');
+      expect(dataHandlerCall).toBeDefined();
+      const dataHandler = dataHandlerCall![1];
+
+      // Create test message
+      const message =
+        JSON.stringify({
+          id: 'test-id',
+          method: 'testMethod',
+          params: {},
+        }) + '\n\n';
+
+      // Send message
+      await dataHandler(Buffer.from(message));
+
+      // 确保异步处理完成
+      await vi.runAllTimersAsync();
+
+      // 等待Promise被拒绝
+      try {
+        const pendingHandlerPromise = mockEventHandler.testMethod.mock.results[0].value;
+        await pendingHandlerPromise;
+      } catch (error) {
+        // 错误预期会被捕获
+      }
+
+      // Verify error response
+      expect(mockSocket.write).toHaveBeenCalledWith(
+        expect.stringContaining(
+          '{"error":"Failed to handle method(testMethod): Handler error","id":"test-id"}\n\n',
+        ),
+      );
+    });
+  });
+
+  describe('server close', () => {
+    it('should close server and clean up socket file', async () => {
+      // Setup
+      mockServer.listen.mockImplementation((path, callback) => {
+        callback?.();
+        return mockServer;
+      });
+
+      // 明确模拟关闭回调
+      mockServer.close.mockImplementation((callback) => {
+        if (callback) {
+          setTimeout(() => callback(), 0);
+        }
+        return mockServer;
+      });
+
+      // 为非Windows环境设置平台
+      Object.defineProperty(process, 'platform', { value: 'darwin' });
+
+      // 模拟文件存在
+      vi.mocked(fs.existsSync).mockReturnValue(true);
+
+      // Execute
+      const server = new ElectronIPCServer(appId, mockEventHandler as any);
+      await server.start();
+
+      // 调用关闭方法
+      const closePromise = server.close();
+
+      // 运行所有计时器使关闭回调触发
+      await vi.runAllTimersAsync();
+
+      // 等待关闭完成
+      await closePromise;
+
+      // Verify
+      expect(mockServer.close).toHaveBeenCalled();
+      expect(fs.unlinkSync).toHaveBeenCalledWith(mockSocketPath);
+    });
+  });
+});

package/packages/electron-server-ipc/src/ipcServer.ts

@@ -70,20 +70,25 @@ export class ElectronIPCServer {
       log('Received data chunk, size: %d bytes', chunk.length);
       dataBuffer += chunk;
 
-      try {
-        // 尝试解析 JSON 消息
-        const message = JSON.parse(dataBuffer);
-        log('Successfully parsed JSON message: %o', {
-          id: message.id,
-          method: message.method,
-        });
-        dataBuffer = ''; // 重置缓冲区
-
-        // 处理请求
-        this.handleRequest(socket, message);
-      } catch {
-        // 如果不是有效的 JSON，可能是消息不完整，继续等待
-        log('Incomplete or invalid JSON, buffering for more data');
+      // 按 \n\n 分割消息
+      const messages = dataBuffer.split('\n');
+      // 保留最后一个可能不完整的消息
+      dataBuffer = messages.pop() || '';
+
+      // 处理每个完整的消息
+      for (const message of messages) {
+        if (!message.trim()) continue;
+
+        try {
+          const parsedMessage = JSON.parse(message);
+          log('Successfully parsed JSON message: %o', {
+            id: parsedMessage.id,
+            method: parsedMessage.method,
+          });
+          this.handleRequest(socket, parsedMessage);
+        } catch (err) {
+          console.error('Failed to parse message: %s', err);
+        }
       }
     });
 
@@ -123,14 +128,14 @@ export class ElectronIPCServer {
 
   // 发送结果
   private sendResult(socket: net.Socket, id: string, result: any): void {
-    const response = JSON.stringify({ id, result }) + '\n';
+    const response = JSON.stringify({ id, result }) + '\n\n';
     log('Sending success response for ID: %s, size: %d bytes', id, response.length);
     socket.write(response);
   }
 
   // 发送错误
   private sendError(socket: net.Socket, id: string, error: string): void {
-    const response = JSON.stringify({ error, id }) + '\n';
+    const response = JSON.stringify({ error, id }) + '\n\n';
     log('Sending error response for ID: %s: %s', id, error);
     socket.write(response);
   }

package/src/const/hotkeys.ts

@@ -11,6 +11,13 @@ const combineKeys = (keys: string[]) => keys.join('+');
 // mod 在 Mac 上是 command 键，alt 在 Win 上是 ctrl 键
 export const HOTKEYS_REGISTRATION: HotkeyRegistration = [
   // basic
+  {
+    group: HotkeyGroupEnum.Essential,
+    id: HotkeyEnum.ShowApp,
+    keys: combineKeys([KeyEnum.Mod, 'e']),
+    nonEditable: true,
+    scopes: [HotkeyScopeEnum.Global],
+  },
   {
     group: HotkeyGroupEnum.Essential,
     id: HotkeyEnum.Search,

package/src/const/url.ts

@@ -17,7 +17,7 @@ export const OG_URL = '/og/cover.png?v=1';
 
 export const GITHUB = pkg.homepage;
 export const GITHUB_ISSUES = urlJoin(GITHUB, 'issues/new/choose');
-export const CHANGELOG = urlJoin(GITHUB, 'blob/main/CHANGELOG.md');
+export const CHANGELOG = 'https://lobehub.com/changelog';
 export const DOCKER_IMAGE = 'https://hub.docker.com/r/lobehub/lobe-chat';
 
 export const DOCUMENTS = urlJoin(OFFICIAL_SITE, '/docs');

package/src/features/User/UserPanel/useMenu.tsx

@@ -25,6 +25,7 @@ import { enableAuth } from '@/const/auth';
 import { LOBE_CHAT_CLOUD } from '@/const/branding';
 import { DEFAULT_HOTKEY_CONFIG } from '@/const/settings';
 import {
+  CHANGELOG,
   DISCORD,
   DOCUMENTS_REFER_URL,
   EMAIL_SUPPORT,
@@ -144,7 +145,7 @@ export const useMenu = () => {
     {
       icon: <Icon icon={FileClockIcon} />,
       key: 'changelog',
-      label: <Link href={'/changelog/modal'}>{t('changelog')}</Link>,
+      label: <Link href={isDesktop ? CHANGELOG : '/changelog/modal'}>{t('changelog')}</Link>,
     },
     {
       children: [

package/src/locales/default/hotkey.ts

@@ -37,6 +37,10 @@ const hotkey: HotkeyI18nTranslations = {
     desc: '唤起当前页面主要搜索框',
     title: '搜索',
   },
+  showApp: {
+    desc: '快速唤起应用主窗口',
+    title: '显示主窗口',
+  },
   switchAgent: {
     desc: '通过按住 Ctrl 加数字 0~9 切换固定在侧边栏的助手',
     title: '快捷切换助手',

package/src/services/__tests__/_url.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest';
+
+import { API_ENDPOINTS } from '../_url';
+
+describe('API_ENDPOINTS', () => {
+  it('should return correct basePath URLs', () => {
+    expect(API_ENDPOINTS.oauth).toBe('/api/auth');
+    expect(API_ENDPOINTS.proxy).toBe('/webapi/proxy');
+    expect(API_ENDPOINTS.gateway).toBe('/webapi/plugin/gateway');
+    expect(API_ENDPOINTS.trace).toBe('/webapi/trace');
+    expect(API_ENDPOINTS.stt).toBe('/webapi/stt/openai');
+    expect(API_ENDPOINTS.tts).toBe('/webapi/tts/openai');
+    expect(API_ENDPOINTS.edge).toBe('/webapi/tts/edge');
+    expect(API_ENDPOINTS.microsoft).toBe('/webapi/tts/microsoft');
+  });
+
+  it('should return correct dynamic URLs', () => {
+    expect(API_ENDPOINTS.chat('openai')).toBe('/webapi/chat/openai');
+    expect(API_ENDPOINTS.models('anthropic')).toBe('/webapi/models/anthropic');
+    expect(API_ENDPOINTS.modelPull('azure')).toBe('/webapi/models/azure/pull');
+    expect(API_ENDPOINTS.images('dalle')).toBe('/webapi/text-to-image/dalle');
+  });
+});

package/src/types/hotkey.ts

@@ -66,6 +66,7 @@ export const HotkeyEnum = {
   RegenerateMessage: 'regenerateMessage',
   SaveTopic: 'saveTopic',
   Search: 'search',
+  ShowApp: 'showApp',
   SwitchAgent: 'switchAgent',
   ToggleLeftPanel: 'toggleLeftPanel',
   ToggleRightPanel: 'toggleRightPanel',

package/vitest.config.ts

@@ -1,4 +1,4 @@
-import { resolve } from 'node:path';
+import { join, resolve } from 'node:path';
 import { coverageConfigDefaults, defineConfig } from 'vitest/config';
 
 export default defineConfig({
@@ -32,6 +32,7 @@ export default defineConfig({
       '**/node_modules/**',
       '**/dist/**',
       '**/build/**',
+      '**/apps/desktop/**',
       'src/database/server/**/**',
       'src/database/repositories/dataImporter/deprecated/**/**',
     ],
@@ -41,6 +42,6 @@ export default defineConfig({
         inline: ['vitest-canvas-mock'],
       },
     },
-    setupFiles: './tests/setup.ts',
+    setupFiles: join(__dirname, './tests/setup.ts'),
   },
 });