@theia/task 1.73.0-next.9 → 1.73.1

package/src/browser/task-service.ts

@@ -26,7 +26,7 @@ import { EditorManager } from '@theia/editor/lib/browser';
 import { ProblemManager } from '@theia/markers/lib/browser/problem/problem-manager';
 import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-service';
 import { TerminalWidget } from '@theia/terminal/lib/browser/base/terminal-widget';
-import { TerminalWidgetFactoryOptions } from '@theia/terminal/lib/browser/terminal-widget-impl';
+import { TerminalWidgetFactoryOptions, nextTerminalCreationToken } from '@theia/terminal/lib/browser/terminal-widget-impl';
 import { VariableResolverService } from '@theia/variable-resolver/lib/browser';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
 import { WorkspaceTrustService } from '@theia/workspace/lib/browser';
@@ -121,7 +121,7 @@ export class TaskService implements TaskConfigurationClient {
     @inject(TaskServer)
     protected readonly taskServer: TaskServer;
 
-    @inject(ILogger) @named('task')
+    @inject(ILogger) @named('task:TaskService')
     protected readonly logger: ILogger;
 
     @inject(WidgetManager)
@@ -338,7 +338,7 @@ export class TaskService implements TaskConfigurationClient {
             } else if (event.signal !== undefined) {
                 this.messageService.info(nls.localize('theia/task/taskTerminatedBySignal', "Task '{0}' was terminated by signal {1}.", taskIdentifier, event.signal));
             } else {
-                console.error('Invalid TaskExitedEvent received, neither code nor signal is set.');
+                this.logger.error('Invalid TaskExitedEvent received, neither code nor signal is set.');
             }
         });
     }
@@ -588,7 +588,7 @@ export class TaskService implements TaskConfigurationClient {
             return this.runCompoundTask(token, task, runTaskOption);
         } else {
             return this.runTask(task, runTaskOption).catch(error => {
-                console.error('Error at launching task', error);
+                this.logger.error('Error at launching task', error);
                 return undefined;
             });
         }
@@ -606,12 +606,12 @@ export class TaskService implements TaskConfigurationClient {
             const rootNode = new TaskNode(task, [], []);
             this.detectDirectedAcyclicGraph(task, rootNode, tasks);
         } catch (error) {
-            console.error(`Error at launching task '${task.label}'`, error);
+            this.logger.error(`Error at launching task '${task.label}'`, error);
             this.messageService.error(error.message);
             return undefined;
         }
         return this.runTasksGraph(task, tasks, option).catch(error => {
-            console.error(`Error at launching task '${task.label}'`, error);
+            this.logger.error(`Error at launching task '${task.label}'`, error);
             return undefined;
         });
     }
