Add more features to the Java Dashboard

Signed-off-by: Thomas Mäder <t.s.maeder@gmail.com>

Author: tsmaeder

icons/icon24.png

@@ -1752,7 +1752,21 @@
         "command": "java.action.showExtendedOutline",
         "title": "%java.action.showExtendedOutline%",
         "category": "Java"
-      }
+      },
+			{
+				"command": "java.dashboard.refresh",
+				"category": "Java",
+				"title": "Refresh",
+        "icon": "$(refresh)",
+        "when": "java:dashboard == true"
+      },
+      {
+        "command": "java.dashboard.dumpState",
+        "category": "Java",
+        "title": "Dump State",
+        "icon": "$(json)",
+        "when": "java:dashboard == true"
+			}		
     ],
     "keybindings": [
       {
@@ -1928,6 +1942,16 @@
           "command": "java.action.showSubtypeHierarchy",
           "group": "navigation@1",
           "when": "view == references-view.tree && reference-list.hasResult && reference-list.source == javaTypeHierarchy"
+        },
+				{
+					"command": "java.dashboard.refresh",
+					"group": "navigation",
+					"when": "view == java.dashboard"
+				},
+        {
+          "command": "java.dashboard.dumpState",
+          "group": "navigation",
+          "when": "view == java.dashboard"
         }
       ],
       "view/item/context": [
@@ -1938,22 +1962,13 @@
         }
       ]
     },
