[release] src/goLanguageServer: suggest updating gopls before filing an issue

We're getting a lot of crash issue reports with people using outdated
gopls versions. We can just suggest an update to them instead of filing
an issue.

Also, update the hardcoded latest gopls version and clean up the
installing message which used to print "[email protected]@0.5.3".

Some formatting changes seem to have snuck in--I have format on save set
for TypeScript with the TSLint extension. Should I change something?

Change-Id: I3aca9e47f42e1e9951b1f6ad99944e36afac766f
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/272209
Trust: Rebecca Stambler <[email protected]>
Trust: Hyang-Ah Hana Kim <[email protected]>
Run-TryBot: Rebecca Stambler <[email protected]>
TryBot-Result: kokoro <[email protected]>
Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
(cherry picked from commit dd08b76)
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/272966
Trust: Robert Findley <[email protected]>

Author: stamblerre

src/goInstallTools.ts

@@ -226,8 +226,6 @@ export async function installTool(
 	}
 	args.push(importPath);
 
-	const toolImportPath = tool.version ? importPath + '@' + tool.version : importPath;
-
 	let output: string;
 	let result: string = '';
 	try {
@@ -253,10 +251,10 @@ export async function installTool(
 			await execFile(goBinary, ['build', '-o', outputFile, importPath], opts);
 		}
 		const toolInstallPath = getBinPath(tool.name);
-		outputChannel.appendLine(`Installing ${toolImportPath} (${toolInstallPath}) SUCCEEDED`);
+		outputChannel.appendLine(`Installing ${importPath} (${toolInstallPath}) SUCCEEDED`);
 	} catch (e) {
-		outputChannel.appendLine(`Installing ${toolImportPath} FAILED`);
-		result = `failed to install ${tool.name}(${toolImportPath}): ${e} ${output} `;
+		outputChannel.appendLine(`Installing ${importPath} FAILED`);
+		result = `failed to install ${tool.name}(${importPath}): ${e} ${output} `;
 	}
 
 	// Delete the temporary installation directory.
@@ -316,29 +314,36 @@ Run "go get -v ${getImportPath(tool, goVersion)}" to install.`;
 	}
 }
 
-export async function promptForUpdatingTool(toolName: string, newVersion?: SemVer) {
+export async function promptForUpdatingTool(toolName: string, newVersion?: SemVer, crashed?: boolean) {
 	const tool = getTool(toolName);
 	const toolVersion = { ...tool, version: newVersion }; // ToolWithVersion
 
 	// If user has declined to update, then don't prompt.
 	if (containsTool(declinedUpdates, tool)) {
 		return;
 	}
-	const goVersion = await getGoVersion();
-	let updateMsg = `Your version of ${tool.name} appears to be out of date. Please update for an improved experience.`;
+
+	// Adjust the prompt if it occurred because the tool crashed.
+	let updateMsg: string;
+	if (crashed === true) {
+		updateMsg = `${tool.name} has crashed, but you are using an outdated version. Please update to the latest version of ${tool.name}.`;
+	} else if (newVersion) {
+		updateMsg = `A new version of ${tool.name} (v${newVersion}) is available. Please update for an improved experience.`;
+	} else {
+		updateMsg = `Your version of ${tool.name} appears to be out of date. Please update for an improved experience.`;
+	}
+
 	let choices: string[] = ['Update'];
 	if (toolName === `gopls`) {
 		choices.push('Release Notes');
 	}
-	if (newVersion) {
-		updateMsg = `A new version of ${tool.name} (v${newVersion}) is available. Please update for an improved experience.`;
-	}
 
 	while (choices.length > 0) {
 		const selected = await vscode.window.showInformationMessage(updateMsg, ...choices);
 		switch (selected) {
 			case 'Update':
 				choices = [];
+				const goVersion = await getGoVersion();
 				await installTools([toolVersion], goVersion);
 				break;
 			case 'Release Notes':

src/goLanguageServer.ts

@@ -215,19 +215,19 @@ export interface BuildLanguageClientOption extends LanguageServerConfig {
 // used in building a new LanguageClient instance. Options specified
 // in LanguageServerConfig
 function buildLanguageClientOption(cfg: LanguageServerConfig): BuildLanguageClientOption {
-		// Reuse the same output channel for each instance of the server.
-		if (cfg.enabled) {
-			if (!serverOutputChannel) {
-				serverOutputChannel = vscode.window.createOutputChannel(cfg.serverName + ' (server)');
-			}
-			if (!serverTraceChannel) {
-				serverTraceChannel = vscode.window.createOutputChannel(cfg.serverName);
-			}
+	// Reuse the same output channel for each instance of the server.
+	if (cfg.enabled) {
+		if (!serverOutputChannel) {
+			serverOutputChannel = vscode.window.createOutputChannel(cfg.serverName + ' (server)');
+		}
+		if (!serverTraceChannel) {
+			serverTraceChannel = vscode.window.createOutputChannel(cfg.serverName);
 		}
-		return Object.assign({
-			outputChannel: serverOutputChannel,
-			traceOutputChannel: serverTraceChannel
-		}, cfg);
+	}
+	return Object.assign({
+		outputChannel: serverOutputChannel,
+		traceOutputChannel: serverTraceChannel
+	}, cfg);
 }
 
 // buildLanguageClient returns a language client built using the given language server config.
@@ -1128,6 +1128,17 @@ async function suggestGoplsIssueReport(msg: string, reason: errorKind) {
 		return;
 	}
 
+	// The user may have an outdated version of gopls, in which case we should
+	// just prompt them to update, not file an issue.
+	const tool = getTool('gopls');
+	if (tool) {
+		const versionToUpdate = await shouldUpdateLanguageServer(tool, latestConfig);
+		if (versionToUpdate) {
+			promptForUpdatingTool(tool.name, versionToUpdate, true);
+			return;
+		}
+	}
+
 	// Show the user the output channel content to alert them to the issue.
 	serverOutputChannel.show();
 
@@ -1165,8 +1176,8 @@ You will be asked to provide additional information and logs, so PLEASE READ THE
 					errKind = 'initialization';
 					break;
 			}
+			// Get the user's version in case the update prompt above failed.
 			const usersGoplsVersion = await getLocalGoplsVersion(latestConfig);
-			// TODO(hakim): If gopls version is too old, ask users to update it.
 			const settings = latestConfig.flags.join(' ');
 			const title = `gopls: automated issue report (${errKind})`;
 			const sanitizedLog = collectGoplsLog();
@@ -1258,7 +1269,7 @@ export function showServerOutputChannel() {
 			}
 			found = doc;
 			// .log, as some decoration is better than none
-			vscode.workspace.openTextDocument({language: 'log', content: contents});
+			vscode.workspace.openTextDocument({ language: 'log', content: contents });
 		}
 	}
 	if (found === undefined) {