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

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

@@ -1,67 +1,67 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson 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, Container } from '@theia/core/shared/inversify';
-import { RawProcess, RawProcessOptions, RawProcessFactory, RawForkOptions } from './raw-process';
-import { TerminalProcess, TerminalProcessOptions, TerminalProcessFactory } from './terminal-process';
-import { TaskTerminalProcess, TaskTerminalProcessFactory } from './task-terminal-process';
-import { BackendApplicationContribution } from '@theia/core/lib/node';
-import { ProcessManager } from './process-manager';
-import { ILogger } from '@theia/core/lib/common';
-import { MultiRingBuffer, MultiRingBufferOptions } from './multi-ring-buffer';
-
-export default new ContainerModule(bind => {
-    bind(RawProcess).toSelf().inTransientScope();
-    bind(ProcessManager).toSelf().inSingletonScope();
-    bind(BackendApplicationContribution).toService(ProcessManager);
-    bind(ILogger).toDynamicValue(ctx => {
-        const parentLogger = ctx.container.get<ILogger>(ILogger);
-        return parentLogger.child('process');
-    }).inSingletonScope().whenTargetNamed('process');
-    bind(RawProcessFactory).toFactory(ctx =>
-        (options: RawProcessOptions | RawForkOptions) => {
-            const child = new Container({ defaultScope: 'Singleton' });
-            child.parent = ctx.container;
-
-            child.bind(RawProcessOptions).toConstantValue(options);
-            return child.get(RawProcess);
-        }
-    );
-
-    bind(TerminalProcess).toSelf().inTransientScope();
-    bind(TerminalProcessFactory).toFactory(ctx =>
-        (options: TerminalProcessOptions) => {
-            const child = new Container({ defaultScope: 'Singleton' });
-            child.parent = ctx.container;
-
-            child.bind(TerminalProcessOptions).toConstantValue(options);
-            return child.get(TerminalProcess);
-        }
-    );
-
-    bind(TaskTerminalProcess).toSelf().inTransientScope();
-    bind(TaskTerminalProcessFactory).toFactory(ctx =>
-        (options: TerminalProcessOptions) => {
-            const child = ctx.container.createChild();
-            child.bind(TerminalProcessOptions).toConstantValue(options);
-            return child.get(TaskTerminalProcess);
-        }
-    );
-
-    bind(MultiRingBuffer).toSelf().inTransientScope();
-    /* 1MB size, TODO should be a user preference. */
-    bind(MultiRingBufferOptions).toConstantValue({ size: 1048576 });
-});
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson 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, Container } from '@theia/core/shared/inversify';
+import { RawProcess, RawProcessOptions, RawProcessFactory, RawForkOptions } from './raw-process';
+import { TerminalProcess, TerminalProcessOptions, TerminalProcessFactory } from './terminal-process';
+import { TaskTerminalProcess, TaskTerminalProcessFactory } from './task-terminal-process';
+import { BackendApplicationContribution } from '@theia/core/lib/node';
+import { ProcessManager } from './process-manager';
+import { ILogger } from '@theia/core/lib/common';
+import { MultiRingBuffer, MultiRingBufferOptions } from './multi-ring-buffer';
+
+export default new ContainerModule(bind => {
+    bind(RawProcess).toSelf().inTransientScope();
+    bind(ProcessManager).toSelf().inSingletonScope();
+    bind(BackendApplicationContribution).toService(ProcessManager);
+    bind(ILogger).toDynamicValue(ctx => {
+        const parentLogger = ctx.container.get<ILogger>(ILogger);
+        return parentLogger.child('process');
+    }).inSingletonScope().whenTargetNamed('process');
+    bind(RawProcessFactory).toFactory(ctx =>
+        (options: RawProcessOptions | RawForkOptions) => {
+            const child = new Container({ defaultScope: 'Singleton' });
+            child.parent = ctx.container;
+
+            child.bind(RawProcessOptions).toConstantValue(options);
+            return child.get(RawProcess);
+        }
+    );
+
+    bind(TerminalProcess).toSelf().inTransientScope();
+    bind(TerminalProcessFactory).toFactory(ctx =>
+        (options: TerminalProcessOptions) => {
+            const child = new Container({ defaultScope: 'Singleton' });
+            child.parent = ctx.container;
+
+            child.bind(TerminalProcessOptions).toConstantValue(options);
+            return child.get(TerminalProcess);
+        }
+    );
+
+    bind(TaskTerminalProcess).toSelf().inTransientScope();
+    bind(TaskTerminalProcessFactory).toFactory(ctx =>
+        (options: TerminalProcessOptions) => {
+            const child = ctx.container.createChild();
+            child.bind(TerminalProcessOptions).toConstantValue(options);
+            return child.get(TaskTerminalProcess);
+        }
+    );
+
+    bind(MultiRingBuffer).toSelf().inTransientScope();
+    /* 1MB size, TODO should be a user preference. */
+    bind(MultiRingBufferOptions).toConstantValue({ size: 1048576 });
+});

package/src/node/process-manager.ts

