internal/mod: disable legacy CodeLensRunGovulncheck conditionally

- If CodeLensVulncheck is enabled, then disable CodeLensRunGovulncheck,
  otherwise two identical "Run govulncheck" codelenses will appear in
  the IDE, which makes for an unpleasant UX.

Change-Id: I3921490965a4e1b3086adf6695f10e0dca2b2b2d
Reviewed-on: https://go-review.googlesource.com/c/tools/+/706898
Reviewed-by: Hongxiang Jiang <hxjiang@golang.org>
Auto-Submit: Ethan Lee <ethanalee@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>

Author: ethanalee-work

gopls/internal/mod/code_lens.go

@@ -173,6 +173,11 @@ func vulncheckLenses(ctx context.Context, snapshot *cache.Snapshot, fh file.Hand
 }
 
 func runGovulncheckLenses(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle) ([]protocol.CodeLens, error) {
+	// If CodeLensVulncheck is enabled, do not use the legacy CodeLensRunGovulncheck.
+	if snapshot.Options().UserOptions.UIOptions.Codelenses[settings.CodeLensVulncheck] {
+		return nil, nil
+	}
+
 	pm, err := snapshot.ParseMod(ctx, fh)
 	if err != nil || pm.File == nil {
 		return nil, err

gopls/internal/settings/settings.go

@@ -1239,8 +1239,15 @@ func (o *Options) setOne(name string, value any) (applied []CounterPath, _ error
 			counts = append(counts, CounterPath{string(k), fmt.Sprint(v)})
 		}
 
+		var errs []string
 		if name == "codelens" {
-			return counts, deprecatedError("codelenses")
+			errs = append(errs, deprecatedError("codelenses").Error())
+		}
+		if lensOverrides[CodeLensRunGovulncheck] && lensOverrides[CodeLensVulncheck] {
+			errs = append(errs, "The 'run_govulncheck' codelens is superseded by the 'vulncheck' codelens. Only 'vulncheck' should be set.")
+		}
+		if len(errs) > 0 {
+			return counts, &SoftError{msg: strings.Join(errs, "\n")}
 		}
 		return counts, nil
 

gopls/internal/test/integration/misc/vuln_test.go

@@ -193,6 +193,7 @@ func main() {
 
 	for _, legacy := range []bool{false, true} {
 		t.Run(fmt.Sprintf("legacy=%v", legacy), func(t *testing.T) {
+			lenses := map[string]bool{"vulncheck": !legacy, "run_govulncheck": legacy}
 			WithOptions(
 				EnvVars{
 					// Let the analyzer read vulnerabilities data from the testdata/vulndb.
@@ -204,10 +205,7 @@ func main() {
 					"_GOPLS_TEST_BINARY_RUN_AS_GOPLS": "true", // needed to run `gopls vulncheck`.
 				},
 				Settings{
-					"codelenses": map[string]bool{
-						"run_govulncheck": true,
-						"vulncheck":       true,
-					},
+					"codelenses": lenses,
 				},
 			).Run(t, files, func(t *testing.T, env *Env) {
 				env.OpenFile("go.mod")