internal/lsp/source: make matchers selectable in WorkspaceSymbols

This change allows to use fuzzy or case-sensitive matchers in addition to case-insensitive when searching for symbols. Matcher is specified by UserOptions.Matcher just like Completion. Updates golang/go#33844 Change-Id: I4000fb7984c75f0f41c38d740dbe164398032312 Reviewed-on: https://go-review.googlesource.com/c/tools/+/218737 Reviewed-by: Rebecca Stambler <[email protected]> Run-TryBot: Rebecca Stambler <[email protected]> TryBot-Result: Gobot Gobot <[email protected]>
golang · Feb 13, 2020 · 885dec1 · 885dec1
1 parent 695c81b
commit 885dec1
Show file tree

Hide file tree

Showing 15 changed files with 307 additions and 86 deletions.
diff --git a/internal/lsp/cmd/test/cmdtest.go b/internal/lsp/cmd/test/cmdtest.go
@@ -102,6 +102,14 @@ func (r *runner) WorkspaceSymbols(*testing.T, string, []protocol.SymbolInformati
 	//TODO: add command line workspace symbol tests when it works
 }
 
+func (r *runner) FuzzyWorkspaceSymbols(*testing.T, string, []protocol.SymbolInformation, map[string]struct{}) {
+	//TODO: add command line workspace symbol tests when it works
+}
+
+func (r *runner) CaseSensitiveWorkspaceSymbols(*testing.T, string, []protocol.SymbolInformation, map[string]struct{}) {
+	//TODO: add command line workspace symbol tests when it works
+}
+
 func (r *runner) runGoplsCmd(t testing.TB, args ...string) (string, string) {
 	rStdout, wStdout, err := os.Pipe()
 	if err != nil {

diff --git a/internal/lsp/lsp_test.go b/internal/lsp/lsp_test.go
@@ -785,14 +785,24 @@ func (r *runner) Symbols(t *testing.T, uri span.URI, expectedSymbols []protocol.
 }
 
 func (r *runner) WorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
-	params := &protocol.WorkspaceSymbolParams{
-		Query: query,
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.CaseInsensitive
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
+	if len(got) != len(expectedSymbols) {
+		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
+		return
 	}
-	symbols, err := r.server.Symbol(r.ctx, params)
-	if err != nil {
-		t.Fatal(err)
+	if diff := tests.DiffWorkspaceSymbols(expectedSymbols, got); diff != "" {
+		t.Error(diff)
 	}
-	got := tests.FilterWorkspaceSymbols(symbols, dirs)
+}
+
+func (r *runner) FuzzyWorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.Fuzzy
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
 	if len(got) != len(expectedSymbols) {
 		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
 		return
@@ -802,6 +812,46 @@ func (r *runner) WorkspaceSymbols(t *testing.T, query string, expectedSymbols []
 	}
 }
 
+func (r *runner) CaseSensitiveWorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.CaseSensitive
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
+	if len(got) != len(expectedSymbols) {
+		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
+		return
+	}
+	if diff := tests.DiffWorkspaceSymbols(expectedSymbols, got); diff != "" {
+		t.Error(diff)
+	}
+}
+
+func (r *runner) callWorkspaceSymbols(t *testing.T, query string, options func(*source.Options)) []protocol.SymbolInformation {
+	t.Helper()
+
+	for _, view := range r.server.session.Views() {
+		original := view.Options()
+		modified := original
+		options(&modified)
+		var err error
+		view, err = view.SetOptions(r.ctx, modified)
+		if err != nil {
+			t.Error(err)
+			return nil
+		}
+		defer view.SetOptions(r.ctx, original)
+	}
+
+	params := &protocol.WorkspaceSymbolParams{
+		Query: query,
+	}
+	symbols, err := r.server.Symbol(r.ctx, params)
+	if err != nil {
+		t.Fatal(err)
+	}
+	return symbols
+}
+
 func (r *runner) SignatureHelp(t *testing.T, spn span.Span, want *protocol.SignatureHelp) {
 	m, err := r.data.Mapper(spn.URI())
 	if err != nil {

diff --git a/internal/lsp/source/source_test.go b/internal/lsp/source/source_test.go
@@ -798,11 +798,38 @@ func (r *runner) Symbols(t *testing.T, uri span.URI, expectedSymbols []protocol.
 }
 
 func (r *runner) WorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
-	symbols, err := source.WorkspaceSymbols(r.ctx, []source.View{r.view}, query)
-	if err != nil {
-		t.Errorf("symbols failed: %v", err)
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.CaseInsensitive
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
+	if len(got) != len(expectedSymbols) {
+		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
+		return
+	}
+	if diff := tests.DiffWorkspaceSymbols(expectedSymbols, got); diff != "" {
+		t.Error(diff)
+	}
+}
+
+func (r *runner) FuzzyWorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.Fuzzy
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
+	if len(got) != len(expectedSymbols) {
+		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
+		return
+	}
+	if diff := tests.DiffWorkspaceSymbols(expectedSymbols, got); diff != "" {
+		t.Error(diff)
 	}
-	got := tests.FilterWorkspaceSymbols(symbols, dirs)
+}
+
+func (r *runner) CaseSensitiveWorkspaceSymbols(t *testing.T, query string, expectedSymbols []protocol.SymbolInformation, dirs map[string]struct{}) {
+	got := r.callWorkspaceSymbols(t, query, func(opts *source.Options) {
+		opts.Matcher = source.CaseSensitive
+	})
+	got = tests.FilterWorkspaceSymbols(got, dirs)
 	if len(got) != len(expectedSymbols) {
 		t.Errorf("want %d symbols, got %d", len(expectedSymbols), len(got))
 		return
@@ -812,6 +839,25 @@ func (r *runner) WorkspaceSymbols(t *testing.T, query string, expectedSymbols []
 	}
 }
 
+func (r *runner) callWorkspaceSymbols(t *testing.T, query string, options func(*source.Options)) []protocol.SymbolInformation {
+	t.Helper()
+
+	original := r.view.Options()
+	modified := original
+	options(&modified)
+	view, err := r.view.SetOptions(r.ctx, modified)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer r.view.SetOptions(r.ctx, original)
+
+	got, err := source.WorkspaceSymbols(r.ctx, []source.View{view}, query)
+	if err != nil {
+		t.Fatal(err)
+	}
+	return got
+}
+
 func (r *runner) SignatureHelp(t *testing.T, spn span.Span, want *protocol.SignatureHelp) {
 	_, rng, err := spanToRange(r.data, spn)
 	if err != nil {

diff --git a/internal/lsp/source/workspace_symbol.go b/internal/lsp/source/workspace_symbol.go
@@ -11,6 +11,7 @@ import (
 	"go/types"
 	"strings"
 
+	"golang.org/x/tools/internal/lsp/fuzzy"
 	"golang.org/x/tools/internal/lsp/protocol"
 	"golang.org/x/tools/internal/telemetry/log"
 	"golang.org/x/tools/internal/telemetry/trace"
@@ -20,18 +21,14 @@ func WorkspaceSymbols(ctx context.Context, views []View, query string) ([]protoc
 	ctx, done := trace.StartSpan(ctx, "source.WorkspaceSymbols")
 	defer done()
 
-	q := strings.ToLower(query)
-	matcher := func(s string) bool {
-		return strings.Contains(strings.ToLower(s), q)
-	}
-
 	seen := make(map[string]struct{})
 	var symbols []protocol.SymbolInformation
 	for _, view := range views {
 		knownPkgs, err := view.Snapshot().KnownPackages(ctx)
 		if err != nil {
 			return nil, err
 		}
+		matcher := makeMatcher(view.Options().Matcher, query)
 		for _, ph := range knownPkgs {
 			pkg, err := ph.Check(ctx)
 			if err != nil {
@@ -75,6 +72,25 @@ type symbolInformation struct {
 
 type matcherFunc func(string) bool
 
+func makeMatcher(m Matcher, query string) matcherFunc {
+	switch m {
+	case Fuzzy:
+		fm := fuzzy.NewMatcher(query)
+		return func(s string) bool {
+			return fm.Score(s) > 0
+		}
+	case CaseSensitive:
+		return func(s string) bool {
+			return strings.Contains(s, query)
+		}
+	default:
+		q := strings.ToLower(query)
+		return func(s string) bool {
+			return strings.Contains(strings.ToLower(s), q)
+		}
+	}
+}
+
 func findSymbol(decls []ast.Decl, info *types.Info, matcher matcherFunc) []symbolInformation {
 	var result []symbolInformation
 	for _, decl := range decls {

diff --git a/internal/lsp/testdata/indirect/summary.txt.golden b/internal/lsp/testdata/indirect/summary.txt.golden
@@ -19,6 +19,8 @@ RenamesCount = 0
 PrepareRenamesCount = 0
 SymbolsCount = 0
 WorkspaceSymbolsCount = 0
+FuzzyWorkspaceSymbolsCount = 0
+CaseSensitiveWorkspaceSymbolsCount = 0
 SignaturesCount = 0
 LinksCount = 0
 ImplementationsCount = 0

diff --git a/internal/lsp/testdata/lsp/primarymod/workspacesymbol/a/a.go b/internal/lsp/testdata/lsp/primarymod/workspacesymbol/a/a.go
@@ -3,3 +3,7 @@ package a
 var WorkspaceSymbolVariableA = "a" //@symbol("WorkspaceSymbolVariableA", "WorkspaceSymbolVariableA", "Variable", "")
 
 const WorkspaceSymbolConstantA = "a" //@symbol("WorkspaceSymbolConstantA", "WorkspaceSymbolConstantA", "Constant", "")
+
+const (
+	workspacesymbolinvariable = iota //@symbol("workspacesymbolinvariable", "workspacesymbolinvariable", "Constant", "")
+)
diff --git a/internal/lsp/testdata/lsp/primarymod/workspacesymbol/a/a.go.golden b/internal/lsp/testdata/lsp/primarymod/workspacesymbol/a/a.go.golden
@@ -1,4 +1,5 @@
 -- symbols --
 WorkspaceSymbolVariableA Variable 3:5-3:29
 WorkspaceSymbolConstantA Constant 5:7-5:31
+workspacesymbolinvariable Constant 8:2-8:27
 
diff --git a/internal/lsp/testdata/lsp/primarymod/workspacesymbol/casesensitive/casesensitive.go b/internal/lsp/testdata/lsp/primarymod/workspacesymbol/casesensitive/casesensitive.go
@@ -0,0 +1,6 @@
+package casesensitive
+
+/*@
+workspacesymbolcasesensitive("baz", baz)
+workspacesymbolcasesensitive("Baz", Baz)
+*/
diff --git a/internal/lsp/testdata/lsp/primarymod/workspacesymbol/fuzzy/fuzzy.go b/internal/lsp/testdata/lsp/primarymod/workspacesymbol/fuzzy/fuzzy.go
@@ -0,0 +1,23 @@
+package fuzzy
+
+/*@
+workspacesymbolfuzzy("wsym",
+	WorkspaceSymbolVariableA,
+	WorkspaceSymbolConstantA,
+	workspacesymbolinvariable,
+	WorkspaceSymbolVariableB,
+	WorkspaceSymbolStructB,
+)
+workspacesymbolfuzzy("symbola",
+	WorkspaceSymbolVariableA,
+	WorkspaceSymbolConstantA,
+	workspacesymbolinvariable,
+	WorkspaceSymbolVariableB,
+)
+workspacesymbolfuzzy("symbolb",
+	WorkspaceSymbolVariableA,
+	workspacesymbolinvariable,
+	WorkspaceSymbolVariableB,
+	WorkspaceSymbolStructB,
+)
+*/
diff --git a/internal/lsp/testdata/lsp/primarymod/workspacesymbol/workspacesymbol.go b/internal/lsp/testdata/lsp/primarymod/workspacesymbol/workspacesymbol.go
@@ -31,6 +31,7 @@ workspacesymbol("",
 	ioWriter,
 	WorkspaceSymbolVariableA,
 	WorkspaceSymbolConstantA,
+	workspacesymbolinvariable,
 	WorkspaceSymbolVariableB,
 	WorkspaceSymbolStructB,
 	bBar,

diff --git a/internal/lsp/testdata/lsp/summary.txt.golden b/internal/lsp/testdata/lsp/summary.txt.golden
@@ -19,6 +19,8 @@ RenamesCount = 23
 PrepareRenamesCount = 7
 SymbolsCount = 3
 WorkspaceSymbolsCount = 2
+FuzzyWorkspaceSymbolsCount = 3
+CaseSensitiveWorkspaceSymbolsCount = 2
 SignaturesCount = 23
 LinksCount = 8
 ImplementationsCount = 5

diff --git a/internal/lsp/testdata/missingdep/summary.txt.golden b/internal/lsp/testdata/missingdep/summary.txt.golden
@@ -19,6 +19,8 @@ RenamesCount = 0
 PrepareRenamesCount = 0
 SymbolsCount = 0
 WorkspaceSymbolsCount = 0
+FuzzyWorkspaceSymbolsCount = 0
+CaseSensitiveWorkspaceSymbolsCount = 0
 SignaturesCount = 0
 LinksCount = 0
 ImplementationsCount = 0

diff --git a/internal/lsp/testdata/missingtwodep/summary.txt.golden b/internal/lsp/testdata/missingtwodep/summary.txt.golden
@@ -19,6 +19,8 @@ RenamesCount = 0
 PrepareRenamesCount = 0
 SymbolsCount = 0
 WorkspaceSymbolsCount = 0
+FuzzyWorkspaceSymbolsCount = 0
+CaseSensitiveWorkspaceSymbolsCount = 0
 SignaturesCount = 0
 LinksCount = 0
 ImplementationsCount = 0

diff --git a/internal/lsp/testdata/unused/summary.txt.golden b/internal/lsp/testdata/unused/summary.txt.golden
@@ -19,6 +19,8 @@ RenamesCount = 0
 PrepareRenamesCount = 0
 SymbolsCount = 0
 WorkspaceSymbolsCount = 0
+FuzzyWorkspaceSymbolsCount = 0
+CaseSensitiveWorkspaceSymbolsCount = 0
 SignaturesCount = 0
 LinksCount = 0
 ImplementationsCount = 0