@@ -759,9 +759,9 @@ export class TaskService implements TaskConfigurationClient {
         if (!(await this.requestWorkspaceTrust())) {
             return;
         }
-        console.debug('entering runTask');
+        this.logger.debug('entering runTask');
         const releaseLock = await this.taskStartingLock.acquire();
-        console.debug('got lock');
+        this.logger.debug('got lock');
 
         try {
             // resolve problemMatchers
@@ -779,11 +779,11 @@ export class TaskService implements TaskConfigurationClient {
                 const taskConfig = taskInfo.config;
                 return this.taskDefinitionRegistry.compareTasks(taskConfig, task);
             });
-            console.debug(`running task ${JSON.stringify(task)}, already running = ${!!matchedRunningTaskInfo}`);
+            this.logger.debug(`running task ${JSON.stringify(task)}, already running = ${!!matchedRunningTaskInfo}`);
 
             if (matchedRunningTaskInfo) { // the task is active
                 releaseLock();
-                console.debug('released lock');
+                this.logger.debug('released lock');
                 const taskName = this.taskNameResolver.resolve(task);
                 const terminalId = matchedRunningTaskInfo.terminalId;
                 if (terminalId) {
@@ -805,10 +805,10 @@ export class TaskService implements TaskConfigurationClient {
                     return this.restartTask(matchedRunningTaskInfo, option);
                 }
             } else { // run task as the task is not active
-                console.debug('task about to start');
+                this.logger.debug('task about to start');
                 const taskInfo = await this.doRunTask(task, option);
                 releaseLock();
-                console.debug('release lock 2');
+                this.logger.debug('release lock 2');
                 return taskInfo;
             }
         } catch (e) {
@@ -911,7 +911,7 @@ export class TaskService implements TaskConfigurationClient {
         return this.runTasksGraph(task, tasks, {
             customization: { ...taskCustomization, ...{ problemMatcher: resolvedMatchers } }
         }).catch(error => {
-            console.log(error.message);
+            this.logger.info(error.message);
             return undefined;
         });
     }
@@ -1083,7 +1083,7 @@ export class TaskService implements TaskConfigurationClient {
         const selectedText: string = this.editorManager.currentEditor.editor.document.getText(selectedRange).trimRight() + '\n';
         let terminal = this.terminalService.lastUsedTerminal;
         if (!terminal || terminal.kind !== 'user' || (await terminal.hasChildProcesses())) {
-            terminal = <TerminalWidget>await this.terminalService.newTerminal(<TerminalWidgetFactoryOptions>{ created: new Date().toString() });
+            terminal = <TerminalWidget>await this.terminalService.newTerminal(<TerminalWidgetFactoryOptions>{ created: nextTerminalCreationToken() });
             await terminal.start();
             this.terminalService.open(terminal);
         }
@@ -1109,7 +1109,7 @@ export class TaskService implements TaskConfigurationClient {
         const { taskId } = taskInfo;
         // Create / find a terminal widget to display an execution output of a task that was launched as a command inside a shell.
         const widget = await this.taskTerminalWidgetManager.open({
-            created: new Date().toString(),
+            created: nextTerminalCreationToken(),
             id: this.getTerminalWidgetId(terminalId),
             title: nls.localizeByDefault('Task: {0}', taskInfo.config.label || nls.localize('theia/task/taskIdLabel', '#{0}', taskId)),
             destroyTermOnClose: true,

package/src/browser/task-terminal-widget-manager.ts

@@ -15,7 +15,7 @@
 // *****************************************************************************
 
 import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import { ApplicationShell, WidgetManager, WidgetOpenerOptions } from '@theia/core/lib/browser';
+import { WidgetOpenerOptions } from '@theia/core/lib/browser';
 import { TerminalWidget } from '@theia/terminal/lib/browser/base/terminal-widget';
 import { TerminalWidgetFactoryOptions } from '@theia/terminal/lib/browser/terminal-widget-impl';
 import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-service';
@@ -25,9 +25,6 @@ import { TaskDefinitionRegistry } from './task-definition-registry';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
 import URI from '@theia/core/lib/common/uri';
 import { nls } from '@theia/core';
-import { TerminalManagerWidget } from '@theia/terminal-manager/lib/browser/terminal-manager-widget';
-import { TerminalManagerFrontendViewContribution } from '@theia/terminal-manager/lib/browser/terminal-manager-frontend-view-contribution';
-import { TerminalManagerPreferences } from '@theia/terminal-manager/lib/browser/terminal-manager-preferences';
 
 export interface TaskTerminalWidget extends TerminalWidget {
     readonly kind: 'task';
@@ -71,9 +68,6 @@ export namespace TaskTerminalWidgetOpenerOptions {
 @injectable()
 export class TaskTerminalWidgetManager {
 
-    @inject(ApplicationShell)
-    protected readonly shell: ApplicationShell;
-
     @inject(TaskDefinitionRegistry)
     protected readonly taskDefinitionRegistry: TaskDefinitionRegistry;
 
@@ -89,15 +83,6 @@ export class TaskTerminalWidgetManager {
     @inject(WorkspaceService)
     protected readonly workspaceService: WorkspaceService;
 
-    @inject(TerminalManagerPreferences)
-    protected readonly preferences: TerminalManagerPreferences;
-
-    @inject(WidgetManager)
-    protected readonly widgetManager: WidgetManager;
-
-    @inject(TerminalManagerFrontendViewContribution)
-    protected readonly terminalManagerViewContribution: TerminalManagerFrontendViewContribution;
-
     @postConstruct()
     protected init(): void {
         this.taskWatcher.onTaskExit((event: TaskExitedEvent) => {
@@ -154,14 +139,7 @@ export class TaskTerminalWidgetManager {
         }
 
         const { isNew, widget } = await this.getWidgetToRunTask(factoryOptions, openerOptions);
-        const isTreeMode = this.preferences['terminal.grouping.mode'] === 'tree';
-        if (isNew && isTreeMode) {
-            const terminalManagerWidget = await this.widgetManager.getOrCreateWidget<TerminalManagerWidget>(TerminalManagerWidget.ID);
-            terminalManagerWidget.addTerminalToTasksPage(widget);
-            widget.resetTerminal();
-            await this.terminalManagerViewContribution.openView({ reveal: true });
-        } else if (isNew) {
-            this.shell.addWidget(widget, { area: openerOptions.widgetOptions ? openerOptions.widgetOptions.area : 'bottom' });
+        if (isNew) {
             widget.resetTerminal();
         } else {
             if (factoryOptions.title) {
@@ -171,14 +149,13 @@ export class TaskTerminalWidgetManager {
                 widget.clearOutput();
             }
         }
-        this.terminalService.open(widget, openerOptions);
-        if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) &&
-            taskInfo && ProcessTaskInfo.is(taskInfo) && taskInfo.command && taskInfo.command.length > 0
-        ) {
+        await this.terminalService.open(widget, openerOptions);
+        const command = taskInfo && ProcessTaskInfo.is(taskInfo) ? taskInfo.command : undefined;
+        if (TaskTerminalWidgetOpenerOptions.echoExecutedCommand(openerOptions) && command && command.length > 0) {
             if (widget.commandHistoryState) {
-                widget.writeLine('\x1b]133;prompt_started\x07');
+                widget.write('\x1b]133;prompt_started\x07');
             }
-            widget.writeLine('\x1b[1m> ' + nls.localizeByDefault('Executing task: {0}', taskInfo.command) + ' <\x1b[0m\n');
+            widget.writeLine('\x1b[1m> ' + nls.localizeByDefault('Executing task: {0}', command) + ' <\x1b[0m\n');
         }
         return widget;
     }

package/src/node/task-server.slow-spec.ts

@@ -111,7 +111,7 @@ describe('Task server / back-end', function (): void {
             setup.connectionProvider.listen(`${terminalsPath}/${terminalId}`, (path, channel) => {
                 channel.onMessage(e => stringBuffer.push(e().readString()));
                 channel.onError(reject);
-                channel.onClose(() => reject(new Error('Channel has been closed')));
+                // onClose is not used to reject: the server now closes the channel after process exit (expected behavior).
             }, false);
             stringBuffer.onData(currentMessage => {
                 // Instead of waiting for one message from the terminal, we wait for several ones as the very first message can be something unexpected.
@@ -359,6 +359,52 @@ describe('Task server / back-end', function (): void {
         expect(exitStatus).eq(0);
     });
 
+    it('onDidStartTaskProcess is fired when a terminal-process task is created', async function (): Promise<void> {
+        const command = isWindows ? commandShortRunningWindows : (isOSX ? commandShortRunningOsx : commandShortRunning);
+        let startEvent: TaskInfo | undefined;
+        const toDispose = taskWatcher.onDidStartTaskProcess(event => { startEvent = event; });
+        const taskInfo = await taskServer.run(createProcessTaskConfig('shell', command, undefined), wsRoot);
+        toDispose.dispose();
+
+        if (startEvent === undefined) {
+            throw new Error('onDidStartTaskProcess was not fired');
+        }
+        expect(startEvent.taskId).equals(taskInfo.taskId);
+        expect(startEvent.processId).to.be.a('number');
+        await checkSuccessfulProcessExit(taskInfo, taskWatcher);
+    });
+
+    it('onDidStartTaskProcess is fired when a raw-process task is created', async function (): Promise<void> {
+        const command = isWindows ? commandShortRunningWindows : (isOSX ? commandShortRunningOsx : commandShortRunning);
+        const executable = FileUri.fsPath(wsRootUri.resolve(command));
+        let startEvent: TaskInfo | undefined;
+        const toDispose = taskWatcher.onDidStartTaskProcess(event => { startEvent = event; });
+        const taskInfo = await taskServer.run(createProcessTaskConfig('process', executable, []), wsRoot);
+        toDispose.dispose();
+
+        if (startEvent === undefined) {
+            throw new Error('onDidStartTaskProcess was not fired');
+        }
+        expect(startEvent.taskId).equals(taskInfo.taskId);
+        expect(startEvent.processId).to.be.a('number');
+        await checkSuccessfulProcessExit(taskInfo, taskWatcher);
+    });
+
+    it('onDidStartTaskProcess is not fired for a non-process (custom) task', async function (): Promise<void> {
+        let processStarted = false;
+        let taskCreated = false;
+        const disposeStart = taskWatcher.onDidStartTaskProcess(() => { processStarted = true; });
+        const disposeCreated = taskWatcher.onTaskCreated(() => { taskCreated = true; });
+        const taskInfo = await taskServer.run(createCustomTaskConfig(), wsRoot);
+        disposeStart.dispose();
+        disposeCreated.dispose();
+
+        // The events are fired synchronously while `run` is awaited, so by now they have either fired or not.
+        expect(taskCreated, 'onTaskCreated was expected to fire for a custom task').to.equal(true);
+        expect(processStarted, 'onDidStartTaskProcess should not fire for a non-process task').to.equal(false);
+        await taskServer.kill(taskInfo.taskId);
+    });
+
 });
 
 function createTaskConfig(taskType: string, command: string, args: string[]): TaskConfiguration {
@@ -397,6 +443,15 @@ function createProcessTaskConfig2(processType: ProcessType, command: string, arg
     };
 }
 
+function createCustomTaskConfig(): TaskConfiguration {
+    return {
+        label: 'test custom task',
+        type: 'customExecution',
+        _source: '/source/folder',
+        _scope: '/source/folder'
+    };
+}
+
 function createTaskConfigTaskLongRunning(processType: ProcessType): TaskConfiguration {
     return <ProcessTaskConfiguration>{
         label: '[Task] long running test task (~300s)',

package/src/node/task-server.ts

@@ -163,7 +163,7 @@ export class TaskServerImpl implements TaskServer, Disposable {
         this.toDispose.get(task.id)!.push(task);
 
         const taskInfo = await task.getRuntimeInfo();
-        this.fireTaskCreatedEvent(taskInfo);
+        this.fireTaskCreatedEvent(taskInfo, task);
         return taskInfo;
     }