hot exit - turn progress on shutdown to a modal dialog (microsoft#122774)

Author: bpasero

src/vs/platform/progress/common/progress.ts

@@ -19,7 +19,7 @@ export interface IProgressService {
 	readonly _serviceBrand: undefined;
 
 	withProgress<R>(
-		options: IProgressOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
+		options: IProgressOptions | IProgressDialogOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
 		task: (progress: IProgress<IProgressStep>) => Promise<R>,
 		onDidCancel?: (choice?: number) => void
 	): Promise<R>;
@@ -66,6 +66,11 @@ export interface IProgressNotificationOptions extends IProgressOptions {
 	readonly silent?: boolean;
 }
 
+export interface IProgressDialogOptions extends IProgressOptions {
+	readonly delay?: number;
+	readonly detail?: string;
+}
+
 export interface IProgressWindowOptions extends IProgressOptions {
 	readonly location: ProgressLocation.Window;
 	readonly command?: string;
@@ -134,7 +139,7 @@ export class UnmanagedProgress extends Disposable {
 	private lastStep?: IProgressStep;
 
 	constructor(
-		options: IProgressOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
+		options: IProgressOptions | IProgressDialogOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
 		@IProgressService progressService: IProgressService,
 	) {
 		super();
@@ -159,7 +164,6 @@ export class UnmanagedProgress extends Disposable {
 	}
 }
 
-
 export class LongRunningOperation extends Disposable {
 	private currentOperationId = 0;
 	private readonly currentOperationDisposables = this._register(new DisposableStore());

src/vs/workbench/services/progress/browser/progressService.ts

@@ -7,10 +7,10 @@ import 'vs/css!./media/progressService';
 
 import { localize } from 'vs/nls';
 import { IDisposable, dispose, DisposableStore, Disposable, toDisposable } from 'vs/base/common/lifecycle';
-import { IProgressService, IProgressOptions, IProgressStep, ProgressLocation, IProgress, Progress, IProgressCompositeOptions, IProgressNotificationOptions, IProgressRunner, IProgressIndicator, IProgressWindowOptions } from 'vs/platform/progress/common/progress';
+import { IProgressService, IProgressOptions, IProgressStep, ProgressLocation, IProgress, Progress, IProgressCompositeOptions, IProgressNotificationOptions, IProgressRunner, IProgressIndicator, IProgressWindowOptions, IProgressDialogOptions } from 'vs/platform/progress/common/progress';
 import { IViewletService } from 'vs/workbench/services/viewlet/browser/viewlet';
 import { StatusbarAlignment, IStatusbarService, IStatusbarEntryAccessor, IStatusbarEntry } from 'vs/workbench/services/statusbar/common/statusbar';
-import { timeout } from 'vs/base/common/async';
+import { RunOnceScheduler, timeout } from 'vs/base/common/async';
 import { ProgressBadge, IActivityService } from 'vs/workbench/services/activity/common/activity';
 import { INotificationService, Severity, INotificationHandle } from 'vs/platform/notification/common/notification';
 import { Action } from 'vs/base/common/actions';
@@ -438,7 +438,7 @@ export class ProgressService extends Disposable implements IProgressService {
 		return promise;
 	}
 
-	private showOnActivityBar<P extends Promise<R>, R = unknown>(viewletId: string, options: IProgressCompositeOptions, promise: P) {
+	private showOnActivityBar<P extends Promise<R>, R = unknown>(viewletId: string, options: IProgressCompositeOptions, promise: P): void {
 		let activityProgress: IDisposable;
 		let delayHandle: any = setTimeout(() => {
 			delayHandle = undefined;
@@ -501,8 +501,9 @@ export class ProgressService extends Disposable implements IProgressService {
 		return promise;
 	}
 
-	private withDialogProgress<P extends Promise<R>, R = unknown>(options: IProgressOptions, task: (progress: IProgress<IProgressStep>) => P, onDidCancel?: (choice?: number) => void): P {
+	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',
@@ -515,7 +516,6 @@ export class ProgressService extends Disposable implements IProgressService {
 		let dialog: Dialog;
 
 		const createDialog = (message: string) => {
-
 			const buttons = options.buttons || [];
 			buttons.push(options.cancellable ? localize('cancel', "Cancel") : localize('dismiss', "Dismiss"));
 
@@ -525,6 +525,7 @@ export class ProgressService extends Disposable implements IProgressService {
 				buttons,
 				{
 					type: 'pending',
+					detail: options.detail,
 					cancelId: buttons.length - 1,
 					keyEventProcessor: (event: StandardKeyboardEvent) => {
 						const resolved = this.keybindingService.softDispatch(event, this.layoutService.container);
@@ -540,22 +541,37 @@ export class ProgressService extends Disposable implements IProgressService {
 			disposables.add(dialog);
 			disposables.add(attachDialogStyler(dialog, this.themeService));
 
-			dialog.show().then((dialogResult) => {
-				if (typeof onDidCancel === 'function') {
-					onDidCancel(dialogResult.button);
-				}
+			dialog.show().then(dialogResult => {
+				onDidCancel?.(dialogResult.button);
 
 				dispose(dialog);
 			});
 
 			return dialog;
 		};
 
-		const updateDialog = (message?: string) => {
-			if (message && !dialog) {
-				dialog = createDialog(message);
-			} else if (message) {
-				dialog.updateMessage(message);
+		// 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);
 			}
 		};
 
@@ -569,6 +585,10 @@ export class ProgressService extends Disposable implements IProgressService {
 			dispose(disposables);
 		});
 
+		if (options.title) {
+			updateDialog(options.title);
+		}
+
 		return promise;
 	}
 }

src/vs/workbench/services/workingCopy/electron-sandbox/workingCopyBackupTracker.ts

@@ -224,7 +224,10 @@ export class NativeWorkingCopyBackupTracker extends WorkingCopyBackupTracker imp
 			} catch (backupError) {
 				error = backupError;
 			}
-		}, localize('backupBeforeShutdown', "Waiting for dirty editors to backup..."));
+		},
+			localize('backupBeforeShutdownMessage', "Waiting for dirty editors to backup..."),
+			localize('backupBeforeShutdownDetail', "Click 'Cancel' skip backups and save or revert dirty editors.")
+		);
 
 		return { backups, error };
 	}
@@ -313,14 +316,15 @@ export class NativeWorkingCopyBackupTracker extends WorkingCopyBackupTracker imp
 		}, localize('revertBeforeShutdown', "Waiting for dirty editors to revert..."));
 	}
 
-	private withProgressAndCancellation(promiseFactory: (token: CancellationToken) => Promise<void>, title: string): Promise<void> {
+	private withProgressAndCancellation(promiseFactory: (token: CancellationToken) => Promise<void>, title: string, detail?: string): Promise<void> {
 		const cts = new CancellationTokenSource();
 
 		return this.progressService.withProgress({
-			location: ProgressLocation.Notification,
-			cancellable: true, // for issues such as https://github.com/microsoft/vscode/issues/112278
-			delay: 800, // delay notification so that it only appears when operation takes a long time
-			title
+			location: ProgressLocation.Dialog, 	// use a dialog to prevent the user from making any more changes now (https://github.com/microsoft/vscode/issues/122774)
+			cancellable: true, 					// allow to cancel (https://github.com/microsoft/vscode/issues/112278)
+			delay: 800, 						// delay notification so that it only appears when operation takes a long time
+			title,
+			detail
 		}, () => raceCancellation(promiseFactory(cts.token), cts.token), () => cts.dispose(true));
 	}
 

src/vs/workbench/test/browser/workbenchTestServices.ts

@@ -83,7 +83,7 @@ import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/
 import { createTextBufferFactoryFromStream } from 'vs/editor/common/model/textModel';
 import { IPathService } from 'vs/workbench/services/path/common/pathService';
 import { Direction } from 'vs/base/browser/ui/grid/grid';
-import { IProgressService, IProgressOptions, IProgressWindowOptions, IProgressNotificationOptions, IProgressCompositeOptions, IProgress, IProgressStep, Progress } from 'vs/platform/progress/common/progress';
+import { IProgressService, IProgressOptions, IProgressWindowOptions, IProgressNotificationOptions, IProgressCompositeOptions, IProgress, IProgressStep, Progress, IProgressDialogOptions } from 'vs/platform/progress/common/progress';
 import { IWorkingCopyFileService, WorkingCopyFileService } from 'vs/workbench/services/workingCopy/common/workingCopyFileService';
 import { UndoRedoService } from 'vs/platform/undoRedo/common/undoRedoService';
 import { IUndoRedoService } from 'vs/platform/undoRedo/common/undoRedo';
@@ -411,7 +411,7 @@ export class TestProgressService implements IProgressService {
 	declare readonly _serviceBrand: undefined;
 
 	withProgress(
-		options: IProgressOptions | IProgressWindowOptions | IProgressNotificationOptions | IProgressCompositeOptions,
+		options: IProgressOptions | IProgressDialogOptions | IProgressWindowOptions | IProgressNotificationOptions | IProgressCompositeOptions,
 		task: (progress: IProgress<IProgressStep>) => Promise<any>,
 		onDidCancel?: ((choice?: number | undefined) => void) | undefined
 	): Promise<any> {