refactor the progress api based on feedback

Author: testforstephen

README.md

@@ -121,7 +121,7 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
 - `java.debug.settings.jdwp.limitOfVariablesPerJdwpRequest`: The maximum number of variables or fields that can be requested in one JDWP request. The higher the value, the less frequently debuggee will be requested when expanding the variable view. Also a large number can cause JDWP request timeout. Defaults to 100.
 - `java.debug.settings.jdwp.requestTimeout`: The timeout (ms) of JDWP request when the debugger communicates with the target JVM. Defaults to 3000.
 - `java.debug.settings.vmArgs`: The default VM arguments to launch the Java program. Eg. Use '-Xmx1G -ea' to increase the heap size to 1GB and enable assertions. If you want to customize the VM arguments for a specific debug session, please modify the 'vmArgs' config in launch.json.
-- `java.debug.settings.showRunStatusAsNotification`: Show the build status as the progress notification every time you run or debug a program. Defaults to `true`.
+- `java.silentNotification`: Control whether the progress notifications can be shown. Defaults to `false`.
 
 Pro Tip: The documentation [Configuration.md](https://github.com/microsoft/vscode-java-debug/blob/master/Configuration.md) provides lots of samples to demonstrate how to use these debug configurations, recommend to take a look.
 

package.json

@@ -742,10 +742,10 @@
           "description": "%java.debugger.configuration.vmArgs.description%",
           "default": ""
         },
-        "java.debug.settings.showRunStatusAsNotification": {
+        "java.silentNotification": {
           "type": "boolean",
-          "description": "%java.debugger.configuration.showRunStatusAsNotification%",
-          "default": true
+          "description": "%java.debugger.configuration.silentNotification%",
+          "default": false
         }
       }
     }

package.nls.json

@@ -59,5 +59,5 @@
     "java.debugger.configuration.jdwp.limitOfVariablesPerJdwpRequest.description": "The maximum number of variables or fields that can be requested in one JDWP request. The higher the value, the less frequently debuggee will be requested when expanding the variable view. Also a large number can cause JDWP request timeout.",
     "java.debugger.configuration.jdwp.requestTimeout.description": "The timeout (ms) of JDWP request when the debugger communicates with the target JVM.",
     "java.debugger.configuration.vmArgs.description": "The default VM arguments to launch the Java program. Eg. Use '-Xmx1G -ea' to increase the heap size to 1GB and enable assertions. If you want to customize the VM arguments for a specific debug session, please modify the 'vmArgs' config in launch.json.",
-    "java.debugger.configuration.showRunStatusAsNotification": "Show the build status as the progress notification every time you run or debug a program."
+    "java.debugger.configuration.silentNotification": "Control whether the progress notifications can be shown."
 }

package.nls.zh.json

@@ -57,5 +57,5 @@
     "java.debugger.configuration.jdwp.limitOfVariablesPerJdwpRequest.description": "一次JDWP请求中可以请求的变量或字段的最大数量。该值越高，在展开变量视图时，请求debuggee的频率就越低。同时数量过大也会导致JDWP请求超时。",
     "java.debugger.configuration.jdwp.requestTimeout.description": "调试器与目标JVM通信时JDWP请求的超时时间（ms）。",
     "java.debugger.configuration.vmArgs.description": "启动Java程序的默认VM参数。例如，使用'-Xmx1G -ea'将堆大小增加到1GB并启用断言。如果要为特定的调试会话定制VM参数，请修改launch.json中的'vmArgs'配置。",
-    "java.debugger.configuration.showRunStatusAsNotification": "每次运行或调试程序时，将构建状态显示为进度通知。"
+    "java.debugger.configuration.silentNotification": "控制是否可以显示进度通知。"
 }

src/build.ts

@@ -56,16 +56,13 @@ async function handleBuildFailure(operationId: string, err: any, progressReporte
     });
     setErrorCode(error, Number(err));
     sendOperationError(operationId, "build", error);
