gopls/internal/lsp/command: add maybePromptForTelemetry

VS Code collapses notifications when there are multiple
notification messages or progress messages. In order to
increase the visibility, VS Code can pick the quiet time
(when there was no message exchanges for a while and
show prompt).

This internal command makes the invocation easy.
I thought about setting the telemetryPrompt option when
VS Code wants gopls to prompt, but that is a configuration
change and may cause other progress notifications to
get in the way.

Change-Id: Id9c18118a27931e41ef96e1648c0e8b6fe27f7ae
Reviewed-on: https://go-review.googlesource.com/c/tools/+/530457
Reviewed-by: Robert Findley <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
Run-TryBot: Hyang-Ah Hana Kim <[email protected]>

Author: hyangah

gopls/doc/commands.md

@@ -238,6 +238,12 @@ Result:
 }
 ```
 
+### **checks for the right conditions, and then prompts**
+Identifier: `gopls.maybe_prompt_for_telemetry`
+
+the user to ask if they want to enable Go telemetry uploading. If the user
+responds 'Yes', the telemetry mode is set to "on".
+
 ### **fetch memory statistics**
 Identifier: `gopls.mem_stats`
 

gopls/internal/lsp/command.go

@@ -64,7 +64,11 @@ type commandHandler struct {
 	params *protocol.ExecuteCommandParams
 }
 
-// AddTelemetryCounters implements command.Interface.
+func (h *commandHandler) MaybePromptForTelemetry(ctx context.Context) error {
+	go h.s.maybePromptForTelemetry(ctx, true)
+	return nil
+}
+
 func (*commandHandler) AddTelemetryCounters(_ context.Context, args command.AddTelemetryCountersArgs) error {
 	if len(args.Names) != len(args.Values) {
 		return fmt.Errorf("Names and Values must have the same length")

gopls/internal/lsp/command/command_gen.go

@@ -195,6 +195,11 @@ type Interface interface {
 	// Gopls will prepend "fwd/" to all the counters updated using this command
 	// to avoid conflicts with other counters gopls collects.
 	AddTelemetryCounters(context.Context, AddTelemetryCountersArgs) error
+
+	// MaybePromptForTelemetry: checks for the right conditions, and then prompts
+	// the user to ask if they want to enable Go telemetry uploading. If the user
+	// responds 'Yes', the telemetry mode is set to "on".
+	MaybePromptForTelemetry(context.Context) error
 }
 
 type RunTestsArgs struct {

gopls/internal/lsp/command/interface.go

@@ -241,7 +241,7 @@ func (s *Server) initialized(ctx context.Context, params *protocol.InitializedPa
 
 	// Ask (maybe) about enabling telemetry. Do this asynchronously, as it's OK
 	// for users to ignore or dismiss the question.
-	go s.maybePromptForTelemetry(ctx)
+	go s.maybePromptForTelemetry(ctx, options.TelemetryPrompt)
 
 	return nil
 }

gopls/internal/lsp/general.go

@@ -81,13 +81,15 @@ func (s *Server) setTelemetryMode(mode string) error {
 //
 // The actual conditions for prompting are defensive, erring on the side of not
 // prompting.
-func (s *Server) maybePromptForTelemetry(ctx context.Context) {
+// If enabled is false, this will not prompt the user in any condition,
+// but will send work progress reports to help testing.
+func (s *Server) maybePromptForTelemetry(ctx context.Context, enabled bool) {
 	if s.Options().VerboseWorkDoneProgress {
 		work := s.progress.Start(ctx, TelemetryPromptWorkTitle, "Checking if gopls should prompt about telemetry...", nil, nil)
 		defer work.End(ctx, "Done.")
 	}
 
-	if !s.Options().TelemetryPrompt {
+	if !enabled { // check this after the work progress message for testing.
 		return // prompt is disabled
 	}
 

gopls/internal/lsp/prompt.go

@@ -12,6 +12,7 @@ import (
 	"testing"
 
 	"golang.org/x/tools/gopls/internal/lsp"
+	"golang.org/x/tools/gopls/internal/lsp/command"
 	"golang.org/x/tools/gopls/internal/lsp/protocol"
 	. "golang.org/x/tools/gopls/internal/lsp/regtest"
 )
@@ -177,3 +178,48 @@ func main() {
 		})
 	}
 }
+
+// Test that gopls prompts for telemetry only when it is supposed to.
+func TestTelemetryPrompt_Conditions2(t *testing.T) {
+	const src = `
+-- go.mod --
+module mod.com
+
+go 1.12
+-- main.go --
+package main
+
+func main() {
+}
+`
+	modeFile := filepath.Join(t.TempDir(), "mode")
+	WithOptions(
+		Modes(Default), // no need to run this in all modes
+		EnvVars{
+			lsp.GoplsConfigDirEnvvar:        t.TempDir(),
+			lsp.FakeTelemetryModefileEnvvar: modeFile,
+		},
+		Settings{
+			// off because we are testing
+			// if we can trigger the prompt with command.
+			"telemetryPrompt": false,
+		},
+	).Run(t, src, func(t *testing.T, env *Env) {
+		cmd, err := command.NewMaybePromptForTelemetryCommand("prompt")
+		if err != nil {
+			t.Fatal(err)
+		}
+		var result error
+		env.ExecuteCommand(&protocol.ExecuteCommandParams{
+			Command: cmd.Command,
+		}, &result)
+		if result != nil {
+			t.Fatal(err)
+		}
+		expectation := ShownMessageRequest(".*Would you like to enable Go telemetry?")
+		env.OnceMet(
+			CompletedWork(lsp.TelemetryPromptWorkTitle, 2, true),
+			expectation,
+		)
+	})
+}