gopls/internal/lsp: update telemetry prompt and add a follow-up message

Update the telemetry prompt per discussion, and add a follow up message
with more information after telemetry is enabled.

For golang/go#62576

Change-Id: If03cade72b27a765da43db293c74d53d19b95a9c
Reviewed-on: https://go-review.googlesource.com/c/tools/+/530459
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Hyang-Ah Hana Kim <[email protected]>

Author: findleyr

gopls/internal/lsp/prompt.go

@@ -28,6 +28,8 @@ const (
 	TelemetryPromptWorkTitle    = "Checking telemetry prompt"     // progress notification title, for awaiting in tests
 	GoplsConfigDirEnvvar        = "GOPLS_CONFIG_DIR"              // overridden for testing
 	FakeTelemetryModefileEnvvar = "GOPLS_FAKE_TELEMETRY_MODEFILE" // overridden for testing
+	TelemetryYes                = "Yes, I'd like to help."
+	TelemetryNo                 = "No, thanks."
 )
 
 // getenv returns the effective environment variable value for the provided
@@ -203,35 +205,50 @@ Would you like to enable Go telemetry?
 	params := &protocol.ShowMessageRequestParams{
 		Type:    protocol.Info,
 		Message: prompt,
-		Actions: []protocol.MessageActionItem{{Title: "Yes"}, {Title: "No"}},
+		Actions: []protocol.MessageActionItem{
+			{Title: TelemetryYes},
+			{Title: TelemetryNo},
+		},
 	}
+
 	item, err := s.client.ShowMessageRequest(ctx, params)
 	if err != nil {
 		errorf("ShowMessageRequest failed: %v", err)
 		// Defensive: ensure item == nil for the logic below.
 		item = nil
 	}
 
+	message := func(typ protocol.MessageType, msg string) {
+		if err := s.client.ShowMessage(ctx, &protocol.ShowMessageParams{
+			Type:    typ,
+			Message: msg,
+		}); err != nil {
+			errorf("ShowMessage(unrecognize) failed: %v", err)
+		}
+	}
+
 	result := pFailed
 	if item == nil {
 		// e.g. dialog was dismissed
 		errorf("no response")
 	} else {
 		// Response matches MessageActionItem.Title.
 		switch item.Title {
-		case "Yes":
+		case TelemetryYes:
 			result = pYes
-			s.setTelemetryMode("on")
-		case "No":
+			if err := s.setTelemetryMode("on"); err == nil {
+				message(protocol.Info, telemetryOnMessage())
+			} else {
+				errorf("enabling telemetry failed: %v", err)
+				msg := fmt.Sprintf("Failed to enable Go telemetry: %v\nTo enable telemetry manually, please run `go run golang.org/x/telemetry/cmd/gotelemetry@latest on`", err)
+				message(protocol.Error, msg)
+			}
+
+		case TelemetryNo:
 			result = pNo
 		default:
 			errorf("unrecognized response %q", item.Title)
-			if err := s.client.ShowMessage(ctx, &protocol.ShowMessageParams{
-				Type:    protocol.Error,
-				Message: fmt.Sprintf("Unrecognized response %q", item.Title),
-			}); err != nil {
-				errorf("ShowMessage failed: %v", err)
-			}
+			message(protocol.Error, fmt.Sprintf("Unrecognized response %q", item.Title))
 		}
 	}
 	resultContent := []byte(fmt.Sprintf("%s %d", result, attempts))
@@ -240,6 +257,17 @@ Would you like to enable Go telemetry?
 	}
 }
 
+func telemetryOnMessage() string {
+	reportDate := time.Now().AddDate(0, 0, 7).Format("2006-01-02")
+	return fmt.Sprintf(`Telemetry uploading is now enabled and may be sent to https://telemetry.go.dev/ starting %s. Uploaded data is used to help improve the Go toolchain and related tools, and it will be published as part of a public dataset.
+
+For more details, see https://telemetry.go.dev/privacy.
+This data is collected in accordance with the Google Privacy Policy (https://policies.google.com/privacy).
+
+To disable telemetry uploading, run %s.
+`, reportDate, "`go run golang.org/x/telemetry/cmd/gotelemetry@latest off`")
+}
+
 // acquireLockFile attempts to "acquire a lock" for writing to path.
 //
 // This is achieved by creating an exclusive lock file at <path>.lock. Lock

gopls/internal/regtest/misc/prompt_test.go

@@ -82,12 +82,13 @@ func main() {
 `
 
 	tests := []struct {
-		response string
-		wantMode string
+		response string // response to choose for the telemetry dialog
+		wantMode string // resulting telemetry mode
+		wantMsg  string // substring contained in the follow-up popup (if empty, no popup is expected)
 	}{
-		{"Yes", "on"},
-		{"No", ""},
-		{"", ""},
+		{lsp.TelemetryYes, "on", "uploading is now enabled"},
+		{lsp.TelemetryNo, "", ""},
+		{"", "", ""},
 	}
 	for _, test := range tests {
 		t.Run(fmt.Sprintf("response=%s", test.response), func(t *testing.T) {
@@ -117,8 +118,13 @@ func main() {
 				},
 				MessageResponder(respond),
 			).Run(t, src, func(t *testing.T, env *Env) {
-				env.Await(
+				var postConditions []Expectation
+				if test.wantMsg != "" {
+					postConditions = append(postConditions, ShownMessage(test.wantMsg))
+				}
+				env.OnceMet(
 					CompletedWork(lsp.TelemetryPromptWorkTitle, 1, true),
+					postConditions...,
 				)
 				gotMode := ""
 				if contents, err := os.ReadFile(modeFile); err == nil {