Updates view progress proposal - microsoft#92421

Eric Amodio · Eric Amodio · commit 7fcc44cd1976 · 2020-03-16T15:50:19.000-04:00
diff --git a/src/vs/platform/progress/common/progress.ts b/src/vs/platform/progress/common/progress.ts
@@ -45,8 +45,7 @@ export const enum ProgressLocation {
 	Extensions = 5,
 	Window = 10,
 	Notification = 15,
-	Dialog = 20,
-	View = 25
+	Dialog = 20
 }
 
 export interface IProgressOptions {
diff --git a/src/vs/vscode.d.ts b/src/vs/vscode.d.ts
@@ -7932,7 +7932,7 @@ declare module 'vscode' {
 		/**
 		 * The location at which progress should show.
 		 */
-		location: ProgressLocation;
+		location: ProgressLocation | { viewId: string };
 
 		/**
 		 * A human-readable string which will be used to describe the
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -1891,23 +1891,4 @@ declare module 'vscode' {
 
 	//#endregion
 
-	//#region https://github.com/microsoft/vscode/issues/92421
-
-	export enum ProgressLocation {
-		/**
-		 * Show progress for a view, as progress bar inside the view (when visible),
-		 * and as an overlay on the activity bar icon. Doesn't support cancellation or discrete progress.
-		 */
-		View = 25,
-	}
-
-	export interface ProgressOptions {
-		/**
-		 * The target view identifier for showing progress when using [ProgressLocation.View](#ProgressLocation.View).
-		 */
-		viewId?: string
-	}
-
-	//#endregion
-
 }
diff --git a/src/vs/workbench/api/common/extHost.api.impl.ts b/src/vs/workbench/api/common/extHost.api.impl.ts
@@ -540,7 +540,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 				return extHostProgress.withProgress(extension, { location: extHostTypes.ProgressLocation.SourceControl }, (progress, token) => task({ report(n: number) { /*noop*/ } }));
 			},
 			withProgress<R>(options: vscode.ProgressOptions, task: (progress: vscode.Progress<{ message?: string; worked?: number }>, token: vscode.CancellationToken) => Thenable<R>) {
-				if (options.location === extHostTypes.ProgressLocation.View) {
+				if (typeof options.location !== 'number') {
 					checkProposedApiEnabled(extension);
 				}
 				return extHostProgress.withProgress(extension, options, task);
diff --git a/src/vs/workbench/api/common/extHostProgress.ts b/src/vs/workbench/api/common/extHostProgress.ts
@@ -24,10 +24,10 @@ export class ExtHostProgress implements ExtHostProgressShape {
 
 	withProgress<R>(extension: IExtensionDescription, options: ProgressOptions, task: (progress: Progress<IProgressStep>, token: CancellationToken) => Thenable<R>): Thenable<R> {
 		const handle = this._handles++;
-		const { title, location, cancellable, viewId } = options;
+		const { title, location, cancellable } = options;
 		const source = localize('extensionSource', "{0} (Extension)", extension.displayName || extension.name);
 
-		this._proxy.$startProgress(handle, { location: ProgressLocation.from(location, viewId), title, source, cancellable }, extension);
+		this._proxy.$startProgress(handle, { location: ProgressLocation.from(location), title, source, cancellable }, extension);
 		return this._withProgress(handle, task, !!cancellable);
 	}
 
diff --git a/src/vs/workbench/api/common/extHostTypeConverters.ts b/src/vs/workbench/api/common/extHostTypeConverters.ts
@@ -1093,12 +1093,15 @@ export namespace EndOfLine {
 }
 
 export namespace ProgressLocation {
-	export function from(loc: vscode.ProgressLocation, viewId?: string): MainProgressLocation | string {
+	export function from(loc: vscode.ProgressLocation | { viewId: string }): MainProgressLocation | string {
+		if (typeof loc === 'string') {
+			return loc;
+		}
+
 		switch (loc) {
 			case types.ProgressLocation.SourceControl: return MainProgressLocation.Scm;
 			case types.ProgressLocation.Window: return MainProgressLocation.Window;
 			case types.ProgressLocation.Notification: return MainProgressLocation.Notification;
-			case types.ProgressLocation.View: return viewId ?? '';
 		}
 		throw new Error(`Unknown 'ProgressLocation'`);
 	}
diff --git a/src/vs/workbench/api/common/extHostTypes.ts b/src/vs/workbench/api/common/extHostTypes.ts
@@ -2082,8 +2082,7 @@ export class Task implements vscode.Task2 {
 export enum ProgressLocation {
 	SourceControl = 1,
 	Window = 10,
-	Notification = 15,
-	View = 25
+	Notification = 15
 }
 
 @es5ClassCompat

Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,7 @@ export const enum ProgressLocation {`
`45`	`45`	`Extensions = 5,`
`46`	`46`	`Window = 10,`
`47`	`47`	`Notification = 15,`
`48`		`- Dialog = 20,`
`49`		`- View = 25`
	`48`	`+ Dialog = 20`
`50`	`49`	`}`
`51`	`50`
`52`	`51`	`export interface IProgressOptions {`
Original file line number	Diff line number	Diff line change
`@@ -540,7 +540,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I`
`540`	`540`	`return extHostProgress.withProgress(extension, { location: extHostTypes.ProgressLocation.SourceControl }, (progress, token) => task({ report(n: number) { /noop/ } }));`
`541`	`541`	`},`
`542`	`542`	`withProgress<R>(options: vscode.ProgressOptions, task: (progress: vscode.Progress<{ message?: string; worked?: number }>, token: vscode.CancellationToken) => Thenable<R>) {`
`543`		`- if (options.location === extHostTypes.ProgressLocation.View) {`
	`543`	`+ if (typeof options.location !== 'number') {`
`544`	`544`	`checkProposedApiEnabled(extension);`
`545`	`545`	`}`
`546`	`546`	`return extHostProgress.withProgress(extension, options, task);`
Original file line number	Diff line number	Diff line change
`@@ -1093,12 +1093,15 @@ export namespace EndOfLine {`
`1093`	`1093`	`}`
`1094`	`1094`
`1095`	`1095`	`export namespace ProgressLocation {`
`1096`		`- export function from(loc: vscode.ProgressLocation, viewId?: string): MainProgressLocation \| string {`
	`1096`	`+ export function from(loc: vscode.ProgressLocation \| { viewId: string }): MainProgressLocation \| string {`
	`1097`	`+ if (typeof loc === 'string') {`
	`1098`	`+ return loc;`
	`1099`	`+ }`
	`1100`	`+`
`1097`	`1101`	`switch (loc) {`
`1098`	`1102`	`case types.ProgressLocation.SourceControl: return MainProgressLocation.Scm;`
`1099`	`1103`	`case types.ProgressLocation.Window: return MainProgressLocation.Window;`
`1100`	`1104`	`case types.ProgressLocation.Notification: return MainProgressLocation.Notification;`
`1101`		`- case types.ProgressLocation.View: return viewId ?? '';`
`1102`	`1105`	`}`
`1103`	`1106`	throw new Error(`Unknown 'ProgressLocation'`);
`1104`	`1107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2082,8 +2082,7 @@ export class Task implements vscode.Task2 {`
`2082`	`2082`	`export enum ProgressLocation {`
`2083`	`2083`	`SourceControl = 1,`
`2084`	`2084`	`Window = 10,`
`2085`		`- Notification = 15,`
`2086`		`- View = 25`
	`2085`	`+ Notification = 15`
`2087`	`2086`	`}`
`2088`	`2087`
`2089`	`2088`	`@es5ClassCompat`