@@ -1,107 +1,107 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson 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 } from '@theia/core/shared/inversify';
-import { Emitter, Event } from '@theia/core/lib/common';
-import { ILogger } from '@theia/core/lib/common/logger';
-import { BackendApplicationContribution } from '@theia/core/lib/node';
-import { ManagedProcessManager, ManagedProcess } from '../common/process-manager-types';
-import { MAX_SAFE_INTEGER } from '@theia/core/lib/common/numbers';
-import { Process } from './process';
-
-@injectable()
-export class ProcessManager implements ManagedProcessManager, BackendApplicationContribution {
-
-    protected readonly processes: Map<number, Process>;
-    protected readonly deleteEmitter: Emitter<number>;
-
-    constructor(
-        @inject(ILogger) @named('process') protected logger: ILogger
-    ) {
-        this.processes = new Map();
-        this.deleteEmitter = new Emitter<number>();
-    }
-
-    /**
-     * Registers the given process into this manager. Both on process termination and on error,
-     * the process will be automatically removed from the manager.
-     *
-     * @param process the process to register.
-     */
-    register(process: Process): number {
-        const id = this.generateId();
-        this.processes.set(id, process);
-        process.onError(() => this.unregister(process));
-        return id;
-    }
-
-    /**
-     * @returns a random id for a process that is not assigned to a different process yet.
-     */
-    protected generateId(): number {
-        let id = undefined;
-        while (id === undefined) {
-            const candidate = Math.floor(Math.random() * MAX_SAFE_INTEGER);
-            if (!this.processes.has(candidate)) {
-                id = candidate;
-            }
-        }
-        return id;
-    }
-
-    /**
-     * Removes the process from this process manager. Invoking this method, will make
-     * sure that the process is terminated before eliminating it from the manager's cache.
-     *
-     * @param process the process to unregister from this process manager.
-     */
-    unregister(process: ManagedProcess): void {
-        const processLabel = this.getProcessLabel(process);
-        this.logger.debug(`Unregistering process. ${processLabel}`);
-        if (!process.killed) {
-            this.logger.debug(`Ensuring process termination. ${processLabel}`);
-            process.kill();
-        }
-        if (this.processes.delete(process.id)) {
-            this.deleteEmitter.fire(process.id);
-            this.logger.debug(`The process was successfully unregistered. ${processLabel}`);
-        } else {
-            this.logger.warn(`This process was not registered or was already unregistered. ${processLabel}`);
-        }
-    }
-
-    get(id: number): ManagedProcess | undefined {
-        return this.processes.get(id);
-    }
-
-    get onDelete(): Event<number> {
-        return this.deleteEmitter.event;
-    }
-
-    onStop(): void {
-        for (const process of this.processes.values()) {
-            try {
-                this.unregister(process);
-            } catch (error) {
-                this.logger.error(`Error occurred when unregistering process. ${this.getProcessLabel(process)}`, error);
-            }
-        }
-    }
-
-    private getProcessLabel(process: ManagedProcess): string {
-        return `[ID: ${process.id}]`;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson 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 } from '@theia/core/shared/inversify';
+import { Emitter, Event } from '@theia/core/lib/common';
+import { ILogger } from '@theia/core/lib/common/logger';
+import { BackendApplicationContribution } from '@theia/core/lib/node';
+import { ManagedProcessManager, ManagedProcess } from '../common/process-manager-types';
+import { MAX_SAFE_INTEGER } from '@theia/core/lib/common/numbers';
+import { Process } from './process';
+
+@injectable()
+export class ProcessManager implements ManagedProcessManager, BackendApplicationContribution {
+
+    protected readonly processes: Map<number, Process>;
+    protected readonly deleteEmitter: Emitter<number>;
+
+    constructor(
+        @inject(ILogger) @named('process') protected logger: ILogger
+    ) {
+        this.processes = new Map();
+        this.deleteEmitter = new Emitter<number>();
+    }
+
+    /**
+     * Registers the given process into this manager. Both on process termination and on error,
+     * the process will be automatically removed from the manager.
+     *
+     * @param process the process to register.
+     */
+    register(process: Process): number {
+        const id = this.generateId();
+        this.processes.set(id, process);
+        process.onError(() => this.unregister(process));
+        return id;
+    }
+
+    /**
+     * @returns a random id for a process that is not assigned to a different process yet.
+     */
+    protected generateId(): number {
+        let id = undefined;
+        while (id === undefined) {
+            const candidate = Math.floor(Math.random() * MAX_SAFE_INTEGER);
+            if (!this.processes.has(candidate)) {
+                id = candidate;
+            }
+        }
+        return id;
+    }
+
+    /**
+     * Removes the process from this process manager. Invoking this method, will make
+     * sure that the process is terminated before eliminating it from the manager's cache.
+     *
+     * @param process the process to unregister from this process manager.
+     */
+    unregister(process: ManagedProcess): void {
+        const processLabel = this.getProcessLabel(process);
+        this.logger.debug(`Unregistering process. ${processLabel}`);
+        if (!process.killed) {
+            this.logger.debug(`Ensuring process termination. ${processLabel}`);
+            process.kill();
+        }
+        if (this.processes.delete(process.id)) {
+            this.deleteEmitter.fire(process.id);
+            this.logger.debug(`The process was successfully unregistered. ${processLabel}`);
+        } else {
+            this.logger.warn(`This process was not registered or was already unregistered. ${processLabel}`);
+        }
+    }
+
+    get(id: number): ManagedProcess | undefined {
+        return this.processes.get(id);
+    }
+
+    get onDelete(): Event<number> {
+        return this.deleteEmitter.event;
+    }
+
+    onStop(): void {
+        for (const process of this.processes.values()) {
+            try {
+                this.unregister(process);
+            } catch (error) {
+                this.logger.error(`Error occurred when unregistering process. ${this.getProcessLabel(process)}`, error);
+            }
+        }
+    }
+
+    private getProcessLabel(process: ManagedProcess): string {
+        return `[ID: ${process.id}]`;
+    }
+
+}