feat: support collaborationWsPath config

Author: Ricbet

packages/collaboration/__tests__/browser/textmodel-binding.test.ts

@@ -9,7 +9,7 @@ import { ICodeEditor } from '@opensumi/ide-monaco';
 import * as monaco from '@opensumi/monaco-editor-core/esm/vs/editor/editor.api';
 
 import { TextModelBinding } from '../../src/browser/textmodel-binding';
-import { ICollaborationService } from '../../src/common';
+import { ICollaborationService, COLLABORATION_PORT } from '../../src/common';
 
 const injector = new Injector();
 
@@ -40,7 +40,7 @@ describe('TextModelBinding test for yText and TextModel', () => {
 
   beforeEach(() => {
     doc = new Y.Doc();
-    wsProvider = new WebsocketProvider('ws://127.0.0.1:12345', 'test', doc, { connect: false }); // we don't use wsProvider here
+    wsProvider = new WebsocketProvider(`ws://127.0.0.1:${COLLABORATION_PORT}`, 'test', doc, { connect: false }); // we don't use wsProvider here
     user1 = createBindingWithTextModel(doc, wsProvider.awareness);
     user2 = createBindingWithTextModel(doc, wsProvider.awareness);
     jest.mock('@opensumi/di');
@@ -205,7 +205,7 @@ describe('TextModelBinding test for editor', () => {
 
   beforeAll(() => {
     doc = new Y.Doc();
-    const wsProvider = new WebsocketProvider('ws://127.0.0.1:12345', 'test', doc, { connect: false });
+    const wsProvider = new WebsocketProvider(`ws://127.0.0.1:${COLLABORATION_PORT}`, 'test', doc, { connect: false });
 
     const {
       binding: _binding,

packages/collaboration/src/browser/collaboration.service.ts

@@ -95,13 +95,24 @@ export class CollaborationService extends WithEventBus implements ICollaboration
   }
 
   initialize() {
+    /**
+     * 优先使用 appConfig.collaborationWsPath 配置
+     * 如果没有该配置才根据 wsPath 去转换端口
+     */
+    const { collaborationWsPath, wsPath } = this.appConfig;
+    let serverUrl: string | undefined = collaborationWsPath;
+
+    if (!serverUrl) {
+      const path = new URL(wsPath.toString());
+      path.port = String(COLLABORATION_PORT);
+
+      serverUrl = path.toString();
+    }
+
     this.yDoc = new Y.Doc();
     this.yTextMap = this.yDoc.getMap();
 
-    // transform url
-    const wsPath = new URL(this.appConfig.wsPath.toString());
-    wsPath.port = String(COLLABORATION_PORT);
-    this.yWebSocketProvider = new WebsocketProvider(wsPath.toString(), ROOM_NAME, this.yDoc);
+    this.yWebSocketProvider = new WebsocketProvider(serverUrl.toString(), ROOM_NAME, this.yDoc);
 
     this.yTextMap.observe(this.yMapObserver);
 

packages/collaboration/src/node/y-websocket-server.ts

@@ -9,7 +9,7 @@ import { INodeLogger } from '@opensumi/ide-core-node';
 import { FileChangeType, IFileService } from '@opensumi/ide-file-service';
 import { FileService } from '@opensumi/ide-file-service/lib/node';
 
-import { IYWebsocketServer, ROOM_NAME } from '../common';
+import { COLLABORATION_PORT, IYWebsocketServer, ROOM_NAME } from '../common';
 
 @Injectable()
 export class YWebsocketServerImpl implements IYWebsocketServer {
@@ -50,8 +50,8 @@ export class YWebsocketServerImpl implements IYWebsocketServer {
       this.websocketServer.handleUpgrade(req, socket, head, handleAuth);
     });
 
-    this.server.listen(12345, () => {
-      this.logger.log('y-websocket server listening on port 12345');
+    this.server.listen(COLLABORATION_PORT, () => {
+      this.logger.log(`y-websocket server listening on port ${COLLABORATION_PORT}`);
     });
 
     // init

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

@@ -232,6 +232,11 @@ export interface AppConfig {
    * 配置插件 browser 层的 component 样式文件和 iconfont 样式文件
    */
   extensionBrowserStyleSheet?: ExtensionBrowserStyleSheet;
+  /**
+   * 定义协同模块的通信路径
+   * 需要带端口号, 默认是 12345，可使用 COLLABORATION_PORT 字段来指定
+   */
+  collaborationWsPath?: string;
 }
 
 export const ConfigContext = React.createContext<AppConfig>({