Fix: preserve JDK_HOME priority when sorting JDKs (#4426)

Author: jhkim1067

src/jdkUtils.ts

@@ -60,7 +60,7 @@ export async function listJdks(force?: boolean): Promise<IJavaRuntime[]> {
  * 4. Others
  */
 export function sortJdksBySource(jdks: IJavaRuntime[]) {
-	const rankedJdks = jdks as Array<IJavaRuntime & { rank: number }>;
+	const rankedJdks = jdks as Array<IJavaRuntime & { rank?: number }>;
 	const env: string[] = ["JDK_HOME", "JAVA_HOME", "PATH"];
 	const jdkManagers: string[] = ["SDKMAN", "jEnv", "jabba", "asdf"];
 	for (const jdk of rankedJdks) {
@@ -72,7 +72,7 @@ export function sortJdksBySource(jdks: IJavaRuntime[]) {
 			}
 		}
 
-		if (jdk.rank) {
+		if (typeof jdk.rank === "number") {
 			continue;
 		}
 

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

@@ -2,8 +2,9 @@
 
 import * as assert from 'assert';
 import { getJavaConfiguration, getBuildFilePatterns, getInclusionPatternsFromNegatedExclusion, getExclusionGlob, convertToGlob } from '../../src/utils';
+import { IJavaRuntime } from 'jdk-utils';
 import { WorkspaceConfiguration } from 'vscode';
-import { listJdks } from '../../src/jdkUtils';
+import { listJdks, sortJdksBySource } from '../../src/jdkUtils';
 import { platform } from 'os';
 
 let exclusion: string[];
@@ -119,6 +120,28 @@ suite('Utils Test', () => {
 		assert.equal(result, "{**/node_modules/test/**/**/pom.xml}");
 	});
 
+	test('sortJdksBySource() - ranks JDK_HOME before lower-priority sources', () => {
+		const jdks: IJavaRuntime[] = [
+			{ homedir: "java-home", isJavaHomeEnv: true },
+			{ homedir: "path", isInPathEnv: true },
+			{ homedir: "sdkman", isFromSDKMAN: true },
+			{ homedir: "common" },
+			{ homedir: "gradle", isFromGradle: true },
+			{ homedir: "jdk-home", isJdkHomeEnv: true },
+		];
+
+		sortJdksBySource(jdks);
+
+		assert.deepEqual(jdks.map(jdk => jdk.homedir), [
+			"jdk-home",
+			"java-home",
+			"path",
+			"sdkman",
+			"common",
+			"gradle",
+		]);
+	});
+
 	test('listJdks() - no /usr as Java home on macOS', async function () {
 		// Skip this test if it's not macOS.
 		if (platform() !== "darwin") {