Use diagnostic refresh instead of publish on watch changes

Author: andrewbranch

internal/api/api.go

@@ -124,6 +124,11 @@ func (api *API) Client() project.Client {
 	return nil
 }
 
+// IsWatchEnabled implements ProjectHost.
+func (api *API) IsWatchEnabled() bool {
+	return false
+}
+
 func (api *API) HandleRequest(id int, method string, payload []byte) ([]byte, error) {
 	params, err := unmarshalPayload(method, payload)
 	if err != nil {

internal/lsp/server.go

@@ -151,9 +151,14 @@ func (s *Server) UnwatchFiles(handle project.WatcherHandle) error {
 	return fmt.Errorf("no file watcher exists with ID %s", handle)
 }
 
-// PublishDiagnostics implements project.Client.
-func (s *Server) PublishDiagnostics(params *lsproto.PublishDiagnosticsParams) error {
-	return s.sendNotification(lsproto.MethodTextDocumentPublishDiagnostics, params)
+// RefreshDiagnostics implements project.Client.
+func (s *Server) RefreshDiagnostics() error {
+	if ptrIsTrue(s.initializeParams.Capabilities.Workspace.Diagnostics.RefreshSupport) {
+		if err := s.sendRequest(lsproto.MethodWorkspaceDiagnosticRefresh, nil); err != nil {
+			return fmt.Errorf("failed to refresh diagnostics: %w", err)
+		}
+	}
+	return nil
 }
 
 func (s *Server) Run() error {
@@ -551,3 +556,10 @@ func codeFence(lang string, code string) string {
 func ptrTo[T any](v T) *T {
 	return &v
 }
+
+func ptrIsTrue(v *bool) bool {
+	if v == nil {
+		return false
+	}
+	return *v
+}

internal/project/host.go

@@ -10,7 +10,7 @@ type WatcherHandle string
 type Client interface {
 	WatchFiles(watchers []*lsproto.FileSystemWatcher) (WatcherHandle, error)
 	UnwatchFiles(handle WatcherHandle) error
-	PublishDiagnostics(params *lsproto.PublishDiagnosticsParams) error
+	RefreshDiagnostics() error
 }
 
 type ServiceHost interface {

internal/project/project.go

@@ -45,6 +45,7 @@ type ProjectHost interface {
 	Log(s string)
 	PositionEncoding() lsproto.PositionEncodingKind
 
+	IsWatchEnabled() bool
 	Client() Client
 }
 
@@ -90,7 +91,7 @@ func NewConfiguredProject(configFileName string, configFilePath tspath.Path, hos
 	project.configFilePath = configFilePath
 	project.initialLoadPending = true
 	client := host.Client()
-	if client != nil {
+	if host.IsWatchEnabled() && client != nil {
 		project.rootFilesWatch = newWatchedFiles(client, lsproto.WatchKindChange|lsproto.WatchKindCreate|lsproto.WatchKindDelete, core.Identity)
 	}
 	return project
@@ -117,7 +118,7 @@ func NewProject(name string, kind Kind, currentDirectory string, host ProjectHos
 		UseCaseSensitiveFileNames: host.FS().UseCaseSensitiveFileNames(),
 	}
 	client := host.Client()
-	if client != nil {
+	if host.IsWatchEnabled() && client != nil {
 		project.failedLookupsWatch = newWatchedFiles(client, lsproto.WatchKindCreate, func(data map[tspath.Path]string) []string {
 			return slices.Sorted(maps.Values(data))
 		})
@@ -271,7 +272,7 @@ func (p *Project) getModuleResolutionWatchGlobs() (failedLookups map[tspath.Path
 
 func (p *Project) updateWatchers() {
 	client := p.host.Client()
-	if client == nil {
+	if !p.host.IsWatchEnabled() || client == nil {
 		return
 	}
 

internal/project/service.go

@@ -2,7 +2,6 @@ package project
 
 import (
 	"fmt"
-	"slices"
 	"strings"
 	"sync"
 
@@ -135,10 +134,12 @@ func (s *Service) PositionEncoding() lsproto.PositionEncodingKind {
 
 // Client implements ProjectHost.
 func (s *Service) Client() Client {
-	if s.options.WatchEnabled {
-		return s.host.Client()
-	}
-	return nil
+	return s.host.Client()
+}
+
+// IsWatchEnabled implements ProjectHost.
+func (s *Service) IsWatchEnabled() bool {
+	return s.options.WatchEnabled
 }
 
 func (s *Service) Projects() []*Project {
@@ -261,13 +262,11 @@ func (s *Service) OnWatchedFilesChanged(changes []*lsproto.FileEvent) error {
 		}
 	}
 
-	for _, project := range s.configuredProjects {
-		if project.updateIfDirty() {
-			if err := s.publishDiagnosticsForOpenFiles(project); err != nil {
-				return err
-			}
-		}
+	client := s.host.Client()
+	if client != nil {
+		return client.RefreshDiagnostics()
 	}
+
 	return nil
 }
 
@@ -290,36 +289,6 @@ func (s *Service) onConfigFileChanged(project *Project, changeKind lsproto.FileC
 	return nil
 }
 
-func (s *Service) publishDiagnosticsForOpenFiles(project *Project) error {
-	client := s.host.Client()
-	if client == nil {
-		return nil
-	}
-
-	for path := range s.openFiles {
-		info := s.GetScriptInfoByPath(path)
-		if slices.Contains(info.containingProjects, project) {
-			diagnostics := project.LanguageService().GetDocumentDiagnostics(info.fileName)
-			lspDiagnostics := make([]*lsproto.Diagnostic, len(diagnostics))
-			for i, diagnostic := range diagnostics {
-				if diag, err := s.converters.ToLSPDiagnostic(diagnostic); err != nil {
-					return fmt.Errorf("error converting diagnostic: %w", err)
-				} else {
-					lspDiagnostics[i] = diag
-				}
-			}
-
-			if err := client.PublishDiagnostics(&lsproto.PublishDiagnosticsParams{
-				Uri:         ls.FileNameToDocumentURI(info.fileName),
-				Diagnostics: lspDiagnostics,
-			}); err != nil {
-				return fmt.Errorf("error publishing diagnostics: %w", err)
-			}
-		}
-	}
-	return nil
-}
-
 func (s *Service) ensureProjectStructureUpToDate() {
 	var hasChanges bool
 	for _, project := range s.configuredProjects {