fix: skip diagnostics pull if diagnostics already received (#2623)

Author: rchl

plugin/documents.py

@@ -277,9 +277,8 @@ def on_session_shutdown_async(self, session: Session) -> None:
     def _diagnostics_async(
         self, allow_stale: bool = False
     ) -> Generator[tuple[SessionBufferProtocol, list[tuple[Diagnostic, sublime.Region]]], None, None]:
-        change_count = self.view.change_count()
         for sb in self.session_buffers_async():
-            if sb.diagnostics_version == change_count or allow_stale:
+            if sb.has_latest_diagnostics() or allow_stale:
                 yield sb, sb.diagnostics
 
     def diagnostics_intersecting_region_async(

plugin/session_buffer.py

@@ -128,7 +128,7 @@ def __init__(self, session_view: SessionViewProtocol, buffer_id: int, uri: Docum
         self._pending_changes: PendingChanges | None = None
         self.diagnostics: list[tuple[Diagnostic, sublime.Region]] = []
         self.diagnostics_data_per_severity: dict[tuple[int, bool], DiagnosticSeverityData] = {}
-        self.diagnostics_version = -1
+        self._diagnostics_version = -1
         self.diagnostics_flags = 0
         self._diagnostics_are_visible = False
         self.document_diagnostic_needs_refresh = False
@@ -496,8 +496,13 @@ def do_document_diagnostic_async(
             return
         if mgr.should_ignore_diagnostics(self._last_known_uri, self.session.config):
             return
+        change_count = view.change_count()
         if version is None:
-            version = view.change_count()
+            version = change_count
+        elif version < change_count:
+            return
+        if version == self._diagnostics_version:
+            return
         if self._document_diagnostic_pending_request:
             if self._document_diagnostic_pending_request.version == version and not forced_update:
                 return
@@ -520,18 +525,17 @@ def _on_document_diagnostic_async(self, version: int, response: DocumentDiagnost
         self._document_diagnostic_pending_request = None
         self._if_view_unchanged(self._apply_document_diagnostic_async, version)(response)
 
-    def _apply_document_diagnostic_async(
-        self, view: sublime.View | None, response: DocumentDiagnosticReport
-    ) -> None:
+    def _apply_document_diagnostic_async(self, view: sublime.View | None, response: DocumentDiagnosticReport) -> None:
         self.session.diagnostics_result_ids[self._last_known_uri] = response.get('resultId')
         if is_full_document_diagnostic_report(response):
             self.session.m_textDocument_publishDiagnostics(
                 {'uri': self._last_known_uri, 'diagnostics': response['items']})
-        for uri, diagnostic_report in response.get('relatedDocuments', {}):
-            sb = self.session.get_session_buffer_for_uri_async(uri)
-            if sb:
-                cast(SessionBuffer, sb)._apply_document_diagnostic_async(
-                    None, cast(DocumentDiagnosticReport, diagnostic_report))
+        if 'relatedDocuments' in response:
+            for uri, diagnostic_report in response['relatedDocuments'].items():
+                sb = self.session.get_session_buffer_for_uri_async(uri)
+                if sb:
+                    cast(SessionBuffer, sb)._apply_document_diagnostic_async(
+                        None, cast(DocumentDiagnosticReport, diagnostic_report))
 
     def _on_document_diagnostic_error_async(self, version: int, error: ResponseError) -> None:
         self._document_diagnostic_pending_request = None
@@ -580,7 +584,7 @@ def on_diagnostics_async(
         self.diagnostics_data_per_severity = data_per_severity
 
         def present() -> None:
-            self.diagnostics_version = diagnostics_version
+            self._diagnostics_version = diagnostics_version
             self.diagnostics = diagnostics
             self._diagnostics_are_visible = bool(diagnostics)
             for sv in self.session_views:
@@ -604,6 +608,12 @@ def present() -> None:
                     condition=lambda: bool(view and view.is_valid() and view.change_count() == diagnostics_version),
                 )
 
+    def has_latest_diagnostics(self) -> bool:
+        view = self.some_view()
+        if view is None:
+            return False
+        return self._diagnostics_version == view.change_count()
+
     # --- textDocument/semanticTokens ----------------------------------------------------------------------------------
 
     def do_semantic_tokens_async(self, view: sublime.View, only_viewport: bool = False) -> None: