[release] goLanguageServer: track language server's restart history

And show it in automated issue reports. This will allow us to see if
crashes were potentially caused by a bad restart. Sometimes we notice
crashes that don't have any associated gopls stack traces, so we were
wondering if there is something about the way that we do restarts that
causes these issues.

Automated issues will list when and why the language server was
restarted, as well as when the issue was suggested.

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

Author: stamblerre

src/goInstallTools.ts

@@ -34,7 +34,6 @@ import {
 	getBinPath,
 	getBinPathWithExplanation,
 	getCheckForToolsUpdatesConfig,
-	getCurrentGoPath,
 	getGoVersion,
 	getTempFilePath,
 	getWorkspaceFolderPath,
@@ -44,7 +43,7 @@ import {
 import { correctBinname, envPath, getCurrentGoRoot, setCurrentGoRoot } from './utils/pathUtils';
 import util = require('util');
 import vscode = require('vscode');
-import { isInPreviewMode } from './goLanguageServer';
+import { isInPreviewMode, RestartReason } from './goLanguageServer';
 
 // declinedUpdates tracks the tools that the user has declined to update.
 const declinedUpdates: Tool[] = [];
@@ -174,7 +173,7 @@ export async function installTools(
 		if (result.reason === '') {
 			// Restart the language server if a new binary has been installed.
 			if (result.tool.name === 'gopls') {
-				restartLanguageServer();
+				restartLanguageServer('installation');
 			}
 		} else {
 			failures.push(result);

src/goLanguageServer.ts

@@ -105,8 +105,37 @@ let serverTraceChannel: vscode.OutputChannel;
 let crashCount = 0;
 
 // Some metrics for automated issue reports:
-let manualRestartCount = 0;
-let totalStartCount = 0;
+let restartHistory: Restart[] = [];
+
+export function updateRestartHistory(reason: RestartReason, enabled: boolean) {
+	// Keep the history limited to 10 elements.
+	while (restartHistory.length > 10) {
+		restartHistory = restartHistory.slice(1);
+	}
+	restartHistory.push(new Restart(reason, new Date(), enabled));
+}
+
+function formatRestartHistory(): string {
+	const result: string[] = [];
+	for (const restart of restartHistory) {
+		result.push(`${restart.timestamp.toUTCString()}: ${restart.reason} (enabled: ${restart.enabled})`);
+	}
+	return result.join('\n');
+}
+
+export type RestartReason = 'activation' | 'manual' | 'config change' | 'installation';
+
+class Restart {
+	reason: RestartReason;
+	timestamp: Date;
+	enabled: boolean;
+
+	constructor(reason: RestartReason, timestamp: Date, enabled: boolean) {
+		this.reason = reason;
+		this.timestamp = timestamp;
+		this.enabled = enabled;
+	}
+}
 
 // defaultLanguageProviders is the list of providers currently registered.
 let defaultLanguageProviders: vscode.Disposable[] = [];
@@ -121,7 +150,7 @@ export let lastUserAction: Date = new Date();
 
 // startLanguageServerWithFallback starts the language server, if enabled,
 // or falls back to the default language providers.
-export async function startLanguageServerWithFallback(ctx: vscode.ExtensionContext, activation: boolean) {
+export async function startLanguageServerWithFallback(ctx: vscode.ExtensionContext, reason: RestartReason) {
 	for (const folder of vscode.workspace.workspaceFolders || []) {
 		switch (folder.uri.scheme) {
 			case 'vsls':
@@ -148,9 +177,11 @@ export async function startLanguageServerWithFallback(ctx: vscode.ExtensionConte
 	const goConfig = getGoConfig();
 	const cfg = buildLanguageServerConfig(goConfig);
 
+	updateRestartHistory(reason, cfg.enabled);
+
 	// We have some extra prompts for gopls users and for people who have opted
 	// out of gopls.
-	if (activation) {
+	if (reason === 'activation') {
 		scheduleGoplsSuggestions();
 	}
 
@@ -406,9 +437,7 @@ async function startLanguageServer(ctx: vscode.ExtensionContext, config: Languag
 				"Looks like you're about to manually restart the language server.",
 				errorKind.manualRestart
 			);
-
-			manualRestartCount++;
-			restartLanguageServer();
+			restartLanguageServer('manual');
 		});
 		ctx.subscriptions.push(restartCommand);
 	}
@@ -418,7 +447,6 @@ async function startLanguageServer(ctx: vscode.ExtensionContext, config: Languag
 	disposeDefaultProviders();
 
 	languageServerDisposable = languageClient.start();
-	totalStartCount++;
 	ctx.subscriptions.push(languageServerDisposable);
 	await languageClient.onReady();
 	return true;
@@ -922,7 +950,7 @@ export async function watchLanguageServerConfiguration(e: vscode.ConfigurationCh
 		e.affectsConfiguration('go.formatTool')
 		// TODO: Should we check http.proxy too? That affects toolExecutionEnvironment too.
 	) {
-		restartLanguageServer();
+		restartLanguageServer('config change');
 	}
 
 	if (e.affectsConfiguration('go.useLanguageServer') && getGoConfig()['useLanguageServer'] === false) {
@@ -1384,6 +1412,7 @@ Please copy the stack trace and error messages from that window and paste it in
 
 Failed to auto-collect gopls trace: ${failureReason}.
 `;
+				const now = new Date();
 
 				const body = `
 gopls version: ${usersGoplsVersion}
@@ -1393,8 +1422,9 @@ extension version: ${extInfo.version}
 go version: ${goVersion?.format(true)}
 environment: ${extInfo.appName} ${process.platform}
 initialization error: ${initializationError}
-manual restart count: ${manualRestartCount}
-total start count: ${totalStartCount}
+issue timestamp: ${now.toUTCString()}
+restart history:
+${formatRestartHistory()}
 
 ATTENTION: PLEASE PROVIDE THE DETAILS REQUESTED BELOW.
 

src/goMain.ts

@@ -47,6 +47,7 @@ import {
 import {
 	isInPreviewMode,
 	languageServerIsRunning,
+	RestartReason,
 	showServerOutputChannel,
 	startLanguageServerWithFallback,
 	watchLanguageServerConfiguration
@@ -124,7 +125,7 @@ export let vetDiagnosticCollection: vscode.DiagnosticCollection;
 // restartLanguageServer wraps all of the logic needed to restart the
 // language server. It can be used to enable, disable, or otherwise change
 // the configuration of the server.
-export let restartLanguageServer = () => {
+export let restartLanguageServer = (reason: RestartReason) => {
 	return;
 };
 
@@ -887,12 +888,12 @@ function configureLanguageServer(ctx: vscode.ExtensionContext) {
 	// Set the function that is used to restart the language server.
 	// This is necessary, even if the language server is not currently
 	// in use.
-	restartLanguageServer = async () => {
-		startLanguageServerWithFallback(ctx, false);
+	restartLanguageServer = async (reason: RestartReason) => {
+		startLanguageServerWithFallback(ctx, reason);
 	};
 
 	// Start the language server, or fallback to the default language providers.
-	return startLanguageServerWithFallback(ctx, true);
+	return startLanguageServerWithFallback(ctx, 'activation');
 }
 
 function getCurrentGoPathCommand() {