Add a setting 'java.jdt.ls.java.home' to manually set up a JDK to start JLS (#2284)

* Add a setting 'java.jdt.ls.java.home' to manually set up a JDK to start JLS

Signed-off-by: Jinbo Wang <[email protected]>

Author: testforstephen

README.md

@@ -12,7 +12,7 @@ Quick Start
 ============
 1. Install the Extension
 2. If you do not have a _Java_ Development Kit correctly [set](#setting-the-jdk)
-    * Download and install a Java Development Kit for your project (Java 1.5 or above is supported)   
+    * Download and install a Java Development Kit for your project (Java 1.5 or above is supported)
 3. Extension is activated when you first access a Java file
     * Recognizes projects with *Maven* or *Gradle* build files in the directory hierarchy.
 
@@ -60,7 +60,7 @@ The following part is only kept for the universal version without embedded JRE.
 
 >The tooling JDK will be used to launch the Language Server for Java. And by default, will also be used to compile your projects.\
 \
-The path to the Java Development Kit can be specified by the `java.home` setting in VS Code settings (workspace/user settings). If not specified, it is searched in the following order until a JDK meets current minimum requirement.
+The path to the Java Development Kit can be specified by the `java.jdt.ls.java.home` setting in VS Code settings (workspace/user settings). If not specified, it is searched in the following order until a JDK meets current minimum requirement.
 >- the `JDK_HOME` environment variable
 >- the `JAVA_HOME` environment variable
 >- on the current system path
@@ -110,7 +110,7 @@ Supported VS Code settings
 ==========================
 The following settings are supported:
 
-* `java.home` : **Deprecated, only used for universal version without embedded JRE.** Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart.
+* `java.home` : **Deprecated, please use 'java.jdt.ls.java.home' instead.** Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart.
 * `java.jdt.ls.vmargs` : Extra VM arguments used to launch the Java Language Server. Requires VS Code restart.
 * `java.errors.incompleteClasspath.severity` : Specifies the severity of the message when the classpath is incomplete for a Java file. Supported values are `ignore`, `info`, `warning`, `error`.
 * `java.trace.server` : Traces the communication between VS Code and the Java language server.
@@ -196,12 +196,12 @@ The following settings are supported:
   - `lastMember`: Insert the generated code as the last member of the target type.
 * `java.settings.url` : Specifies the url or file path to the workspace Java settings. See [Setting Global Preferences](https://github.com/redhat-developer/vscode-java/wiki/Settings-Global-Preferences)
 * `java.symbols.includeSourceMethodDeclarations` : Include method declarations from source files in symbol search. Defaults to `false`.
-
-New in 1.1.0:
  * `java.quickfix.showAt` : Show quickfixes at the problem or line level.
  * `java.configuration.workspaceCacheLimit` : The number of days (if enabled) to keep unused workspace cache data. Beyond this limit, cached workspace data may be removed.
  * `java.import.generatesMetadataFilesAtProjectRoot` : Specify whether the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated at the project root. Defaults to `false`.
 
+New in 1.3.0:
+* `java.jdt.ls.java.home`: Absolute path to JDK home folder used to launch the Java Language Server. This setting will replace the Java extension's embedded JRE to start the Java Language Server. Requires VS Code restart.
 
 Semantic Highlighting
 ===============

package.json

@@ -14,6 +14,7 @@
     "untrustedWorkspaces": {
       "supported": "limited",
       "restrictedConfigurations": [
+        "java.jdt.ls.java.home",
         "java.home",
         "java.jdt.ls.vmargs"
       ]
@@ -171,7 +172,16 @@
           "default": null,
           "description": "Specifies the folder path to the JDK (11 or more recent) used to launch the Java Language Server.\nOn Windows, backslashes must be escaped, i.e.\n\"java.home\":\"C:\\\\Program Files\\\\Java\\\\jdk11.0_8\"",
           "scope": "machine-overridable",
-          "deprecationMessage": "This setting will be deprecated, please use the environment variable 'JAVA_HOME' instead."
+          "deprecationMessage": "This setting is deprecated, please use 'java.jdt.ls.java.home' instead."
+        },
+        "java.jdt.ls.java.home": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null,
+          "description": "Specifies the folder path to the JDK (11 or more recent) used to launch the Java Language Server. This setting will replace the Java extension's embedded JRE to start the Java Language Server. \n\nOn Windows, backslashes must be escaped, i.e.\n\"java.jdt.ls.java.home\":\"C:\\\\Program Files\\\\Java\\\\jdk11.0_8\"",
+          "scope": "machine-overridable"
         },
         "java.jdt.ls.vmargs": {
           "type": [

src/requirements.ts

@@ -34,11 +34,12 @@ export async function resolveRequirements(context: ExtensionContext): Promise<Re
     let toolingJre: string = await findEmbeddedJRE(context);
     let toolingJreVersion: number = await getMajorVersion(toolingJre);
     return new Promise(async (resolve, reject) => {
-        let source: string;
+        const javaPreferences = await checkJavaPreferences(context);
+        const preferenceName = javaPreferences.preference;
+        let javaHome = javaPreferences.javaHome;
         let javaVersion: number = 0;
-        let javaHome = await checkJavaPreferences(context);
-        if (!toolingJre && javaHome) { // "java.home" setting is only used for the universal version.
-            source = `java.home variable defined in ${env.appName} settings`;
+        if (javaHome) {
+            const source = `${preferenceName} variable defined in ${env.appName} settings`;
             javaHome = expandHomeDir(javaHome);
             if (!await fse.pathExists(javaHome)) {
                 invalidJavaHome(reject, `The ${source} points to a missing or inaccessible folder (${javaHome})`);
@@ -52,51 +53,49 @@ export async function resolveRequirements(context: ExtensionContext): Promise<Re
                 invalidJavaHome(reject, msg);
             }
             javaVersion = await getMajorVersion(javaHome);
-            toolingJre = javaHome;
-            toolingJreVersion = javaVersion;
-        } else {
-            // java.home not specified, search valid JDKs from env.JAVA_HOME, env.PATH, SDKMAN, jEnv, jabba, Common directories
-            const javaRuntimes = await findRuntimes({checkJavac: true, withVersion: true, withTags: true});
-            if (!toolingJre) { // universal version
-                // as latest version as possible.
-                sortJdksByVersion(javaRuntimes);
-                const validJdks = javaRuntimes.filter(r => r.version.major >= REQUIRED_JDK_VERSION);
-                if (validJdks.length > 0) {
-                    sortJdksBySource(validJdks);
-                    javaHome = validJdks[0].homedir;
-                    javaVersion = validJdks[0].version.major;
-                    toolingJre = javaHome;
-                    toolingJreVersion = javaVersion;
-                }
-            } else { // pick a default project JDK/JRE
-                /**
-                 * For legacy users, we implicitly following the order below to
-                 * set a default project JDK during initialization:
-                 * java.home > env.JDK_HOME > env.JAVA_HOME > env.PATH
-                 *
-                 * We'll keep it for compatibility.
-                 */
-                if (javaHome && (await getRuntime(javaHome) !== undefined)) {
-                    const runtime = await getRuntime(javaHome, {withVersion: true});
-                    javaHome = runtime.homedir;
-                    javaVersion = runtime.version?.major;
-                    logger.info("Use the JDK from 'java.home' setting as the initial default project JDK.");
-                } else if (javaRuntimes.length) {
-                    sortJdksBySource(javaRuntimes);
-                    javaHome = javaRuntimes[0].homedir;
-                    javaVersion = javaRuntimes[0].version?.major;
-                    logger.info(`Use the JDK from '${getSources(javaRuntimes[0])}' as the initial default project JDK.`);
-                } else if (javaHome = await findDefaultRuntimeFromSettings()) {
-                    javaVersion = await getMajorVersion(javaHome);
-                    logger.info("Use the JDK from 'java.configuration.runtimes' as the initial default project JDK.");
-                } else {
-                    openJDKDownload(reject, "Please download and install a JDK to compile your project. You can configure your projects with different JDKs by the setting ['java.configuration.runtimes'](https://github.com/redhat-developer/vscode-java/wiki/JDK-Requirements#java.configuration.runtimes)");
-                }
+            if (preferenceName === "java.jdt.ls.java.home" || !toolingJre) {
+                toolingJre = javaHome;
+                toolingJreVersion = javaVersion;
+            }
+        }
+
+        // search valid JDKs from env.JAVA_HOME, env.PATH, SDKMAN, jEnv, jabba, Common directories
+        const javaRuntimes = await findRuntimes({ checkJavac: true, withVersion: true, withTags: true });
+        if (!toolingJre) { // universal version
+            // as latest version as possible.
+            sortJdksByVersion(javaRuntimes);
+            const validJdks = javaRuntimes.filter(r => r.version.major >= REQUIRED_JDK_VERSION);
+            if (validJdks.length > 0) {
+                sortJdksBySource(validJdks);
+                javaHome = validJdks[0].homedir;
+                javaVersion = validJdks[0].version.major;
+                toolingJre = javaHome;
+                toolingJreVersion = javaVersion;
+            }
+        } else { // pick a default project JDK/JRE
+            /**
+             * For legacy users, we implicitly following the order below to
+             * set a default project JDK during initialization:
+             * java.jdt.ls.java.home > java.home > env.JDK_HOME > env.JAVA_HOME > env.PATH
+             *
+             * We'll keep it for compatibility.
+             */
+            if (javaHome) {
+                logger.info("Use the JDK from 'java.home' setting as the initial default project JDK.");
+            } else if (javaRuntimes.length) {
+                sortJdksBySource(javaRuntimes);
+                javaHome = javaRuntimes[0].homedir;
+                javaVersion = javaRuntimes[0].version?.major;
+                logger.info(`Use the JDK from '${getSources(javaRuntimes[0])}' as the initial default project JDK.`);
+            } else if (javaHome = await findDefaultRuntimeFromSettings()) {
+                javaVersion = await getMajorVersion(javaHome);
+                logger.info("Use the JDK from 'java.configuration.runtimes' as the initial default project JDK.");
+            } else {
+                openJDKDownload(reject, "Please download and install a JDK to compile your project. You can configure your projects with different JDKs by the setting ['java.configuration.runtimes'](https://github.com/redhat-developer/vscode-java/wiki/JDK-Requirements#java.configuration.runtimes)");
             }
         }
 
         if (!toolingJre || toolingJreVersion < REQUIRED_JDK_VERSION) {
-            // For universal version, we still require users to install a qualified JDK to run Java extension.
             openJDKDownload(reject, `Java ${REQUIRED_JDK_VERSION} or more recent is required to run the Java extension. Please download and install a recent JDK. You can still compile your projects with older JDKs by configuring ['java.configuration.runtimes'](https://github.com/redhat-developer/vscode-java/wiki/JDK-Requirements#java.configuration.runtimes)`);
         }
 

src/settings.ts

@@ -8,7 +8,8 @@ import { cleanWorkspaceFileName } from './extension';
 import { ensureExists, getJavaConfiguration } from './utils';
 
 const DEFAULT_HIDDEN_FILES: string[] = ['**/.classpath', '**/.project', '**/.settings', '**/.factorypath'];
-export const IS_WORKSPACE_JDK_ALLOWED = "java.ls.isJdkAllowed";
+const IS_WORKSPACE_JDK_ALLOWED = "java.ls.isJdkAllowed";
+const IS_WORKSPACE_JLS_JDK_ALLOWED = "java.jdt.ls.java.home.isAllowed";
 export const IS_WORKSPACE_VMARGS_ALLOWED = "java.ls.isVmargsAllowed";
 const extensionName = 'Language Support for Java';
 export const ACTIVE_BUILD_TOOL_STATE = "java.activeBuildTool";
@@ -102,7 +103,8 @@ function excludeProjectSettingsFilesForWorkspace(workspaceUri: Uri) {
 }
 
 function hasJavaConfigChanged(oldConfig: WorkspaceConfiguration, newConfig: WorkspaceConfiguration) {
-	return hasConfigKeyChanged('home', oldConfig, newConfig)
+	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);
@@ -125,30 +127,63 @@ export function getJavaEncoding(): string {
 	return javaEncoding;
 }
 
-export async function checkJavaPreferences(context: ExtensionContext) {
+export async function checkJavaPreferences(context: ExtensionContext): Promise<{javaHome?: string, preference: string}> {
 	const allow = 'Allow';
 	const disallow = 'Disallow';
-	let javaHome = workspace.getConfiguration().inspect<string>('java.home').workspaceValue;
+	let preference: string = 'java.jdt.ls.java.home';
+	let javaHome = workspace.getConfiguration().inspect<string>('java.jdt.ls.java.home').workspaceValue;
 	let isVerified = javaHome === undefined || javaHome === null;
 	if (isVerified) {
-		javaHome = getJavaConfiguration().get('home');
+		javaHome = getJavaConfiguration().get('jdt.ls.java.home');
 	}
-	const key = getKey(IS_WORKSPACE_JDK_ALLOWED, context.storagePath, javaHome);
+	const key = getKey(IS_WORKSPACE_JLS_JDK_ALLOWED, context.storagePath, javaHome);
 	const globalState = context.globalState;
 	if (!isVerified) {
 		isVerified = globalState.get(key);
 		if (isVerified === undefined) {
-			await window.showErrorMessage(`Security Warning! Do you allow this workspace to set the java.home variable? \n java.home: ${javaHome}`, disallow, allow).then(async selection => {
+			await window.showErrorMessage(`Security Warning! Do you allow this workspace to set the java.jdt.ls.java.home variable? \n java.jdt.ls.java.home: ${javaHome}`, disallow, allow).then(async selection => {
 				if (selection === allow) {
 					globalState.update(key, true);
 				} else if (selection === disallow) {
 					globalState.update(key, false);
-					await workspace.getConfiguration().update('java.home', undefined, ConfigurationTarget.Workspace);
+					await workspace.getConfiguration().update('java.jdt.ls.java.home', undefined, ConfigurationTarget.Workspace);
 				}
 			});
 			isVerified = globalState.get(key);
 		}
+		if (!isVerified) { // java.jdt.ls.java.home from workspace settings is disallowed.
+			javaHome = workspace.getConfiguration().inspect<string>('java.jdt.ls.java.home').globalValue;
+		}
+	}
+
+	if (!javaHome) { // Read java.home from the deprecated "java.home" setting.
+		preference = 'java.home';
+		javaHome = workspace.getConfiguration().inspect<string>('java.home').workspaceValue;
+		isVerified = javaHome === undefined || javaHome === null;
+		if (isVerified) {
+			javaHome = getJavaConfiguration().get('home');
+		}
+		const key = getKey(IS_WORKSPACE_JDK_ALLOWED, context.storagePath, javaHome);
+		const globalState = context.globalState;
+		if (!isVerified) {
+			isVerified = globalState.get(key);
+			if (isVerified === undefined) {
+				await window.showErrorMessage(`Security Warning! Do you allow this workspace to set the java.home variable? \n java.home: ${javaHome}`, disallow, allow).then(async selection => {
+					if (selection === allow) {
+						globalState.update(key, true);
+					} else if (selection === disallow) {
+						globalState.update(key, false);
+						await workspace.getConfiguration().update('java.home', undefined, ConfigurationTarget.Workspace);
+					}
+				});
+				isVerified = globalState.get(key);
+			}
+			if (!isVerified) { // java.home from workspace settings is disallowed.
+				javaHome = workspace.getConfiguration().inspect<string>('java.home').globalValue;
+			}
+		}
 	}
+
 	const vmargs = workspace.getConfiguration().inspect('java.jdt.ls.vmargs').workspaceValue;
 	if (vmargs !== undefined) {
 		const isWorkspaceTrusted = (workspace as any).isTrusted; // keep compatibility for old engines < 1.56.0
@@ -168,11 +203,11 @@ export async function checkJavaPreferences(context: ExtensionContext) {
 			}
 		}
 	}
-	if (isVerified) {
-		return javaHome;
-	} else {
-		return workspace.getConfiguration().inspect<string>('java.home').globalValue;
-	}
+
+	return {
+		javaHome,
+		preference
+	};
 }
 
 export function getKey(prefix, storagePath, value) {