LSP fix syntax highlight on semantic tokens (#4065)

Author: emcfarlane

private/buf/buflsp/file.go

@@ -44,7 +44,6 @@ import (
 	"github.com/bufbuild/protocompile/experimental/incremental"
 	"github.com/bufbuild/protocompile/experimental/incremental/queries"
 	"github.com/bufbuild/protocompile/experimental/ir"
-	"github.com/bufbuild/protocompile/experimental/report"
 	"github.com/bufbuild/protocompile/experimental/seq"
 	"github.com/bufbuild/protocompile/experimental/source"
 	"go.lsp.dev/protocol"
@@ -656,7 +655,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		msg.def = msg
 		resolved = append(resolved, msg)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsType().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsType().Options())...)
 	case ir.SymbolKindEnum:
 		enum := &symbol{
 			ir:   irSymbol,
@@ -668,7 +667,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		enum.def = enum
 		resolved = append(resolved, enum)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsType().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsType().Options())...)
 	case ir.SymbolKindEnumValue:
 		name := &symbol{
 			ir:   irSymbol,
@@ -689,7 +688,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		tag.def = tag
 		resolved = append(resolved, tag)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options())...)
 	case ir.SymbolKindField:
 		typ := &symbol{
 			ir:   irSymbol,
@@ -723,7 +722,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		tag.def = tag
 		resolved = append(resolved, tag)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options())...)
 	case ir.SymbolKindExtension:
 		// TODO: we should figure out if we need to do any resolution here.
 		ext := &symbol{
@@ -735,7 +734,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 			},
 		}
 		resolved = append(resolved, ext)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMember().Options())...)
 	case ir.SymbolKindOneof:
 		oneof := &symbol{
 			ir:   irSymbol,
@@ -747,7 +746,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		oneof.def = oneof
 		resolved = append(resolved, oneof)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsOneof().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsOneof().Options())...)
 	case ir.SymbolKindService:
 		service := &symbol{
 			ir:   irSymbol,
@@ -759,7 +758,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 		}
 		service.def = service
 		resolved = append(resolved, service)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsService().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsService().Options())...)
 	case ir.SymbolKindMethod:
 		method := &symbol{
 			ir:   irSymbol,
@@ -793,7 +792,7 @@ func (f *file) irToSymbols(irSymbol ir.Symbol) ([]*symbol, []*symbol) {
 			},
 		}
 		unresolved = append(unresolved, outputSym)
-		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMethod().Options(), report.Span{})...)
+		unresolved = append(unresolved, f.messageToSymbols(irSymbol.AsMethod().Options())...)
 	}
 	return resolved, unresolved
 }
@@ -822,19 +821,14 @@ func (f *file) importToSymbol(imp ir.Import) *symbol {
 	}
 }
 
-func (f *file) messageToSymbols(msg ir.MessageValue, prefix report.Span) []*symbol {
+func (f *file) messageToSymbols(msg ir.MessageValue) []*symbol {
 	var symbols []*symbol
 	for field := range msg.Fields() {
 		if field.ValueAST().IsZero() {
 			continue
 		}
 		for element := range seq.Values(field.Elements()) {
 			span := element.Value().KeyASTs().At(element.ValueNodeIndex()).Span()
-			// We only want the subset of the option path that applies specifically to this element,
-			// and we trim the prefix.
-			if !prefix.IsZero() {
-				span.Start = prefix.End
-			}
 			elem := &symbol{
 				// NOTE: no [ir.Symbol] for option elements
 				file: f,
@@ -846,7 +840,7 @@ func (f *file) messageToSymbols(msg ir.MessageValue, prefix report.Span) []*symb
 			}
 			symbols = append(symbols, elem)
 			if !element.AsMessage().IsZero() {
-				symbols = append(symbols, f.messageToSymbols(element.AsMessage(), span)...)
+				symbols = append(symbols, f.messageToSymbols(element.AsMessage())...)
 			}
 		}
 	}
@@ -869,8 +863,8 @@ func (f *file) SymbolAt(ctx context.Context, cursor protocol.Position) *symbol {
 	}
 	symbol := f.symbols[idx]
 	f.lsp.logger.DebugContext(ctx, "found symbol", slog.Any("symbol", symbol))
-	// Check that cursor is before the end of the symbol.
-	if comparePositions(symbol.Range().End, cursor) <= 0 {
+	// Check that cursor is before the end of the symbol. Range is half-open [Start, End).
+	if comparePositions(symbol.Range().End, cursor) < 0 {
 		return nil
 	}
 

private/buf/buflsp/jsonrpc_wrappers.go

@@ -72,7 +72,7 @@ func (c *connWrapper) Call(
 			xslog.ErrorAttr(err),
 		)
 	} else {
-		c.logger.Warn(
+		c.logger.Debug(
 			"call returned",
 			slog.String("method", method),
 			slog.Any("result", result),

private/buf/buflsp/server.go

@@ -485,19 +485,19 @@ func (s *server) SemanticTokensFull(
 			newLine := uint32(i - 1)
 			var newCol uint32
 			if i == startLocation.Line {
-				newCol = uint32(startLocation.Column)
+				newCol = uint32(startLocation.Column - 1)
 				if prevLine == newLine {
 					newCol -= prevCol
 				}
 			}
-			symbolLen := uint32(endLocation.Column)
+			symbolLen := uint32(endLocation.Column - 1)
 			if i == startLocation.Line {
-				symbolLen -= uint32(startLocation.Column)
+				symbolLen -= uint32(startLocation.Column - 1)
 			}
 			encoded = append(encoded, newLine-prevLine, newCol, symbolLen, semanticType, 0)
 			prevLine = newLine
 			if i == startLocation.Line {
-				prevCol = uint32(startLocation.Column)
+				prevCol = uint32(startLocation.Column - 1)
 			} else {
 				prevCol = 0
 			}

private/buf/buflsp/symbol.go

@@ -170,8 +170,6 @@ func (s *symbol) LogValue() slog.Value {
 //
 // Returns the empty string if no docs are available.
 func (s *symbol) FormatDocs(ctx context.Context) string {
-	missingDocs := "<missing docs>"
-	var tooltip strings.Builder
 	var def ast.DeclDef
 	switch s.kind.(type) {
 	case *imported:
@@ -240,7 +238,7 @@ func (s *symbol) FormatDocs(ctx context.Context) string {
 		if ok {
 			return strings.Join(comments, "\n")
 		}
-		return missingDocs
+		return ""
 	case *referenceable:
 		referenceable, _ := s.kind.(*referenceable)
 		def = referenceable.ast
@@ -251,11 +249,10 @@ func (s *symbol) FormatDocs(ctx context.Context) string {
 		reference, _ := s.kind.(*reference)
 		def = reference.def
 	}
+	var tooltip strings.Builder
 	docs := getCommentsFromDef(def)
 	if docs != "" {
 		fmt.Fprintln(&tooltip, docs)
-	} else {
-		fmt.Fprintln(&tooltip, missingDocs)
 	}
 	return tooltip.String()
 }