Added restart Java language server command.

- Show progress for restarting the language server

Signed-off-by: AlexXuChen <[email protected]>
Co-authored-by: Roland Grunberg <[email protected]>
Co-authored-by: Jessica He <[email protected]>

Author: 3 people

README.md

@@ -108,6 +108,7 @@ The following commands are available:
 - `Java: List All Java Source Paths`: lists all the Java source paths recognized by the Java Language Server workspace.
 - `Java: Show Build Job Status`: shows the Java Language Server job status in Visual Studio Code terminal.
 - `Java: Go to Super Implementation`: goes to the super implementation for the current selected symbol in editor.
+- `Java: Restart Java Language Server`: restarts the Java language server.
 
 Supported VS Code settings
 ==========================

package.json

@@ -1250,6 +1250,11 @@
         "command": "java.clean.sharedIndexes",
         "title": "%java.clean.sharedIndexes%",
         "category": "Java"
+      },
+      {
+        "command": "java.server.restart",
+        "title": "%java.server.restart%",
+        "category": "Java"
       }
     ],
     "keybindings": [
@@ -1381,6 +1386,10 @@
         {
           "command": "java.server.mode.switch",
           "when": "java:serverMode == LightWeight"
+        },
+        {
+          "command": "java.server.restart",
+          "when": "javaLSReady"
         }
       ],
       "view/title": [

package.nls.json

@@ -23,5 +23,6 @@
 	"java.action.showSubtypeHierarchy": "Show Subtype Hierarchy",
 	"java.action.changeBaseType": "Base on this Type",
 	"java.project.createModuleInfo.command": "Create module-info.java",
-	"java.clean.sharedIndexes": "Clean Shared Indexes"
+	"java.clean.sharedIndexes": "Clean Shared Indexes",
+	"java.server.restart": "Restart Java Language Server"
 }

src/commands.ts

