src/language/goLanguageServer: restore gopls opt-out survey prompt

triggered by gopls setting change.
(revert of https://go-review.googlesource.com/c/vscode-go/+/387656)

While we are here, remove the intermediate prompt that
asks users to re-enable gopls for users who disabled gopls.
It was added a year ago while making gopls the default, in order
to ask users to return to use gopls. It served well for the purpose
and it's time to retire.

For #2120

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

Author: hyangah

src/language/goLanguageServer.ts

@@ -254,8 +254,6 @@ function scheduleGoplsSuggestions() {
 			if (cfg.serverName !== '' && cfg.serverName !== 'gopls') {
 				return;
 			}
-			// Prompt the user to enable gopls and record what actions they took.
-			await promptAboutGoplsOptOut();
 			// Check if the language server has now been enabled, and if so,
 			// it will be installed below.
 			cfg = buildLanguageServerConfig(getGoConfig());
@@ -285,8 +283,8 @@ function scheduleGoplsSuggestions() {
 	setTimeout(survey, 30 * timeMinute);
 }
 
-// Ask users to enable gopls. If they still don't want it, ask to fill out opt-out survey with the probability.
-export async function promptAboutGoplsOptOut(probability = 0.5) {
+// Ask users to fill out opt-out survey.
+export async function promptAboutGoplsOptOut() {
 	// Check if the configuration is set in the workspace.
 	const useLanguageServer = getGoConfig().inspect('useLanguageServer');
 	const workspace = useLanguageServer.workspaceFolderValue === false || useLanguageServer.workspaceValue === false;
@@ -301,51 +299,10 @@ export async function promptAboutGoplsOptOut(probability = 0.5) {
 			return cfg;
 		}
 		cfg.lastDatePrompted = new Date();
-
-		const selected = await vscode.window.showInformationMessage(
-			`We noticed that you have disabled the language server.
-It has [stabilized](https://blog.golang.org/gopls-vscode-go) and is now enabled by default in this extension.
-Would you like to enable it now?`,
-			{ title: 'Enable' },
-			{ title: 'Not now' },
-			{ title: 'Never' }
+		await promptForGoplsOptOutSurvey(
+			cfg,
+			"It looks like you've disabled the Go language server. Would you be willing to tell us why you've disabled it, so that we can improve it?"
 		);
-		if (!selected) {
-			return cfg;
-		}
-		switch (selected.title) {
-			case 'Enable':
-				{
-					// Change the user's Go configuration to enable the language server.
-					// Remove the setting entirely, since it's on by default now.
-					const goConfig = getGoConfig();
-					await goConfig.update('useLanguageServer', undefined, vscode.ConfigurationTarget.Global);
-					if (goConfig.inspect('useLanguageServer').workspaceValue === false) {
-						await goConfig.update('useLanguageServer', undefined, vscode.ConfigurationTarget.Workspace);
-					}
-					if (goConfig.inspect('useLanguageServer').workspaceFolderValue === false) {
-						await goConfig.update(
-							'useLanguageServer',
-							undefined,
-							vscode.ConfigurationTarget.WorkspaceFolder
-						);
-					}
-					cfg.prompt = false;
-				}
-				break;
-			case 'Not now':
-				cfg.prompt = true;
-				break;
-			case 'Never':
-				cfg.prompt = false;
-				if (Math.random() < probability) {
-					await promptForGoplsOptOutSurvey(
-						cfg,
-						'No problem. Would you be willing to tell us why you have opted out of the language server?'
-					);
-				}
-				break;
-		}
 		return cfg;
 	};
 	cfg = await promptFn();
@@ -390,12 +347,12 @@ export const getGoplsOptOutConfig = (workspace: boolean): GoplsOptOutConfig => {
 	return getStateConfig(goplsOptOutConfigKey, workspace) as GoplsOptOutConfig;
 };
 
-function flushGoplsOptOutConfig(cfg: GoplsOptOutConfig, workspace: boolean) {
+export const flushGoplsOptOutConfig = (cfg: GoplsOptOutConfig, workspace: boolean) => {
 	if (workspace) {
 		updateWorkspaceState(goplsOptOutConfigKey, JSON.stringify(cfg));
 	}
 	updateGlobalState(goplsOptOutConfigKey, JSON.stringify(cfg));
-}
+};
 
 async function startLanguageServer(ctx: vscode.ExtensionContext, config: LanguageServerConfig): Promise<boolean> {
 	// If the client has already been started, make sure to clear existing
@@ -911,6 +868,10 @@ export async function watchLanguageServerConfiguration(e: vscode.ConfigurationCh
 	) {
 		restartLanguageServer('config change');
 	}
+
+	if (e.affectsConfiguration('go.useLanguageServer') && getGoConfig()['useLanguageServer'] === false) {
+		promptAboutGoplsOptOut();
+	}
 }
 
 export function buildLanguageServerConfig(goConfig: vscode.WorkspaceConfiguration): LanguageServerConfig {

test/gopls/survey.test.ts

@@ -197,31 +197,42 @@ suite('gopls opt out', () => {
 		sandbox.restore();
 	});
 
-	// testConfig, choice, probability, wantCount
-	const testCases: [goLanguageServer.GoplsOptOutConfig, string, number, number][] = [
+	const today = new Date();
+	const yesterday = new Date(today.valueOf() - 1000 * 60 * 60 * 24);
+
+	// testConfig, choice, wantCount
+	const testCases: [goLanguageServer.GoplsOptOutConfig, string, number][] = [
 		// No saved config, different choices in the first dialog box.
-		[{}, 'Enable', undefined, 1],
-		[{}, 'Not now', undefined, 1],
-		[{}, 'Never', 1, 2],
-		[{}, 'Never', 0, 1],
-		[{}, 'Never', undefined, -1], // Non-deterministic. Skip callCount check.
-		// Saved config, doesn't matter what the user chooses.
-		[{ prompt: false }, '', undefined, 0],
-		[{ prompt: false, lastDatePrompted: new Date() }, '', undefined, 0],
-		[{ prompt: true }, '', undefined, 1],
-		[{ prompt: true, lastDatePrompted: new Date() }, '', undefined, 0]
+		[{}, 'Yes', 1],
+		[{}, 'No', 1],
+		[{}, '', 1],
+		[{ lastDatePrompted: new Date('2020-04-02') }, '', 1],
+		[{ lastDatePrompted: yesterday }, '', 0],
+		[{ prompt: false }, '', 0],
+		[{ prompt: false, lastDatePrompted: new Date('2020-04-02') }, '', 0],
+		[{ prompt: false, lastDatePrompted: yesterday }, '', 0],
+		[{ prompt: true }, '', 1],
+		[{ prompt: true, lastDatePrompted: new Date('2020-04-02') }, 'Yes', 1],
+		[{ prompt: true, lastDatePrompted: yesterday }, '', 0]
 	];
 
-	testCases.map(async ([testConfig, choice, probability, wantCount], i) => {
+	testCases.map(async ([testConfig, choice, wantCount], i) => {
 		test(`opt out: ${i}`, async () => {
 			const stub = sandbox.stub(vscode.window, 'showInformationMessage').resolves({ title: choice });
 			const getGoplsOptOutConfigStub = sandbox.stub(goLanguageServer, 'getGoplsOptOutConfig').returns(testConfig);
+			const flushGoplsOptOutConfigStub = sandbox.stub(goLanguageServer, 'flushGoplsOptOutConfig');
 
-			await goLanguageServer.promptAboutGoplsOptOut(probability);
-			if (wantCount >= 0) {
-				assert.strictEqual(stub.callCount, wantCount);
-			}
+			await goLanguageServer.promptAboutGoplsOptOut();
+			assert.strictEqual(stub.callCount, wantCount, 'unexpected call count');
 			sandbox.assert.called(getGoplsOptOutConfigStub);
+			sandbox.assert.calledOnce(flushGoplsOptOutConfigStub);
+			const got = flushGoplsOptOutConfigStub.getCall(0).args[0];
+			if (choice === 'Yes') assert.strictEqual(got.prompt, false, 'unexpected prompt config stored');
+			if (wantCount > 0)
+				assert(
+					got.lastDatePrompted >= today,
+					`unexpected lastDatePrompted: ${JSON.stringify(got.lastDatePrompted)}`
+				);
 		});
 	});
 });