src/goMain: use inspectGoToolVersion instead of runGoVersionM

And reduce the verbosity of `Go: Locate Configured Go Tools`.
With go1.18 which includes more details in go version -m output,
reporting everything from `go version -m` will be too excessive.

`Go: Locate Configured Go Tools` used runGoVersionM to
retrieve the build info of each located tool. However,
the default inspectGoToolVersion also utilizes `go version -m`,
so, they overlap with each other.

As we also want to reduce the verbosity of the `Go: Locate
Configured Go Tools` output, runGoVersionM is not much different
from inspectGoToolVersion any more. This CL unifies them.

Since go1.18 changes the build info encoding, we will see
failed `go version -m` more often. So, let's not print the error
output in the output channel.

For #1939

Change-Id: I1f674b030ca97804d34df63c66272cddb42b1c65
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/382159
Trust: Hyang-Ah Hana Kim <[email protected]>
Run-TryBot: Hyang-Ah Hana Kim <[email protected]>
TryBot-Result: kokoro <[email protected]>
Reviewed-by: Suzy Mueller <[email protected]>

Author: hyangah

src/goInstallTools.ts

@@ -677,11 +677,15 @@ export async function latestToolVersion(tool: Tool, includePrerelease?: boolean)
 // inspectGoToolVersion reads the go version and module version
 // of the given go tool using `go version -m` command.
 export const inspectGoToolVersion = defaultInspectGoToolVersion;
-async function defaultInspectGoToolVersion(binPath: string): Promise<{ goVersion?: string; moduleVersion?: string }> {
+async function defaultInspectGoToolVersion(
+	binPath: string
+): Promise<{ goVersion?: string; moduleVersion?: string; debugInfo?: string }> {
 	const goCmd = getBinPath('go');
 	const execFile = util.promisify(cp.execFile);
+	let debugInfo = 'go version -m failed';
 	try {
 		const { stdout } = await execFile(goCmd, ['version', '-m', binPath]);
+		debugInfo = stdout;
 		/* The output format will look like this
 
 		   if the binary was built in module mode.
@@ -705,11 +709,9 @@ async function defaultInspectGoToolVersion(binPath: string): Promise<{ goVersion
 		const moduleVersion = lines[2].split(/\s+/)[3];
 		return { goVersion, moduleVersion };
 	} catch (e) {
-		outputChannel.appendLine(
-			`Failed to determine the version of ${binPath}. For debugging, run "go version -m ${binPath}"`
-		);
-		// either go version failed or stdout is not in the expected format.
-		return {};
+		// either go version failed (e.g. the tool was compiled with a more recent version of go)
+		// or stdout is not in the expected format.
+		return { debugInfo };
 	}
 }
 

src/goMain.ts

@@ -38,6 +38,7 @@ import { implCursor } from './goImpl';
 import { addImport, addImportToWorkspace } from './goImport';
 import { installCurrentPackage } from './goInstall';
 import {
+	inspectGoToolVersion,
 	installAllTools,
 	installTools,
 	offerToInstallTools,
@@ -94,11 +95,9 @@ import {
 	getGoVersion,
 	getToolsGopath,
 	getWorkspaceFolderPath,
-	GoVersion,
 	handleDiagnosticErrors,
 	isGoPathSet,
-	resolvePath,
-	runGoVersionM
+	resolvePath
 } from './util';
 import { clearCacheForTools, fileExists, getCurrentGoRoot, dirExists, envPath } from './utils/pathUtils';
 import { WelcomePanel } from './welcome';
@@ -955,11 +954,11 @@ async function getConfiguredGoToolsCommand() {
 			if (goVersionTooOld) {
 				return `\t${tool.name}:\t${toolPath}: unknown version`;
 			}
-			try {
-				const out = await runGoVersionM(toolPath);
-				return `\t${tool.name}:${out.replace(/^/gm, '\t')}`;
-			} catch (e) {
-				return `\t${tool.name}:\t${toolPath}: go version -m failed: ${e}`;
+			const { goVersion, moduleVersion, debugInfo } = await inspectGoToolVersion(toolPath);
+			if (goVersion || moduleVersion) {
+				return `\t${tool.name}:\t${toolPath}\t(version: ${moduleVersion} built with go: ${goVersion})`;
+			} else {
+				return `\t${tool.name}:\t${toolPath}\t(version: unknown - ${debugInfo})`;
 			}
 		})
 	);

src/util.ts

@@ -389,20 +389,6 @@ export async function getGoEnv(cwd?: string): Promise<string> {
 	return stdout;
 }
 
-/**
- * Returns the output of `go version -m` with the toolPath.
- */
-export async function runGoVersionM(toolPath: string): Promise<string> {
-	const goRuntime = getBinPath('go');
-	const execFile = util.promisify(cp.execFile);
-	const opts = { env: toolExecutionEnvironment() };
-	const { stdout, stderr } = await execFile(goRuntime, ['version', '-m', toolPath], opts);
-	if (stderr) {
-		throw new Error(`failed to run 'go version -m ${toolPath}': ${stderr}`);
-	}
-	return stdout;
-}
-
 /**
  * Returns boolean indicating if GOPATH is set or not
  * If not set, then prompts user to do set GOPATH