Fix cancellable option for withProgress

also cleaned up unused `NotificationMain.$startProgress` options. Fixes #5578 Signed-off-by: Alex Tugarev <alex.tugarev@typefox.io>
eclipse-theia · Oct 11, 2019 · b98c5fb · b98c5fb
1 parent e4fb256
commit b98c5fb
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts
@@ -686,14 +686,15 @@ export interface DecorationProvider {
 }
 
 export interface NotificationMain {
-    $startProgress(options: string | NotificationMain.StartProgressOptions): Promise<string>;
+    $startProgress(options: NotificationMain.StartProgressOptions): Promise<string>;
     $stopProgress(id: string): void;
     $updateProgress(id: string, report: NotificationMain.ProgressReport): void;
 }
 export namespace NotificationMain {
     export interface StartProgressOptions {
         title: string;
         location?: string;
+        cancellable?: boolean;
     }
     export interface ProgressReport {
         message?: string;

diff --git a/packages/plugin-ext/src/main/browser/notification-main.ts b/packages/plugin-ext/src/main/browser/notification-main.ts
@@ -38,7 +38,7 @@ export class NotificationMainImpl implements NotificationMain, Disposable {
         this.toDispose.dispose();
     }
 
-    async $startProgress(options: string | NotificationMain.StartProgressOptions): Promise<string> {
+    async $startProgress(options: NotificationMain.StartProgressOptions): Promise<string> {
         const progressMessage = this.mapOptions(options);
         const progress = await this.progressService.showProgress(progressMessage);
         const id = progress.id;
@@ -51,10 +51,9 @@ export class NotificationMainImpl implements NotificationMain, Disposable {
         }
         return id;
     }
-    protected mapOptions(options: string | NotificationMain.StartProgressOptions): ProgressMessage {
-        const text = typeof options === 'string' ? options : options.title;
-        const location = typeof options === 'string' ? 'notification' : options.location;
-        return { text, options: { location, cancelable: true } };
+    protected mapOptions(options: NotificationMain.StartProgressOptions): ProgressMessage {
+        const { title, location, cancellable } = options;
+        return { text: title, options: { location, cancelable: cancellable } };
     }
 
     $stopProgress(id: string): void {

diff --git a/packages/plugin-ext/src/plugin/notification.ts b/packages/plugin-ext/src/plugin/notification.ts
@@ -37,7 +37,8 @@ export class NotificationExtImpl implements NotificationExt {
         const progress = task({ report: async item => this.proxy.$updateProgress(await id.promise, item)}, tokenSource.token);
         const title = options.title ? options.title : '';
         const location = this.mapLocation(options.location);
-        id.resolve(await this.proxy.$startProgress({ title, location }));
+        const cancellable = options.cancellable;
+        id.resolve(await this.proxy.$startProgress({ title, location, cancellable }));
         const stop = async () => this.proxy.$stopProgress(await id.promise);
         const promise = Promise.all([
             progress,