Detect whether the client supports server-initiated work-done progress

Author: AJenbo

docs/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- **Progress notifications.** The server no longer sends `window/workDoneProgress/create` requests to clients that do not advertise support for it. Previously this could block clients indefinitely while they waited for a response that never came.
 - **Change visibility.** The code action no longer appears when the cursor is inside a method body. It now only triggers on the method signature (modifiers, name, parameters, return type).
 - **Update docblock.** The code action no longer appears when the cursor is inside a function or method body. It now only triggers on the signature or the preceding docblock.
 - **Update docblock.** No longer suggests adding redundant `@param` tags when the docblock has no `@param` tags and all parameters already have sufficient native type hints. This matches the generate-docblock behaviour, which intentionally omits `@param` for fully-typed non-templated parameters.

docs/todo.md

@@ -19,6 +19,12 @@ within the same impact tier.
 
 # Scheduled Sprints
 
+## Sprint 3 — Bug fixes
+
+| #   | Item                                              | Impact | Effort |
+| --- | ------------------------------------------------- | ------ | ------ |
+| B13 | [Stop showing dummy symbols in hover](todo/bugs.md#b13--hover-shows-dummy-symbols) | Medium | Low    |
+
 ## Sprint 4 — Refactoring toolkit
 
 | #   | Item                                                                               | Impact | Effort |

docs/todo/bugs.md

@@ -55,3 +55,19 @@ In practice this is unlikely because pruning only ever removes entries
 **Fix:** Replace the length comparison with a content comparison, or
 unconditionally write the pruned set back into the cache (the extra
 write is negligible).
+
+---
+
+## B13 — Hover shows dummy symbols
+
+| Impact | Effort |
+| ------ | ------ |
+| Medium | Low    |
+
+When hovering over certain constructs the hover popup displays
+internal dummy/placeholder symbols instead of filtering them out.
+These symbols are not meaningful to the user and clutter the hover
+output.
+
+**Fix:** Filter out dummy symbols before building the hover response
+so only real, user-relevant information is shown.

src/lib.rs

@@ -438,6 +438,13 @@ pub struct Backend {
     /// the rename response includes a `RenameFile` operation alongside the
     /// text edits so the file is renamed to match the new class name.
     pub(crate) supports_file_rename: Arc<std::sync::atomic::AtomicBool>,
+    /// Whether the client supports server-initiated work-done progress.
+    ///
+    /// Set during `initialize` based on the client's
+    /// `window.workDoneProgress` capability.  When `false`, the server
+    /// must not send `window/workDoneProgress/create` requests because
+    /// the client will not handle them, blocking the server indefinitely.
+    pub(crate) supports_work_done_progress: Arc<std::sync::atomic::AtomicBool>,
     /// Shared flag set to `true` when the LSP `shutdown` request is
     /// received.  Background workers (diagnostic, PHPStan) check this
     /// flag on each iteration and exit their loops.  The PHPStan
@@ -504,6 +511,7 @@ impl Backend {
             diag_last_full: Arc::new(Mutex::new(HashMap::new())),
             supports_pull_diagnostics: Arc::new(std::sync::atomic::AtomicBool::new(false)),
             supports_file_rename: Arc::new(std::sync::atomic::AtomicBool::new(false)),
+            supports_work_done_progress: Arc::new(std::sync::atomic::AtomicBool::new(false)),
             shutdown_flag: Arc::new(std::sync::atomic::AtomicBool::new(false)),
             config: Mutex::new(config::Config::default()),
         }
@@ -702,6 +710,7 @@ impl Backend {
             diag_last_full: Arc::clone(&self.diag_last_full),
             supports_pull_diagnostics: Arc::clone(&self.supports_pull_diagnostics),
             supports_file_rename: Arc::clone(&self.supports_file_rename),
+            supports_work_done_progress: Arc::clone(&self.supports_work_done_progress),
             shutdown_flag: Arc::clone(&self.shutdown_flag),
             config: Mutex::new(self.config.lock().clone()),
         }

src/server.rs

@@ -80,6 +80,18 @@ impl LanguageServer for Backend {
         self.supports_file_rename
             .store(client_supports_file_rename, Ordering::Release);
 
+        // Detect whether the client supports server-initiated work-done
+        // progress (window/workDoneProgress/create).  Per the LSP spec,
+        // we must not send that request unless the client opts in.
+        let client_supports_work_done_progress = params
+            .capabilities
+            .window
+            .as_ref()
+            .and_then(|w| w.work_done_progress)
+            .unwrap_or(false);
+        self.supports_work_done_progress
+            .store(client_supports_work_done_progress, Ordering::Release);
+
         Ok(InitializeResult {
             offset_encoding: None,
             capabilities: ServerCapabilities {

src/util.rs

@@ -840,6 +840,16 @@ impl Backend {
     pub(crate) async fn progress_create(&self, token_name: &str) -> Option<NumberOrString> {
         use tower_lsp::lsp_types::request::WorkDoneProgressCreate;
 
+        // Per the LSP spec, servers must only use
+        // window/workDoneProgress/create when the client signals
+        // support via the window.workDoneProgress capability.
+        if !self
+            .supports_work_done_progress
+            .load(std::sync::atomic::Ordering::Relaxed)
+        {
+            return None;
+        }
+
         let client = self.client.as_ref()?;
         let token = NumberOrString::String(token_name.to_string());
         let params = WorkDoneProgressCreateParams {