Explicitly show import progress (#2022)

* Reuse 'java.showBuildStatusOnStart.enabled' to control the appearance of the progress notification

Signed-off-by: Sheng Chen <sheche@microsoft.com>

Author: jdneo

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Change Log
 
 ## 0.81.0
+* enhancement - Show job status via progress notification on start. See [#2022](https://github.com/redhat-developer/vscode-java/pull/2022)
 * other - Change the default value of the setting `java.project.importOnFirstTimeStartup` to `automatic`. See [#2016](https://github.com/redhat-developer/vscode-java/pull/2016)
 
 ## 0.80.0 (June 30th, 2021)

README.md

@@ -156,7 +156,11 @@ The following settings are supported:
 * `java.codeGeneration.toString.listArrayContents`: List contents of arrays instead of using native toString(). Defaults to `true`.
 * `java.codeGeneration.toString.limitElements`: Limit number of items in arrays/collections/maps to list, if 0 then list all. Defaults to `0`.
 * `java.selectionRange.enabled`: Enable/disable Smart Selection support for Java. Disabling this option will not affect the VS Code built-in word-based and bracket-based smart selection.
-* `java.showBuildStatusOnStart.enabled`: Automatically show build status on startup. Defaults to `false`.
+* `java.showBuildStatusOnStart.enabled`: Automatically show build status on startup, defaults to `notification`.
+  - `notification`: Show the build status via progress notification.
+  - `terminal`: Show the build status via terminal.
+  - `off`: Do not show any build status.
+  > For backward compatibility, this setting also accepts boolean value, where `true` has the same meaning as `notification` and `false` has the same meaning as `off`.
 * `java.project.outputPath`: A relative path to the workspace where stores the compiled output. `Only` effective in the `WORKSPACE` scope. The setting will `NOT` affect Maven or Gradle project.
 * `java.project.referencedLibraries`: Configure glob patterns for referencing local libraries to a Java project.
 * `java.completion.maxResults`: Maximum number of completion results (not including snippets). `0` (the default value) disables the limit, all results are returned. In case of performance problems, consider setting a sensible limit..

package.json

@@ -605,9 +605,23 @@
           "scope": "window"
         },
         "java.showBuildStatusOnStart.enabled": {
-          "type": "boolean",
+          "anyOf": [
+            {
+              "enum": [
+                "notification",
+                "terminal",
+                "off"
+              ],
+              "enumDescriptions": [
+                "Show the build status via progress notification on start",
+                "Show the build status via terminal on start",
+                "Do not show any build status on start"
+              ]
+            },
+            "boolean"
+          ],
           "description": "Automatically show build status on startup.",
-          "default": false,
+          "default": "notification",
           "scope": "window"
         },
         "java.configuration.runtimes": {

src/serverTaskPresenter.ts

@@ -1,19 +1,21 @@
-import { tasks, Task, TaskScope, Pseudoterminal, CustomExecution, TaskExecution, TaskRevealKind, TaskPanelKind, EventEmitter, Event, TerminalDimensions } from "vscode";
-import * as vscode from "vscode";
+import { tasks, Task, TaskScope, Pseudoterminal, CustomExecution, TaskExecution, TaskRevealKind, TaskPanelKind, EventEmitter, Event, TerminalDimensions, window, ProgressLocation, Progress } from "vscode";
 import { serverTasks } from "./serverTasks";
 import { Disposable } from "vscode-languageclient";
 import { ProgressReport } from "./protocol";
+import { Commands } from "./commands";
+import { getJavaConfiguration } from "./utils";
 
 const JAVA_SERVER_TASK_PRESENTER_TASK_NAME = "Java Build Status";
 
 export namespace serverTaskPresenter {
 	export async function presentServerTaskView() {
 		const execution = await getPresenterTaskExecution();
-		const terminals = vscode.window.terminals;
+		const terminals = window.terminals;
 		const presenterTerminals = terminals.filter(terminal => terminal.name.indexOf(execution.task.name) >= 0);
 		if (presenterTerminals.length > 0) {
 			presenterTerminals[0].show();
 		}
+		activationProgressNotification.hide();
 	}
 }
 
@@ -57,7 +59,7 @@ async function killExistingExecutions() {
 	execs.forEach(exec => exec.terminate());
 	await new Promise(resolve => setTimeout(resolve, 0));
 
-	let terminals = vscode.window.terminals;
+	let terminals = window.terminals;
 	terminals = terminals.filter(terminal => terminal.name.indexOf(JAVA_SERVER_TASK_PRESENTER_TASK_NAME) >= 0);
 	terminals.forEach(terminal => terminal.dispose());
 	await new Promise(resolve => setTimeout(resolve, 0));
@@ -112,3 +114,48 @@ class ServerTaskTerminal implements Pseudoterminal {
 		serverTasks.suggestTaskEntrySize(dimensions.rows - 1);
 	}
 }
+
+export class ActivationProgressNotification {
+	private hideEmitter = new EventEmitter<void>();
+	private onHide = this.hideEmitter.event;
+	private disposables: Disposable[] = [];
+	private lastJobId: string;
+
+	public showProgress() {
+		const showBuildStatusEnabled = getJavaConfiguration().get("showBuildStatusOnStart.enabled");
+		if (typeof showBuildStatusEnabled === "string" || showBuildStatusEnabled instanceof String) {
+			if (showBuildStatusEnabled !== "notification") {
+				return;
+			}
+		} else if (!showBuildStatusEnabled) {
+			return;
+		}
+		const isProgressReportEnabled: boolean = getJavaConfiguration().get("progressReports.enabled");
+		const title = isProgressReportEnabled ? "Opening Java Projects" : "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})`
+					});
+				}
+				this.onHide(() => {
+					for (const disposable of this.disposables) {
+						disposable.dispose();
+					}
+					return resolve();
+				});
+			});
+		});
+	}
+
+	public hide() {
+		this.hideEmitter.fire();
+	}
+}
+
+export const activationProgressNotification = new ActivationProgressNotification();

