fix: add rpcMessageTimeout option in appConfig (#2709)

Author: pipiiiiii

packages/connection/__test__/node/index.test.ts

@@ -266,6 +266,6 @@ describe('connection', () => {
     });
 
     await expect(timeoutBProtocol.getProxy(testTimeoutIdentifier).$test()).resolves.toBe(void 0);
-    await expect(timeoutCProtocol.getProxy(testTimeoutIdentifier).$test()).rejects.toBe('RPC Timeout');
+    await expect(timeoutCProtocol.getProxy(testTimeoutIdentifier).$test()).rejects.toThrow(new Error('RPC Timeout: 1'));
   });
 });

packages/connection/src/common/rpcProtocol.ts

@@ -203,8 +203,6 @@ function canceled(): Error {
   error.name = error.message;
   return error;
 }
-// 默认 30s 超时
-export const DEFAULT_TIMEOUT_MS = 30000;
 
 export class RPCProtocol implements IRPCProtocol {
   private readonly _protocol: IMessagePassingProtocol;
@@ -281,12 +279,13 @@ export class RPCProtocol implements IRPCProtocol {
     const msg = MessageIO.serializeRequest(callId, rpcId, methodName, args);
 
     this._protocol.send(msg);
-    // 设置超时回调
-    const timeoutHandle = setTimeout(() => {
-      this._handleTimeout(callId);
-    }, this._protocol.timeout || DEFAULT_TIMEOUT_MS);
-
-    this._timeoutHandles.set(callId, timeoutHandle);
+    // 设置超时回调, -1 即不配置超时时间
+    if (this._protocol.timeout && this._protocol.timeout !== -1) {
+      const timeoutHandle = setTimeout(() => {
+        this._handleTimeout(callId);
+      }, this._protocol.timeout);
+      this._timeoutHandles.set(callId, timeoutHandle);
+    }
 
     return result.promise;
   }
@@ -411,6 +410,6 @@ export class RPCProtocol implements IRPCProtocol {
     this._pendingRPCReplies.delete(callId);
     this._timeoutHandles.delete(callId);
 
-    pendingReply.reject('RPC Timeout');
+    pendingReply.reject(new Error('RPC Timeout: '+ callId));
   }
 }

packages/core-browser/src/bootstrap/app.ts

@@ -139,6 +139,7 @@ export class ClientApp implements IClientApp, IDisposable {
       editorBackgroundImage: opts.editorBackgroundImage || editorBackgroundImage,
       allowSetDocumentTitleFollowWorkspaceDir,
       devtools: opts.devtools ?? false,
+      rpcMessageTimeout: opts.rpcMessageTimeout || -1,
     };
 
     if (this.config.devtools) {

packages/core-browser/src/react-providers/config-provider.tsx

@@ -247,6 +247,11 @@ export interface AppConfig {
    * 需要带端口号, 默认是 12345，可使用 COLLABORATION_PORT 字段来指定
    */
   collaborationWsPath?: string;
+  /**
+   * control rpcProtocol message timeout
+   * default -1，it means disable
+   */
+  rpcMessageTimeout?: number;
 }
 
 export const ConfigContext = React.createContext<AppConfig>({

packages/core-node/src/bootstrap/app.ts

@@ -78,6 +78,7 @@ export class ServerApp implements IServerApp {
       blockPatterns: opts.blockPatterns,
       extHostIPCSockPath: opts.extHostIPCSockPath,
       extHostForkOptions: opts.extHostForkOptions,
+      rpcMessageTimeout: opts.rpcMessageTimeout || -1,
     };
     this.bindProcessHandler();
     this.initBaseProvider();

packages/core-node/src/types.ts

@@ -108,6 +108,11 @@ interface Config {
    * 配置关闭 keytar 校验能力，默认开启
    */
   disableKeytar?: boolean;
+  /**
+   * control rpcProtocol message timeout
+   * default -1，it means disable
+   */
+  rpcMessageTimeout?: number;
 }
 
 export interface AppConfig extends Partial<Config> {

packages/extension/src/browser/extension-node.service.ts

@@ -193,6 +193,7 @@ export class NodeExtProcessService implements AbstractNodeExtProcessService<IExt
     const mainThreadProtocol = new RPCProtocol({
       onMessage,
       send,
+      timeout: this.appConfig.rpcMessageTimeout,
     });
 
     // 重启/重连时直接覆盖前一个连接

packages/extension/src/browser/extension-worker.service.ts

@@ -193,6 +193,7 @@ export class WorkerExtProcessService
       {
         onMessage,
         send: port.postMessage.bind(port),
+        timeout: this.appConfig.rpcMessageTimeout,
       },
       this.logger,
     );

packages/extension/src/common/ext.host.proxy.ts

@@ -122,6 +122,11 @@ export interface IExtHostProxyOptions {
    * 默认 1000ms
    */
   retryTime?: number;
+  /**
+   * control rpcProtocol message timeout
+   * default -1，it means disable
+   */
+   rpcMessageTimeout?: number;
 }
 
 /**

packages/extension/src/hosted/ext.host.proxy-base.ts

@@ -142,6 +142,7 @@ export class ExtHostProxy extends Disposable implements IExtHostProxy {
     this.protocol = new RPCProtocol({
       onMessage,
       send,
+      timeout: this.options.rpcMessageTimeout,
     });
     this.extServerProxy = this.protocol.getProxy(EXT_SERVER_IDENTIFIER);
     const extHostProxyRPCService = new ExtHostProxyRPCService(this.extServerProxy);

packages/extension/src/hosted/ext.process-base.ts

@@ -70,9 +70,14 @@ export interface ExtProcessConfig {
   builtinCommands?: IBuiltInCommand[];
   customDebugChildProcess?: CustomChildProcessModule;
   customVSCodeEngineVersion?: string;
+   /**
+   * control rpcProtocol message timeout
+   * default -1，it means disable
+   */
+   rpcMessageTimeout?: number;
 }
 
-async function initRPCProtocol(extInjector): Promise<any> {
+async function initRPCProtocol(extInjector: Injector): Promise<any> {
   const extCenter = new RPCServiceCenter();
   const { getRPCService } = initRPCService<{
     onMessage(msg: string): void;
@@ -92,9 +97,12 @@ async function initRPCProtocol(extInjector): Promise<any> {
   const onMessage = onMessageEmitter.event;
   const send = service.onMessage;
 
+  const appConfig = extInjector.get(AppConfig);
+
   const extProtocol = new RPCProtocol({
     onMessage,
     send,
+    timeout: appConfig.rpcMessageTimeout,
   });
 
   logger = new ExtensionLogger2(extInjector); // new ExtensionLogger(extProtocol);

packages/extension/src/node/extension.host.proxy.manager.ts

@@ -4,7 +4,7 @@ import { Injectable, Optional, Autowired } from '@opensumi/di';
 import { getRPCService, RPCProtocol, IRPCProtocol } from '@opensumi/ide-connection';
 import { createSocketConnection } from '@opensumi/ide-connection/lib/node';
 import { MaybePromise, Emitter, IDisposable, toDisposable, Disposable } from '@opensumi/ide-core-common';
-import { RPCServiceCenter, INodeLogger } from '@opensumi/ide-core-node';
+import { RPCServiceCenter, INodeLogger, AppConfig } from '@opensumi/ide-core-node';
 
 import {
   IExtensionHostManager,
@@ -21,6 +21,9 @@ export class ExtensionHostProxyManager implements IExtensionHostManager {
   @Autowired(INodeLogger)
   private readonly logger: INodeLogger;
 
+  @Autowired(AppConfig)
+  private readonly appconfig: AppConfig;
+
   private callId = 0;
 
   private extHostProxyProtocol: IRPCProtocol;
@@ -96,6 +99,7 @@ export class ExtensionHostProxyManager implements IExtensionHostManager {
     this.extHostProxyProtocol = new RPCProtocol({
       onMessage,
       send,
+      timeout: this.appconfig.rpcMessageTimeout,
     });
 
     this.extHostProxyProtocol.set(EXT_SERVER_IDENTIFIER, {