@opensumi/ide-connection 3.3.4-next-1727344885.0 → 3.4.0

package/README.md

@@ -1,21 +1,16 @@
-# 通信模块(connection)
+# 通信模块
 
 基于 sumi rpc 完成多端远程调用场景，兼容 lsp 等通信方式
 
-### opensumi 中使用
+### 后端服务: backService
 
-**准备**
-
-1. 框架中服务分为运行在浏览器环境的 前端服务(frontService) 与运行在 node 环境的 后端服务(backService)，服务在两端的实现方式是一致的
-2. 目前在 `tools/dev-tool` 中的启动逻辑中完成了服务的注册和获取逻辑，在具体功能模块中无需关心具体的通信注册获取逻辑
-
-**后端服务(backService)** 后端服务(backService) 即在 Web Server 暴露的能力，类似 web 应用框架中 controller 提供的请求响应逻辑
+backService 即在 Web Server 暴露的能力，类似 web 应用框架中 controller 提供的请求响应逻辑
 
 1. 注册服务
 
 `packages/file-service/src/node/index.ts`
 
-```javascript
+```ts
 import { FileSystemNodeOptions, FileService } from './file-service';
 import { servicePath } from '../common/index';
 
@@ -37,7 +32,7 @@ export class FileServiceModule extends NodeModule {
 
 `packages/file-tree/src/browser/index.ts`
 
-```javascript
+```ts
 import { servicePath as FileServicePath } from '@opensumi/ide-file-service';
 
 @Injectable()
@@ -55,12 +50,11 @@ export class FileTreeModule extends BrowserModule {
 
 `packages/file-tree/src/browser/file-tree.service.ts`
 
-```javascript
-import {servicePath as FileServicePath} from '@opensumi/ide-file-service';
+```ts
+import { servicePath as FileServicePath } from '@opensumi/ide-file-service';
 
 @Injectable()
 export default class FileTreeService extends Disposable {
-
   @observable.shallow
   files: CloudFile[] = [];
 
@@ -75,8 +69,8 @@ export default class FileTreeService extends Disposable {
 
     this.getFiles();
   }
-   createFile = async () => {
-    const {content} = await this.fileService.resolveContent('{file_path}');
+  createFile = async () => {
+    const { content } = await this.fileService.resolveContent('{file_path}');
     const file = await this.fileAPI.createFile({
       name: 'name' + Date.now() + '\n' + content,
       path: 'path' + Date.now(),
@@ -90,13 +84,13 @@ export default class FileTreeService extends Disposable {
     } else {
       this.files = [file];
     }
-  }
+  };
 }
 ```
 
 在 file-tree.service.ts 中通过 `servicePath` 进行注入，并直接调用在服务类上的方法
 
-```javascript
+```ts
 constructor(@Inject(FileServicePath) protected readonly fileService) {
     super();
 
@@ -106,97 +100,34 @@ constructor(@Inject(FileServicePath) protected readonly fileService) {
 
 方法调用会转换成一个远程调用进行响应，返回结果
 
-```javascript
+```ts
 const { content } = await this.fileService.resolveContent('{file_path}');
 ```
 
-**前端服务(frontService)** 后端服务(backService) 即在 Browser 环境下运行的代码暴露的能力
-
-1. 注册服务
+### 后端服务: remoteService
 
-`packages/file-ree/src/browser/index.ts`
+remoteService 提供了一种更简单，显式的 API 声明，我们将上面的 fileService 使用 remoteService 重写一遍：
 
-```javascript
-@Injectable()
-export class FileTreeModule extends BrowserModule {
-  providers: Provider[] = [createFileTreeAPIProvider(FileTreeAPIImpl)];
-  backServices = [
-    {
-      servicePath: FileServicePath,
-    },
-  ];
-  frontServices = [
-    {
-      servicePath: FileTreeServicePath,
-      token: FileTreeService,
-    },
-  ];
-}
-```
-
-与后端服务注册类似，例如在 file-tree 模块中声明 `frontServices` 字段，传入对应的服务地址 `servicePath` 和对应服务的注入 `token`
-
-2. 服务使用
+1. 注册服务
 
 `packages/file-service/src/node/index.ts`
 
-```javascript
-import { servicePath as FileTreeServicePath } from '@opensumi/ide-file-tree';
+```ts
+import { FileSystemNodeOptions, FileService } from './file-service';
 
-@Injectable()
 export class FileServiceModule extends NodeModule {
   providers = [{ token: 'FileServiceOptions', useValue: FileSystemNodeOptions.DEFAULT }];
-
-  backServices = [
-    {
-      servicePath,
-      token: FileService,
-    },
-  ];
-  frontServices = [
-    {
-      servicePath: FileTreeServicePath,
-    },
-  ];
+  remoteServices = [FileService];
 }
 ```
 
-与使用后端服务一致，在模块定义中声明需要使用的前端服务 `frontServices`，传入前端服务注册时用的 `servicePath` 一致
-
 `packages/file-service/src/node/file-service.ts`
 
-```javascript
-@Injectable()
-export class FileService implements IFileService {
-
-  constructor(
-    @Inject('FileServiceOptions') protected readonly options: FileSystemNodeOptions,
-    @Inject(FileTreeServicePath) protected readonly fileTreeService
-  ) { }
-
-  async resolveContent(uri: string, options?: { encoding?: string }): Promise<{ stat: FileStat, content: string }> {
-    const fileTree = await this.fileTreeService
-    fileTree.fileName(uri.substr(-5))
-
-    ...
-    return { stat, content };
-  }
-```
-
-与使用后端服务使用方式一致，在 file-service.ts 中通过 `servicePath` 进行注入，通过调用注入服务的对应方法
-
-```javascript
-  constructor(
-    @Inject('FileServiceOptions') protected readonly options: FileSystemNodeOptions,
-    @Inject(FileTreeServicePath) protected readonly fileTreeService
-  ) { }
-```
-
-方法调用会转换成一个远程调用进行响应，返回结果
+```ts
+import { servicePath } from '../common/index';
 
-```javascript
-const fileTree = await this.fileTreeService;
-fileTree.fileName(uri.substr(-5));
+export class FileService extends RemoteService {
+  servicePath = servicePath;
+  // write your own logic here
+}
 ```
-
-与后端服务调用区别的是，目前因前端代码后置执行，所以首先需要获取服务 `await this.fileTreeService` 后进行调用

package/lib/common/rpc-service/index.d.ts

@@ -3,8 +3,6 @@ export * from './center';
 export * from './registry';
 export declare abstract class RPCService<T = any> {
     rpcClient?: T[];
-    rpcRegistered?: boolean;
-    register?(): () => Promise<T>;
     get client(): T | undefined;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/common/rpc-service/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/rpc-service/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAE3B,8BAAsB,UAAU,CAAC,CAAC,GAAG,GAAG;IACtC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC;IAC7B,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAE1B;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/rpc-service/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAE3B,8BAAsB,UAAU,CAAC,CAAC,GAAG,GAAG;IACtC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;IAChB,IAAI,MAAM,IAAI,CAAC,GAAG,SAAS,CAE1B;CACF"}

package/lib/common/rpc-service/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/rpc-service/index.ts"],"names":[],"mappings":";;;;AAAA,iDAAuB;AACvB,mDAAyB;AACzB,qDAA2B;AAE3B,MAAsB,UAAU;IAI9B,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxD,CAAC;CACF;AAPD,gCAOC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/rpc-service/index.ts"],"names":[],"mappings":";;;;AAAA,iDAAuB;AACvB,mDAAyB;AACzB,qDAA2B;AAE3B,MAAsB,UAAU;IAE9B,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxD,CAAC;CACF;AALD,gCAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensumi/ide-connection",
-  "version": "3.3.4-next-1727344885.0",
+  "version": "3.4.0",
   "files": [
     "lib",
     "src"
@@ -19,17 +19,17 @@
   "dependencies": {
     "@furyjs/fury": "0.5.9-beta",
     "@opensumi/events": "^1.0.0",
-    "@opensumi/ide-core-common": "3.3.4-next-1727344885.0",
-    "@opensumi/ide-utils": "3.3.4-next-1727344885.0",
+    "@opensumi/ide-core-common": "3.4.0",
+    "@opensumi/ide-utils": "3.4.0",
     "@opensumi/reconnecting-websocket": "^4.4.0",
     "@opensumi/vscode-jsonrpc": "^8.0.0-next.2",
     "path-to-regexp": "^6.2.1",
     "ws": "^8.16.0"
   },
   "devDependencies": {
-    "@opensumi/ide-components": "3.3.4-next-1727344885.0",
-    "@opensumi/ide-dev-tool": "3.3.4-next-1727344885.0",
+    "@opensumi/ide-components": "3.4.0",
+    "@opensumi/ide-dev-tool": "3.4.0",
     "@opensumi/mock-socket": "^9.3.1"
   },
-  "gitHead": "d1683cd89971d85ea479d7ea348cc8ee33e05988"
+  "gitHead": "1596a2b1b547d2b99c880afe14f91f16f76bb9d5"
 }

package/src/common/rpc-service/index.ts

@@ -4,8 +4,6 @@ export * from './registry';
 
 export abstract class RPCService<T = any> {
   rpcClient?: T[];
-  rpcRegistered?: boolean;
-  register?(): () => Promise<T>;
   get client(): T | undefined {
     return this.rpcClient ? this.rpcClient[0] : undefined;
   }