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

package/src/node/messaging/ipc-connection-provider.ts

@@ -1,107 +1,107 @@
-// *****************************************************************************
-// 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 * as cp from 'child_process';
-import { inject, injectable } from 'inversify';
-import * as path from 'path';
-import { createInterface } from 'readline';
-import { Channel, ConnectionErrorHandler, Disposable, DisposableCollection, ILogger } from '../../common';
-import { IPCChannel } from './ipc-channel';
-import { createIpcEnv } from './ipc-protocol';
-
-export interface ResolvedIPCConnectionOptions {
-    readonly serverName: string
-    readonly entryPoint: string
-    readonly logger: ILogger
-    readonly args: string[]
-    readonly errorHandler?: ConnectionErrorHandler
-    readonly env?: NodeJS.ProcessEnv
-}
-export type IPCConnectionOptions = Partial<ResolvedIPCConnectionOptions> & {
-    readonly serverName: string
-    readonly entryPoint: string
-};
-
-@injectable()
-export class IPCConnectionProvider {
-
-    @inject(ILogger)
-    protected readonly logger: ILogger;
-
-    listen(options: IPCConnectionOptions, acceptor: (connection: Channel) => void): Disposable {
-        return this.doListen({
-            logger: this.logger,
-            args: [],
-            ...options
-        }, acceptor);
-    }
-
-    protected doListen(options: ResolvedIPCConnectionOptions, acceptor: (connection: Channel) => void): Disposable {
-        const childProcess = this.fork(options);
-        const channel = new IPCChannel(childProcess);
-        const toStop = new DisposableCollection();
-        const toCancelStop = toStop.push(Disposable.create(() => childProcess.kill()));
-        const errorHandler = options.errorHandler;
-        if (errorHandler) {
-            let errorCount = 0;
-            channel.onError((err: Error) => {
-                errorCount++;
-                if (errorHandler.shouldStop(err, errorCount)) {
-                    toStop.dispose();
-                }
-            });
-            channel.onClose(() => {
-                if (toStop.disposed) {
-                    return;
-                }
-                if (errorHandler.shouldRestart()) {
-                    toCancelStop.dispose();
-                    toStop.push(this.doListen(options, acceptor));
-                }
-            });
-        }
-        acceptor(channel);
-        return toStop;
-    }
-
-    protected fork(options: ResolvedIPCConnectionOptions): cp.ChildProcess {
-        const forkOptions: cp.ForkOptions = {
-            env: createIpcEnv(options),
-            execArgv: [],
-            // 5th element MUST be 'overlapped' for it to work properly on Windows.
-            // 'overlapped' works just like 'pipe' on non-Windows platforms.
-            // See: https://nodejs.org/docs/latest-v14.x/api/child_process.html#child_process_options_stdio
-            // Note: For some reason `@types/node` does not know about 'overlapped'.
-            stdio: ['pipe', 'pipe', 'pipe', 'ipc', 'overlapped' as 'pipe']
-        };
-        const inspectArgPrefix = `--${options.serverName}-inspect`;
-        const inspectArg = process.argv.find(v => v.startsWith(inspectArgPrefix));
-        if (inspectArg !== undefined) {
-            forkOptions.execArgv = ['--nolazy', `--inspect${inspectArg.substring(inspectArgPrefix.length)}`];
-        }
-
-        const childProcess = cp.fork(path.join(__dirname, 'ipc-bootstrap'), options.args, forkOptions);
-
-        createInterface(childProcess.stdout!).on('line', line => this.logger.info(`[${options.serverName}: ${childProcess.pid}] ${line}`));
-        createInterface(childProcess.stderr!).on('line', line => this.logger.error(`[${options.serverName}: ${childProcess.pid}] ${line}`));
-
-        this.logger.debug(`[${options.serverName}: ${childProcess.pid}] IPC started`);
-        childProcess.once('exit', () => this.logger.debug(`[${options.serverName}: ${childProcess.pid}] IPC exited`));
-
-        return childProcess;
-    }
-
-}
+// *****************************************************************************
+// 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 * as cp from 'child_process';
+import { inject, injectable } from 'inversify';
+import * as path from 'path';
+import { createInterface } from 'readline';
+import { Channel, ConnectionErrorHandler, Disposable, DisposableCollection, ILogger } from '../../common';
+import { IPCChannel } from './ipc-channel';
+import { createIpcEnv } from './ipc-protocol';
+
+export interface ResolvedIPCConnectionOptions {
+    readonly serverName: string
+    readonly entryPoint: string
+    readonly logger: ILogger
+    readonly args: string[]
+    readonly errorHandler?: ConnectionErrorHandler
+    readonly env?: NodeJS.ProcessEnv
+}
+export type IPCConnectionOptions = Partial<ResolvedIPCConnectionOptions> & {
+    readonly serverName: string
+    readonly entryPoint: string
+};
+
+@injectable()
+export class IPCConnectionProvider {
+
+    @inject(ILogger)
+    protected readonly logger: ILogger;
+
+    listen(options: IPCConnectionOptions, acceptor: (connection: Channel) => void): Disposable {
+        return this.doListen({
+            logger: this.logger,
+            args: [],
+            ...options
+        }, acceptor);
+    }
+
+    protected doListen(options: ResolvedIPCConnectionOptions, acceptor: (connection: Channel) => void): Disposable {
+        const childProcess = this.fork(options);
+        const channel = new IPCChannel(childProcess);
+        const toStop = new DisposableCollection();
+        const toCancelStop = toStop.push(Disposable.create(() => childProcess.kill()));
+        const errorHandler = options.errorHandler;
+        if (errorHandler) {
+            let errorCount = 0;
+            channel.onError((err: Error) => {
+                errorCount++;
+                if (errorHandler.shouldStop(err, errorCount)) {
+                    toStop.dispose();
+                }
+            });
+            channel.onClose(() => {
+                if (toStop.disposed) {
+                    return;
+                }
+                if (errorHandler.shouldRestart()) {
+                    toCancelStop.dispose();
+                    toStop.push(this.doListen(options, acceptor));
+                }
+            });
+        }
+        acceptor(channel);
+        return toStop;
+    }
+
+    protected fork(options: ResolvedIPCConnectionOptions): cp.ChildProcess {
+        const forkOptions: cp.ForkOptions = {
+            env: createIpcEnv(options),
+            execArgv: [],
+            // 5th element MUST be 'overlapped' for it to work properly on Windows.
+            // 'overlapped' works just like 'pipe' on non-Windows platforms.
+            // See: https://nodejs.org/docs/latest-v14.x/api/child_process.html#child_process_options_stdio
+            // Note: For some reason `@types/node` does not know about 'overlapped'.
+            stdio: ['pipe', 'pipe', 'pipe', 'ipc', 'overlapped' as 'pipe']
+        };
+        const inspectArgPrefix = `--${options.serverName}-inspect`;
+        const inspectArg = process.argv.find(v => v.startsWith(inspectArgPrefix));
+        if (inspectArg !== undefined) {
+            forkOptions.execArgv = ['--nolazy', `--inspect${inspectArg.substring(inspectArgPrefix.length)}`];
+        }
+
+        const childProcess = cp.fork(path.join(__dirname, 'ipc-bootstrap'), options.args, forkOptions);
+
+        createInterface(childProcess.stdout!).on('line', line => this.logger.info(`[${options.serverName}: ${childProcess.pid}] ${line}`));
+        createInterface(childProcess.stderr!).on('line', line => this.logger.error(`[${options.serverName}: ${childProcess.pid}] ${line}`));
+
+        this.logger.debug(`[${options.serverName}: ${childProcess.pid}] IPC started`);
+        childProcess.once('exit', () => this.logger.debug(`[${options.serverName}: ${childProcess.pid}] IPC exited`));
+
+        return childProcess;
+    }
+
+}

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

