@theia/core 1.53.0-next.4 → 1.53.0-next.55

package/src/node/messaging/messaging-service.ts

@@ -1,46 +1,46 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { Channel } from '../../common/message-rpc/channel';
-
-export interface MessagingService {
-    /**
-     * Accept a web socket channel on the given path.
-     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
-     */
-    registerChannelHandler(path: string, handler: (params: MessagingService.PathParams, channel: Channel) => void): void;
-    /**
-     * Accept a web socket connection on the given path.
-     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
-     *
-     * #### Important
-     * Prefer using web socket channels over establishing new web socket connection. Clients can handle only limited amount of web sockets
-     * and excessive amount can cause performance degradation. All web socket channels share a single web socket connection.
-     */
-    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void;
-}
-
-export namespace MessagingService {
-    /** Inversify container identifier for the `MessagingService` component. */
-    export const Identifier = Symbol('MessagingService');
-    export interface PathParams {
-        [name: string]: string
-    }
-    export const Contribution = Symbol('MessagingService.Contribution');
-    export interface Contribution {
-        configure(service: MessagingService): void;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Channel } from '../../common/message-rpc/channel';
+
+export interface MessagingService {
+    /**
+     * Accept a web socket channel on the given path.
+     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
+     */
+    registerChannelHandler(path: string, handler: (params: MessagingService.PathParams, channel: Channel) => void): void;
+    /**
+     * Accept a web socket connection on the given path.
+     * A path supports the route syntax: https://github.com/rcs/route-parser#what-can-i-use-in-my-routes.
+     *
+     * #### Important
+     * Prefer using web socket channels over establishing new web socket connection. Clients can handle only limited amount of web sockets
+     * and excessive amount can cause performance degradation. All web socket channels share a single web socket connection.
+     */
+    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void;
+}
+
+export namespace MessagingService {
+    /** Inversify container identifier for the `MessagingService` component. */
+    export const Identifier = Symbol('MessagingService');
+    export interface PathParams {
+        [name: string]: string
+    }
+    export const Contribution = Symbol('MessagingService.Contribution');
+    export interface Contribution {
+        configure(service: MessagingService): void;
+    }
+}

package/src/node/messaging/test/test-web-socket-channel.ts

@@ -1,61 +1,61 @@
-/* eslint-disable @theia/runtime-import-check */
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as http from 'http';
-import * as https from 'https';
-import { AddressInfo } from 'net';
-import { servicesPath } from '../../../common';
-import { WebSocketConnectionSource } from '../../../browser/messaging/ws-connection-source';
-import { Container, inject } from 'inversify';
-import { RemoteConnectionProvider, ServiceConnectionProvider } from '../../../browser/messaging/service-connection-provider';
-import { messagingFrontendModule } from '../../../browser/messaging/messaging-frontend-module';
-import { Socket, io } from 'socket.io-client';
-
-const websocketUrl = Symbol('testWebsocketUrl');
-class TestWebsocketConnectionSource extends WebSocketConnectionSource {
-    @inject(websocketUrl)
-    readonly websocketUrl: string;
-
-    protected override createWebSocketUrl(path: string): string {
-        return this.websocketUrl;
-    }
-
-    protected override createWebSocket(url: string): Socket {
-        return io(url);
-    }
-}
-
-export class TestWebSocketChannelSetup {
-    public readonly connectionProvider: ServiceConnectionProvider;
-
-    constructor({ server, path }: {
-        server: http.Server | https.Server,
-        path: string
-    }) {
-        const address = (server.address() as AddressInfo);
-        const url = `ws://${address.address}:${address.port}${servicesPath}`;
-        this.connectionProvider = this.createConnectionProvider(url);
-    }
-
-    protected createConnectionProvider(socketUrl: string): ServiceConnectionProvider {
-        const container = new Container();
-        container.bind(websocketUrl).toConstantValue(socketUrl);
-        container.load(messagingFrontendModule);
-        container.rebind(WebSocketConnectionSource).to(TestWebsocketConnectionSource);
-        return container.get(RemoteConnectionProvider);
-    }
-}
+/* eslint-disable @theia/runtime-import-check */
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as http from 'http';
+import * as https from 'https';
+import { AddressInfo } from 'net';
+import { servicesPath } from '../../../common';
+import { WebSocketConnectionSource } from '../../../browser/messaging/ws-connection-source';
+import { Container, inject } from 'inversify';
+import { RemoteConnectionProvider, ServiceConnectionProvider } from '../../../browser/messaging/service-connection-provider';
+import { messagingFrontendModule } from '../../../browser/messaging/messaging-frontend-module';
+import { Socket, io } from 'socket.io-client';
+
+const websocketUrl = Symbol('testWebsocketUrl');
+class TestWebsocketConnectionSource extends WebSocketConnectionSource {
+    @inject(websocketUrl)
+    readonly websocketUrl: string;
+
+    protected override createWebSocketUrl(path: string): string {
+        return this.websocketUrl;
+    }
+
+    protected override createWebSocket(url: string): Socket {
+        return io(url);
+    }
+}
+
+export class TestWebSocketChannelSetup {
+    public readonly connectionProvider: ServiceConnectionProvider;
+
+    constructor({ server, path }: {
+        server: http.Server | https.Server,
+        path: string
+    }) {
+        const address = (server.address() as AddressInfo);
+        const url = `ws://${address.address}:${address.port}${servicesPath}`;
+        this.connectionProvider = this.createConnectionProvider(url);
+    }
+
+    protected createConnectionProvider(socketUrl: string): ServiceConnectionProvider {
+        const container = new Container();
+        container.bind(websocketUrl).toConstantValue(socketUrl);
+        container.load(messagingFrontendModule);
+        container.rebind(WebSocketConnectionSource).to(TestWebsocketConnectionSource);
+        return container.get(RemoteConnectionProvider);
+    }
+}

package/src/node/messaging/websocket-endpoint.ts

@@ -1,79 +1,79 @@
-// *****************************************************************************
-// Copyright (C) 2023 STMicroelectronics and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-
-import { MessagingService } from './messaging-service';
-import * as http from 'http';
-import * as https from 'https';
-import { inject, injectable } from 'inversify';
-import { Server, Socket } from 'socket.io';
-import { WsRequestValidator } from '../ws-request-validators';
-import { MessagingListener } from './messaging-listeners';
-import { ConnectionHandlers } from './default-messaging-service';
-import { BackendApplicationContribution } from '../backend-application';
-
-@injectable()
-export class WebsocketEndpoint implements BackendApplicationContribution {
-    @inject(WsRequestValidator)
-    protected readonly wsRequestValidator: WsRequestValidator;
-
-    @inject(MessagingListener)
-    protected readonly messagingListener: MessagingListener;
-
-    protected checkAliveTimeout = 30000; // 30 seconds
-    protected maxHttpBufferSize = 1e8; // 100 MB
-
-    protected readonly wsHandlers = new ConnectionHandlers<Socket>();
-
-    registerConnectionHandler(spec: string, callback: (params: MessagingService.PathParams, socket: Socket) => void): void {
-        this.wsHandlers.push(spec, callback);
-    }
-
-    onStart(server: http.Server | https.Server): void {
-        const socketServer = new Server(server, {
-            pingInterval: this.checkAliveTimeout,
-            pingTimeout: this.checkAliveTimeout * 2,
-            maxHttpBufferSize: this.maxHttpBufferSize
-        });
-        // Accept every namespace by using /.*/
-        socketServer.of(/.*/).on('connection', async socket => {
-            const request = socket.request;
-            // Socket.io strips the `origin` header of the incoming request
-            // We provide a `fix-origin` header in the `WebSocketConnectionProvider`
-            request.headers.origin = request.headers['fix-origin'] as string;
-            if (await this.allowConnect(socket.request)) {
-                await this.handleConnection(socket);
-                this.messagingListener.onDidWebSocketUpgrade(socket.request, socket);
-            } else {
-                socket.disconnect(true);
-            }
-        });
-    }
-
-    protected async allowConnect(request: http.IncomingMessage): Promise<boolean> {
-        try {
-            return this.wsRequestValidator.allowWsUpgrade(request);
-        } catch (e) {
-            return false;
-        }
-    }
-
-    protected async handleConnection(socket: Socket): Promise<void> {
-        const pathname = socket.nsp.name;
-        if (pathname && !this.wsHandlers.route(pathname, socket)) {
-            console.error('Cannot find a ws handler for the path: ' + pathname);
-        }
-    }
-}
-
+// *****************************************************************************
+// Copyright (C) 2023 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+
+import { MessagingService } from './messaging-service';
+import * as http from 'http';
+import * as https from 'https';
+import { inject, injectable } from 'inversify';
+import { Server, Socket } from 'socket.io';
+import { WsRequestValidator } from '../ws-request-validators';
+import { MessagingListener } from './messaging-listeners';
+import { ConnectionHandlers } from './default-messaging-service';
+import { BackendApplicationContribution } from '../backend-application';
+
+@injectable()
+export class WebsocketEndpoint implements BackendApplicationContribution {
+    @inject(WsRequestValidator)
+    protected readonly wsRequestValidator: WsRequestValidator;
+
+    @inject(MessagingListener)
+    protected readonly messagingListener: MessagingListener;
+
+    protected checkAliveTimeout = 30000; // 30 seconds
+    protected maxHttpBufferSize = 1e8; // 100 MB
+
+    protected readonly wsHandlers = new ConnectionHandlers<Socket>();
+
+    registerConnectionHandler(spec: string, callback: (params: MessagingService.PathParams, socket: Socket) => void): void {
+        this.wsHandlers.push(spec, callback);
+    }
+
+    onStart(server: http.Server | https.Server): void {
+        const socketServer = new Server(server, {
+            pingInterval: this.checkAliveTimeout,
+            pingTimeout: this.checkAliveTimeout * 2,
+            maxHttpBufferSize: this.maxHttpBufferSize
+        });
+        // Accept every namespace by using /.*/
+        socketServer.of(/.*/).on('connection', async socket => {
+            const request = socket.request;
+            // Socket.io strips the `origin` header of the incoming request
+            // We provide a `fix-origin` header in the `WebSocketConnectionProvider`
+            request.headers.origin = request.headers['fix-origin'] as string;
+            if (await this.allowConnect(socket.request)) {
+                await this.handleConnection(socket);
+                this.messagingListener.onDidWebSocketUpgrade(socket.request, socket);
+            } else {
+                socket.disconnect(true);
+            }
+        });
+    }
+
+    protected async allowConnect(request: http.IncomingMessage): Promise<boolean> {
+        try {
+            return this.wsRequestValidator.allowWsUpgrade(request);
+        } catch (e) {
+            return false;
+        }
+    }
+
+    protected async handleConnection(socket: Socket): Promise<void> {
+        const pathname = socket.nsp.name;
+        if (pathname && !this.wsHandlers.route(pathname, socket)) {
+            console.error('Cannot find a ws handler for the path: ' + pathname);
+        }
+    }
+}
+