-    if (err === lsPlugin.CompileWorkspaceStatus.WITHERROR || err === lsPlugin.CompileWorkspaceStatus.FAILED) {
+    if (!onBuildFailureProceed && (err === lsPlugin.CompileWorkspaceStatus.WITHERROR || err === lsPlugin.CompileWorkspaceStatus.FAILED)) {
         if (checkErrorsReportedByJavaExtension()) {
             vscode.commands.executeCommand("workbench.actions.view.problems");
         }
 
-        if (!onBuildFailureProceed) {
-            progressReporter.report("Confirm Build Errors", "Build failed, please select the next action...");
-        }
-        const ans = onBuildFailureProceed ? "Proceed" : (await vscode.window.showErrorMessage("Build failed, do you want to continue?",
-            "Proceed", "Fix...", "Cancel"));
+        progressReporter.hide(true);
+        const ans = await vscode.window.showErrorMessage("Build failed, do you want to continue?", "Proceed", "Fix...", "Cancel");
         sendInfo(operationId, {
             operationName: "build",
             choiceForBuildError: ans || "esc",

src/configurationProvider.ts

@@ -17,7 +17,7 @@ import { logger, Type } from "./logger";
 import { mainClassPicker } from "./mainClassPicker";
 import { resolveJavaProcess } from "./processPicker";
 import { IProgressReporter } from "./progressAPI";
-import { progressReporterManager } from "./progressImpl";
+import { progressProvider } from "./progressImpl";
 import * as utility from "./utility";
 
 const platformNameMappings: {[key: string]: string} = {
@@ -90,7 +90,7 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
 
     private provideDebugConfigurationsAsync(folder: vscode.WorkspaceFolder | undefined, token?: vscode.CancellationToken) {
         return new Promise(async (resolve, _reject) => {
-            const progressReporter = progressReporterManager.create("Create launch.json", true);
+            const progressReporter = progressProvider.createProgressReporter("Create launch.json", vscode.ProgressLocation.Window);
             progressReporter.observe(token);
             const defaultLaunchConfig = {
                 type: "java",
@@ -171,11 +171,11 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
 
     private async resolveAndValidateDebugConfiguration(folder: vscode.WorkspaceFolder | undefined, config: vscode.DebugConfiguration,
                                                        token?: vscode.CancellationToken) {
-        let progressReporter = progressReporterManager.get(config.__progressId);
+        let progressReporter = progressProvider.getProgressReporter(config.__progressId);
         if (!progressReporter && config.__progressId) {
             return undefined;
         }
-        progressReporter = progressReporter || progressReporterManager.create(config.noDebug ? "Run" : "Debug");
+        progressReporter = progressReporter || progressProvider.createProgressReporterForPreLaunchTask(config.noDebug ? "Run" : "Debug");
         progressReporter.observe(token);
         if (progressReporter.isCancelled()) {
             return undefined;
@@ -221,6 +221,8 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
                     if (!proceed) {
                         return undefined;
                     }
+
+                    progressReporter.show();
                 }
 
                 if (progressReporter.isCancelled()) {
@@ -353,7 +355,7 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
             utility.showErrorMessageWithTroubleshooting(utility.convertErrorToMessage(ex));
             return undefined;
         } finally {
-            progressReporter.cancel();
+            progressReporter.done();
         }
     }
 
@@ -388,7 +390,7 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
             if (currentFile) {
                 const mainEntries = await lsPlugin.resolveMainMethod(vscode.Uri.file(currentFile));
                 if (mainEntries.length) {
-                    progressReporter.report("Select mainClass", "Selecting the main class to run...");
+                    progressReporter.hide(true);
                     return mainClassPicker.showQuickPick(mainEntries, "Please select a main class you want to run.");
                 }
             }
@@ -433,14 +435,13 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
         }
 
         if (validationResponse.proposals && validationResponse.proposals.length) {
-            progressReporter.report("Confirm Config Error", "Config error, please select the next action...");
+            progressReporter.hide(true);
             const answer = await utility.showErrorMessageWithTroubleshooting({
                 message: errors.join(os.EOL),
                 type: Type.USAGEERROR,
                 anchor: anchor.FAILED_TO_RESOLVE_CLASSPATH,
             }, "Fix");
             if (answer === "Fix") {
-                progressReporter.report("Select mainClass", "Select the main class to run...");
                 const selectedFix = await mainClassPicker.showQuickPick(validationResponse.proposals,
                     "Please select main class<project name>.", false);
                 if (selectedFix) {
@@ -502,7 +503,7 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration
             });
         }
 
-        progressReporter.report("Select mainClass", "Selecting the main class to run...");
+        progressReporter.hide(true);
         return mainClassPicker.showQuickPickWithRecentlyUsed(res, hintMessage || "Select main class<project name>");
     }
 }

src/extension.ts

@@ -20,7 +20,7 @@ import { logger, Type } from "./logger";
 import { mainClassPicker  } from "./mainClassPicker";
 import { pickJavaProcess } from "./processPicker";
 import { IProgressReporter } from "./progressAPI";
-import { progressReporterManager, registerProgressReporters } from "./progressImpl";
+import { progressProvider } from "./progressImpl";
 import { JavaTerminalLinkProvder } from "./terminalLinkProvider";
 import { initializeThreadOperations } from "./threadOperations";
 import * as utility from "./utility";
@@ -36,7 +36,6 @@ function initializeExtension(_operationId: string, context: vscode.ExtensionCont
     // Deprecated
     logger.initialize(context, true);
 
-    registerProgressReporters(context);
     registerDebugEventListener(context);
     context.subscriptions.push(logger);
     context.subscriptions.push(vscode.window.registerTerminalLinkProvider(new JavaTerminalLinkProvder()));
@@ -78,7 +77,7 @@ function initializeExtension(_operationId: string, context: vscode.ExtensionCont
     initializeThreadOperations(context);
 
     return {
-        progressReporterManager,
+        progressProvider,
     };
 }
 
@@ -233,7 +232,7 @@ async function applyHCR(hcrStatusBar: NotificationBar) {
 }
 
 async function runJavaFile(uri: vscode.Uri, noDebug: boolean) {
-    const progressReporter = progressReporterManager.create(noDebug ? "Run" : "Debug");
+    const progressReporter = progressProvider.createProgressReporterForPreLaunchTask(noDebug ? "Run" : "Debug");
     try {
         // Wait for Java Language Support extension being on Standard mode.
         const isOnStandardMode = await utility.waitForStandardMode(progressReporter);
@@ -323,12 +322,13 @@ async function launchMain(mainMethods: IMainClassOption[], uri: vscode.Uri, noDe
         throw new utility.OperationCancelledError("");
     }
 
-    progressReporter.report("Select mainClass", "Selecting the main class to run...");
+    progressReporter.hide(true);
     const pick = await mainClassPicker.showQuickPickWithRecentlyUsed(mainMethods, placeHolder, autoPick);
     if (!pick) {
         throw new utility.OperationCancelledError("");
     }
 
+    progressReporter.show();
     startDebugging(pick.mainClass, pick.projectName || "", uri, noDebug, progressReporter);
 }
 
@@ -341,7 +341,7 @@ async function runJavaProject(node: any, noDebug: boolean) {
         throw error;
     }
 
-    const progressReporter = progressReporterManager.create(noDebug ? "Run" : "Debug");
+    const progressReporter = progressProvider.createProgressReporterForPreLaunchTask(noDebug ? "Run" : "Debug");
     try {
         progressReporter.report("Resolve mainClass", "Resolving main class...");
         const mainClassesOptions: IMainClassOption[] = await utility.searchMainMethods(vscode.Uri.parse(node.uri));
@@ -355,13 +355,14 @@ async function runJavaProject(node: any, noDebug: boolean) {
             throw new utility.OperationCancelledError("");
         }
 
-        progressReporter.report("Select mainClass", "Selecting the main class to run...");
+        progressReporter.hide(true);
         const pick = await mainClassPicker.showQuickPickWithRecentlyUsed(mainClassesOptions,
             "Select the main class to run.");
         if (!pick || progressReporter.isCancelled()) {
             throw new utility.OperationCancelledError("");
         }
 
+        progressReporter.show();
         const projectName: string | undefined = pick.projectName;
         const mainClass: string = pick.mainClass;
         const filePath: string | undefined = pick.filePath;

src/progressAPI.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { CancellationToken } from "vscode";
+import { CancellationToken, ProgressLocation } from "vscode";
 
 export interface IProgressReporter {
     /**
@@ -10,51 +10,71 @@ export interface IProgressReporter {
     getId(): string;
 
     /**
-     * Update the progress message.
-     * @param subTaskName the sub task name to update
-     * @param detailedMessage the detailed message to update
+     * Reports a progress message update.
+     * @param subTaskName the message shown in the status bar
+     * @param detailedMessage the detailed message shown in the notification
      */
     report(subTaskName: string, detailedMessage: string): void;
 
     /**
-     * Cancel the progress reporter.
+     * Shows the progress reporter.
+     */
+    show(): void;
+
+    /**
+     * Hides the progress reporter.
+     * @param onlyNotifications only hide the progress reporter when it's shown as notification
+     */
+    hide(onlyNotifications?: boolean): void;
+
+    /**
+     * Cancels the progress reporter.
      */
     cancel(): void;
 
     /**
-     * Is the progress reporter cancelled.
+     * Returns whether the progress reporter has been cancelled or completed.
      */
     isCancelled(): boolean;
 
+    /**
+     * Notifies the work is done that is either the task is completed or the user has cancelled it.
+     */
+    done(): void;
+
     /**
      * The CancellationToken to monitor if the progress reporter has been cancelled by the user.
      */
     getCancellationToken(): CancellationToken;
 
     /**
-     * Dispose the progress reporter if the observed token has been cancelled.
+     * Disposes the progress reporter if the observed token has been cancelled.
      * @param token the cancellation token to observe
      */
     observe(token?: CancellationToken): void;
 }
 
-export interface IProgressReporterManager {
+export interface IProgressReporterProvider {
     /**
-     * Create a progress reporter.
+     * Creates a progress reporter.
      * @param jobName the job name
-     * @param showInStatusBar whether to show the progress in the status bar
+     * @param progressLocation The location at which progress should show
+     * @param cancellable Controls if a cancel button should show to allow the user
+     *                    to cancel the progress reporter. Note that currently only
+     *                    `ProgressLocation.Notification` is supporting to show a cancel
+     *                    button.
      */
-    create(jobName: string, showInStatusBar?: boolean): IProgressReporter;
+    createProgressReporter(jobName: string, progressLocation: ProgressLocation | { viewId: string }, cancellable?: boolean): IProgressReporter;
 
     /**
-     * Return the progress repoter with the progress id.
-     * @param progressId the progress id
+     * Creates a progress reporter for the task to run before the debug session starts.
+     * @param jobName the job name
      */
-    get(progressId: string): IProgressReporter | undefined;
+    createProgressReporterForPreLaunchTask(jobName: string): IProgressReporter;
 
     /**
-     * Remove the progress reporter from the progress reporter manager.
-     * @param progressReporter the progress reporter to remove
+     * Returns the progress reporter with the progress id.
+     * @param progressId the progress id
      */
-    remove(progressReporter: IProgressReporter): void;
+    getProgressReporter(progressId: string): IProgressReporter | undefined;
 }