FIX (CodeAnalyzer v3): @W-15991264@: Backport java version check bug fix (#1504)

Author: stephen-carter-at-sf

messages/jreSetupManager.md

@@ -2,19 +2,19 @@
 
 We couldn't find Java Home.
 Please verify that Java 1.8 or later is installed on your machine and try again.
-If the problem persists, please manually add a 'javaHome' property to your Config.json file, referencing your Java home directory.
+If the problem persists, please manually add a 'javaHome' property to your `%s` file, referencing your Java home directory.
 
 # InvalidJavaHome
 
 The Java Home is invalid: %s. Error code: %s.
 Please verify that Java 1.8 or later is installed on your machine and try again.
-If the problem persists, please manually add a 'javaHome' property to your Config.json file, referencing your Java home directory.
+If the problem persists, please manually add a 'javaHome' property to your `%s` file, referencing your Java home directory.
 
 # VersionNotFound
 
 We couldn't find the Java version.
 Please verify that Java 1.8 or later is installed on your machine and try again.
-If the problem persists, please manually add a 'javaHome' property to your Config.json file, referencing your Java home directory.
+If the problem persists, please manually add a 'javaHome' property to your `%s` file, referencing your Java home directory.
 
 # InvalidVersion
 

src/lib/JreSetupManager.ts

@@ -30,6 +30,7 @@ export class JreSetupManagerDependencies {
 class JreSetupManager extends AsyncCreatable {
 	private logger!: Logger;
 	private config!: Config;
+	private configFile: string;
 	private dependencies: JreSetupManagerDependencies;
 	private initialized: boolean;
 
@@ -40,6 +41,7 @@ class JreSetupManager extends AsyncCreatable {
 		this.logger = await Logger.child('verifyJRE');
 
 		this.config = await Controller.getConfig();
+		this.configFile = path.join(Controller.getSfdxScannerPath(), CONFIG_FILE)
 		this.dependencies = new JreSetupManagerDependencies();
 
 		this.initialized = true;
@@ -80,7 +82,7 @@ class JreSetupManager extends AsyncCreatable {
 		// So we'll just throw an error telling the user to set it themselves.
 		if (!javaHome) {
 			const errName = 'NoJavaHomeFound';
-			throw new SfError(getMessage(BundleName.JreSetupManager, errName, []), errName);
+			throw new SfError(getMessage(BundleName.JreSetupManager, errName, [this.configFile]), errName);
 		}
 
 		return javaHome;
@@ -110,42 +112,50 @@ class JreSetupManager extends AsyncCreatable {
 		} catch (e) {
 			const error: NodeJS.ErrnoException = e as NodeJS.ErrnoException;
 			const errName = 'InvalidJavaHome';
-			throw new SfError(getMessage(BundleName.JreSetupManager, errName, [javaHome, error.code]), errName);
+			throw new SfError(getMessage(BundleName.JreSetupManager, errName, [javaHome, error.code, this.configFile]), errName);
 		}
 	}
 
 	private async verifyJavaVersion(javaHome: string): Promise<void> {
-		const versionOut = await this.fetchJavaVersion(javaHome);
-
-		// Version output looks like this:
-		// MacOS: "openjdk version "11.0.6" 2020-01-14 LTS\nOpenJDK Runtime Environment Zulu11.37+17-CA (build 11.0.6+10-LTS)\nOpenJDK 64-Bit Server VM Zulu11.37+17-CA (build 11.0.6+10-LTS, mixed mode)\n"
-		// Win10: "openjdk 14 2020-03-17\r\nOpenJDK Runtime Environment (build 14+36-1461)\r\nOpenJDK 64-Bit Server VM (build 14+36-1461, mixed mode, sharing)\r\n"
-		// We want to get the "11.0" or "14" part
-		// The version number could be of the format 11.0 or 1.8 or 14
-		const regex = /(\d+)(\.(\d+))?/;
-		const matchedParts = regex.exec(versionOut);
-		this.logger.trace(`Version output match for pattern ${regex.toString()} is ${JSON.stringify(matchedParts)}`);
-
-		// matchedParts should have four groups: "11.0", "11", ".0", "0" or "14", "14", undefined, undefined
-		if (!matchedParts || matchedParts.length < 4) {
-			throw new SfError(getMessage(BundleName.JreSetupManager, 'VersionNotFound', []));
+		const versionCommandOut = await this.fetchJavaVersion(javaHome);
+
+		// We are using "java -version" below which has output that typically looks like:
+		// * (from MacOS): "openjdk version "11.0.6" 2020-01-14 LTS\nOpenJDK Runtime Environment Zulu11.37+17-CA (build 11.0.6+10-LTS)\nOpenJDK 64-Bit Server VM Zulu11.37+17-CA (build 11.0.6+10-LTS, mixed mode)\n"
+		// From much research it should ideally say "version " and then either a number with or without quotes.
+		// If instead we used java --version then the output would look something like:
+		// * (from Win10): "openjdk 14 2020-03-17\r\nOpenJDK Runtime Environment (build 14+36-1461)\r\nOpenJDK 64-Bit Server VM (build 14+36-1461, mixed mode, sharing)\r\n"
+		// Notice it doesn't have the word "version" but again, we don't call "--version". But for sanity sakes,
+		// we will attempt to support this as well. Basically we want to get the "11.0.6" or "14" part.
+
+		// First we'll see if the word "version" exists with the version number and use that first.
+		const matchedParts = versionCommandOut.match(/version\s+"?(\d+(\.\d+)*)"?/i);
+		this.logger.trace(`Attempt 1: Java version output match results is ${JSON.stringify(matchedParts)}`);
+		let version: string;
+		if (matchedParts && matchedParts.length > 1) {
+			version = matchedParts[1];
+		} else {
+			// Otherwise we'll try to get the version number the old way just be looking for the first number
+			const matchedParts = versionCommandOut.match(/\s+(\d+(\.\d+)*)/);
+			this.logger.trace(`Attempt 2: Java version output match results is ${JSON.stringify(matchedParts)}`);
+			if (!matchedParts || matchedParts.length < 2) {
+				throw new SfError(getMessage(BundleName.JreSetupManager, 'VersionNotFound', [this.configFile]));
+			}
+			version = matchedParts[1];
 		}
 
-		const majorVersion = parseInt(matchedParts[1]);
-		const minorVersion = matchedParts[3] ? parseInt(matchedParts[3]) : '';
-		const version = `${majorVersion}${minorVersion ? `.${minorVersion}` : ''}`;
-
-		// We want to allow 1.8 and greater.
 		// Up to JDK8, the version scheme is 1.blah
 		// Starting JDK 9, the version scheme is 9.blah for 9, 10.blah for 10, etc.
-		// If either version part clicks, we should be good.
+		const versionParts: string[] = version.split('.');
+		const majorVersion = parseInt(versionParts[0]);
+		const minorVersion: number = versionParts.length > 1 ? parseInt(versionParts[1]) : 0;
+
 		if (majorVersion === 1 && minorVersion === 8) {
 			// Accommodating 1.8
 			uxEvents.emit(EVENTS.WARNING_ALWAYS_UNIQUE, getMessage(BundleName.JreSetupManager, 'warning.JavaV8Deprecated', [path.join(Controller.getSfdxScannerPath(), CONFIG_FILE)]));
 		} else if (majorVersion < 9) {
 			// Not matching what we are looking for
 			const errName = 'InvalidVersion';
-			throw new SfError(getMessage(BundleName.JreSetupManager, errName, [version]), errName);
+			throw new SfError(getMessage(BundleName.JreSetupManager, errName, [version, this.configFile]), errName);
 		}
 
 		this.logger.trace(`Java version found as ${version}`);