Support WorkDoneProgress in progress reporting

Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>

Author: hopehadfield

README.md

@@ -149,7 +149,6 @@ The following settings are supported:
 * `java.completion.filteredTypes`: Defines the type filters. All types whose fully qualified name matches the selected filter strings will be ignored in content assist or quick fix proposals and when organizing imports. For example 'java.awt.*' will hide all types from the awt packages.
 * `java.completion.favoriteStaticMembers` : Defines a list of static members or types with static members.
 * `java.completion.importOrder` : Defines the sorting order of import statements.
-* `java.progressReports.enabled` : [Experimental] Enable/disable progress reports from background processes on the server.
 * `java.format.enabled` : Enable/disable the default Java formatter.
 * `java.format.settings.url` : Specifies the url or file path to the [Eclipse formatter xml settings](https://github.com/redhat-developer/vscode-java/wiki/Formatter-settings).
 * `java.format.settings.profile` : Optional formatter profile name from the Eclipse formatter settings.

package.json

@@ -653,12 +653,6 @@
           "description": "Enable/disable smart folding range support. If disabled, it will use the default indentation-based folding range provided by VS Code.",
           "scope": "window"
         },
-        "java.progressReports.enabled": {
-          "type": "boolean",
-          "description": "[Experimental] Enable/disable progress reports from background processes on the server.",
-          "default": true,
-          "scope": "window"
-        },
         "java.format.settings.url": {
           "type": "string",
           "markdownDescription": "Specifies the url or file path to the [Eclipse formatter xml settings](https://github.com/redhat-developer/vscode-java/wiki/Formatter-settings).",

src/extension.ts

@@ -157,7 +157,6 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 					workspaceFolders: workspace.workspaceFolders ? workspace.workspaceFolders.map(f => f.uri.toString()) : null,
 					settings: { java: getJavaConfig(requirements.java_home) },
 					extendedClientCapabilities: {
-						progressReportProvider: getJavaConfiguration().get('progressReports.enabled'),
 						classFileContentsSupport: true,
 						overrideMethodsPromptSupport: true,
 						hashCodeEqualsPromptSupport: true,

src/protocol.ts

@@ -82,15 +82,17 @@ export interface StatusReport {
 }
 
 export interface ProgressReport {
-    id: string;
-    task: string;
-    subTask: string;
-    status: string;
-    workDone: number;
-    totalWork: number;
+    token: string;
+    value: any;
     complete: boolean;
 }
 
+export enum ProgressKind {
+    begin = "begin",
+    report = "report",
+    end = "end"
+}
+
 export interface ActionableMessage {
     severity: MessageType;
     message: string;
@@ -107,8 +109,9 @@ export namespace StatusNotification {
     export const type = new NotificationType<StatusReport>('language/status');
 }
 
-export namespace ProgressReportNotification {
-    export const type = new NotificationType<ProgressReport>('language/progressReport');
+// See https://github.com/microsoft/vscode-languageserver-node/blob/release/client/8.1.0/jsonrpc/src/common/connection.ts#L53-L55
+export namespace ProgressNotification {
+	export const type = new NotificationType<ProgressReport>('$/progress');
 }
 
 export namespace ClassFileContentsRequest {

src/serverStatus.ts

@@ -2,6 +2,7 @@
 
 import { EventEmitter } from "vscode";
 import { serverTasks } from "./serverTasks";
+import { ProgressKind } from "./protocol";
 
 export enum ServerStatusKind {
 	ready = "Ready",
@@ -31,7 +32,7 @@ export namespace serverStatus {
 
 	export function initialize() {
 		serverTasks.onDidUpdateServerTask(tasks => {
-			isBusy = tasks.some(task => !task.complete);
+			isBusy = tasks.some(task => !(task.complete));
 			fireEvent();
 		});
 	}

src/serverTaskPresenter.ts

@@ -1,7 +1,7 @@
-import { tasks, Task, TaskScope, Pseudoterminal, CustomExecution, TaskExecution, TaskRevealKind, TaskPanelKind, EventEmitter, Event, TerminalDimensions, window, ProgressLocation, Progress, workspace } from "vscode";
+import { tasks, Task, TaskScope, Pseudoterminal, CustomExecution, TaskExecution, TaskRevealKind, TaskPanelKind, EventEmitter, Event, TerminalDimensions, window, Progress, ProgressLocation, workspace } from "vscode";
 import { serverTasks } from "./serverTasks";
 import { Disposable } from "vscode-languageclient";
-import { ProgressReport } from "./protocol";
+import { ProgressReport, ProgressKind } from "./protocol";
 import { Commands } from "./commands";
 import { getJavaConfiguration } from "./utils";
 
@@ -91,17 +91,11 @@ class ServerTaskTerminal implements Pseudoterminal {
 
 	private printTask(report: ProgressReport) {
 		if (report.complete) {
-			this.onDidWriteEvent.fire(`${report.id.slice(0, 8)} ${report.task} [Done]\r\n`);
+			this.onDidWriteEvent.fire(`${report.token.slice(0, 8)} ${report.value.message} [Done]\r\n`);
 			return;
 		}
 
-		let taskMsg = `${report.id.slice(0, 8)} ${report.task}`;
-		if (report.status) {
-			taskMsg += `: ${report.status}`;
-		}
-		if (report.totalWork && report.workDone >= 0) {
-			taskMsg += ` [${report.workDone}/${report.totalWork}]`;
-		}
+		const taskMsg = `${report.token.slice(0, 8)} ${report.value.message}`;
 
 		this.onDidWriteEvent.fire(`${taskMsg}\r\n`);
 	}
@@ -141,19 +135,16 @@ export class ActivationProgressNotification {
 		} else if (!showBuildStatusEnabled) {
 			return;
 		}
-		const isProgressReportEnabled: boolean = getJavaConfiguration().get("progressReports.enabled");
-		const title = isProgressReportEnabled ? "Opening Java Projects" : "Opening Java Projects...";
+		const title = "Opening Java Projects";
 		window.withProgress({
 			location: ProgressLocation.Notification,
 			title,
 			cancellable: false,
 		}, (progress: Progress<{ message?: string; increment?: number }>) => {
 			return new Promise<void>((resolve) => {
-				if (isProgressReportEnabled) {
-					progress.report({
-						message: `[check details](command:${Commands.SHOW_SERVER_TASK_STATUS})`
-					});
-				}
+				progress.report({
+					message: `[check details](command:${Commands.SHOW_SERVER_TASK_STATUS})`
+				});
 				this.onHide(() => {
 					for (const disposable of this.disposables) {
 						disposable.dispose();

src/serverTasks.ts

@@ -1,5 +1,5 @@
-import { EventEmitter, Progress } from "vscode";
-import { ProgressReport } from "./protocol";
+import { EventEmitter } from "vscode";
+import { ProgressReport, ProgressKind } from "./protocol";
 
 const findIndex = require("lodash.findindex");
 
@@ -56,7 +56,7 @@ function recycleTasks(tasks: ProgressReport[], length: number) {
 }
 
 function applyReport(report: ProgressReport) {
-	const index = findIndex(tasks, task => task.id === report.id);
+	const index = findIndex(tasks, task => task.token === report.token);
 	if (index === -1) {
 		tasks.push(report);
 	} else {

src/settings.ts

@@ -133,7 +133,6 @@ function hasJavaConfigChanged(oldConfig: WorkspaceConfiguration, newConfig: Work
 	return hasConfigKeyChanged('jdt.ls.java.home', oldConfig, newConfig)
 		|| hasConfigKeyChanged('home', oldConfig, newConfig)
 		|| hasConfigKeyChanged('jdt.ls.vmargs', oldConfig, newConfig)
-		|| hasConfigKeyChanged('progressReports.enabled', oldConfig, newConfig)
 		|| hasConfigKeyChanged('server.launchMode', oldConfig, newConfig)
 		|| hasConfigKeyChanged('sharedIndexes.location', oldConfig, newConfig);;
 }

src/standardLanguageClient.ts

@@ -22,7 +22,7 @@ import * as pasteAction from './pasteAction';
 import { registerPasteEventHandler } from './pasteEventHandler';
 import { collectBuildFilePattern, onExtensionChange } from "./plugin";
 import { pomCodeActionMetadata, PomCodeActionProvider } from "./pom/pomCodeActionProvider";
-import { ActionableNotification, BuildProjectParams, BuildProjectRequest, CompileWorkspaceRequest, CompileWorkspaceStatus, EventNotification, EventType, ExecuteClientCommandRequest, FeatureStatus, FindLinks, GradleCompatibilityInfo, LinkLocation, ProgressReportNotification, ServerNotification, SourceAttachmentAttribute, SourceAttachmentRequest, SourceAttachmentResult, SourceInvalidatedEvent, StatusNotification, UpgradeGradleWrapperInfo } from "./protocol";
+import { ActionableNotification, BuildProjectParams, BuildProjectRequest, CompileWorkspaceRequest, CompileWorkspaceStatus, EventNotification, EventType, ExecuteClientCommandRequest, FeatureStatus, FindLinks, GradleCompatibilityInfo, LinkLocation, ProgressKind, ProgressNotification, ServerNotification, SourceAttachmentAttribute, SourceAttachmentRequest, SourceAttachmentResult, SourceInvalidatedEvent, StatusNotification, UpgradeGradleWrapperInfo } from "./protocol";
 import * as refactorAction from './refactorAction';
 import { getJdkUrl, RequirementsData, sortJdksBySource, sortJdksByVersion } from "./requirements";
 import { serverStatus, ServerStatusKind } from "./serverStatus";
@@ -192,7 +192,8 @@ export class StandardLanguageClient {
 			}
 		});
 
-		this.languageClient.onNotification(ProgressReportNotification.type, (progress) => {
+		this.languageClient.onNotification(ProgressNotification.type, (progress) => {
+			progress.complete = progress.value.kind === ProgressKind.end;
 			serverTasks.updateServerTask(progress);
 		});