@@ -274,6 +274,10 @@ export namespace Commands {
      * Command to switch between standard mode and lightweight mode.
      */
     export const SWITCH_SERVER_MODE = 'java.server.mode.switch';
+	/**
+     * Command to restart the language server.
+     */
+	export const RESTART_LANGUAGE_SERVER = 'java.server.restart';
 
     export const LEARN_MORE_ABOUT_REFACTORING = '_java.learnMoreAboutRefactorings';
 

src/extension.ts

@@ -5,7 +5,7 @@ import * as fs from 'fs';
 import * as fse from 'fs-extra';
 import * as os from 'os';
 import * as path from 'path';
-import { CodeActionContext, commands, ConfigurationTarget, Diagnostic, env, EventEmitter, ExtensionContext, extensions, IndentAction, InputBoxOptions, languages, RelativePattern, TextDocument, UIKind, Uri, ViewColumn, window, workspace, WorkspaceConfiguration } from 'vscode';
+import { CodeActionContext, commands, ConfigurationTarget, Diagnostic, env, EventEmitter, ExtensionContext, extensions, IndentAction, InputBoxOptions, languages, RelativePattern, TextDocument, UIKind, Uri, ViewColumn, window, workspace, WorkspaceConfiguration, ProgressLocation } from 'vscode';
 import { CancellationToken, CodeActionParams, CodeActionRequest, Command, DidChangeConfigurationNotification, ExecuteCommandParams, ExecuteCommandRequest, LanguageClientOptions, RevealOutputChannelOn } from 'vscode-languageclient';
 import { LanguageClient } from 'vscode-languageclient/node';
 import { apiManager } from './apiManager';
@@ -329,6 +329,8 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 
 			context.subscriptions.push(onConfigurationChange(workspacePath, context));
 
+			registerRestartJavaLanguageServerCommand(context);
+
 			/**
 			 * Command to switch the server mode. Currently it only supports switch from lightweight to standard.
 			 * @param force force to switch server mode without asking
@@ -965,3 +967,24 @@ function registerOutOfMemoryDetection(storagePath: string) {
 		showOOMMessage();
 	});
 }
+
+function registerRestartJavaLanguageServerCommand(context: ExtensionContext) {
+	context.subscriptions.push(commands.registerCommand(Commands.RESTART_LANGUAGE_SERVER, async () => {
+		switch (getJavaServerMode()) {
+			case (ServerMode.standard):
+				// Standard server restart
+				await standardClient.getClient().restart();
+				break;
+			case (ServerMode.lightWeight):
+				// Syntax server restart
+				await syntaxClient.getClient().restart();
+				break;
+			case (ServerMode.hybrid):
+				if (syntaxClient.isAlive()) {
+					await syntaxClient.getClient().restart();
+				}
+				await standardClient.getClient().restart();
+				break;
+		}
+	}));
+}

src/javaServerStarter.ts

@@ -14,7 +14,7 @@ import { deleteDirectory, ensureExists, getJavaConfiguration, getTimestamp } fro
 
 // eslint-disable-next-line no-var
 declare var v8debug;
-const DEBUG = (typeof v8debug === 'object') || startedInDebugMode();
+export const DEBUG = (typeof v8debug === 'object') || startedInDebugMode();
 
 /**
  * Argument that tells the program where to generate the heap dump that is created when an OutOfMemoryError is raised and `HEAP_DUMP` has been passed

src/standardLanguageClient.ts

@@ -14,7 +14,7 @@ import { Commands } from "./commands";
 import { ClientStatus } from "./extension.api";
 import * as fileEventHandler from './fileEventHandler';
 import { gradleCodeActionMetadata, GradleCodeActionProvider } from "./gradle/gradleCodeActionProvider";
-import { awaitServerConnection, prepareExecutable } from "./javaServerStarter";
+import { awaitServerConnection, prepareExecutable, DEBUG } from "./javaServerStarter";
 import { logger } from "./log";
 import { checkLombokDependency } from "./lombokSupport";
 import { markdownPreviewProvider } from "./markdownPreviewProvider";
@@ -106,7 +106,7 @@ export class StandardLanguageClient {
 		}
 
 		// Create the language client and start the client.
-		this.languageClient = new TracingLanguageClient('java', extensionName, serverOptions, clientOptions);
+		this.languageClient = new TracingLanguageClient('java', extensionName, serverOptions, clientOptions, DEBUG);
 
 		this.registerCommandsForStandardServer(context, jdtEventEmitter);
 		fileEventHandler.registerFileEventHandlers(this.languageClient, context);

src/syntaxLanguageClient.ts

@@ -13,6 +13,7 @@ import { RequirementsData } from "./requirements";
 import { ServerMode } from "./settings";
 import { snippetCompletionProvider } from "./snippetCompletionProvider";
 import { getJavaConfig } from "./utils";
+import { DEBUG } from "./javaServerStarter";
 
 const extensionName = "Language Support for Java (Syntax Server)";
 
@@ -55,7 +56,7 @@ export class SyntaxLanguageClient {
 		}
 
 		if (serverOptions) {
-			this.languageClient = new LanguageClient('java', extensionName, serverOptions, newClientOptions);
+			this.languageClient = new LanguageClient('java', extensionName, serverOptions, newClientOptions, DEBUG);
 		}
 
 		this.status = ClientStatus.initialized;

test/lightweight-mode-suite/extension.test.ts

@@ -24,6 +24,7 @@ suite('Java Language Extension - LightWeight', () => {
 				Commands.SWITCH_SERVER_MODE,
 				Commands.OPEN_FILE,
 				Commands.CLEAN_SHARED_INDEXES,
+				Commands.RESTART_LANGUAGE_SERVER,
 			].sort();
 			const foundJavaCommands = commands.filter((value) => {
 				return JAVA_COMMANDS.indexOf(value)>=0 || value.startsWith('java.');

test/standard-mode-suite/extension.test.ts

@@ -96,6 +96,7 @@ suite('Java Language Extension - Standard', () => {
 				Commands.RESOLVE_TYPE_HIERARCHY,
 				Commands.RESOLVE_WORKSPACE_SYMBOL,
 				Commands.RUNTIME_VALIDATION_OPEN,
+				Commands.RESTART_LANGUAGE_SERVER,
 				Commands.SHOW_JAVA_IMPLEMENTATIONS,
 				Commands.SHOW_JAVA_REFERENCES,
 				Commands.SHOW_SERVER_TASK_STATUS,