-    "viewsContainers": {
-      "activitybar": [
-        {
-          "id": "vscode-java-container",
-          "title": "Java",
-          "icon": "icons/icon128.png"
-        }
-      ]
-    },
     "views": {
-      "vscode-java-container": [
+      "explorer": [
         {
           "type": "webview",
-          "id": "vscode-java-dashboard",
-          "name": "Dashboard",
-          "icon": "icons/icons128.png"
+          "id": "java.dashboard",
+          "name": "Java Dashboard",
+          "icon": "icons/java-svgrepo-com.svg"
         }
       ]
     }

icons/java-svgrepo-com.svg

@@ -366,6 +366,10 @@ export namespace Commands {
      */
     export const SHOW_EXTEND_OUTLINE = 'java.action.showExtendedOutline';
 
+	/**
+     * Get diagnostic info command in jdt.ls
+     */
+    export const GET_DIAGNOSTIC_INFO = 'java.getDiagnosticInfo';
 }
 
 /**

package.json

@@ -1,12 +1,57 @@
 import { prepareExecutable } from '../javaServerStarter';
-import { getComputedJavaConfig, getExecutable } from '../extension';
+import { getComputedJavaConfig, getExecutable, getWorkspacePath } from '../extension';
 import * as fs from 'fs';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { getNonce, getUri } from '../webviewUtils';
-import { InitializeMessage, JVM, SettingChangedMessage } from '../webviewProtocol/toDashboard';
-import { isLombokSupportEnabled } from '../lombokSupport';
+import { DashboardState, DiagnosticInfo, JVM, UpdateMessage } from '../webviewProtocol/toDashboard';
+import { isLombokSupportEnabled, Lombok } from '../lombokSupport';
+import { Commands } from '../commands';
+import { apiManager } from '../apiManager';
 
+const currentState: DashboardState = {
+};
+
+export namespace Dashboard {
+	export function initialize(context: vscode.ExtensionContext): void {
+		console.log('registering dashboard webview provider');
+		let webview: vscode.Webview;
+
+		context.subscriptions.push(vscode.window.registerWebviewViewProvider('java.dashboard', {
+			resolveWebviewView: async function (webviewView: vscode.WebviewView, webviewContext: vscode.WebviewViewResolveContext, token: vscode.CancellationToken): Promise<void> {
+				vscode.commands.executeCommand('setContext', 'java:dashboard', true);
+				webview = webviewView.webview;
+				webviewView.webview.options = {
+					enableScripts: true,
+					enableCommandUris: true,
+					localResourceRoots: [context.extensionUri]
+				};
+
+				webviewView.webview.html = await getWebviewContent(webviewView.webview, context);
+				webviewView.onDidDispose(() => {
+					vscode.commands.executeCommand('setContext', 'java:dashboard', false);
+				});
+			}
+		}));
+
+		context.subscriptions.push(vscode.commands.registerCommand('java.dashboard.refresh', async () => {
+			refreshLSInfo(webview);
+		}));
+
+		context.subscriptions.push(vscode.commands.registerCommand('java.dashboard.revealFileInOS', async (arg: { path: string }) => {
+			await vscode.commands.executeCommand('revealFileInOS', vscode.Uri.file(arg.path));
+		}));
+
+		context.subscriptions.push(vscode.commands.registerCommand('java.dashboard.dumpState', async () => {
+			await vscode.workspace.openTextDocument({
+				language: 'json',
+				content: JSON.stringify(currentState, null, 2)
+			});
+		}));
+
+		console.log('registered dashboard webview provider');
+	}
+}
 
 async function getJvms(): Promise<JVM[]> {
 	const config = await getComputedJavaConfig();
@@ -19,10 +64,10 @@ async function getJvms(): Promise<JVM[]> {
 
 }
 
-export function getWebviewContent(webview: vscode.Webview, extensionUri: vscode.Uri) {
+function getWebviewContent(webview: vscode.Webview, context: vscode.ExtensionContext) {
 	setWebviewMessageListener(webview);
 
-	const scriptUri = getUri(webview, extensionUri, [
+	const scriptUri = getUri(webview, context.extensionUri, [
 		"dist",
 		"dashboard.js",
 	]);
@@ -45,30 +90,66 @@ export function getWebviewContent(webview: vscode.Webview, extensionUri: vscode.
   </html>
 `;
 }
+async function refreshLSInfo(webview: vscode.Webview): Promise<void> {
+	try {
+		vscode.commands.executeCommand<DiagnosticInfo>(Commands.EXECUTE_WORKSPACE_COMMAND, Commands.GET_DIAGNOSTIC_INFO).then(info => {
+			currentState.diagnosticInfo = info;
+			const msg: UpdateMessage = {
+				type: "update",
+				diagnosticInfo: info
+			};
+			webview.postMessage(msg);
+		});
+	} catch (e) {
+		console.error('Failed to get diagnostic info', e);
+	}
+}
+
+function setWebviewMessageListener(webview: vscode.Webview) {
 
-function setWebviewMessageListener(webview: vscode.Webview)	 {
 	vscode.workspace.onDidChangeConfiguration(e => {
 		if (e.affectsConfiguration('java.jdt.ls.lombokSupport.enabled')) {
-			const msg: SettingChangedMessage = {
-				type: "settingsChanged",
+			currentState.lombokEnabled = isLombokSupportEnabled();
+			const msg: UpdateMessage = {
+				type: "update",
 				lombokEnabled: isLombokSupportEnabled()
-			}
+			};
 			webview.postMessage(msg);
 		}
+		if (e.affectsConfiguration('java')) {
+			setTimeout(() => refreshLSInfo(webview), 1000); // wait for LS to pick up the config change
+		}
 	});
 
 	webview.onDidReceiveMessage(
 		async (message: any) => {
 			const command = message.command;
 			switch (command) {
-				case "webviewReady":
-					const message: InitializeMessage = {
-						type: "initialize",
-						jvms: await getJvms(),
-						lombokEnabled: isLombokSupportEnabled()
+				case "webviewReady": {
+					await apiManager.getApiInstance().serverReady;
+					currentState.lombokEnabled = isLombokSupportEnabled();
+					currentState.activeLombokPath = Lombok.getActiveLombokPath();
+					currentState.workspacePath = getWorkspacePath();
+					const message: UpdateMessage = {
+						type: "update",
+						lombokEnabled: isLombokSupportEnabled(),
+						activeLombokPath: Lombok.getActiveLombokPath(),
+						workspacePath: getWorkspacePath(),
 					};
 					await webview.postMessage(message);
+					getJvms().then(jvms => {
+						currentState.jvms = jvms;
+						const msg: UpdateMessage = {
+							type: "update",
+							jvms: jvms
+						};
+
+						webview.postMessage(msg);
+					});
+
+					refreshLSInfo(webview);
 					break;
+				}
 			}
 		}
 	);

src/commands.ts

@@ -9,6 +9,7 @@ import * as semver from 'semver';
 import { CodeActionContext, commands, CompletionItem, ConfigurationTarget, Diagnostic, env, EventEmitter, ExtensionContext, extensions,
 	IndentAction, InputBoxOptions, languages, Location, MarkdownString, QuickPickItemKind, Range, RelativePattern,
 	SnippetString, SnippetTextEdit, TextDocument, TextEditorRevealType, UIKind, Uri, version, ViewColumn,
+	Webview,
 	WebviewView, WebviewViewResolveContext, window, workspace, WorkspaceConfiguration, WorkspaceEdit } from 'vscode';
 import { CancellationToken, CodeActionParams, CodeActionRequest, CodeActionResolveRequest, Command, CompletionRequest, DidChangeConfigurationNotification, ExecuteCommandParams, ExecuteCommandRequest, LanguageClientOptions, RevealOutputChannelOn } from 'vscode-languageclient';
 import { Executable, LanguageClient } from 'vscode-languageclient/node';
@@ -43,7 +44,7 @@ import { pasteFile } from './pasteAction';
 import { ServerStatusKind } from './serverStatus';
 import { TelemetryService } from '@redhat-developer/vscode-redhat-telemetry/lib/node';
 import { Deferred } from './promiseUtil';
-import { getWebviewContent } from './dashboard/dashboard';
+import { Dashboard } from './dashboard/dashboard';
 
 const syntaxClient: SyntaxLanguageClient = new SyntaxLanguageClient();
 const standardClient: StandardLanguageClient = new StandardLanguageClient();
@@ -129,20 +130,11 @@ export function fixJdtLinksInDocumentation(oldDocumentation: MarkdownString): Ma
 }
 
 export async function activate(context: ExtensionContext): Promise<ExtensionAPI> {
-	console.log('registering webview provider');
-	context.subscriptions.push(window.registerWebviewViewProvider('vscode-java-dashboard', {
-		resolveWebviewView: async function (webviewView: WebviewView, webviewContext: WebviewViewResolveContext, token: CancellationToken): Promise<void> {
-
-			webviewView.webview.options = {
-						enableScripts: true,
-						enableCommandUris: true,
-						localResourceRoots: [context.extensionUri]
-					};
-
-			webviewView.webview.html = await getWebviewContent(webviewView.webview, context.extensionUri);
-		}
-	}));
-	console.log('registered webview provider');
+	storagePath = context.storagePath;
+	if (!storagePath) {
+		storagePath = getTempWorkspace();
+	}
+	Dashboard.initialize(context);
 
 	await loadSupportedJreNames(context);
 	context.subscriptions.push(commands.registerCommand(Commands.FILESEXPLORER_ONPASTE, async () => {
@@ -161,16 +153,13 @@ export async function activate(context: ExtensionContext): Promise<ExtensionAPI>
 		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `_java.notCoveredExecution.md`)), 'Not Covered Maven Plugin Execution', "", context);
 	}));
 
-	storagePath = context.storagePath;
 	context.subscriptions.push(commands.registerCommand(Commands.METADATA_FILES_GENERATION, async () => {
 		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `_java.metadataFilesGeneration.md`)), 'Metadata Files Generation', "", context);
 	}));
 	context.subscriptions.push(commands.registerCommand(Commands.LEARN_MORE_ABOUT_CLEAN_UPS, async () => {
 		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `${Commands.LEARN_MORE_ABOUT_CLEAN_UPS}.md`)), 'Java Clean Ups', "java-clean-ups", context);
 	}));
-	if (!storagePath) {
-		storagePath = getTempWorkspace();
-	}
+
 	const workspacePath = path.resolve(`${storagePath}/jdt_ws`);
 	clientLogFile = path.join(storagePath, 'client.log');
 	const cleanWorkspaceExists = fs.existsSync(path.join(workspacePath, cleanWorkspaceFileName));
@@ -894,18 +883,22 @@ async function cleanSharedIndexes(context: ExtensionContext) {
 }
 
 function openServerLogFile(storagePath, column: ViewColumn = ViewColumn.Active): Thenable<boolean> {
-	const workspacePath = getWorkspacePath(storagePath);
+	const workspacePath = computeWorkspacePath(storagePath);
 	const serverLogFile = path.join(workspacePath, '.metadata', '.log');
 	return openLogFile(serverLogFile, 'Could not open Java Language Server log file', column);
 }
 
-function getWorkspacePath(storagePath: any) {
+function computeWorkspacePath(storagePath: any) {
 	return path.join(storagePath, apiManager.getApiInstance().serverMode === ServerMode.lightWeight ? 'ss_ws' : 'jdt_ws');
 }
 
+export function getWorkspacePath() {
+	return computeWorkspacePath(storagePath);
+}
+
 function openRollingServerLogFile(storagePath, filename, column: ViewColumn = ViewColumn.Active): Thenable<boolean> {
 	return new Promise((resolve) => {
-		const workspacePath = getWorkspacePath(storagePath);
+		const workspacePath = computeWorkspacePath(storagePath);
 		const dirname = path.join(workspacePath, '.metadata');
 
 		// find out the newest one

src/dashboard/dashboard.ts

@@ -30,6 +30,12 @@ let isLombokCommandInitialized: boolean = false;
 let isExtensionLombok: boolean = false;		// whether use extension's Lombok or not
 let projectLombokPath: string = undefined;	// the project's Lombok classpath
 
+export namespace Lombok {
+
+	export function getActiveLombokPath(): string | undefined {
+		return activeLombokPath;
+	}
+}
 export function isLombokSupportEnabled(): boolean {
 	return vscode.workspace.getConfiguration().get("java.jdt.ls.lombokSupport.enabled");
 }