*WIP* Fix Hanging Progress Bar (#536)

* Remove await from ProgressNotification.show * Remove async from ProgressNotification.show * Revert async execute method @W-5227494@
forcedotcom · Jul 30, 2018 · 7f3cba2 · 7f3cba2
1 parent db32fe1
commit 7f3cba2
Show file tree

Hide file tree

Showing 22 changed files with 47 additions and 88 deletions.
diff --git a/packages/salesforcedx-vscode-core/src/commands/commands.ts b/packages/salesforcedx-vscode-core/src/commands/commands.ts
@@ -319,7 +319,7 @@ export abstract class SfdxCommandletExecutor<T>
   implements CommandletExecutor<T> {
   protected showChannelOutput = true;
 
-  protected async attachExecution(
+  protected attachExecution(
     execution: CommandExecution,
     cancellationTokenSource: vscode.CancellationTokenSource,
     cancellationToken: vscode.CancellationToken
@@ -334,22 +334,18 @@ export abstract class SfdxCommandletExecutor<T>
       execution,
       cancellationToken
     );
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 
-  public async execute(response: ContinueResponse<T>): Promise<void> {
+  public execute(response: ContinueResponse<T>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
     const execution = new CliCommandExecutor(this.build(response.data), {
       cwd: vscode.workspace.rootPath
     }).execute(cancellationToken);
 
-    await this.attachExecution(
-      execution,
-      cancellationTokenSource,
-      cancellationToken
-    );
+    this.attachExecution(execution, cancellationTokenSource, cancellationToken);
   }
 
   public abstract build(data: T): Command;
@@ -379,7 +375,7 @@ export class SfdxCommandlet<T> {
       inputs = await this.postchecker.check(inputs);
       switch (inputs.type) {
         case 'CONTINUE':
-          return await this.executor.execute(inputs);
+          return this.executor.execute(inputs);
         case 'CANCEL':
           if (inputs.msg) {
             notificationService.showErrorMessage(inputs.msg);

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceApexClassCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceApexClassCreate.ts
@@ -46,9 +46,7 @@ class ForceApexClassCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -79,7 +77,7 @@ class ForceApexClassCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceApexExecute.ts b/packages/salesforcedx-vscode-core/src/commands/forceApexExecute.ts
@@ -38,7 +38,7 @@ class ForceApexExecuteExecutor extends SfdxCommandletExecutor<{}> {
       .build();
   }
 
-  public async execute(response: ContinueResponse<TempFile>): Promise<void> {
+  public execute(response: ContinueResponse<TempFile>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -56,7 +56,7 @@ class ForceApexExecuteExecutor extends SfdxCommandletExecutor<{}> {
     );
     channelService.showChannelOutput();
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceApexLogGet.ts b/packages/salesforcedx-vscode-core/src/commands/forceApexLogGet.ts
@@ -45,7 +45,7 @@ export class ForceApexLogGetExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  protected async attachExecution(
+  protected attachExecution(
     execution: CommandExecution,
     cancellationTokenSource: vscode.CancellationTokenSource,
     cancellationToken: vscode.CancellationToken
@@ -55,7 +55,7 @@ export class ForceApexLogGetExecutor extends SfdxCommandletExecutor<
       execution,
       cancellationToken
     );
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 
@@ -67,11 +67,7 @@ export class ForceApexLogGetExecutor extends SfdxCommandletExecutor<
     const execution = new CliCommandExecutor(this.build(response.data), {
       cwd: vscode.workspace.rootPath
     }).execute(cancellationToken);
-    await this.attachExecution(
-      execution,
-      cancellationTokenSource,
-      cancellationToken
-    );
+    this.attachExecution(execution, cancellationTokenSource, cancellationToken);
     const result = await new CommandOutput().getCmdResult(execution);
     const resultJson = JSON.parse(result);
     if (resultJson.status === 0) {
@@ -166,7 +162,7 @@ export class ForceApexLogList {
         .build(),
       { cwd: vscode.workspace.workspaceFolders![0].uri.fsPath }
     ).execute();
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
     notificationService.reportExecutionError(
       execution.command.toString(),

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceApexTriggerCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceApexTriggerCreate.ts
@@ -45,9 +45,7 @@ export class ForceApexTriggerCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -78,7 +76,7 @@ export class ForceApexTriggerCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceAuthWebLogin.ts b/packages/salesforcedx-vscode-core/src/commands/forceAuthWebLogin.ts
@@ -66,7 +66,7 @@ export abstract class ForceAuthDemoModeExecutor<
     );
 
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
 
     try {

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceDebuggerStop.ts b/packages/salesforcedx-vscode-core/src/commands/forceDebuggerStop.ts
@@ -95,7 +95,7 @@ export class StopActiveDebuggerSessionExecutor extends SfdxCommandletExecutor<{}
     const resultPromise = new CommandOutput().getCmdResult(execution);
     channelService.streamCommandOutput(execution);
     channelService.showChannelOutput();
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
 
     try {

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceGenerateFauxClasses.ts b/packages/salesforcedx-vscode-core/src/commands/forceGenerateFauxClasses.ts
@@ -44,11 +44,7 @@ class ForceGenerateFauxClassesExecutor extends SfdxCommandletExecutor<{}> {
 
     const execution = new LocalCommandExecution(this.build(response.data));
 
-    await this.attachExecution(
-      execution,
-      cancellationTokenSource,
-      cancellationToken
-    );
+    this.attachExecution(execution, cancellationTokenSource, cancellationToken);
 
     const projectPath: string = vscode.workspace.rootPath as string;
     const gen: FauxClassGenerator = new FauxClassGenerator(

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceLightningAppCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceLightningAppCreate.ts
@@ -45,9 +45,7 @@ class ForceLightningAppCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -80,7 +78,7 @@ class ForceLightningAppCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceLightningComponentCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceLightningComponentCreate.ts
@@ -45,9 +45,7 @@ class ForceLightningComponentCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -80,7 +78,7 @@ class ForceLightningComponentCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceLightningEventCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceLightningEventCreate.ts
@@ -45,9 +45,7 @@ class ForceLightningEventCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -80,7 +78,7 @@ class ForceLightningEventCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceLightningInterfaceCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceLightningInterfaceCreate.ts
@@ -45,9 +45,7 @@ class ForceLightningInterfaceCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -80,7 +78,7 @@ class ForceLightningInterfaceCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceProjectCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceProjectCreate.ts
@@ -59,9 +59,7 @@ export class ForceProjectCreateExecutor extends SfdxCommandletExecutor<
     return builder.build();
   }
 
-  public async execute(
-    response: ContinueResponse<ProjectNameAndPath>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<ProjectNameAndPath>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -85,7 +83,7 @@ export class ForceProjectCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceStartApexDebugLogging.ts b/packages/salesforcedx-vscode-core/src/commands/forceStartApexDebugLogging.ts
@@ -46,7 +46,7 @@ export class ForceStartApexDebugLoggingExecutor extends SfdxCommandletExecutor<{
     const executionWrapper = new CompositeCliCommandExecutor(
       this.build()
     ).execute(this.cancellationToken);
-    await this.attachExecution(
+    this.attachExecution(
       executionWrapper,
       this.cancellationTokenSource,
       this.cancellationToken

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceStopApexDebugLogging.ts b/packages/salesforcedx-vscode-core/src/commands/forceStopApexDebugLogging.ts
@@ -31,19 +31,15 @@ export class ForceStopApexDebugLoggingExecutor extends SfdxCommandletExecutor<{}
     return deleteTraceFlag();
   }
 
-  public async execute(response: ContinueResponse<{}>): Promise<void> {
+  public execute(response: ContinueResponse<{}>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
     const execution = new CliCommandExecutor(this.build(), {
       cwd: vscode.workspace.rootPath
     }).execute(cancellationToken);
 
-    await this.attachExecution(
-      execution,
-      cancellationTokenSource,
-      cancellationToken
-    );
+    this.attachExecution(execution, cancellationTokenSource, cancellationToken);
     execution.processExitSubject.subscribe(async data => {
       if (data !== undefined && data.toString() === '0') {
         developerLogTraceFlag.turnOffLogging();

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceVisualforceComponentCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceVisualforceComponentCreate.ts
@@ -46,9 +46,7 @@ class ForceVisualForceComponentCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -79,7 +77,7 @@ class ForceVisualForceComponentCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceVisualforcePageCreate.ts b/packages/salesforcedx-vscode-core/src/commands/forceVisualforcePageCreate.ts
@@ -46,9 +46,7 @@ class ForceVisualForcePageCreateExecutor extends SfdxCommandletExecutor<
       .build();
   }
 
-  public async execute(
-    response: ContinueResponse<DirFileNameSelection>
-  ): Promise<void> {
+  public execute(response: ContinueResponse<DirFileNameSelection>): void {
     const cancellationTokenSource = new vscode.CancellationTokenSource();
     const cancellationToken = cancellationTokenSource.token;
 
@@ -79,7 +77,7 @@ class ForceVisualForcePageCreateExecutor extends SfdxCommandletExecutor<
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
     channelService.streamCommandOutput(execution);
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/commands/isvdebugging/bootstrapCmd.ts b/packages/salesforcedx-vscode-core/src/commands/isvdebugging/bootstrapCmd.ts
@@ -511,16 +511,12 @@ export class IsvDebugBootstrapExecutor extends SfdxCommandletExecutor<{}> {
 
     const result = new CommandOutput().getCmdResult(execution);
 
-    await this.attachExecution(
-      execution,
-      cancellationTokenSource,
-      cancellationToken
-    );
+    this.attachExecution(execution, cancellationTokenSource, cancellationToken);
 
     return result;
   }
 
-  protected async attachExecution(
+  protected attachExecution(
     execution: CommandExecution,
     cancellationTokenSource: vscode.CancellationTokenSource,
     cancellationToken: vscode.CancellationToken
@@ -531,7 +527,7 @@ export class IsvDebugBootstrapExecutor extends SfdxCommandletExecutor<{}> {
       execution.command.toString(),
       (execution.stderrSubject as any) as Observable<Error | undefined>
     );
-    await ProgressNotification.show(execution, cancellationTokenSource);
+    ProgressNotification.show(execution, cancellationTokenSource);
     taskViewService.addCommandExecution(execution, cancellationTokenSource);
   }
 }

diff --git a/packages/salesforcedx-vscode-core/src/notifications/progressNotification.ts b/packages/salesforcedx-vscode-core/src/notifications/progressNotification.ts
@@ -10,20 +10,21 @@ import { nls } from '../../src/messages';
 import { CommandExecution } from '@salesforce/salesforcedx-utils-vscode/out/src/cli';
 
 export class ProgressNotification {
-  public static async show(
+  public static show(
     execution: CommandExecution,
     token: vscode.CancellationTokenSource
   ) {
-    await vscode.window.withProgress(
+    return vscode.window.withProgress(
       {
         title: nls.localize('progress_notification_text', execution.command),
         location: vscode.ProgressLocation.Notification,
         cancellable: true
       },
-      async (progress, cancellationToken) => {
+      (progress, cancellationToken) => {
         return new Promise(resolve => {
           cancellationToken.onCancellationRequested(() => {
             token.cancel();
+            return resolve();
           });
 
           execution.processExitSubject.subscribe(data => {