respect window.workDoneProgress capability to activate progress reporting

Author: syphar

pylsp/workspace.py

@@ -136,15 +136,26 @@ def report_progress(
         message: Optional[str] = None,
         percentage: Optional[int] = None,
     ) -> Generator[Callable[[str, Optional[int]], None], None, None]:
-        token = self._progress_begin(title, message, percentage)
+        if self._config:
+            client_supports_progress_reporting = self._config.capabilities.get("window", {}).get("workDoneProgress", False)
+        else:
+            client_supports_progress_reporting = False
+
+        if client_supports_progress_reporting:
+            token = self._progress_begin(title, message, percentage)
 
-        def progress_message(message: str, percentage: Optional[int] = None) -> None:
-            self._progress_report(token, message, percentage)
+            def progress_message(message: str, percentage: Optional[int] = None) -> None:
+                self._progress_report(token, message, percentage)
+
+            try:
+                yield progress_message
+            finally:
+                self._progress_end(token)
+        else:
+            def dummy_progress_message(message: str, percentage: Optional[int] = None) -> None:
+                pass
 
-        try:
-            yield progress_message
-        finally:
-            self._progress_end(token)
+            yield dummy_progress_message
 
     def _progress_begin(
         self,
@@ -154,7 +165,7 @@ def _progress_begin(
     ) -> str:
         token = str(uuid.uuid4())
 
-        self._endpoint.request(self.M_INITIALIZE_PROGRESS, {'token': token}).result(_utils.CALL_TIMEOUT)
+        self._endpoint.request(self.M_INITIALIZE_PROGRESS, {'token': token}).result()
 
         value = {
             "kind": "begin",

test/test_workspace.py

@@ -294,8 +294,18 @@ def test_settings_of_added_workspace(pylsp, tmpdir):
     workspace1_jedi_settings = workspace1_object._config.plugin_settings('jedi')
     assert workspace1_jedi_settings == server_settings['pylsp']['plugins']['jedi']
 
+def test_no_progress_without_capability(workspace, consumer):
+    workspace._config.capabilities['window'] = {"workDoneProgress": False}
+
+    with workspace.report_progress("some_title"):
+        pass
+
+    assert len(consumer.call_args_list) == 0
+
 
 def test_progress_simple(workspace, consumer):
+    workspace._config.capabilities['window'] = {"workDoneProgress": True}
+
     with workspace.report_progress("some_title"):
         pass
 
@@ -316,6 +326,8 @@ def test_progress_simple(workspace, consumer):
 
 
 def test_progress_with_percent(workspace, consumer):
+    workspace._config.capabilities['window'] = {"workDoneProgress": True}
+
     with workspace.report_progress(
         "some_title", "initial message", percentage=1
     ) as progress_message:
@@ -348,6 +360,8 @@ def test_progress_with_percent(workspace, consumer):
 
 
 def test_progress_with_exception(workspace, consumer):
+    workspace._config.capabilities['window'] = {"workDoneProgress": True}
+
     class DummyError(Exception):
         pass