-
Notifications
You must be signed in to change notification settings - Fork 28.7k
/
progressService.ts
649 lines (530 loc) · 23.3 KB
/
progressService.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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import './media/progressService.css';
import { localize } from '../../../../nls.js';
import { IDisposable, dispose, DisposableStore, Disposable, toDisposable } from '../../../../base/common/lifecycle.js';
import { IProgressService, IProgressOptions, IProgressStep, ProgressLocation, IProgress, Progress, IProgressCompositeOptions, IProgressNotificationOptions, IProgressRunner, IProgressIndicator, IProgressWindowOptions, IProgressDialogOptions } from '../../../../platform/progress/common/progress.js';
import { StatusbarAlignment, IStatusbarService, IStatusbarEntryAccessor, IStatusbarEntry } from '../../statusbar/browser/statusbar.js';
import { DeferredPromise, RunOnceScheduler, timeout } from '../../../../base/common/async.js';
import { ProgressBadge, IActivityService } from '../../activity/common/activity.js';
import { INotificationService, Severity, INotificationHandle, NotificationPriority, isNotificationSource, NotificationsFilter } from '../../../../platform/notification/common/notification.js';
import { Action } from '../../../../base/common/actions.js';
import { Event, Emitter } from '../../../../base/common/event.js';
import { InstantiationType, registerSingleton } from '../../../../platform/instantiation/common/extensions.js';
import { ILayoutService } from '../../../../platform/layout/browser/layoutService.js';
import { Dialog } from '../../../../base/browser/ui/dialog/dialog.js';
import { IKeybindingService } from '../../../../platform/keybinding/common/keybinding.js';
import { StandardKeyboardEvent } from '../../../../base/browser/keyboardEvent.js';
import { EventHelper } from '../../../../base/browser/dom.js';
import { parseLinkedText } from '../../../../base/common/linkedText.js';
import { IViewDescriptorService, ViewContainerLocation } from '../../../common/views.js';
import { IViewsService } from '../../views/common/viewsService.js';
import { IPaneCompositePartService } from '../../panecomposite/browser/panecomposite.js';
import { stripIcons } from '../../../../base/common/iconLabels.js';
import { defaultButtonStyles, defaultCheckboxStyles, defaultDialogStyles, defaultInputBoxStyles } from '../../../../platform/theme/browser/defaultStyles.js';
import { ResultKind } from '../../../../platform/keybinding/common/keybindingResolver.js';
import { IUserActivityService } from '../../userActivity/common/userActivityService.js';
export class ProgressService extends Disposable implements IProgressService {
declare readonly _serviceBrand: undefined;
constructor(
@IActivityService private readonly activityService: IActivityService,
@IPaneCompositePartService private readonly paneCompositeService: IPaneCompositePartService,
@IViewDescriptorService private readonly viewDescriptorService: IViewDescriptorService,
@IViewsService private readonly viewsService: IViewsService,
@INotificationService private readonly notificationService: INotificationService,
@IStatusbarService private readonly statusbarService: IStatusbarService,
@ILayoutService private readonly layoutService: ILayoutService,
@IKeybindingService private readonly keybindingService: IKeybindingService,
@IUserActivityService private readonly userActivityService: IUserActivityService,
) {
super();
}
async withProgress<R = unknown>(options: IProgressOptions, originalTask: (progress: IProgress<IProgressStep>) => Promise<R>, onDidCancel?: (choice?: number) => void): Promise<R> {
const { location } = options;
const task = async (progress: IProgress<IProgressStep>) => {
const activeLock = this.userActivityService.markActive({ whenHeldFor: 15_000 });
try {
return await originalTask(progress);
} finally {
activeLock.dispose();
}
};
const handleStringLocation = (location: string) => {
const viewContainer = this.viewDescriptorService.getViewContainerById(location);
if (viewContainer) {
const viewContainerLocation = this.viewDescriptorService.getViewContainerLocation(viewContainer);
if (viewContainerLocation !== null) {
return this.withPaneCompositeProgress(location, viewContainerLocation, task, { ...options, location });
}
}
if (this.viewDescriptorService.getViewDescriptorById(location) !== null) {
return this.withViewProgress(location, task, { ...options, location });
}
throw new Error(`Bad progress location: ${location}`);
};
if (typeof location === 'string') {
return handleStringLocation(location);
}
switch (location) {
case ProgressLocation.Notification: {
let priority = (options as IProgressNotificationOptions).priority;
if (priority !== NotificationPriority.URGENT) {
if (this.notificationService.getFilter() === NotificationsFilter.ERROR) {
priority = NotificationPriority.SILENT;
} else if (isNotificationSource(options.source) && this.notificationService.getFilter(options.source) === NotificationsFilter.ERROR) {
priority = NotificationPriority.SILENT;
}
}
return this.withNotificationProgress({ ...options, location, priority }, task, onDidCancel);
}
case ProgressLocation.Window: {
const type = (options as IProgressWindowOptions).type;
if ((options as IProgressWindowOptions).command) {
// Window progress with command get's shown in the status bar
return this.withWindowProgress({ ...options, location, type }, task);
}
// Window progress without command can be shown as silent notification
// which will first appear in the status bar and can then be brought to
// the front when clicking.
return this.withNotificationProgress({ delay: 150 /* default for ProgressLocation.Window */, ...options, priority: NotificationPriority.SILENT, location: ProgressLocation.Notification, type }, task, onDidCancel);
}
case ProgressLocation.Explorer:
return this.withPaneCompositeProgress('workbench.view.explorer', ViewContainerLocation.Sidebar, task, { ...options, location });
case ProgressLocation.Scm:
return handleStringLocation('workbench.scm');
case ProgressLocation.Extensions:
return this.withPaneCompositeProgress('workbench.view.extensions', ViewContainerLocation.Sidebar, task, { ...options, location });
case ProgressLocation.Dialog:
return this.withDialogProgress(options, task, onDidCancel);
default:
throw new Error(`Bad progress location: ${location}`);
}
}
private readonly windowProgressStack: [IProgressWindowOptions, Progress<IProgressStep>][] = [];
private windowProgressStatusEntry: IStatusbarEntryAccessor | undefined = undefined;
private withWindowProgress<R = unknown>(options: IProgressWindowOptions, callback: (progress: IProgress<{ message?: string }>) => Promise<R>): Promise<R> {
const task: [IProgressWindowOptions, Progress<IProgressStep>] = [options, new Progress<IProgressStep>(() => this.updateWindowProgress())];
const promise = callback(task[1]);
let delayHandle: any = setTimeout(() => {
delayHandle = undefined;
this.windowProgressStack.unshift(task);
this.updateWindowProgress();
// show progress for at least 150ms
Promise.all([
timeout(150),
promise
]).finally(() => {
const idx = this.windowProgressStack.indexOf(task);
this.windowProgressStack.splice(idx, 1);
this.updateWindowProgress();
});
}, 150);
// cancel delay if promise finishes below 150ms
return promise.finally(() => clearTimeout(delayHandle));
}
private updateWindowProgress(idx: number = 0) {
// We still have progress to show
if (idx < this.windowProgressStack.length) {
const [options, progress] = this.windowProgressStack[idx];
const progressTitle = options.title;
const progressMessage = progress.value && progress.value.message;
const progressCommand = (<IProgressWindowOptions>options).command;
let text: string;
let title: string;
const source = options.source && typeof options.source !== 'string' ? options.source.label : options.source;
if (progressTitle && progressMessage) {
// <title>: <message>
text = localize('progress.text2', "{0}: {1}", progressTitle, progressMessage);
title = source ? localize('progress.title3', "[{0}] {1}: {2}", source, progressTitle, progressMessage) : text;
} else if (progressTitle) {
// <title>
text = progressTitle;
title = source ? localize('progress.title2', "[{0}]: {1}", source, progressTitle) : text;
} else if (progressMessage) {
// <message>
text = progressMessage;
title = source ? localize('progress.title2', "[{0}]: {1}", source, progressMessage) : text;
} else {
// no title, no message -> no progress. try with next on stack
this.updateWindowProgress(idx + 1);
return;
}
const statusEntryProperties: IStatusbarEntry = {
name: localize('status.progress', "Progress Message"),
text,
showProgress: options.type || true,
ariaLabel: text,
tooltip: title,
command: progressCommand
};
if (this.windowProgressStatusEntry) {
this.windowProgressStatusEntry.update(statusEntryProperties);
} else {
this.windowProgressStatusEntry = this.statusbarService.addEntry(statusEntryProperties, 'status.progress', StatusbarAlignment.LEFT);
}
}
// Progress is done so we remove the status entry
else {
this.windowProgressStatusEntry?.dispose();
this.windowProgressStatusEntry = undefined;
}
}
private withNotificationProgress<P extends Promise<R>, R = unknown>(options: IProgressNotificationOptions, callback: (progress: IProgress<IProgressStep>) => P, onDidCancel?: (choice?: number) => void): P {
const progressStateModel = new class extends Disposable {
private readonly _onDidReport = this._register(new Emitter<IProgressStep>());
readonly onDidReport = this._onDidReport.event;
private readonly _onWillDispose = this._register(new Emitter<void>());
readonly onWillDispose = this._onWillDispose.event;
private _step: IProgressStep | undefined = undefined;
get step() { return this._step; }
private _done = false;
get done() { return this._done; }
readonly promise: P;
constructor() {
super();
this.promise = callback(this);
this.promise.finally(() => {
this.dispose();
});
}
report(step: IProgressStep): void {
this._step = step;
this._onDidReport.fire(step);
}
cancel(choice?: number): void {
onDidCancel?.(choice);
this.dispose();
}
override dispose(): void {
this._done = true;
this._onWillDispose.fire();
super.dispose();
}
};
const createWindowProgress = () => {
// Create a promise that we can resolve as needed
// when the outside calls dispose on us
const promise = new DeferredPromise<void>();
this.withWindowProgress({
location: ProgressLocation.Window,
title: options.title ? parseLinkedText(options.title).toString() : undefined, // convert markdown links => string
command: 'notifications.showList',
type: options.type
}, progress => {
function reportProgress(step: IProgressStep) {
if (step.message) {
progress.report({
message: parseLinkedText(step.message).toString() // convert markdown links => string
});
}
}
// Apply any progress that was made already
if (progressStateModel.step) {
reportProgress(progressStateModel.step);
}
// Continue to report progress as it happens
const onDidReportListener = progressStateModel.onDidReport(step => reportProgress(step));
promise.p.finally(() => onDidReportListener.dispose());
// When the progress model gets disposed, we are done as well
Event.once(progressStateModel.onWillDispose)(() => promise.complete());
return promise.p;
});
// Dispose means completing our promise
return toDisposable(() => promise.complete());
};
const createNotification = (message: string, priority?: NotificationPriority, increment?: number): INotificationHandle => {
const notificationDisposables = new DisposableStore();
const primaryActions = options.primaryActions ? Array.from(options.primaryActions) : [];
const secondaryActions = options.secondaryActions ? Array.from(options.secondaryActions) : [];
if (options.buttons) {
options.buttons.forEach((button, index) => {
const buttonAction = new class extends Action {
constructor() {
super(`progress.button.${button}`, button, undefined, true);
}
override async run(): Promise<void> {
progressStateModel.cancel(index);
}
};
notificationDisposables.add(buttonAction);
primaryActions.push(buttonAction);
});
}
if (options.cancellable) {
const cancelAction = new class extends Action {
constructor() {
super('progress.cancel', localize('cancel', "Cancel"), undefined, true);
}
override async run(): Promise<void> {
progressStateModel.cancel();
}
};
notificationDisposables.add(cancelAction);
primaryActions.push(cancelAction);
}
const notification = this.notificationService.notify({
severity: Severity.Info,
message: stripIcons(message), // status entries support codicons, but notifications do not (https://github.com/microsoft/vscode/issues/145722)
source: options.source,
actions: { primary: primaryActions, secondary: secondaryActions },
progress: typeof increment === 'number' && increment >= 0 ? { total: 100, worked: increment } : { infinite: true },
priority
});
// Switch to window based progress once the notification
// changes visibility to hidden and is still ongoing.
// Remove that window based progress once the notification
// shows again.
let windowProgressDisposable: IDisposable | undefined = undefined;
const onVisibilityChange = (visible: boolean) => {
// Clear any previous running window progress
dispose(windowProgressDisposable);
// Create new window progress if notification got hidden
if (!visible && !progressStateModel.done) {
windowProgressDisposable = createWindowProgress();
}
};
notificationDisposables.add(notification.onDidChangeVisibility(onVisibilityChange));
if (priority === NotificationPriority.SILENT) {
onVisibilityChange(false);
}
// Clear upon dispose
Event.once(notification.onDidClose)(() => notificationDisposables.dispose());
return notification;
};
const updateProgress = (notification: INotificationHandle, increment?: number): void => {
if (typeof increment === 'number' && increment >= 0) {
notification.progress.total(100); // always percentage based
notification.progress.worked(increment);
} else {
notification.progress.infinite();
}
};
let notificationHandle: INotificationHandle | undefined;
let notificationTimeout: any | undefined;
let titleAndMessage: string | undefined; // hoisted to make sure a delayed notification shows the most recent message
const updateNotification = (step?: IProgressStep): void => {
// full message (inital or update)
if (step?.message && options.title) {
titleAndMessage = `${options.title}: ${step.message}`; // always prefix with overall title if we have it (https://github.com/microsoft/vscode/issues/50932)
} else {
titleAndMessage = options.title || step?.message;
}
if (!notificationHandle && titleAndMessage) {
// create notification now or after a delay
if (typeof options.delay === 'number' && options.delay > 0) {
if (typeof notificationTimeout !== 'number') {
notificationTimeout = setTimeout(() => notificationHandle = createNotification(titleAndMessage!, options.priority, step?.increment), options.delay);
}
} else {
notificationHandle = createNotification(titleAndMessage, options.priority, step?.increment);
}
}
if (notificationHandle) {
if (titleAndMessage) {
notificationHandle.updateMessage(titleAndMessage);
}
if (typeof step?.increment === 'number') {
updateProgress(notificationHandle, step.increment);
}
}
};
// Show initially
updateNotification(progressStateModel.step);
const listener = progressStateModel.onDidReport(step => updateNotification(step));
Event.once(progressStateModel.onWillDispose)(() => listener.dispose());
// Clean up eventually
(async () => {
try {
// with a delay we only wait for the finish of the promise
if (typeof options.delay === 'number' && options.delay > 0) {
await progressStateModel.promise;
}
// without a delay we show the notification for at least 800ms
// to reduce the chance of the notification flashing up and hiding
else {
await Promise.all([timeout(800), progressStateModel.promise]);
}
} finally {
clearTimeout(notificationTimeout);
notificationHandle?.close();
}
})();
return progressStateModel.promise;
}
private withPaneCompositeProgress<P extends Promise<R>, R = unknown>(paneCompositeId: string, viewContainerLocation: ViewContainerLocation, task: (progress: IProgress<IProgressStep>) => P, options: IProgressCompositeOptions): P {
// show in viewlet
const progressIndicator = this.paneCompositeService.getProgressIndicator(paneCompositeId, viewContainerLocation);
const promise = progressIndicator ? this.withCompositeProgress(progressIndicator, task, options) : task({ report: () => { } });
// show on activity bar
if (viewContainerLocation === ViewContainerLocation.Sidebar) {
this.showOnActivityBar<P, R>(paneCompositeId, options, promise);
}
return promise;
}
private withViewProgress<P extends Promise<R>, R = unknown>(viewId: string, task: (progress: IProgress<IProgressStep>) => P, options: IProgressCompositeOptions): P {
// show in viewlet
const progressIndicator = this.viewsService.getViewProgressIndicator(viewId);
const promise = progressIndicator ? this.withCompositeProgress(progressIndicator, task, options) : task({ report: () => { } });
const location = this.viewDescriptorService.getViewLocationById(viewId);
if (location !== ViewContainerLocation.Sidebar) {
return promise;
}
const viewletId = this.viewDescriptorService.getViewContainerByViewId(viewId)?.id;
if (viewletId === undefined) {
return promise;
}
// show on activity bar
this.showOnActivityBar(viewletId, options, promise);
return promise;
}
private showOnActivityBar<P extends Promise<R>, R = unknown>(viewletId: string, options: IProgressCompositeOptions, promise: P): void {
let activityProgress: IDisposable;
let delayHandle: any = setTimeout(() => {
delayHandle = undefined;
const handle = this.activityService.showViewContainerActivity(viewletId, { badge: new ProgressBadge(() => ''), priority: 100 });
const startTimeVisible = Date.now();
const minTimeVisible = 300;
activityProgress = {
dispose() {
const d = Date.now() - startTimeVisible;
if (d < minTimeVisible) {
// should at least show for Nms
setTimeout(() => handle.dispose(), minTimeVisible - d);
} else {
// shown long enough
handle.dispose();
}
}
};
}, options.delay || 300);
promise.finally(() => {
clearTimeout(delayHandle);
dispose(activityProgress);
});
}
private withCompositeProgress<P extends Promise<R>, R = unknown>(progressIndicator: IProgressIndicator, task: (progress: IProgress<IProgressStep>) => P, options: IProgressCompositeOptions): P {
let discreteProgressRunner: IProgressRunner | undefined = undefined;
function updateProgress(stepOrTotal: IProgressStep | number | undefined): IProgressRunner | undefined {
// Figure out whether discrete progress applies
// by figuring out the "total" progress to show
// and the increment if any.
let total: number | undefined = undefined;
let increment: number | undefined = undefined;
if (typeof stepOrTotal !== 'undefined') {
if (typeof stepOrTotal === 'number') {
total = stepOrTotal;
} else if (typeof stepOrTotal.increment === 'number') {
total = stepOrTotal.total ?? 100; // always percentage based
increment = stepOrTotal.increment;
}
}
// Discrete
if (typeof total === 'number') {
if (!discreteProgressRunner) {
discreteProgressRunner = progressIndicator.show(total, options.delay);
promise.catch(() => undefined /* ignore */).finally(() => discreteProgressRunner?.done());
}
if (typeof increment === 'number') {
discreteProgressRunner.worked(increment);
}
}
// Infinite
else {
discreteProgressRunner?.done();
progressIndicator.showWhile(promise, options.delay);
}
return discreteProgressRunner;
}
const promise = task({
report: progress => {
updateProgress(progress);
}
});
updateProgress(options.total);
return promise;
}
private withDialogProgress<P extends Promise<R>, R = unknown>(options: IProgressDialogOptions, task: (progress: IProgress<IProgressStep>) => P, onDidCancel?: (choice?: number) => void): P {
const disposables = new DisposableStore();
const allowableCommands = [
'workbench.action.quit',
'workbench.action.reloadWindow',
'copy',
'cut',
'editor.action.clipboardCopyAction',
'editor.action.clipboardCutAction'
];
let dialog: Dialog;
const createDialog = (message: string) => {
const buttons = options.buttons || [];
if (!options.sticky) {
buttons.push(options.cancellable ? localize('cancel', "Cancel") : localize('dismiss', "Dismiss"));
}
dialog = new Dialog(
this.layoutService.activeContainer,
message,
buttons,
{
type: 'pending',
detail: options.detail,
cancelId: buttons.length - 1,
disableCloseAction: options.sticky,
disableDefaultAction: options.sticky,
keyEventProcessor: (event: StandardKeyboardEvent) => {
const resolved = this.keybindingService.softDispatch(event, this.layoutService.activeContainer);
if (resolved.kind === ResultKind.KbFound && resolved.commandId) {
if (!allowableCommands.includes(resolved.commandId)) {
EventHelper.stop(event, true);
}
}
},
buttonStyles: defaultButtonStyles,
checkboxStyles: defaultCheckboxStyles,
inputBoxStyles: defaultInputBoxStyles,
dialogStyles: defaultDialogStyles
}
);
disposables.add(dialog);
dialog.show().then(dialogResult => {
onDidCancel?.(dialogResult.button);
dispose(dialog);
});
return dialog;
};
// In order to support the `delay` option, we use a scheduler
// that will guard each access to the dialog behind a delay
// that is either the original delay for one invocation and
// otherwise runs without delay.
let delay = options.delay ?? 0;
let latestMessage: string | undefined = undefined;
const scheduler = disposables.add(new RunOnceScheduler(() => {
delay = 0; // since we have run once, we reset the delay
if (latestMessage && !dialog) {
dialog = createDialog(latestMessage);
} else if (latestMessage) {
dialog.updateMessage(latestMessage);
}
}, 0));
const updateDialog = function (message?: string): void {
latestMessage = message;
// Make sure to only run one dialog update and not multiple
if (!scheduler.isScheduled()) {
scheduler.schedule(delay);
}
};
const promise = task({
report: progress => {
updateDialog(progress.message);
}
});
promise.finally(() => {
dispose(disposables);
});
if (options.title) {
updateDialog(options.title);
}
return promise;
}
}
registerSingleton(IProgressService, ProgressService, InstantiationType.Delayed);