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

package/src/node/task.ts

@@ -1,103 +1,103 @@
-// *****************************************************************************
-// 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 } from '@theia/core/shared/inversify';
-import { ILogger, Disposable, DisposableCollection, Emitter, Event, MaybePromise } from '@theia/core/lib/common/';
-import { TaskInfo, TaskExitedEvent, TaskConfiguration, TaskOutputEvent, ManagedTask, ManagedTaskManager } from '../common/task-protocol';
-/**
- * Represents the options used for running a task.
- */
-export interface TaskOptions {
-    /** The task label */
-    label: string;
-    /** The task configuration which should be executed */
-    config: TaskConfiguration;
-    /** The optional execution context */
-    context?: string;
-}
-
-/**
- * A {@link Task} represents the execution state of a `TaskConfiguration`.
- * Implementing classes have to call the {@link Task#fireOutputLine} function
- * whenever a new output occurs during the execution.
- */
-@injectable()
-export abstract class Task implements Disposable, ManagedTask {
-
-    protected taskId: number;
-    protected readonly toDispose: DisposableCollection = new DisposableCollection();
-    readonly exitEmitter: Emitter<TaskExitedEvent>;
-    readonly outputEmitter: Emitter<TaskOutputEvent>;
-
-    constructor(
-        protected readonly taskManager: ManagedTaskManager<Task>,
-        protected readonly logger: ILogger,
-        protected readonly options: TaskOptions
-    ) {
-        this.taskId = this.taskManager.register(this, this.options.context);
-        this.exitEmitter = new Emitter<TaskExitedEvent>();
-        this.outputEmitter = new Emitter<TaskOutputEvent>();
-        this.toDispose.push(this.exitEmitter);
-        this.toDispose.push(this.outputEmitter);
-    }
-
-    /**
-     * Terminate this task.
-     *
-     * @returns a promise that resolves once the task has been properly terminated.
-     */
-    abstract kill(): Promise<void>;
-
-    get onExit(): Event<TaskExitedEvent> {
-        return this.exitEmitter.event;
-    }
-
-    get onOutput(): Event<TaskOutputEvent> {
-        return this.outputEmitter.event;
-    }
-
-    /** Has to be called when a task has concluded its execution. */
-    protected fireTaskExited(event: TaskExitedEvent): void {
-        this.exitEmitter.fire(event);
-    }
-
-    protected fireOutputLine(event: TaskOutputEvent): void {
-        this.outputEmitter.fire(event);
-    }
-    /**
-     * Retrieves the runtime information about this task.
-     * The runtime information computation may happen asynchronous.
-     *
-     * @returns (a promise of) the runtime information as `TaskInfo`.
-     */
-    abstract getRuntimeInfo(): MaybePromise<TaskInfo>;
-
-    get id(): number {
-        return this.taskId;
-    }
-
-    get context(): string | undefined {
-        return this.options.context;
-    }
-
-    get label(): string {
-        return this.options.label;
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-}
+// *****************************************************************************
+// 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 } from '@theia/core/shared/inversify';
+import { ILogger, Disposable, DisposableCollection, Emitter, Event, MaybePromise } from '@theia/core/lib/common/';
+import { TaskInfo, TaskExitedEvent, TaskConfiguration, TaskOutputEvent, ManagedTask, ManagedTaskManager } from '../common/task-protocol';
+/**
+ * Represents the options used for running a task.
+ */
+export interface TaskOptions {
+    /** The task label */
+    label: string;
+    /** The task configuration which should be executed */
+    config: TaskConfiguration;
+    /** The optional execution context */
+    context?: string;
+}
+
+/**
+ * A {@link Task} represents the execution state of a `TaskConfiguration`.
+ * Implementing classes have to call the {@link Task#fireOutputLine} function
+ * whenever a new output occurs during the execution.
+ */
+@injectable()
+export abstract class Task implements Disposable, ManagedTask {
+
+    protected taskId: number;
+    protected readonly toDispose: DisposableCollection = new DisposableCollection();
+    readonly exitEmitter: Emitter<TaskExitedEvent>;
+    readonly outputEmitter: Emitter<TaskOutputEvent>;
+
+    constructor(
+        protected readonly taskManager: ManagedTaskManager<Task>,
+        protected readonly logger: ILogger,
+        protected readonly options: TaskOptions
+    ) {
+        this.taskId = this.taskManager.register(this, this.options.context);
+        this.exitEmitter = new Emitter<TaskExitedEvent>();
+        this.outputEmitter = new Emitter<TaskOutputEvent>();
+        this.toDispose.push(this.exitEmitter);
+        this.toDispose.push(this.outputEmitter);
+    }
+
+    /**
+     * Terminate this task.
+     *
+     * @returns a promise that resolves once the task has been properly terminated.
+     */
+    abstract kill(): Promise<void>;
+
+    get onExit(): Event<TaskExitedEvent> {
+        return this.exitEmitter.event;
+    }
+
+    get onOutput(): Event<TaskOutputEvent> {
+        return this.outputEmitter.event;
+    }
+
+    /** Has to be called when a task has concluded its execution. */
+    protected fireTaskExited(event: TaskExitedEvent): void {
+        this.exitEmitter.fire(event);
+    }
+
+    protected fireOutputLine(event: TaskOutputEvent): void {
+        this.outputEmitter.fire(event);
+    }
+    /**
+     * Retrieves the runtime information about this task.
+     * The runtime information computation may happen asynchronous.
+     *
+     * @returns (a promise of) the runtime information as `TaskInfo`.
+     */
+    abstract getRuntimeInfo(): MaybePromise<TaskInfo>;
+
+    get id(): number {
+        return this.taskId;
+    }
+
+    get context(): string | undefined {
+        return this.options.context;
+    }
+
+    get label(): string {
+        return this.options.label;
+    }
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+}

package/src/node/test/task-test-container.ts

@@ -1,63 +1,63 @@
-// *****************************************************************************
-// 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 { Container } from '@theia/core/shared/inversify';
-import { bindLogger } from '@theia/core/lib/node/logger-backend-module';
-import { backendApplicationModule } from '@theia/core/lib/node/backend-application-module';
-import processBackendModule from '@theia/process/lib/node/process-backend-module';
-import terminalBackendModule from '@theia/terminal/lib/node/terminal-backend-module';
-import taskBackendModule from '../task-backend-module';
-import filesystemBackendModule from '@theia/filesystem/lib/node/filesystem-backend-module';
-import workspaceServer from '@theia/workspace/lib/node/workspace-backend-module';
-import { messagingBackendModule } from '@theia/core/lib/node/messaging/messaging-backend-module';
-import { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
-import { TerminalProcess } from '@theia/process/lib/node';
-import { ProcessUtils } from '@theia/core/lib/node/process-utils';
-
-export function createTaskTestContainer(): Container {
-    const testContainer = new Container();
-
-    testContainer.load(backendApplicationModule);
-    testContainer.rebind(ApplicationPackage).toConstantValue({} as ApplicationPackage);
-
-    bindLogger(testContainer.bind.bind(testContainer));
-    testContainer.load(messagingBackendModule);
-    testContainer.load(processBackendModule);
-    testContainer.load(taskBackendModule);
-    testContainer.load(filesystemBackendModule);
-    testContainer.load(workspaceServer);
-    testContainer.load(terminalBackendModule);
-
-    // Make it easier to debug processes.
-    testContainer.rebind(TerminalProcess).to(TestTerminalProcess);
-
-    testContainer.rebind(ProcessUtils).toConstantValue(new class extends ProcessUtils {
-        override terminateProcessTree(): void { } // don't actually kill the tree, it breaks the tests.
-    });
-
-    return testContainer;
-}
-
-class TestTerminalProcess extends TerminalProcess {
-
-    protected override emitOnStarted(): void {
-        if (process.env['THEIA_TASK_TEST_DEBUG']) {
-            console.log(`START ${this.id} ${JSON.stringify([this.executable, this.options.commandLine, ...this.arguments])}`);
-            this.outputStream.on('data', data => console.debug(`${this.id} OUTPUT: ${data.toString().trim()}`));
-        }
-        super.emitOnStarted();
-    }
-
-}
+// *****************************************************************************
+// 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 { Container } from '@theia/core/shared/inversify';
+import { bindLogger } from '@theia/core/lib/node/logger-backend-module';
+import { backendApplicationModule } from '@theia/core/lib/node/backend-application-module';
+import processBackendModule from '@theia/process/lib/node/process-backend-module';
+import terminalBackendModule from '@theia/terminal/lib/node/terminal-backend-module';
+import taskBackendModule from '../task-backend-module';
+import filesystemBackendModule from '@theia/filesystem/lib/node/filesystem-backend-module';
+import workspaceServer from '@theia/workspace/lib/node/workspace-backend-module';
+import { messagingBackendModule } from '@theia/core/lib/node/messaging/messaging-backend-module';
+import { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
+import { TerminalProcess } from '@theia/process/lib/node';
+import { ProcessUtils } from '@theia/core/lib/node/process-utils';
+
+export function createTaskTestContainer(): Container {
+    const testContainer = new Container();
+
+    testContainer.load(backendApplicationModule);
+    testContainer.rebind(ApplicationPackage).toConstantValue({} as ApplicationPackage);
+
+    bindLogger(testContainer.bind.bind(testContainer));
+    testContainer.load(messagingBackendModule);
+    testContainer.load(processBackendModule);
+    testContainer.load(taskBackendModule);
+    testContainer.load(filesystemBackendModule);
+    testContainer.load(workspaceServer);
+    testContainer.load(terminalBackendModule);
+
+    // Make it easier to debug processes.
+    testContainer.rebind(TerminalProcess).to(TestTerminalProcess);
+
+    testContainer.rebind(ProcessUtils).toConstantValue(new class extends ProcessUtils {
+        override terminateProcessTree(): void { } // don't actually kill the tree, it breaks the tests.
+    });
+
+    return testContainer;
+}
+
+class TestTerminalProcess extends TerminalProcess {
+
+    protected override emitOnStarted(): void {
+        if (process.env['THEIA_TASK_TEST_DEBUG']) {
+            console.log(`START ${this.id} ${JSON.stringify([this.executable, this.options.commandLine, ...this.arguments])}`);
+            this.outputStream.on('data', data => console.debug(`${this.id} OUTPUT: ${data.toString().trim()}`));
+        }
+        super.emitOnStarted();
+    }
+
+}