-
Notifications
You must be signed in to change notification settings - Fork 29.9k
/
terminalTaskSystem.ts
1775 lines (1647 loc) · 73.9 KB
/
terminalTaskSystem.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as Async from 'vs/base/common/async';
import { IStringDictionary } from 'vs/base/common/collections';
import { Emitter, Event } from 'vs/base/common/event';
import { isUNC } from 'vs/base/common/extpath';
import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
import { LinkedMap, Touch } from 'vs/base/common/map';
import * as Objects from 'vs/base/common/objects';
import * as path from 'vs/base/common/path';
import * as Platform from 'vs/base/common/platform';
import * as resources from 'vs/base/common/resources';
import Severity from 'vs/base/common/severity';
import * as Types from 'vs/base/common/types';
import * as nls from 'vs/nls';
import { IModelService } from 'vs/editor/common/services/model';
import { IFileService } from 'vs/platform/files/common/files';
import { IMarkerService, MarkerSeverity } from 'vs/platform/markers/common/markers';
import { IWorkspaceContextService, IWorkspaceFolder, WorkbenchState } from 'vs/platform/workspace/common/workspace';
import { Markers } from 'vs/workbench/contrib/markers/common/markers';
import { ProblemMatcher, ProblemMatcherRegistry /*, ProblemPattern, getResource */ } from 'vs/workbench/contrib/tasks/common/problemMatcher';
import { Codicon } from 'vs/base/common/codicons';
import { Schemas } from 'vs/base/common/network';
import { URI } from 'vs/base/common/uri';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { ILogService } from 'vs/platform/log/common/log';
import { INotificationService } from 'vs/platform/notification/common/notification';
import { IShellLaunchConfig, TerminalLocation, TerminalSettingId } from 'vs/platform/terminal/common/terminal';
import { formatMessageForTerminal } from 'vs/platform/terminal/common/terminalStrings';
import { ThemeIcon } from 'vs/platform/theme/common/themeService';
import { IViewDescriptorService, IViewsService, ViewContainerLocation } from 'vs/workbench/common/views';
import { TaskTerminalStatus } from 'vs/workbench/contrib/tasks/browser/taskTerminalStatus';
import { ProblemCollectorEventKind, ProblemHandlingStrategy, StartStopProblemCollector, WatchingProblemCollector } from 'vs/workbench/contrib/tasks/common/problemCollectors';
import { GroupKind } from 'vs/workbench/contrib/tasks/common/taskConfiguration';
import { CommandOptions, CommandString, ContributedTask, CustomTask, DependsOrder, ICommandConfiguration, IExtensionTaskSource, InMemoryTask, IShellConfiguration, IShellQuotingOptions, ITaskEvent, PanelKind, RevealKind, RevealProblemKind, RuntimeType, ShellQuoting, Task, TaskEvent, TaskEventKind, TaskScope, TaskSettingId, TaskSourceKind } from 'vs/workbench/contrib/tasks/common/tasks';
import { ITaskService } from 'vs/workbench/contrib/tasks/common/taskService';
import { IResolvedVariables, IResolveSet, ITaskExecuteResult, ITaskResolver, ITaskSummary, ITaskSystem, ITaskSystemInfo, ITaskSystemInfoResolver, ITaskTerminateResponse, TaskError, TaskErrors, TaskExecuteKind, Triggers } from 'vs/workbench/contrib/tasks/common/taskSystem';
import { ITerminalGroupService, ITerminalInstance, ITerminalService } from 'vs/workbench/contrib/terminal/browser/terminal';
import { VSCodeOscProperty, VSCodeOscPt, VSCodeSequence } from 'vs/workbench/contrib/terminal/browser/terminalEscapeSequences';
import { TerminalProcessExtHostProxy } from 'vs/workbench/contrib/terminal/browser/terminalProcessExtHostProxy';
import { ITerminalProfileResolverService, TERMINAL_VIEW_ID } from 'vs/workbench/contrib/terminal/common/terminal';
import { IConfigurationResolverService } from 'vs/workbench/services/configurationResolver/common/configurationResolver';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IOutputService } from 'vs/workbench/services/output/common/output';
import { IPaneCompositePartService } from 'vs/workbench/services/panecomposite/browser/panecomposite';
import { IPathService } from 'vs/workbench/services/path/common/pathService';
interface ITerminalData {
terminal: ITerminalInstance;
lastTask: string;
group?: string;
}
interface IActiveTerminalData {
terminal: ITerminalInstance;
task: Task;
promise: Promise<ITaskSummary>;
state?: TaskEventKind;
}
class InstanceManager {
private _currentInstances: number = 0;
private _counter: number = 0;
addInstance() {
this._currentInstances++;
this._counter++;
}
removeInstance() {
this._currentInstances--;
}
get instances() {
return this._currentInstances;
}
get counter() {
return this._counter;
}
}
class VariableResolver {
private static _regex = /\$\{(.*?)\}/g;
constructor(public workspaceFolder: IWorkspaceFolder | undefined, public taskSystemInfo: ITaskSystemInfo | undefined, public readonly values: Map<string, string>, private _service: IConfigurationResolverService | undefined) {
}
async resolve(value: string): Promise<string> {
const replacers: Promise<string>[] = [];
value.replace(VariableResolver._regex, (match, ...args) => {
replacers.push(this._replacer(match, args));
return match;
});
const resolvedReplacers = await Promise.all(replacers);
return value.replace(VariableResolver._regex, () => resolvedReplacers.shift()!);
}
private async _replacer(match: string, args: string[]): Promise<string> {
// Strip out the ${} because the map contains them variables without those characters.
const result = this.values.get(match.substring(2, match.length - 1));
if ((result !== undefined) && (result !== null)) {
return result;
}
if (this._service) {
return this._service.resolveAsync(this.workspaceFolder, match);
}
return match;
}
}
export class VerifiedTask {
readonly task: Task;
readonly resolver: ITaskResolver;
readonly trigger: string;
resolvedVariables?: IResolvedVariables;
systemInfo?: ITaskSystemInfo;
workspaceFolder?: IWorkspaceFolder;
shellLaunchConfig?: IShellLaunchConfig;
constructor(task: Task, resolver: ITaskResolver, trigger: string) {
this.task = task;
this.resolver = resolver;
this.trigger = trigger;
}
public verify(): boolean {
let verified = false;
if (this.trigger && this.resolvedVariables && this.workspaceFolder && (this.shellLaunchConfig !== undefined)) {
verified = true;
}
return verified;
}
public getVerifiedTask(): { task: Task; resolver: ITaskResolver; trigger: string; resolvedVariables: IResolvedVariables; systemInfo: ITaskSystemInfo; workspaceFolder: IWorkspaceFolder; shellLaunchConfig: IShellLaunchConfig } {
if (this.verify()) {
return { task: this.task, resolver: this.resolver, trigger: this.trigger, resolvedVariables: this.resolvedVariables!, systemInfo: this.systemInfo!, workspaceFolder: this.workspaceFolder!, shellLaunchConfig: this.shellLaunchConfig! };
} else {
throw new Error('VerifiedTask was not checked. verify must be checked before getVerifiedTask.');
}
}
}
export class TerminalTaskSystem extends Disposable implements ITaskSystem {
public static TelemetryEventName: string = 'taskService';
private static readonly ProcessVarName = '__process__';
private static _shellQuotes: IStringDictionary<IShellQuotingOptions> = {
'cmd': {
strong: '"'
},
'powershell': {
escape: {
escapeChar: '`',
charsToEscape: ' "\'()'
},
strong: '\'',
weak: '"'
},
'bash': {
escape: {
escapeChar: '\\',
charsToEscape: ' "\''
},
strong: '\'',
weak: '"'
},
'zsh': {
escape: {
escapeChar: '\\',
charsToEscape: ' "\''
},
strong: '\'',
weak: '"'
}
};
private static _osShellQuotes: IStringDictionary<IShellQuotingOptions> = {
'Linux': TerminalTaskSystem._shellQuotes['bash'],
'Mac': TerminalTaskSystem._shellQuotes['bash'],
'Windows': TerminalTaskSystem._shellQuotes['powershell']
};
private _activeTasks: IStringDictionary<IActiveTerminalData>;
private _instances: IStringDictionary<InstanceManager>;
private _busyTasks: IStringDictionary<Task>;
private _terminals: IStringDictionary<ITerminalData>;
private _idleTaskTerminals: LinkedMap<string, string>;
private _sameTaskTerminals: IStringDictionary<string>;
private _taskSystemInfoResolver: ITaskSystemInfoResolver;
private _lastTask: VerifiedTask | undefined;
// Should always be set in run
private _currentTask!: VerifiedTask;
private _isRerun: boolean = false;
private _previousPanelId: string | undefined;
private _previousTerminalInstance: ITerminalInstance | undefined;
private _terminalStatusManager: TaskTerminalStatus;
private _terminalCreationQueue: Promise<ITerminalInstance | void> = Promise.resolve();
private _hasReconnected: boolean = false;
private _tasksToReconnect: string[] = [];
private readonly _onDidStateChange: Emitter<ITaskEvent>;
get taskShellIntegrationStartSequence(): string {
return this._configurationService.getValue(TaskSettingId.ShowDecorations) ? VSCodeSequence(VSCodeOscPt.PromptStart) + VSCodeSequence(VSCodeOscPt.Property, `${VSCodeOscProperty.Task}=True`) + VSCodeSequence(VSCodeOscPt.CommandStart) : '';
}
get taskShellIntegrationOutputSequence(): string {
return this._configurationService.getValue(TaskSettingId.ShowDecorations) ? VSCodeSequence(VSCodeOscPt.CommandExecuted) : '';
}
constructor(
private _terminalService: ITerminalService,
private _terminalGroupService: ITerminalGroupService,
private _outputService: IOutputService,
private _paneCompositeService: IPaneCompositePartService,
private _viewsService: IViewsService,
private _markerService: IMarkerService,
private _modelService: IModelService,
private _configurationResolverService: IConfigurationResolverService,
private _contextService: IWorkspaceContextService,
private _environmentService: IWorkbenchEnvironmentService,
private _outputChannelId: string,
private _fileService: IFileService,
private _terminalProfileResolverService: ITerminalProfileResolverService,
private _pathService: IPathService,
private _viewDescriptorService: IViewDescriptorService,
private _logService: ILogService,
private _configurationService: IConfigurationService,
private _notificationService: INotificationService,
taskService: ITaskService,
taskSystemInfoResolver: ITaskSystemInfoResolver,
) {
super();
this._activeTasks = Object.create(null);
this._instances = Object.create(null);
this._busyTasks = Object.create(null);
this._terminals = Object.create(null);
this._idleTaskTerminals = new LinkedMap<string, string>();
this._sameTaskTerminals = Object.create(null);
this._onDidStateChange = new Emitter();
this._taskSystemInfoResolver = taskSystemInfoResolver;
this._register(this._terminalStatusManager = new TaskTerminalStatus(taskService));
}
private _reconnectToTerminals(terminals: ITerminalInstance[]): void {
for (const terminal of terminals) {
const taskForTerminal = terminal.shellLaunchConfig.attachPersistentProcess?.task;
if (taskForTerminal?.id && taskForTerminal?.lastTask) {
this._tasksToReconnect.push(taskForTerminal.id);
this._terminals[terminal.instanceId] = { terminal, lastTask: taskForTerminal.lastTask, group: taskForTerminal.group };
} else {
this._logService.trace(`Could not reconnect to terminal ${terminal.instanceId} with process details ${terminal.shellLaunchConfig.attachPersistentProcess}`);
}
}
}
public get onDidStateChange(): Event<ITaskEvent> {
return this._onDidStateChange.event;
}
private _log(value: string): void {
this._appendOutput(value + '\n');
}
protected _showOutput(): void {
this._outputService.showChannel(this._outputChannelId, true);
}
public reconnect(task: Task, resolver: ITaskResolver, trigger: string = Triggers.command): ITaskExecuteResult | undefined {
const terminals = this._terminalService.getReconnectedTerminals('Task');
if (!this._hasReconnected && terminals && terminals.length > 0) {
this._reconnectToTerminals(terminals);
this._hasReconnected = true;
}
if (this._tasksToReconnect.includes(task._id)) {
this._lastTask = new VerifiedTask(task, resolver, trigger);
this.rerun();
}
return undefined;
}
public run(task: Task, resolver: ITaskResolver, trigger: string = Triggers.command): ITaskExecuteResult {
task = task.clone(); // A small amount of task state is stored in the task (instance) and tasks passed in to run may have that set already.
const recentTaskKey = task.getRecentlyUsedKey() ?? '';
const validInstance = task.runOptions && task.runOptions.instanceLimit && this._instances[recentTaskKey] && this._instances[recentTaskKey].instances < task.runOptions.instanceLimit;
const instance = this._instances[recentTaskKey] ? this._instances[recentTaskKey].instances : 0;
this._currentTask = new VerifiedTask(task, resolver, trigger);
if (instance > 0) {
task.instance = this._instances[recentTaskKey].counter;
}
const lastTaskInstance = this.getLastInstance(task);
const terminalData = lastTaskInstance ? this._activeTasks[lastTaskInstance.getMapKey()] : undefined;
if (terminalData && terminalData.promise && !validInstance) {
this._lastTask = this._currentTask;
return { kind: TaskExecuteKind.Active, task: terminalData.task, active: { same: true, background: task.configurationProperties.isBackground! }, promise: terminalData.promise };
}
try {
const executeResult = { kind: TaskExecuteKind.Started, task, started: {}, promise: this._executeTask(task, resolver, trigger, new Set()) };
executeResult.promise.then(summary => {
this._lastTask = this._currentTask;
});
if (InMemoryTask.is(task) || !this._isTaskEmpty(task)) {
if (!this._instances[recentTaskKey]) {
this._instances[recentTaskKey] = new InstanceManager();
}
this._instances[recentTaskKey].addInstance();
}
return executeResult;
} catch (error) {
if (error instanceof TaskError) {
throw error;
} else if (error instanceof Error) {
this._log(error.message);
throw new TaskError(Severity.Error, error.message, TaskErrors.UnknownError);
} else {
this._log(error.toString());
throw new TaskError(Severity.Error, nls.localize('TerminalTaskSystem.unknownError', 'A unknown error has occurred while executing a task. See task output log for details.'), TaskErrors.UnknownError);
}
}
}
public rerun(): ITaskExecuteResult | undefined {
if (this._lastTask && this._lastTask.verify()) {
if ((this._lastTask.task.runOptions.reevaluateOnRerun !== undefined) && !this._lastTask.task.runOptions.reevaluateOnRerun) {
this._isRerun = true;
}
const result = this.run(this._lastTask.task, this._lastTask.resolver);
result.promise.then(summary => {
this._isRerun = false;
});
return result;
} else {
return undefined;
}
}
private _showTaskLoadErrors(task: Task) {
if (task.taskLoadMessages && task.taskLoadMessages.length > 0) {
task.taskLoadMessages.forEach(loadMessage => {
this._log(loadMessage + '\n');
});
const openOutput = 'Show Output';
this._notificationService.prompt(Severity.Warning,
nls.localize('TerminalTaskSystem.taskLoadReporting', "There are issues with task \"{0}\". See the output for more details.",
task._label), [{
label: openOutput,
run: () => this._showOutput()
}]);
}
}
public isTaskVisible(task: Task): boolean {
const terminalData = this._activeTasks[task.getMapKey()];
if (!terminalData) {
return false;
}
const activeTerminalInstance = this._terminalService.activeInstance;
const isPanelShowingTerminal = !!this._viewsService.getActiveViewWithId(TERMINAL_VIEW_ID);
return isPanelShowingTerminal && (activeTerminalInstance?.instanceId === terminalData.terminal.instanceId);
}
public revealTask(task: Task): boolean {
const terminalData = this._activeTasks[task.getMapKey()];
if (!terminalData) {
return false;
}
const isTerminalInPanel: boolean = this._viewDescriptorService.getViewLocationById(TERMINAL_VIEW_ID) === ViewContainerLocation.Panel;
if (isTerminalInPanel && this.isTaskVisible(task)) {
if (this._previousPanelId) {
if (this._previousTerminalInstance) {
this._terminalService.setActiveInstance(this._previousTerminalInstance);
}
this._paneCompositeService.openPaneComposite(this._previousPanelId, ViewContainerLocation.Panel);
} else {
this._paneCompositeService.hideActivePaneComposite(ViewContainerLocation.Panel);
}
this._previousPanelId = undefined;
this._previousTerminalInstance = undefined;
} else {
if (isTerminalInPanel) {
this._previousPanelId = this._paneCompositeService.getActivePaneComposite(ViewContainerLocation.Panel)?.getId();
if (this._previousPanelId === TERMINAL_VIEW_ID) {
this._previousTerminalInstance = this._terminalService.activeInstance ?? undefined;
}
}
this._terminalService.setActiveInstance(terminalData.terminal);
if (CustomTask.is(task) || ContributedTask.is(task)) {
this._terminalGroupService.showPanel(task.command.presentation!.focus);
}
}
return true;
}
public isActive(): Promise<boolean> {
return Promise.resolve(this.isActiveSync());
}
public isActiveSync(): boolean {
return Object.keys(this._activeTasks).length > 0;
}
public canAutoTerminate(): boolean {
return Object.keys(this._activeTasks).every(key => !this._activeTasks[key].task.configurationProperties.promptOnClose);
}
public getActiveTasks(): Task[] {
return Object.keys(this._activeTasks).map(key => this._activeTasks[key].task);
}
public getLastInstance(task: Task): Task | undefined {
let lastInstance = undefined;
const recentKey = task.getRecentlyUsedKey();
Object.keys(this._activeTasks).forEach((key) => {
if (recentKey && recentKey === this._activeTasks[key].task.getRecentlyUsedKey()) {
lastInstance = this._activeTasks[key].task;
}
});
return lastInstance;
}
public getBusyTasks(): Task[] {
return Object.keys(this._busyTasks).map(key => this._busyTasks[key]);
}
public customExecutionComplete(task: Task, result: number): Promise<void> {
const activeTerminal = this._activeTasks[task.getMapKey()];
if (!activeTerminal) {
return Promise.reject(new Error('Expected to have a terminal for an custom execution task'));
}
return new Promise<void>((resolve) => {
// activeTerminal.terminal.rendererExit(result);
resolve();
});
}
private _removeInstances(task: Task) {
const recentTaskKey = task.getRecentlyUsedKey() ?? '';
if (this._instances[recentTaskKey]) {
this._instances[recentTaskKey].removeInstance();
if (this._instances[recentTaskKey].instances === 0) {
delete this._instances[recentTaskKey];
}
}
}
private _removeFromActiveTasks(task: Task): void {
if (!this._activeTasks[task.getMapKey()]) {
return;
}
delete this._activeTasks[task.getMapKey()];
this._removeInstances(task);
}
private _fireTaskEvent(event: ITaskEvent) {
if (event.__task) {
const activeTask = this._activeTasks[event.__task.getMapKey()];
if (activeTask) {
activeTask.state = event.kind;
}
}
this._onDidStateChange.fire(event);
}
public terminate(task: Task): Promise<ITaskTerminateResponse> {
const activeTerminal = this._activeTasks[task.getMapKey()];
if (!activeTerminal) {
return Promise.resolve<ITaskTerminateResponse>({ success: false, task: undefined });
}
return new Promise<ITaskTerminateResponse>((resolve, reject) => {
const terminal = activeTerminal.terminal;
const onExit = terminal.onExit(() => {
const task = activeTerminal.task;
try {
onExit.dispose();
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Terminated, task));
} catch (error) {
// Do nothing.
}
resolve({ success: true, task: task });
});
terminal.dispose();
});
}
public terminateAll(): Promise<ITaskTerminateResponse[]> {
const promises: Promise<ITaskTerminateResponse>[] = [];
Object.keys(this._activeTasks).forEach((key) => {
const terminalData = this._activeTasks[key];
const terminal = terminalData.terminal;
promises.push(new Promise<ITaskTerminateResponse>((resolve, reject) => {
const onExit = terminal.onExit(() => {
const task = terminalData.task;
try {
onExit.dispose();
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Terminated, task));
} catch (error) {
// Do nothing.
}
resolve({ success: true, task: terminalData.task });
});
}));
terminal.dispose();
});
this._activeTasks = Object.create(null);
return Promise.all<ITaskTerminateResponse>(promises);
}
private _showDependencyCycleMessage(task: Task) {
this._log(nls.localize('dependencyCycle',
'There is a dependency cycle. See task "{0}".',
task._label
));
this._showOutput();
}
private async _executeTask(task: Task, resolver: ITaskResolver, trigger: string, encounteredDependencies: Set<string>, alreadyResolved?: Map<string, string>): Promise<ITaskSummary> {
if (encounteredDependencies.has(task.getCommonTaskId())) {
this._showDependencyCycleMessage(task);
return {};
}
this._showTaskLoadErrors(task);
alreadyResolved = alreadyResolved ?? new Map<string, string>();
const promises: Promise<ITaskSummary>[] = [];
if (task.configurationProperties.dependsOn) {
for (const dependency of task.configurationProperties.dependsOn) {
const dependencyTask = await resolver.resolve(dependency.uri, dependency.task!);
if (dependencyTask) {
this._adoptConfigurationForDependencyTask(dependencyTask, task);
const key = dependencyTask.getMapKey();
let promise = this._activeTasks[key] ? this._getDependencyPromise(this._activeTasks[key]) : undefined;
if (!promise) {
this._fireTaskEvent(TaskEvent.create(TaskEventKind.DependsOnStarted, task));
encounteredDependencies.add(task.getCommonTaskId());
promise = this._executeDependencyTask(dependencyTask, resolver, trigger, encounteredDependencies, alreadyResolved);
}
promises.push(promise);
if (task.configurationProperties.dependsOrder === DependsOrder.sequence) {
const promiseResult = await promise;
if (promiseResult.exitCode === 0) {
promise = Promise.resolve(promiseResult);
} else {
promise = Promise.reject(promiseResult);
break;
}
}
promises.push(promise);
} else {
this._log(nls.localize('dependencyFailed',
'Couldn\'t resolve dependent task \'{0}\' in workspace folder \'{1}\'',
Types.isString(dependency.task) ? dependency.task : JSON.stringify(dependency.task, undefined, 0),
dependency.uri.toString()
));
this._showOutput();
}
}
}
if ((ContributedTask.is(task) || CustomTask.is(task)) && (task.command)) {
return Promise.all(promises).then((summaries): Promise<ITaskSummary> | ITaskSummary => {
encounteredDependencies.delete(task.getCommonTaskId());
for (const summary of summaries) {
if (summary.exitCode !== 0) {
this._removeInstances(task);
return { exitCode: summary.exitCode };
}
}
if (this._isRerun) {
return this._reexecuteCommand(task, trigger, alreadyResolved!);
} else {
return this._executeCommand(task, trigger, alreadyResolved!);
}
});
} else {
return Promise.all(promises).then((summaries): ITaskSummary => {
encounteredDependencies.delete(task.getCommonTaskId());
for (const summary of summaries) {
if (summary.exitCode !== 0) {
return { exitCode: summary.exitCode };
}
}
return { exitCode: 0 };
});
}
}
private _createInactiveDependencyPromise(task: Task): Promise<ITaskSummary> {
return new Promise<ITaskSummary>(resolve => {
const taskInactiveDisposable = this.onDidStateChange(taskEvent => {
if ((taskEvent.kind === TaskEventKind.Inactive) && (taskEvent.__task === task)) {
taskInactiveDisposable.dispose();
resolve({ exitCode: 0 });
}
});
});
}
private _adoptConfigurationForDependencyTask(dependencyTask: Task, task: Task): void {
if (dependencyTask.configurationProperties.icon) {
dependencyTask.configurationProperties.icon.id ||= task.configurationProperties.icon?.id;
dependencyTask.configurationProperties.icon.color ||= task.configurationProperties.icon?.color;
} else {
dependencyTask.configurationProperties.icon = task.configurationProperties.icon;
}
if (dependencyTask.configurationProperties.hide) {
dependencyTask.configurationProperties.hide ||= task.configurationProperties.hide;
} else {
dependencyTask.configurationProperties.hide = task.configurationProperties.hide;
}
}
private async _getDependencyPromise(task: IActiveTerminalData): Promise<ITaskSummary> {
if (!task.task.configurationProperties.isBackground) {
return task.promise;
}
if (!task.task.configurationProperties.problemMatchers || task.task.configurationProperties.problemMatchers.length === 0) {
return task.promise;
}
if (task.state === TaskEventKind.Inactive) {
return { exitCode: 0 };
}
return this._createInactiveDependencyPromise(task.task);
}
private async _executeDependencyTask(task: Task, resolver: ITaskResolver, trigger: string, encounteredDependencies: Set<string>, alreadyResolved?: Map<string, string>): Promise<ITaskSummary> {
// If the task is a background task with a watching problem matcher, we don't wait for the whole task to finish,
// just for the problem matcher to go inactive.
if (!task.configurationProperties.isBackground) {
return this._executeTask(task, resolver, trigger, encounteredDependencies, alreadyResolved);
}
const inactivePromise = this._createInactiveDependencyPromise(task);
return Promise.race([inactivePromise, this._executeTask(task, resolver, trigger, encounteredDependencies, alreadyResolved)]);
}
private async _resolveAndFindExecutable(systemInfo: ITaskSystemInfo | undefined, workspaceFolder: IWorkspaceFolder | undefined, task: CustomTask | ContributedTask, cwd: string | undefined, envPath: string | undefined): Promise<string> {
const command = await this._configurationResolverService.resolveAsync(workspaceFolder, CommandString.value(task.command.name!));
cwd = cwd ? await this._configurationResolverService.resolveAsync(workspaceFolder, cwd) : undefined;
const paths = envPath ? await Promise.all(envPath.split(path.delimiter).map(p => this._configurationResolverService.resolveAsync(workspaceFolder, p))) : undefined;
let foundExecutable = await systemInfo?.findExecutable(command, cwd, paths);
if (!foundExecutable) {
foundExecutable = path.join(cwd ?? '', command);
}
return foundExecutable;
}
private _findUnresolvedVariables(variables: Set<string>, alreadyResolved: Map<string, string>): Set<string> {
if (alreadyResolved.size === 0) {
return variables;
}
const unresolved = new Set<string>();
for (const variable of variables) {
if (!alreadyResolved.has(variable.substring(2, variable.length - 1))) {
unresolved.add(variable);
}
}
return unresolved;
}
private _mergeMaps(mergeInto: Map<string, string>, mergeFrom: Map<string, string>) {
for (const entry of mergeFrom) {
if (!mergeInto.has(entry[0])) {
mergeInto.set(entry[0], entry[1]);
}
}
}
private async _acquireInput(taskSystemInfo: ITaskSystemInfo | undefined, workspaceFolder: IWorkspaceFolder | undefined, task: CustomTask | ContributedTask, variables: Set<string>, alreadyResolved: Map<string, string>): Promise<IResolvedVariables | undefined> {
const resolved = await this._resolveVariablesFromSet(taskSystemInfo, workspaceFolder, task, variables, alreadyResolved);
this._fireTaskEvent(TaskEvent.create(TaskEventKind.AcquiredInput, task));
return resolved;
}
private _resolveVariablesFromSet(taskSystemInfo: ITaskSystemInfo | undefined, workspaceFolder: IWorkspaceFolder | undefined, task: CustomTask | ContributedTask, variables: Set<string>, alreadyResolved: Map<string, string>): Promise<IResolvedVariables | undefined> {
const isProcess = task.command && task.command.runtime === RuntimeType.Process;
const options = task.command && task.command.options ? task.command.options : undefined;
const cwd = options ? options.cwd : undefined;
let envPath: string | undefined = undefined;
if (options && options.env) {
for (const key of Object.keys(options.env)) {
if (key.toLowerCase() === 'path') {
if (Types.isString(options.env[key])) {
envPath = options.env[key];
}
break;
}
}
}
const unresolved = this._findUnresolvedVariables(variables, alreadyResolved);
let resolvedVariables: Promise<IResolvedVariables | undefined>;
if (taskSystemInfo && workspaceFolder) {
const resolveSet: IResolveSet = {
variables: unresolved
};
if (taskSystemInfo.platform === Platform.Platform.Windows && isProcess) {
resolveSet.process = { name: CommandString.value(task.command.name!) };
if (cwd) {
resolveSet.process.cwd = cwd;
}
if (envPath) {
resolveSet.process.path = envPath;
}
}
resolvedVariables = taskSystemInfo.resolveVariables(workspaceFolder, resolveSet, TaskSourceKind.toConfigurationTarget(task._source.kind)).then(async (resolved) => {
if (!resolved) {
return undefined;
}
this._mergeMaps(alreadyResolved, resolved.variables);
resolved.variables = new Map(alreadyResolved);
if (isProcess) {
let process = CommandString.value(task.command.name!);
if (taskSystemInfo.platform === Platform.Platform.Windows) {
process = await this._resolveAndFindExecutable(taskSystemInfo, workspaceFolder, task, cwd, envPath);
}
resolved.variables.set(TerminalTaskSystem.ProcessVarName, process);
}
return resolved;
});
return resolvedVariables;
} else {
const variablesArray = new Array<string>();
unresolved.forEach(variable => variablesArray.push(variable));
return new Promise<IResolvedVariables | undefined>((resolve, reject) => {
this._configurationResolverService.resolveWithInteraction(workspaceFolder, variablesArray, 'tasks', undefined, TaskSourceKind.toConfigurationTarget(task._source.kind)).then(async (resolvedVariablesMap: Map<string, string> | undefined) => {
if (resolvedVariablesMap) {
this._mergeMaps(alreadyResolved, resolvedVariablesMap);
resolvedVariablesMap = new Map(alreadyResolved);
if (isProcess) {
let processVarValue: string;
if (Platform.isWindows) {
processVarValue = await this._resolveAndFindExecutable(taskSystemInfo, workspaceFolder, task, cwd, envPath);
} else {
processVarValue = await this._configurationResolverService.resolveAsync(workspaceFolder, CommandString.value(task.command.name!));
}
resolvedVariablesMap.set(TerminalTaskSystem.ProcessVarName, processVarValue);
}
const resolvedVariablesResult: IResolvedVariables = {
variables: resolvedVariablesMap,
};
resolve(resolvedVariablesResult);
} else {
resolve(undefined);
}
}, reason => {
reject(reason);
});
});
}
}
private _executeCommand(task: CustomTask | ContributedTask, trigger: string, alreadyResolved: Map<string, string>): Promise<ITaskSummary> {
const taskWorkspaceFolder = task.getWorkspaceFolder();
let workspaceFolder: IWorkspaceFolder | undefined;
if (taskWorkspaceFolder) {
workspaceFolder = this._currentTask.workspaceFolder = taskWorkspaceFolder;
} else {
const folders = this._contextService.getWorkspace().folders;
workspaceFolder = folders.length > 0 ? folders[0] : undefined;
}
const systemInfo: ITaskSystemInfo | undefined = this._currentTask.systemInfo = this._taskSystemInfoResolver(workspaceFolder);
const variables = new Set<string>();
this._collectTaskVariables(variables, task);
const resolvedVariables = this._acquireInput(systemInfo, workspaceFolder, task, variables, alreadyResolved);
return resolvedVariables.then((resolvedVariables) => {
if (resolvedVariables && !this._isTaskEmpty(task)) {
this._currentTask.resolvedVariables = resolvedVariables;
return this._executeInTerminal(task, trigger, new VariableResolver(workspaceFolder, systemInfo, resolvedVariables.variables, this._configurationResolverService), workspaceFolder);
} else {
// Allows the taskExecutions array to be updated in the extension host
this._fireTaskEvent(TaskEvent.create(TaskEventKind.End, task));
return Promise.resolve({ exitCode: 0 });
}
}, reason => {
return Promise.reject(reason);
});
}
private _isTaskEmpty(task: CustomTask | ContributedTask): boolean {
const isCustomExecution = (task.command.runtime === RuntimeType.CustomExecution);
return !((task.command !== undefined) && task.command.runtime && (isCustomExecution || (task.command.name !== undefined)));
}
private _reexecuteCommand(task: CustomTask | ContributedTask, trigger: string, alreadyResolved: Map<string, string>): Promise<ITaskSummary> {
const lastTask = this._lastTask;
if (!lastTask) {
return Promise.reject(new Error('No task previously run'));
}
const workspaceFolder = this._currentTask.workspaceFolder = lastTask.workspaceFolder;
const variables = new Set<string>();
this._collectTaskVariables(variables, task);
// Check that the task hasn't changed to include new variables
let hasAllVariables = true;
variables.forEach(value => {
if (value.substring(2, value.length - 1) in lastTask.getVerifiedTask().resolvedVariables) {
hasAllVariables = false;
}
});
if (!hasAllVariables) {
return this._acquireInput(lastTask.getVerifiedTask().systemInfo, lastTask.getVerifiedTask().workspaceFolder, task, variables, alreadyResolved).then((resolvedVariables) => {
if (!resolvedVariables) {
// Allows the taskExecutions array to be updated in the extension host
this._fireTaskEvent(TaskEvent.create(TaskEventKind.End, task));
return { exitCode: 0 };
}
this._currentTask.resolvedVariables = resolvedVariables;
return this._executeInTerminal(task, trigger, new VariableResolver(lastTask.getVerifiedTask().workspaceFolder, lastTask.getVerifiedTask().systemInfo, resolvedVariables.variables, this._configurationResolverService), workspaceFolder!);
}, reason => {
return Promise.reject(reason);
});
} else {
this._currentTask.resolvedVariables = lastTask.getVerifiedTask().resolvedVariables;
return this._executeInTerminal(task, trigger, new VariableResolver(lastTask.getVerifiedTask().workspaceFolder, lastTask.getVerifiedTask().systemInfo, lastTask.getVerifiedTask().resolvedVariables.variables, this._configurationResolverService), workspaceFolder!);
}
}
private async _executeInTerminal(task: CustomTask | ContributedTask, trigger: string, resolver: VariableResolver, workspaceFolder: IWorkspaceFolder | undefined): Promise<ITaskSummary> {
let terminal: ITerminalInstance | undefined = undefined;
let error: TaskError | undefined = undefined;
let promise: Promise<ITaskSummary> | undefined = undefined;
if (task.configurationProperties.isBackground) {
const problemMatchers = await this._resolveMatchers(resolver, task.configurationProperties.problemMatchers);
const watchingProblemMatcher = new WatchingProblemCollector(problemMatchers, this._markerService, this._modelService, this._fileService);
if ((problemMatchers.length > 0) && !watchingProblemMatcher.isWatching()) {
this._appendOutput(nls.localize('TerminalTaskSystem.nonWatchingMatcher', 'Task {0} is a background task but uses a problem matcher without a background pattern', task._label));
this._showOutput();
}
const toDispose = new DisposableStore();
let eventCounter: number = 0;
const mapKey = task.getMapKey();
toDispose.add(watchingProblemMatcher.onDidStateChange((event) => {
if (event.kind === ProblemCollectorEventKind.BackgroundProcessingBegins) {
eventCounter++;
this._busyTasks[mapKey] = task;
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Active, task));
} else if (event.kind === ProblemCollectorEventKind.BackgroundProcessingEnds) {
eventCounter--;
if (this._busyTasks[mapKey]) {
delete this._busyTasks[mapKey];
}
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Inactive, task));
if (eventCounter === 0) {
if ((watchingProblemMatcher.numberOfMatches > 0) && watchingProblemMatcher.maxMarkerSeverity &&
(watchingProblemMatcher.maxMarkerSeverity >= MarkerSeverity.Error)) {
const reveal = task.command.presentation!.reveal;
const revealProblems = task.command.presentation!.revealProblems;
if (revealProblems === RevealProblemKind.OnProblem) {
this._viewsService.openView(Markers.MARKERS_VIEW_ID, true);
} else if (reveal === RevealKind.Silent) {
this._terminalService.setActiveInstance(terminal!);
this._terminalGroupService.showPanel(false);
}
}
}
}
}));
watchingProblemMatcher.aboutToStart();
let delayer: Async.Delayer<any> | undefined = undefined;
[terminal, error] = await this._createTerminal(task, resolver, workspaceFolder);
if (error) {
return Promise.reject(new Error((<TaskError>error).message));
}
if (!terminal) {
return Promise.reject(new Error(`Failed to create terminal for task ${task._label}`));
}
this._terminalStatusManager.addTerminal(task, terminal, watchingProblemMatcher);
let processStartedSignaled = false;
terminal.processReady.then(() => {
if (!processStartedSignaled) {
this._fireTaskEvent(TaskEvent.create(TaskEventKind.ProcessStarted, task, terminal!.processId!));
processStartedSignaled = true;
}
}, (_error) => {
this._logService.error('Task terminal process never got ready');
});
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Start, task, terminal.instanceId));
const onData = terminal.onLineData((line) => {
watchingProblemMatcher.processLine(line);
if (!delayer) {
delayer = new Async.Delayer(3000);
}
delayer.trigger(() => {
watchingProblemMatcher.forceDelivery();
delayer = undefined;
});
});
promise = new Promise<ITaskSummary>((resolve, reject) => {
const onExit = terminal!.onExit((terminalLaunchResult) => {
const exitCode = typeof terminalLaunchResult === 'number' ? terminalLaunchResult : terminalLaunchResult?.code;
onData.dispose();
onExit.dispose();
const key = task.getMapKey();
if (this._busyTasks[mapKey]) {
delete this._busyTasks[mapKey];
}
this._removeFromActiveTasks(task);
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Changed));
if (terminalLaunchResult !== undefined) {
// Only keep a reference to the terminal if it is not being disposed.
switch (task.command.presentation!.panel) {
case PanelKind.Dedicated:
this._sameTaskTerminals[key] = terminal!.instanceId.toString();
break;
case PanelKind.Shared:
this._idleTaskTerminals.set(key, terminal!.instanceId.toString(), Touch.AsOld);
break;
}
}
const reveal = task.command.presentation!.reveal;
if ((reveal === RevealKind.Silent) && ((exitCode !== 0) || (watchingProblemMatcher.numberOfMatches > 0) && watchingProblemMatcher.maxMarkerSeverity &&
(watchingProblemMatcher.maxMarkerSeverity >= MarkerSeverity.Error))) {
try {
this._terminalService.setActiveInstance(terminal!);
this._terminalGroupService.showPanel(false);
} catch (e) {
// If the terminal has already been disposed, then setting the active instance will fail. #99828
// There is nothing else to do here.
}
}
watchingProblemMatcher.done();
watchingProblemMatcher.dispose();
if (!processStartedSignaled) {
this._fireTaskEvent(TaskEvent.create(TaskEventKind.ProcessStarted, task, terminal!.processId!));
processStartedSignaled = true;
}
this._fireTaskEvent(TaskEvent.create(TaskEventKind.ProcessEnded, task, exitCode ?? undefined));
for (let i = 0; i < eventCounter; i++) {
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Inactive, task));
}
eventCounter = 0;
this._fireTaskEvent(TaskEvent.create(TaskEventKind.End, task));
toDispose.dispose();
resolve({ exitCode: exitCode ?? undefined });
});
});
} else {
[terminal, error] = await this._createTerminal(task, resolver, workspaceFolder);
if (error) {
return Promise.reject(new Error((<TaskError>error).message));
}
if (!terminal) {
return Promise.reject(new Error(`Failed to create terminal for task ${task._label}`));
}
let processStartedSignaled = false;
terminal.processReady.then(() => {
if (!processStartedSignaled) {
this._fireTaskEvent(TaskEvent.create(TaskEventKind.ProcessStarted, task, terminal!.processId!));
processStartedSignaled = true;
}
}, (_error) => {
// The process never got ready. Need to think how to handle this.
});
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Start, task, terminal.instanceId, resolver.values));
const mapKey = task.getMapKey();
this._busyTasks[mapKey] = task;
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Active, task));
const problemMatchers = await this._resolveMatchers(resolver, task.configurationProperties.problemMatchers);
const startStopProblemMatcher = new StartStopProblemCollector(problemMatchers, this._markerService, this._modelService, ProblemHandlingStrategy.Clean, this._fileService);
this._terminalStatusManager.addTerminal(task, terminal, startStopProblemMatcher);
const onData = terminal.onLineData((line) => {
startStopProblemMatcher.processLine(line);
});
promise = new Promise<ITaskSummary>((resolve, reject) => {
const onExit = terminal!.onExit((terminalLaunchResult) => {
const exitCode = typeof terminalLaunchResult === 'number' ? terminalLaunchResult : terminalLaunchResult?.code;
onExit.dispose();
const key = task.getMapKey();
this._removeFromActiveTasks(task);
this._fireTaskEvent(TaskEvent.create(TaskEventKind.Changed));
if (terminalLaunchResult !== undefined) {
// Only keep a reference to the terminal if it is not being disposed.
switch (task.command.presentation!.panel) {
case PanelKind.Dedicated:
this._sameTaskTerminals[key] = terminal!.instanceId.toString();
break;
case PanelKind.Shared:
this._idleTaskTerminals.set(key, terminal!.instanceId.toString(), Touch.AsOld);
break;