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

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

@@ -1,129 +1,129 @@
-// *****************************************************************************
-// 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 { injectable, inject, named, interfaces, Container } from 'inversify';
-import { ContributionProvider, ConnectionHandler, bindContributionProvider, servicesPath } from '../../common';
-import { MessagingService } from './messaging-service';
-import { ConnectionContainerModule } from './connection-container-module';
-import Route = require('route-parser');
-import { Channel, ChannelMultiplexer } from '../../common/message-rpc/channel';
-import { FrontendConnectionService } from './frontend-connection-service';
-import { BackendApplicationContribution } from '../backend-application';
-
-export const MessagingContainer = Symbol('MessagingContainer');
-export const MainChannel = Symbol('MainChannel');
-
-@injectable()
-export class DefaultMessagingService implements MessagingService, BackendApplicationContribution {
-    @inject(MessagingContainer)
-    protected readonly container: interfaces.Container;
-
-    @inject(FrontendConnectionService)
-    protected readonly frontendConnectionService: FrontendConnectionService;
-
-    @inject(ContributionProvider) @named(ConnectionContainerModule)
-    protected readonly connectionModules: ContributionProvider<interfaces.ContainerModule>;
-
-    @inject(ContributionProvider) @named(MessagingService.Contribution)
-    protected readonly contributions: ContributionProvider<MessagingService.Contribution>;
-
-    protected readonly channelHandlers = new ConnectionHandlers<Channel>();
-
-    initialize(): void {
-        this.registerConnectionHandler(servicesPath, (_, socket) => this.handleConnection(socket));
-        for (const contribution of this.contributions.getContributions()) {
-            contribution.configure(this);
-        }
-    }
-
-    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void {
-        this.frontendConnectionService.registerConnectionHandler(path, callback);
-    }
-
-    registerChannelHandler(spec: string, callback: (params: MessagingService.PathParams, channel: Channel) => void): void {
-        this.channelHandlers.push(spec, (params, channel) => callback(params, channel));
-    }
-
-    protected handleConnection(channel: Channel): void {
-        const multiplexer = new ChannelMultiplexer(channel);
-        const channelHandlers = this.getConnectionChannelHandlers(channel);
-        multiplexer.onDidOpenChannel(event => {
-            if (channelHandlers.route(event.id, event.channel)) {
-                console.debug(`Opening channel for service path '${event.id}'.`);
-                event.channel.onClose(() => console.info(`Closing channel on service path '${event.id}'.`));
-            }
-        });
-    }
-
-    protected createMainChannelContainer(socket: Channel): Container {
-        const connectionContainer: Container = this.container.createChild() as Container;
-        connectionContainer.bind(MainChannel).toConstantValue(socket);
-        return connectionContainer;
-    }
-
-    protected getConnectionChannelHandlers(socket: Channel): ConnectionHandlers<Channel> {
-        const connectionContainer = this.createMainChannelContainer(socket);
-        bindContributionProvider(connectionContainer, ConnectionHandler);
-        connectionContainer.load(...this.connectionModules.getContributions());
-        const connectionChannelHandlers = new ConnectionHandlers<Channel>(this.channelHandlers);
-        const connectionHandlers = connectionContainer.getNamed<ContributionProvider<ConnectionHandler>>(ContributionProvider, ConnectionHandler);
-        for (const connectionHandler of connectionHandlers.getContributions(true)) {
-            connectionChannelHandlers.push(connectionHandler.path, (_, channel) => {
-                connectionHandler.onConnection(channel);
-            });
-        }
-        return connectionChannelHandlers;
-    }
-
-}
-
-export class ConnectionHandlers<T> {
-    protected readonly handlers: ((path: string, connection: T) => string | false)[] = [];
-
-    constructor(
-        protected readonly parent?: ConnectionHandlers<T>
-    ) { }
-
-    push(spec: string, callback: (params: MessagingService.PathParams, connection: T) => void): void {
-        const route = new Route(spec);
-        const handler = (path: string, channel: T): string | false => {
-            const params = route.match(path);
-            if (!params) {
-                return false;
-            }
-            callback(params, channel);
-            return route.reverse(params);
-        };
-        this.handlers.push(handler);
-    }
-
-    route(path: string, connection: T): string | false {
-        for (const handler of this.handlers) {
-            try {
-                const result = handler(path, connection);
-                if (result) {
-                    return result;
-                }
-            } catch (e) {
-                console.error(e);
-            }
-        }
-        if (this.parent) {
-            return this.parent.route(path, connection);
-        }
-        return false;
-    }
-}
+// *****************************************************************************
+// 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 { injectable, inject, named, interfaces, Container } from 'inversify';
+import { ContributionProvider, ConnectionHandler, bindContributionProvider, servicesPath } from '../../common';
+import { MessagingService } from './messaging-service';
+import { ConnectionContainerModule } from './connection-container-module';
+import Route = require('route-parser');
+import { Channel, ChannelMultiplexer } from '../../common/message-rpc/channel';
+import { FrontendConnectionService } from './frontend-connection-service';
+import { BackendApplicationContribution } from '../backend-application';
+
+export const MessagingContainer = Symbol('MessagingContainer');
+export const MainChannel = Symbol('MainChannel');
+
+@injectable()
+export class DefaultMessagingService implements MessagingService, BackendApplicationContribution {
+    @inject(MessagingContainer)
+    protected readonly container: interfaces.Container;
+
+    @inject(FrontendConnectionService)
+    protected readonly frontendConnectionService: FrontendConnectionService;
+
+    @inject(ContributionProvider) @named(ConnectionContainerModule)
+    protected readonly connectionModules: ContributionProvider<interfaces.ContainerModule>;
+
+    @inject(ContributionProvider) @named(MessagingService.Contribution)
+    protected readonly contributions: ContributionProvider<MessagingService.Contribution>;
+
+    protected readonly channelHandlers = new ConnectionHandlers<Channel>();
+
+    initialize(): void {
+        this.registerConnectionHandler(servicesPath, (_, socket) => this.handleConnection(socket));
+        for (const contribution of this.contributions.getContributions()) {
+            contribution.configure(this);
+        }
+    }
+
+    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void {
+        this.frontendConnectionService.registerConnectionHandler(path, callback);
+    }
+
+    registerChannelHandler(spec: string, callback: (params: MessagingService.PathParams, channel: Channel) => void): void {
+        this.channelHandlers.push(spec, (params, channel) => callback(params, channel));
+    }
+
+    protected handleConnection(channel: Channel): void {
+        const multiplexer = new ChannelMultiplexer(channel);
+        const channelHandlers = this.getConnectionChannelHandlers(channel);
+        multiplexer.onDidOpenChannel(event => {
+            if (channelHandlers.route(event.id, event.channel)) {
+                console.debug(`Opening channel for service path '${event.id}'.`);
+                event.channel.onClose(() => console.info(`Closing channel on service path '${event.id}'.`));
+            }
+        });
+    }
+
+    protected createMainChannelContainer(socket: Channel): Container {
+        const connectionContainer: Container = this.container.createChild() as Container;
+        connectionContainer.bind(MainChannel).toConstantValue(socket);
+        return connectionContainer;
+    }
+
+    protected getConnectionChannelHandlers(socket: Channel): ConnectionHandlers<Channel> {
+        const connectionContainer = this.createMainChannelContainer(socket);
+        bindContributionProvider(connectionContainer, ConnectionHandler);
+        connectionContainer.load(...this.connectionModules.getContributions());
+        const connectionChannelHandlers = new ConnectionHandlers<Channel>(this.channelHandlers);
+        const connectionHandlers = connectionContainer.getNamed<ContributionProvider<ConnectionHandler>>(ContributionProvider, ConnectionHandler);
+        for (const connectionHandler of connectionHandlers.getContributions(true)) {
+            connectionChannelHandlers.push(connectionHandler.path, (_, channel) => {
+                connectionHandler.onConnection(channel);
+            });
+        }
+        return connectionChannelHandlers;
+    }
+
+}
+
+export class ConnectionHandlers<T> {
+    protected readonly handlers: ((path: string, connection: T) => string | false)[] = [];
+
+    constructor(
+        protected readonly parent?: ConnectionHandlers<T>
+    ) { }
+
+    push(spec: string, callback: (params: MessagingService.PathParams, connection: T) => void): void {
+        const route = new Route(spec);
+        const handler = (path: string, channel: T): string | false => {
+            const params = route.match(path);
+            if (!params) {
+                return false;
+            }
+            callback(params, channel);
+            return route.reverse(params);
+        };
+        this.handlers.push(handler);
+    }
+
+    route(path: string, connection: T): string | false {
+        for (const handler of this.handlers) {
+            try {
+                const result = handler(path, connection);
+                if (result) {
+                    return result;
+                }
+            } catch (e) {
+                console.error(e);
+            }
+        }
+        if (this.parent) {
+            return this.parent.route(path, connection);
+        }
+        return false;
+    }
+}

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

