LSP fix file imports becoming unresolvable (#4097)

Author: emcfarlane

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Fix LSP published diagnostics to filter to the opened file.
 - Add `textDocument/documentSymbol` support for `buf lsp serve`.
+- Fix LSP navigation for cached modules which could cause import paths to become unresolvable.
 
 ## [v1.59.0] - 2025-10-20
 

private/buf/buflsp/buflsp.go

@@ -62,6 +62,7 @@ func Serve(
 		queryExecutor: queryExecutor,
 	}
 	lsp.fileManager = newFileManager(lsp)
+	lsp.workspaceManager = newWorkspaceManager(lsp)
 	off := protocol.TraceOff
 	lsp.traceValue.Store(&off)
 
@@ -83,13 +84,14 @@ type lsp struct {
 	client    protocol.Client
 	container appext.Container
 
-	logger        *slog.Logger
-	controller    bufctl.Controller
-	wasmRuntime   wasm.Runtime
-	fileManager   *fileManager
-	queryExecutor *incremental.Executor
-	wktBucket     storage.ReadBucket
-	shutdown      bool
+	logger           *slog.Logger
+	controller       bufctl.Controller
+	wasmRuntime      wasm.Runtime
+	fileManager      *fileManager
+	workspaceManager *workspaceManager
+	queryExecutor    *incremental.Executor
+	wktBucket        storage.ReadBucket
+	shutdown         bool
 
 	lock sync.Mutex
 

private/buf/buflsp/file.go

@@ -33,11 +33,9 @@ import (
 	"buf.build/go/standard/xio"
 	"buf.build/go/standard/xlog/xslog"
 	"buf.build/go/standard/xslices"
-	"github.com/bufbuild/buf/private/buf/bufworkspace"
 	"github.com/bufbuild/buf/private/bufpkg/bufanalysis"
 	"github.com/bufbuild/buf/private/bufpkg/bufcheck"
 	"github.com/bufbuild/buf/private/bufpkg/bufimage"
-	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
 	"github.com/bufbuild/buf/private/pkg/git"
 	"github.com/bufbuild/buf/private/pkg/normalpath"
 	"github.com/bufbuild/buf/private/pkg/storage"
@@ -72,9 +70,7 @@ type file struct {
 	version int32
 	hasText bool // Whether this file has ever had text read into it.
 
-	workspace   bufworkspace.Workspace
-	module      bufmodule.Module
-	checkClient bufcheck.Client
+	workspace *workspace
 
 	againstStrategy againstStrategy
 	againstGitRef   string
@@ -135,6 +131,10 @@ func (f *file) Close(ctx context.Context) {
 		close(f.checkWork)
 		f.checkWork = nil
 	}
+	if f.workspace != nil {
+		f.workspace.Release()
+		f.workspace = nil
+	}
 }
 
 // IsOpenInEditor returns whether this file was opened in the LSP client's
@@ -314,44 +314,30 @@ func (f *file) Refresh(ctx context.Context) {
 // The Buf workspace provides the sources for the compiler to work with.
 func (f *file) RefreshWorkspace(ctx context.Context) {
 	f.lsp.logger.Debug(
-		"getting workspace",
+		"refresh workspace",
 		slog.String("file", f.uri.Filename()),
 		slog.Int("version", int(f.version)),
 	)
-	workspace, err := f.lsp.controller.GetWorkspace(ctx, f.uri.Filename())
-	if err != nil {
-		f.lsp.logger.Error(
-			"could not load workspace",
-			slog.String("uri", string(f.uri)),
-			xslog.ErrorAttr(err),
-		)
-		return
-	}
-	f.workspace = workspace
-
-	var module bufmodule.Module
-	for _, mod := range workspace.Modules() {
-		// We do not care about this error, so we discard it.
-		_ = mod.WalkFileInfos(ctx, func(fileInfo bufmodule.FileInfo) error {
-			if fileInfo.LocalPath() == f.uri.Filename() {
-				module = mod
-			}
-			return nil
-		})
-		if module != nil {
-			break
+	if f.workspace != nil {
+		if err := f.workspace.Refresh(ctx); err != nil {
+			f.lsp.logger.Error(
+				"could not refresh workspace",
+				slog.String("uri", string(f.uri)),
+				xslog.ErrorAttr(err),
+			)
 		}
+	} else {
+		workspace, err := f.lsp.workspaceManager.LeaseWorkspace(ctx, f.uri)
+		if err != nil {
+			f.lsp.logger.Error(
+				"could not lease workspace",
+				slog.String("uri", string(f.uri)),
+				xslog.ErrorAttr(err),
+			)
+			return
+		}
+		f.workspace = workspace
 	}
-	if module == nil {
-		f.lsp.logger.Warn("could not find module", slog.String("file", f.uri.Filename()))
-	}
-	f.module = module
-
-	checkClient, err := f.lsp.controller.GetCheckClientForWorkspace(ctx, workspace, f.lsp.wasmRuntime)
-	if err != nil {
-		f.lsp.logger.Warn("could not get check client", xslog.ErrorAttr(err))
-	}
-	f.checkClient = checkClient
 }
 
 // IndexImports keeps track of importable files.
@@ -407,17 +393,9 @@ func (f *file) IndexImports(ctx context.Context) {
 func (f *file) getWorkspaceFileInfos(ctx context.Context) ([]storage.ObjectInfo, error) {
 	seen := make(map[string]struct{})
 	var fileInfos []storage.ObjectInfo
-	for _, module := range f.workspace.Modules() {
-		if err := module.WalkFileInfos(ctx, func(fileInfo bufmodule.FileInfo) error {
-			if fileInfo.FileType() != bufmodule.FileTypeProto {
-				return nil
-			}
-			fileInfos = append(fileInfos, fileInfo)
-			seen[fileInfo.Path()] = struct{}{}
-			return nil
-		}); err != nil {
-			return nil, err
-		}
+	for _, fileInfo := range f.workspace.fileNameToFileInfo {
+		fileInfos = append(fileInfos, fileInfo)
+		seen[fileInfo.Path()] = struct{}{}
 	}
 	// Add all wellknown types if not provided within the workspace.
 	if err := f.lsp.wktBucket.Walk(ctx, "", func(objectInfo storage.ObjectInfo) error {
@@ -1046,22 +1024,29 @@ func (f *file) RunLints(ctx context.Context) bool {
 		return false
 	}
 
-	if f.module == nil || f.image == nil {
+	workspace := f.workspace.Workspace()
+	module := f.workspace.GetModule(f.uri)
+	checkClient := f.workspace.CheckClient()
+	if workspace == nil {
+		f.lsp.logger.Warn(fmt.Sprintf("could not find workspace for %q", f.uri))
+		return false
+	}
+	if module == nil || f.image == nil {
 		f.lsp.logger.Warn(fmt.Sprintf("could not find image for %q", f.uri))
 		return false
 	}
-	if f.checkClient == nil {
+	if checkClient == nil {
 		f.lsp.logger.Warn(fmt.Sprintf("could not find check client for %q", f.uri))
 		return false
 	}
 
-	f.lsp.logger.Debug(fmt.Sprintf("running lint for %q in %v", f.uri, f.module.FullName()))
-	return f.appendLintErrors("buf lint", f.checkClient.Lint(
+	f.lsp.logger.Debug(fmt.Sprintf("running lint for %q in %v", f.uri, module.FullName()))
+	return f.appendLintErrors("buf lint", checkClient.Lint(
 		ctx,
-		f.workspace.GetLintConfigForOpaqueID(f.module.OpaqueID()),
+		workspace.GetLintConfigForOpaqueID(module.OpaqueID()),
 		f.image,
-		bufcheck.WithPluginConfigs(f.workspace.PluginConfigs()...),
-		bufcheck.WithPolicyConfigs(f.workspace.PolicyConfigs()...),
+		bufcheck.WithPluginConfigs(workspace.PluginConfigs()...),
+		bufcheck.WithPolicyConfigs(workspace.PolicyConfigs()...),
 	))
 }
 
@@ -1074,23 +1059,30 @@ func (f *file) RunBreaking(ctx context.Context) bool {
 		return false
 	}
 
-	if f.module == nil || f.image == nil || f.againstImage == nil {
+	workspace := f.workspace.Workspace()
+	module := f.workspace.GetModule(f.uri)
+	checkClient := f.workspace.CheckClient()
+	if workspace == nil {
+		f.lsp.logger.Warn(fmt.Sprintf("could not find workspace for %q", f.uri))
+		return false
+	}
+	if module == nil || f.image == nil || f.againstImage == nil {
 		f.lsp.logger.Warn(fmt.Sprintf("could not find --against image for %q", f.uri))
 		return false
 	}
-	if f.checkClient == nil {
+	if checkClient == nil {
 		f.lsp.logger.Warn(fmt.Sprintf("could not find check client for %q", f.uri))
 		return false
 	}
 
-	f.lsp.logger.Debug(fmt.Sprintf("running breaking for %q in %v", f.uri, f.module.FullName()))
-	return f.appendLintErrors("buf breaking", f.checkClient.Breaking(
+	f.lsp.logger.Debug(fmt.Sprintf("running breaking for %q in %v", f.uri, module.FullName()))
+	return f.appendLintErrors("buf breaking", checkClient.Breaking(
 		ctx,
-		f.workspace.GetBreakingConfigForOpaqueID(f.module.OpaqueID()),
+		workspace.GetBreakingConfigForOpaqueID(module.OpaqueID()),
 		f.image,
 		f.againstImage,
-		bufcheck.WithPluginConfigs(f.workspace.PluginConfigs()...),
-		bufcheck.WithPolicyConfigs(f.workspace.PolicyConfigs()...),
+		bufcheck.WithPluginConfigs(workspace.PluginConfigs()...),
+		bufcheck.WithPolicyConfigs(workspace.PolicyConfigs()...),
 	))
 }
 

private/buf/buflsp/file_manager.go

@@ -30,7 +30,7 @@ type fileManager struct {
 	uriToFile refcount.Map[protocol.URI, file]
 }
 
-// newFiles creates a new file manager.
+// newFileManager creates a new file manager.
 func newFileManager(lsp *lsp) *fileManager {
 	return &fileManager{lsp: lsp}
 }