src/standardLanguageClient.ts

@@ -10,7 +10,7 @@ import { LanguageClient, StreamInfo } from "vscode-languageclient/node";
 import { CompileWorkspaceRequest, CompileWorkspaceStatus, SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute, ProjectConfigurationUpdateRequest, FeatureStatus, StatusNotification, ProgressReportNotification, ActionableNotification, ExecuteClientCommandRequest, ServerNotification, EventNotification, EventType, LinkLocation, FindLinks } from "./protocol";
 import { setGradleWrapperChecksum, excludeProjectSettingsFiles, ServerMode } from "./settings";
 import { onExtensionChange, collectBuildFilePattern } from "./plugin";
-import { serverTaskPresenter } from "./serverTaskPresenter";
+import { activationProgressNotification, serverTaskPresenter } from "./serverTaskPresenter";
 import { RequirementsData } from "./requirements";
 import * as net from 'net';
 import * as path from 'path';
@@ -45,7 +45,7 @@ export class StandardLanguageClient {
 			return;
 		}
 
-		if (workspace.getConfiguration().get("java.showBuildStatusOnStart.enabled")) {
+		if (workspace.getConfiguration().get("java.showBuildStatusOnStart.enabled") === "terminal") {
 			commands.executeCommand(Commands.SHOW_SERVER_TASK_STATUS);
 		}
 
@@ -90,11 +90,14 @@ export class StandardLanguageClient {
 		this.languageClient.registerProposedFeatures();
 
 		this.languageClient.onReady().then(() => {
+			activationProgressNotification.showProgress();
 			this.languageClient.onNotification(StatusNotification.type, (report) => {
 				switch (report.type) {
 					case 'ServiceReady':
 						apiManager.updateServerMode(ServerMode.STANDARD);
 						apiManager.fireDidServerModeChange(ServerMode.STANDARD);
+						activationProgressNotification.hide();
+						showImportFinishNotification(context);
 						break;
 					case 'Started':
 						this.status = ClientStatus.Started;
@@ -443,6 +446,23 @@ export class StandardLanguageClient {
 	}
 }
 
+function showImportFinishNotification(context: ExtensionContext) {
+	const showNotification: boolean | undefined = context.globalState.get<boolean>("java.neverShowImportFinishNotification");
+	if (!showNotification) {
+		const options = ["Don't show again"];
+		if (extensions.getExtension("vscjava.vscode-java-dependency")) {
+			options.unshift("View projects");
+		}
+		window.showInformationMessage("Projects are imported into workspace.", ...options).then((choice) => {
+			if (choice === "Don't show again") {
+				context.globalState.update("java.neverShowImportFinishNotification", true);
+			} else if (choice === "View projects") {
+				commands.executeCommand("javaProjectExplorer.focus");
+			}
+		});
+	}
+}
+
 function logNotification(message: string) {
 	return new Promise(() => {
 		logger.verbose(message);