@@ -1,24 +1,24 @@
-// *****************************************************************************
-// 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 { Channel } from '../../common/message-rpc/';
-import { MessagingService } from './messaging-service';
-
-export const FrontendConnectionService = Symbol('FrontendConnectionService');
-
-export interface FrontendConnectionService {
-    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void;
-}
-
+// *****************************************************************************
+// 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 { Channel } from '../../common/message-rpc/';
+import { MessagingService } from './messaging-service';
+
+export const FrontendConnectionService = Symbol('FrontendConnectionService');
+
+export interface FrontendConnectionService {
+    registerConnectionHandler(path: string, callback: (params: MessagingService.PathParams, mainChannel: Channel) => void): void;
+}
+

package/src/node/messaging/index.ts

@@ -1,19 +1,19 @@
-// *****************************************************************************
-// Copyright (C) 2017 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
-// *****************************************************************************
-
-export * from './messaging-service';
-export * from './ipc-connection-provider';
-export * from './ipc-channel';
+// *****************************************************************************
+// Copyright (C) 2017 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
+// *****************************************************************************
+
+export * from './messaging-service';
+export * from './ipc-connection-provider';
+export * from './ipc-channel';

package/src/node/messaging/ipc-bootstrap.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2017 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 'reflect-metadata';
-import { dynamicRequire } from '../dynamic-require';
-import { IPCChannel } from './ipc-channel';
-import { checkParentAlive, IPCEntryPoint } from './ipc-protocol';
-
-checkParentAlive();
-
-const entryPoint = IPCEntryPoint.getScriptFromEnv();
-
-dynamicRequire<{ default: IPCEntryPoint }>(entryPoint).default(new IPCChannel());
-
+// *****************************************************************************
+// Copyright (C) 2017 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 'reflect-metadata';
+import { dynamicRequire } from '../dynamic-require';
+import { IPCChannel } from './ipc-channel';
+import { checkParentAlive, IPCEntryPoint } from './ipc-protocol';
+
+checkParentAlive();
+
+const entryPoint = IPCEntryPoint.getScriptFromEnv();
+
+dynamicRequire<{ default: IPCEntryPoint }>(entryPoint).default(new IPCChannel());
+

package/src/node/messaging/ipc-channel.ts

@@ -1,77 +1,77 @@
-// *****************************************************************************
-// Copyright (C) 2022 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
-// *****************************************************************************
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import * as cp from 'child_process';
-import { Socket } from 'net';
-import { Duplex } from 'stream';
-import { AbstractChannel, Disposable, WriteBuffer } from '../../common';
-import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '../../common/message-rpc/uint8-array-message-buffer';
-import { BinaryMessagePipe } from './binary-message-pipe';
-
-/**
- * A {@link Channel} to send messages between two processes using a dedicated pipe/fd for binary messages.
- * This fd is opened as 5th channel in addition to the default stdios (stdin, stdout, stderr, ipc). This means the default channels
- * are not blocked and can be used by the respective process for additional custom message handling.
- */
-export class IPCChannel extends AbstractChannel {
-
-    protected messagePipe: BinaryMessagePipe;
-
-    protected ipcErrorListener: (error: Error) => void = error => this.onErrorEmitter.fire(error);
-
-    constructor(childProcess?: cp.ChildProcess) {
-        super();
-        if (childProcess) {
-            this.setupChildProcess(childProcess);
-        } else {
-            this.setupProcess();
-        }
-        this.messagePipe.onMessage(message => {
-            this.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(message));
-        });
-    }
-
-    protected setupChildProcess(childProcess: cp.ChildProcess): void {
-        childProcess.once('exit', code => this.onCloseEmitter.fire({ reason: 'Child process has been terminated', code: code ?? undefined }));
-        this.messagePipe = new BinaryMessagePipe(childProcess.stdio[4] as Duplex);
-        childProcess.on('error', this.ipcErrorListener);
-        this.toDispose.push(Disposable.create(() => {
-            childProcess.removeListener('error', this.ipcErrorListener);
-            this.messagePipe.dispose();
-        }));
-    }
-
-    protected setupProcess(): void {
-        process.once('beforeExit', code => this.onCloseEmitter.fire({ reason: 'Process is about to be terminated', code }));
-        this.messagePipe = new BinaryMessagePipe(new Socket({ fd: 4 }));
-        process.on('uncaughtException', this.ipcErrorListener);
-        this.toDispose.push(Disposable.create(() => {
-            (process as NodeJS.EventEmitter).removeListener('uncaughtException', this.ipcErrorListener);
-            this.messagePipe.dispose();
-        }));
-    }
-
-    getWriteBuffer(): WriteBuffer {
-        const result = new Uint8ArrayWriteBuffer();
-        result.onCommit(buffer => {
-            this.messagePipe.send(buffer);
-        });
-
-        return result;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2022 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
+// *****************************************************************************
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import * as cp from 'child_process';
+import { Socket } from 'net';
+import { Duplex } from 'stream';
+import { AbstractChannel, Disposable, WriteBuffer } from '../../common';
+import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '../../common/message-rpc/uint8-array-message-buffer';
+import { BinaryMessagePipe } from './binary-message-pipe';
+
+/**
+ * A {@link Channel} to send messages between two processes using a dedicated pipe/fd for binary messages.
+ * This fd is opened as 5th channel in addition to the default stdios (stdin, stdout, stderr, ipc). This means the default channels
+ * are not blocked and can be used by the respective process for additional custom message handling.
+ */
+export class IPCChannel extends AbstractChannel {
+
+    protected messagePipe: BinaryMessagePipe;
+
+    protected ipcErrorListener: (error: Error) => void = error => this.onErrorEmitter.fire(error);
+
+    constructor(childProcess?: cp.ChildProcess) {
+        super();
+        if (childProcess) {
+            this.setupChildProcess(childProcess);
+        } else {
+            this.setupProcess();
+        }
+        this.messagePipe.onMessage(message => {
+            this.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(message));
+        });
+    }
+
+    protected setupChildProcess(childProcess: cp.ChildProcess): void {
+        childProcess.once('exit', code => this.onCloseEmitter.fire({ reason: 'Child process has been terminated', code: code ?? undefined }));
+        this.messagePipe = new BinaryMessagePipe(childProcess.stdio[4] as Duplex);
+        childProcess.on('error', this.ipcErrorListener);
+        this.toDispose.push(Disposable.create(() => {
+            childProcess.removeListener('error', this.ipcErrorListener);
+            this.messagePipe.dispose();
+        }));
+    }
+
+    protected setupProcess(): void {
+        process.once('beforeExit', code => this.onCloseEmitter.fire({ reason: 'Process is about to be terminated', code }));
+        this.messagePipe = new BinaryMessagePipe(new Socket({ fd: 4 }));
+        process.on('uncaughtException', this.ipcErrorListener);
+        this.toDispose.push(Disposable.create(() => {
+            (process as NodeJS.EventEmitter).removeListener('uncaughtException', this.ipcErrorListener);
+            this.messagePipe.dispose();
+        }));
+    }
+
+    getWriteBuffer(): WriteBuffer {
+        const result = new Uint8ArrayWriteBuffer();
+        result.onCommit(buffer => {
+            this.messagePipe.send(buffer);
+        });
+
+        return result;
+    }
+
+}