@@ -1,76 +1,76 @@
-
-// *****************************************************************************
-// 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 { Channel } from '../../common/message-rpc/channel';
-
-const THEIA_PARENT_PID = 'THEIA_PARENT_PID';
-const THEIA_ENTRY_POINT = 'THEIA_ENTRY_POINT';
-
-export const ipcEntryPoint: string | undefined = process.env[THEIA_ENTRY_POINT];
-
-export type IPCEntryPoint = (connection: Channel) => void;
-export namespace IPCEntryPoint {
-    /**
-     * Throws if `THEIA_ENTRY_POINT` is undefined or empty.
-     */
-    export function getScriptFromEnv(): string {
-        if (!ipcEntryPoint) {
-            throw new Error(`"${THEIA_ENTRY_POINT}" is missing from the environment`);
-        }
-        return ipcEntryPoint;
-    }
-}
-
-/**
- * Exit the current process if the parent process is not alive.
- * Relevant only for some OS, like Windows
- */
-export function checkParentAlive(): void {
-    if (process.env[THEIA_PARENT_PID]) {
-        const parentPid = Number(process.env[THEIA_PARENT_PID]);
-
-        if (typeof parentPid === 'number' && !isNaN(parentPid)) {
-            setInterval(() => {
-                try {
-                    // throws an exception if the main process doesn't exist anymore.
-                    process.kill(parentPid, 0);
-                } catch {
-                    process.exit();
-                }
-            }, 5000).unref(); // we don't want this timeout to keep the process alive
-        }
-    }
-}
-
-export function createIpcEnv(options?: {
-    entryPoint?: string
-    env?: NodeJS.ProcessEnv
-}): NodeJS.ProcessEnv {
-    const op = Object.assign({}, options);
-    const childEnv = Object.assign({}, op.env);
-
-    for (const key of Object.keys(childEnv)) {
-        if (key.startsWith('THEIA_')) {
-            delete childEnv[key];
-        }
-    }
-
-    childEnv[THEIA_PARENT_PID] = String(process.pid);
-    childEnv[THEIA_ENTRY_POINT] = op.entryPoint;
-
-    return childEnv;
-}
+
+// *****************************************************************************
+// 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 { Channel } from '../../common/message-rpc/channel';
+
+const THEIA_PARENT_PID = 'THEIA_PARENT_PID';
+const THEIA_ENTRY_POINT = 'THEIA_ENTRY_POINT';
+
+export const ipcEntryPoint: string | undefined = process.env[THEIA_ENTRY_POINT];
+
+export type IPCEntryPoint = (connection: Channel) => void;
+export namespace IPCEntryPoint {
+    /**
+     * Throws if `THEIA_ENTRY_POINT` is undefined or empty.
+     */
+    export function getScriptFromEnv(): string {
+        if (!ipcEntryPoint) {
+            throw new Error(`"${THEIA_ENTRY_POINT}" is missing from the environment`);
+        }
+        return ipcEntryPoint;
+    }
+}
+
+/**
+ * Exit the current process if the parent process is not alive.
+ * Relevant only for some OS, like Windows
+ */
+export function checkParentAlive(): void {
+    if (process.env[THEIA_PARENT_PID]) {
+        const parentPid = Number(process.env[THEIA_PARENT_PID]);
+
+        if (typeof parentPid === 'number' && !isNaN(parentPid)) {
+            setInterval(() => {
+                try {
+                    // throws an exception if the main process doesn't exist anymore.
+                    process.kill(parentPid, 0);
+                } catch {
+                    process.exit();
+                }
+            }, 5000).unref(); // we don't want this timeout to keep the process alive
+        }
+    }
+}
+
+export function createIpcEnv(options?: {
+    entryPoint?: string
+    env?: NodeJS.ProcessEnv
+}): NodeJS.ProcessEnv {
+    const op = Object.assign({}, options);
+    const childEnv = Object.assign({}, op.env);
+
+    for (const key of Object.keys(childEnv)) {
+        if (key.startsWith('THEIA_')) {
+            delete childEnv[key];
+        }
+    }
+
+    childEnv[THEIA_PARENT_PID] = String(process.pid);
+    childEnv[THEIA_ENTRY_POINT] = op.entryPoint;
+
+    return childEnv;
+}

