Postpone diagnostic collection until everything was emitted

swyddfa · Dec 1, 2024 · be1a4df · be1a4df
1 parent 39123f8
commit be1a4df
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/lib/esbonio/changes/925.fix.md b/lib/esbonio/changes/925.fix.md
@@ -0,0 +1 @@
+The sphinx agent should now be able to collect diagnostics from extensions that make use of the `build-finished` event e.g. sphinx-needs by @AlexanderLanin
diff --git a/lib/esbonio/esbonio/sphinx_agent/handlers/diagnostics.py b/lib/esbonio/esbonio/sphinx_agent/handlers/diagnostics.py
@@ -45,4 +45,8 @@ def setup(app: Sphinx):
     # TODO: Support for Sphinx v7+
     # app.connect("include-read")
 
-    app.connect("build-finished", sync_diagnostics)
+    # sync_diagnostics needs to run after all diagnostics have been emitted.
+    # This ensures proper synchronization of data, as some extensions, like
+    # sphinx-needs, emit diagnostics during the "build-finished" event.
+    # Setting priority to 900 ensures this handler runs after typical operations.
+    app.connect("build-finished", sync_diagnostics, priority=900)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The sphinx agent should now be able to collect diagnostics from extensions that make use of the `build-finished` event e.g. sphinx-needs by @AlexanderLanin