@lobehub/lobehub 2.0.0-next.164 → 2.0.0-next.166

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

@@ -1,18 +1,16 @@
 import { ElectronAppState, ThemeMode } from '@lobechat/electron-client-ipc';
 import { app, nativeTheme, shell, systemPreferences } from 'electron';
 import { macOS } from 'electron-is';
-import { readFileSync, writeFileSync } from 'node:fs';
-import { join } from 'node:path';
 import process from 'node:process';
 
-import { DB_SCHEMA_HASH_FILENAME, LOCAL_DATABASE_DIR, userDataDir } from '@/const/dir';
 import { createLogger } from '@/utils/logger';
 
-import { ControllerModule, ipcClientEvent, ipcServerEvent } from './index';
+import { ControllerModule, IpcMethod } from './index';
 
 const logger = createLogger('controllers:SystemCtr');
 
 export default class SystemController extends ControllerModule {
+  static override readonly groupName = 'system';
   private systemThemeListenerInitialized = false;
 
   /**
@@ -26,7 +24,7 @@ export default class SystemController extends ControllerModule {
    * Handles the 'getDesktopAppState' IPC request.
    * Gathers essential application and system information.
    */
-  @ipcClientEvent('getDesktopAppState')
+  @IpcMethod()
   async getAppState(): Promise<ElectronAppState> {
     const platform = process.platform;
     const arch = process.arch;
@@ -56,13 +54,13 @@ export default class SystemController extends ControllerModule {
   /**
    * 检查可用性
    */
-  @ipcClientEvent('checkSystemAccessibility')
+  @IpcMethod()
   checkAccessibilityForMacOS() {
     if (!macOS()) return;
     return systemPreferences.isTrustedAccessibilityClient(true);
   }
 
-  @ipcClientEvent('openExternalLink')
+  @IpcMethod()
   openExternalLink(url: string) {
     return shell.openExternal(url);
   }
@@ -70,7 +68,7 @@ export default class SystemController extends ControllerModule {
   /**
    * 更新应用语言设置
    */
-  @ipcClientEvent('updateLocale')
+  @IpcMethod()
   async updateLocale(locale: string) {
     // 保存语言设置
     this.app.storeManager.set('locale', locale);
@@ -82,7 +80,7 @@ export default class SystemController extends ControllerModule {
     return { success: true };
   }
 
-  @ipcClientEvent('updateThemeMode')
+  @IpcMethod()
   async updateThemeModeHandler(themeMode: ThemeMode) {
     this.app.storeManager.set('themeMode', themeMode);
     this.app.browserManager.broadcastToAllWindows('themeChanged', { themeMode });
@@ -91,34 +89,6 @@ export default class SystemController extends ControllerModule {
     this.app.browserManager.handleAppThemeChange();
   }
 
-  @ipcServerEvent('getDatabasePath')
-  async getDatabasePath() {
-    return join(this.app.appStoragePath, LOCAL_DATABASE_DIR);
-  }
-
-  @ipcServerEvent('getDatabaseSchemaHash')
-  async getDatabaseSchemaHash() {
-    try {
-      return readFileSync(this.DB_SCHEMA_HASH_PATH, 'utf8');
-    } catch {
-      return undefined;
-    }
-  }
-
-  @ipcServerEvent('getUserDataPath')
-  async getUserDataPath() {
-    return userDataDir;
-  }
-
-  @ipcServerEvent('setDatabaseSchemaHash')
-  async setDatabaseSchemaHash(hash: string) {
-    writeFileSync(this.DB_SCHEMA_HASH_PATH, hash, 'utf8');
-  }
-
-  private get DB_SCHEMA_HASH_PATH() {
-    return join(this.app.appStoragePath, DB_SCHEMA_HASH_FILENAME);
-  }
-
   /**
    * Initialize system theme listener to monitor OS theme changes
    */

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

@@ -0,0 +1,38 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import { DB_SCHEMA_HASH_FILENAME, LOCAL_DATABASE_DIR, userDataDir } from '@/const/dir';
+
+import { ControllerModule, IpcServerMethod } from './index';
+
+export default class SystemServerCtr extends ControllerModule {
+  static override readonly groupName = 'system';
+
+  @IpcServerMethod()
+  async getDatabasePath() {
+    return join(this.app.appStoragePath, LOCAL_DATABASE_DIR);
+  }
+
+  @IpcServerMethod()
+  async getDatabaseSchemaHash() {
+    try {
+      return readFileSync(this.DB_SCHEMA_HASH_PATH, 'utf8');
+    } catch {
+      return undefined;
+    }
+  }
+
+  @IpcServerMethod()
+  async getUserDataPath() {
+    return userDataDir;
+  }
+
+  @IpcServerMethod()
+  async setDatabaseSchemaHash(hash: string) {
+    writeFileSync(this.DB_SCHEMA_HASH_PATH, hash, 'utf8');
+  }
+
+  private get DB_SCHEMA_HASH_PATH() {
+    return join(this.app.appStoragePath, DB_SCHEMA_HASH_FILENAME);
+  }
+}

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

@@ -6,12 +6,13 @@ import {
 
 import { createLogger } from '@/utils/logger';
 
-import { ControllerModule, ipcClientEvent } from './index';
+import { ControllerModule, IpcMethod } from './index';
 
 // Create logger
 const logger = createLogger('controllers:TrayMenuCtr');
 
 export default class TrayMenuCtr extends ControllerModule {
+  static override readonly groupName = 'tray';
   async toggleMainWindow() {
     logger.debug('Toggle main window visibility via shortcut');
     const mainWindow = this.app.browserManager.getMainWindow();
@@ -23,7 +24,7 @@ export default class TrayMenuCtr extends ControllerModule {
    * @param options Balloon options
    * @returns Operation result
    */
-  @ipcClientEvent('showTrayNotification')
+  @IpcMethod()
   async showNotification(options: ShowTrayNotificationParams) {
     logger.debug('Show tray balloon notification');
 
@@ -52,7 +53,7 @@ export default class TrayMenuCtr extends ControllerModule {
    * @param options Icon options
    * @returns Operation result
    */
-  @ipcClientEvent('updateTrayIcon')
+  @IpcMethod()
   async updateTrayIcon(options: UpdateTrayIconParams) {
     logger.debug('Update tray icon');
 
@@ -84,7 +85,7 @@ export default class TrayMenuCtr extends ControllerModule {
    * @param options Tooltip text options
    * @returns Operation result
    */
-  @ipcClientEvent('updateTrayTooltip')
+  @IpcMethod()
   async updateTrayTooltip(options: UpdateTrayTooltipParams) {
     logger.debug('Update tray tooltip text');
 

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

@@ -1,14 +1,15 @@
 import { createLogger } from '@/utils/logger';
 
-import { ControllerModule, ipcClientEvent } from './index';
+import { ControllerModule, IpcMethod } from './index';
 
 const logger = createLogger('controllers:UpdaterCtr');
 
 export default class UpdaterCtr extends ControllerModule {
+  static override readonly groupName = 'autoUpdate';
   /**
    * Check for updates
    */
-  @ipcClientEvent('checkUpdate')
+  @IpcMethod()
   async checkForUpdates() {
     logger.info('Check for updates requested');
     await this.app.updaterManager.checkForUpdates();
@@ -17,7 +18,7 @@ export default class UpdaterCtr extends ControllerModule {
   /**
    * Download update
    */
-  @ipcClientEvent('downloadUpdate')
+  @IpcMethod()
   async downloadUpdate() {
     logger.info('Download update requested');
     await this.app.updaterManager.downloadUpdate();
@@ -26,7 +27,7 @@ export default class UpdaterCtr extends ControllerModule {
   /**
    * Quit application and install update
    */
-  @ipcClientEvent('installNow')
+  @IpcMethod()
   quitAndInstallUpdate() {
     logger.info('Quit and install update requested');
     this.app.updaterManager.installNow();
@@ -35,7 +36,7 @@ export default class UpdaterCtr extends ControllerModule {
   /**
    * Install update on next startup
    */
-  @ipcClientEvent('installLater')
+  @IpcMethod()
   installLater() {
     logger.info('Install later requested');
     this.app.updaterManager.installLater();

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

@@ -1,39 +1,17 @@
 import { UploadFileParams } from '@lobechat/electron-client-ipc';
-import { CreateFileParams } from '@lobechat/electron-server-ipc';
 
 import FileService from '@/services/fileSrv';
 
-import { ControllerModule, ipcClientEvent, ipcServerEvent } from './index';
+import { ControllerModule, IpcMethod } from './index';
 
 export default class UploadFileCtr extends ControllerModule {
+  static override readonly groupName = 'upload';
   private get fileService() {
     return this.app.getService(FileService);
   }
 
-  @ipcClientEvent('createFile')
+  @IpcMethod()
   async uploadFile(params: UploadFileParams) {
     return this.fileService.uploadFile(params);
   }
-
-  // ======== server event
-
-  @ipcServerEvent('getStaticFilePath')
-  async getFileUrlById(id: string) {
-    return this.fileService.getFilePath(id);
-  }
-
-  @ipcServerEvent('getFileHTTPURL')
-  async getFileHTTPURL(path: string) {
-    return this.fileService.getFileHTTPURL(path);
-  }
-
-  @ipcServerEvent('deleteFiles')
-  async deleteFiles(paths: string[]) {
-    return this.fileService.deleteFiles(paths);
-  }
-
-  @ipcServerEvent('createFile')
-  async createFile(params: CreateFileParams) {
-    return this.fileService.uploadFile(params);
-  }
 }

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

@@ -0,0 +1,33 @@
+import { CreateFileParams } from '@lobechat/electron-server-ipc';
+
+import FileService from '@/services/fileSrv';
+
+import { ControllerModule, IpcServerMethod } from './index';
+
+export default class UploadFileServerCtr extends ControllerModule {
+  static override readonly groupName = 'upload';
+
+  private get fileService() {
+    return this.app.getService(FileService);
+  }
+
+  @IpcServerMethod()
+  async getFileUrlById(id: string) {
+    return this.fileService.getFilePath(id);
+  }
+
+  @IpcServerMethod()
+  async getFileHTTPURL(path: string) {
+    return this.fileService.getFileHTTPURL(path);
+  }
+
+  @IpcServerMethod()
+  async deleteFiles(paths: string[]) {
+    return this.fileService.deleteFiles(paths);
+  }
+
+  @IpcServerMethod()
+  async createFile(params: CreateFileParams) {
+    return this.fileService.uploadFile(params);
+  }
+}

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

@@ -18,11 +18,18 @@ vi.mock('@/utils/logger', () => ({
   }),
 }));
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
 // Mock electron
 vi.mock('electron', () => ({
   BrowserWindow: {
     getAllWindows: vi.fn(() => []),
   },
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
   shell: {
     openExternal: vi.fn().mockResolvedValue(undefined),
   },
@@ -99,6 +106,7 @@ describe('AuthCtr', () => {
 
   beforeEach(() => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
     randomBytesCounter = 0; // Reset counter for each test
 
     // Reset shell.openExternal to default successful behavior
@@ -123,7 +131,7 @@ describe('AuthCtr', () => {
 
   afterEach(() => {
     // Clean up authCtr intervals (using real timers, not fake timers)
-    authCtr.cleanup();
+    authCtr?.cleanup?.();
     // Clean up any fake timers if used
     vi.clearAllTimers();
   });

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

@@ -3,10 +3,21 @@ import { Mock, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import { AppBrowsersIdentifiers, BrowsersIdentifiers } from '@/appBrowsers';
 import type { App } from '@/core/App';
-import type { IpcClientEventSender } from '@/types/ipcClientEvent';
+import type { IpcContext } from '@/utils/ipc';
+import { runWithIpcContext } from '@/utils/ipc';
 
 import BrowserWindowsCtr from '../BrowserWindowsCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));
+
 // 模拟 App 及其依赖项
 const mockToggleVisible = vi.fn();
 const mockLoadUrl = vi.fn();
@@ -16,6 +27,9 @@ const mockCloseWindow = vi.fn();
 const mockMinimizeWindow = vi.fn();
 const mockMaximizeWindow = vi.fn();
 const mockRetrieveByIdentifier = vi.fn();
+const testSenderIdentifierString: string = 'test-window-event-id';
+
+const mockGetIdentifierByWebContents = vi.fn(() => testSenderIdentifierString);
 const mockGetMainWindow = vi.fn(() => ({
   toggleVisible: mockToggleVisible,
   loadUrl: mockLoadUrl,
@@ -32,6 +46,7 @@ const { findMatchingRoute } = await import('~common/routes');
 
 const mockApp = {
   browserManager: {
+    getIdentifierByWebContents: mockGetIdentifierByWebContents,
     getMainWindow: mockGetMainWindow,
     redirectToPage: mockRedirectToPage,
     closeWindow: mockCloseWindow,
@@ -53,6 +68,7 @@ describe('BrowserWindowsCtr', () => {
 
   beforeEach(() => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
     browserWindowsCtr = new BrowserWindowsCtr(mockApp);
   });
 
@@ -82,28 +98,32 @@ describe('BrowserWindowsCtr', () => {
     });
   });
 
-  const testSenderIdentifierString: string = 'test-window-event-id';
-  const sender: IpcClientEventSender = {
-    identifier: testSenderIdentifierString,
-  };
-
   describe('closeWindow', () => {
     it('should close the window with the given sender identifier', () => {
-      browserWindowsCtr.closeWindow(undefined, sender);
+      const sender = {} as any;
+      const context = { sender, event: { sender } as any } as IpcContext;
+      runWithIpcContext(context, () => browserWindowsCtr.closeWindow());
+      expect(mockGetIdentifierByWebContents).toHaveBeenCalledWith(context.sender);
       expect(mockCloseWindow).toHaveBeenCalledWith(testSenderIdentifierString);
     });
   });
 
   describe('minimizeWindow', () => {
     it('should minimize the window with the given sender identifier', () => {
-      browserWindowsCtr.minimizeWindow(undefined, sender);
+      const sender = {} as any;
+      const context = { sender, event: { sender } as any } as IpcContext;
+      runWithIpcContext(context, () => browserWindowsCtr.minimizeWindow());
+      expect(mockGetIdentifierByWebContents).toHaveBeenCalledWith(context.sender);
       expect(mockMinimizeWindow).toHaveBeenCalledWith(testSenderIdentifierString);
     });
   });
 
   describe('maximizeWindow', () => {
     it('should maximize the window with the given sender identifier', () => {
-      browserWindowsCtr.maximizeWindow(undefined, sender);
+      const sender = {} as any;
+      const context = { sender, event: { sender } as any } as IpcContext;
+      runWithIpcContext(context, () => browserWindowsCtr.maximizeWindow());
+      expect(mockGetIdentifierByWebContents).toHaveBeenCalledWith(context.sender);
       expect(mockMaximizeWindow).toHaveBeenCalledWith(testSenderIdentifierString);
     });
   });

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

@@ -4,6 +4,16 @@ import type { App } from '@/core/App';
 
 import DevtoolsCtr from '../DevtoolsCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));
+
 // 模拟 App 及其依赖项
 const mockShow = vi.fn();
 const mockRetrieveByIdentifier = vi.fn(() => ({
@@ -24,10 +34,9 @@ describe('DevtoolsCtr', () => {
 
   beforeEach(() => {
     vi.clearAllMocks(); // 只清除 vi.fn() 创建的模拟函数的记录，不影响 IoCContainer 状态
+    ipcMainHandleMock.mockClear();
 
-    // 实例化 DevtoolsCtr。
-    // 它将继承自真实的 ControllerModule。
-    // 其 @ipcClientEvent 装饰器会执行并与真实的 IoCContainer 交互。
+    // 实例化 DevtoolsCtr。其 @IpcMethod 装饰器会执行并与真实的 IoCContainer 交互。
     devtoolsCtr = new DevtoolsCtr(mockApp);
   });
 

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

@@ -4,6 +4,10 @@ import type { App } from '@/core/App';
 
 import LocalFileCtr from '../LocalFileCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
 // Mock logger
 vi.mock('@/utils/logger', () => ({
   createLogger: () => ({
@@ -22,6 +26,9 @@ vi.mock('@lobechat/file-loaders', () => ({
 
 // Mock electron
 vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
   shell: {
     openPath: vi.fn(),
   },

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

@@ -4,6 +4,16 @@ import type { App } from '@/core/App';
 
 import MenuController from '../MenuCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));
+
 // 模拟 App 及其依赖项
 const mockRefreshMenus = vi.fn();
 const mockShowContextMenu = vi.fn();

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

@@ -5,6 +5,10 @@ import type { App } from '@/core/App';
 
 import NetworkProxyCtr from '../NetworkProxyCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
 // 模拟 logger
 vi.mock('@/utils/logger', () => ({
   createLogger: () => ({
@@ -54,6 +58,7 @@ describe('NetworkProxyCtr', () => {
 
   beforeEach(async () => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
 
     // 动态导入 undici Mock
     mockUndici = await import('undici');
@@ -418,3 +423,8 @@ describe('NetworkProxyCtr', () => {
     });
   });
 });
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));

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

@@ -5,6 +5,10 @@ import type { App } from '@/core/App';
 
 import NotificationCtr from '../NotificationCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
 // Mock logger
 vi.mock('@/utils/logger', () => ({
   createLogger: () => ({
@@ -25,6 +29,9 @@ vi.mock('electron', () => {
   MockNotification.isSupported = vi.fn(() => true);
 
   return {
+    ipcMain: {
+      handle: ipcMainHandleMock,
+    },
     Notification: MockNotification,
     app: {
       setAppUserModelId: vi.fn(),
@@ -65,6 +72,7 @@ describe('NotificationCtr', () => {
 
   beforeEach(() => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
     vi.useFakeTimers();
     controller = new NotificationCtr(mockApp);
   });

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

@@ -5,6 +5,10 @@ import type { App } from '@/core/App';
 
 import RemoteServerConfigCtr from '../RemoteServerConfigCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
 // Mock logger
 vi.mock('@/utils/logger', () => ({
   createLogger: () => ({
@@ -17,6 +21,9 @@ vi.mock('@/utils/logger', () => ({
 
 // Mock electron
 vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
   safeStorage: {
     decryptString: vi.fn((buffer: Buffer) => buffer.toString()),
     encryptString: vi.fn((str: string) => Buffer.from(str)),
@@ -45,6 +52,7 @@ describe('RemoteServerConfigCtr', () => {
 
   beforeEach(() => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
     mockStoreManager.get.mockReturnValue({
       active: false,
       storageMode: 'local',

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

@@ -22,6 +22,7 @@ vi.mock('electron', () => ({
     getPath: vi.fn(() => '/mock/user/data'),
   },
   ipcMain: {
+    handle: vi.fn(),
     on: vi.fn(),
   },
 }));

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

@@ -4,6 +4,16 @@ import type { App } from '@/core/App';
 
 import ShellCommandCtr from '../ShellCommandCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));
+
 // Mock logger
 vi.mock('@/utils/logger', () => ({
   createLogger: () => ({

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

@@ -4,6 +4,16 @@ import type { App } from '@/core/App';
 
 import ShortcutController from '../ShortcutCtr';
 
+const { ipcMainHandleMock } = vi.hoisted(() => ({
+  ipcMainHandleMock: vi.fn(),
+}));
+
+vi.mock('electron', () => ({
+  ipcMain: {
+    handle: ipcMainHandleMock,
+  },
+}));
+
 // 模拟 App 及其依赖项
 const mockGetShortcutsConfig = vi.fn().mockReturnValue({
   toggleMainWindow: 'CommandOrControl+Shift+L',
@@ -26,6 +36,7 @@ describe('ShortcutController', () => {
 
   beforeEach(() => {
     vi.clearAllMocks();
+    ipcMainHandleMock.mockClear();
     shortcutController = new ShortcutController(mockApp);
   });