package/src/node/messaging/messaging-backend-module.ts

@@ -1,52 +1,52 @@
-// *****************************************************************************
-// 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 { ContainerModule } from 'inversify';
-import { ConnectionHandler, RpcConnectionHandler, bindContributionProvider } from '../../common';
-// import { BackendApplicationContribution } from '../backend-application';
-import { DefaultMessagingService, MessagingContainer } from './default-messaging-service';
-import { ConnectionContainerModule } from './connection-container-module';
-import { MessagingService } from './messaging-service';
-import { MessagingListener, MessagingListenerContribution } from './messaging-listeners';
-import { FrontendConnectionService } from './frontend-connection-service';
-import { BackendApplicationContribution } from '../backend-application';
-import { connectionCloseServicePath } from '../../common/messaging/connection-management';
-import { WebsocketFrontendConnectionService } from './websocket-frontend-connection-service';
-import { WebsocketEndpoint } from './websocket-endpoint';
-
-export const messagingBackendModule = new ContainerModule(bind => {
-    bindContributionProvider(bind, ConnectionContainerModule);
-    bindContributionProvider(bind, MessagingService.Contribution);
-    bind(DefaultMessagingService).toSelf().inSingletonScope();
-    bind(MessagingService.Identifier).toService(DefaultMessagingService);
-    bind(BackendApplicationContribution).toService(DefaultMessagingService);
-    bind(MessagingContainer).toDynamicValue(({ container }) => container).inSingletonScope();
-    bind(WebsocketEndpoint).toSelf().inSingletonScope();
-    bind(BackendApplicationContribution).toService(WebsocketEndpoint);
-    bind(WebsocketFrontendConnectionService).toSelf().inSingletonScope();
-    bind(FrontendConnectionService).toService(WebsocketFrontendConnectionService);
-    bind(MessagingListener).toSelf().inSingletonScope();
-    bindContributionProvider(bind, MessagingListenerContribution);
-
-    bind(ConnectionHandler).toDynamicValue(context => {
-        const connectionService = context.container.get<WebsocketFrontendConnectionService>(FrontendConnectionService);
-        return new RpcConnectionHandler<object>(connectionCloseServicePath, () => ({
-            markForClose: (channelId: string) => {
-                connectionService.markForClose(channelId);
-            }
-        }));
-    }).inSingletonScope();
-});
+// *****************************************************************************
+// 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 { ContainerModule } from 'inversify';
+import { ConnectionHandler, RpcConnectionHandler, bindContributionProvider } from '../../common';
+// import { BackendApplicationContribution } from '../backend-application';
+import { DefaultMessagingService, MessagingContainer } from './default-messaging-service';
+import { ConnectionContainerModule } from './connection-container-module';
+import { MessagingService } from './messaging-service';
+import { MessagingListener, MessagingListenerContribution } from './messaging-listeners';
+import { FrontendConnectionService } from './frontend-connection-service';
+import { BackendApplicationContribution } from '../backend-application';
+import { connectionCloseServicePath } from '../../common/messaging/connection-management';
+import { WebsocketFrontendConnectionService } from './websocket-frontend-connection-service';
+import { WebsocketEndpoint } from './websocket-endpoint';
+
+export const messagingBackendModule = new ContainerModule(bind => {
+    bindContributionProvider(bind, ConnectionContainerModule);
+    bindContributionProvider(bind, MessagingService.Contribution);
+    bind(DefaultMessagingService).toSelf().inSingletonScope();
+    bind(MessagingService.Identifier).toService(DefaultMessagingService);
+    bind(BackendApplicationContribution).toService(DefaultMessagingService);
+    bind(MessagingContainer).toDynamicValue(({ container }) => container).inSingletonScope();
+    bind(WebsocketEndpoint).toSelf().inSingletonScope();
+    bind(BackendApplicationContribution).toService(WebsocketEndpoint);
+    bind(WebsocketFrontendConnectionService).toSelf().inSingletonScope();
+    bind(FrontendConnectionService).toService(WebsocketFrontendConnectionService);
+    bind(MessagingListener).toSelf().inSingletonScope();
+    bindContributionProvider(bind, MessagingListenerContribution);
+
+    bind(ConnectionHandler).toDynamicValue(context => {
+        const connectionService = context.container.get<WebsocketFrontendConnectionService>(FrontendConnectionService);
+        return new RpcConnectionHandler<object>(connectionCloseServicePath, () => ({
+            markForClose: (channelId: string) => {
+                connectionService.markForClose(channelId);
+            }
+        }));
+    }).inSingletonScope();
+});

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

@@ -1,52 +1,52 @@
-// *****************************************************************************
-// Copyright (C) 2021 MayStreet Inc. 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 { inject, injectable, named } from 'inversify';
-import { ContributionProvider, MaybePromise } from '../../common';
-import { Socket } from 'socket.io';
-
-import * as http from 'http';
-
-/**
- * Bind components to this symbol to subscribe to WebSocket events.
- */
-export const MessagingListenerContribution = Symbol('MessagingListenerContribution');
-export interface MessagingListenerContribution {
-    /**
-     * Function invoked when a HTTP connection is upgraded to a websocket.
-     *
-     * @param request The HTTP connection upgrade request received by the server.
-     * @param socket The WebSocket that the connection was upgraded to.
-     */
-    onDidWebSocketUpgrade(request: http.IncomingMessage, socket: Socket): MaybePromise<void>;
-}
-
-/**
- * Handler of Theia messaging system events, dispatching to MessagingListenerContribution instances.
- */
-@injectable()
-export class MessagingListener {
-
-    @inject(ContributionProvider) @named(MessagingListenerContribution)
-    protected readonly messagingListenerContributions: ContributionProvider<MessagingListenerContribution>;
-
-    /**
-     * Notify all the subscribed `MessagingListenerContribution`s that the Websocket was upgraded.
-     */
-    async onDidWebSocketUpgrade(request: http.IncomingMessage, socket: Socket): Promise<void> {
-        await Promise.all(Array.from(this.messagingListenerContributions.getContributions(), async messagingListener => messagingListener.onDidWebSocketUpgrade(request, socket)));
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 MayStreet Inc. 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 { inject, injectable, named } from 'inversify';
+import { ContributionProvider, MaybePromise } from '../../common';
+import { Socket } from 'socket.io';
+
+import * as http from 'http';
+
+/**
+ * Bind components to this symbol to subscribe to WebSocket events.
+ */
+export const MessagingListenerContribution = Symbol('MessagingListenerContribution');
+export interface MessagingListenerContribution {
+    /**
+     * Function invoked when a HTTP connection is upgraded to a websocket.
+     *
+     * @param request The HTTP connection upgrade request received by the server.
+     * @param socket The WebSocket that the connection was upgraded to.
+     */
+    onDidWebSocketUpgrade(request: http.IncomingMessage, socket: Socket): MaybePromise<void>;
+}
+
+/**
+ * Handler of Theia messaging system events, dispatching to MessagingListenerContribution instances.
+ */
+@injectable()
+export class MessagingListener {
+
+    @inject(ContributionProvider) @named(MessagingListenerContribution)
+    protected readonly messagingListenerContributions: ContributionProvider<MessagingListenerContribution>;
+
+    /**
+     * Notify all the subscribed `MessagingListenerContribution`s that the Websocket was upgraded.
+     */
+    async onDidWebSocketUpgrade(request: http.IncomingMessage, socket: Socket): Promise<void> {
+        await Promise.all(Array.from(this.messagingListenerContributions.getContributions(), async messagingListener => messagingListener.onDidWebSocketUpgrade(request, socket)));
+    }
+}