feat(cli): show spinner when cloning repo for dataset import/update (#2914)

Author: Panaetius

renku/core/dataset/dataset.py

@@ -1023,9 +1023,10 @@ def update_dataset_git_files(
             if url in visited_repos:
                 remote_repository, remote_client = visited_repos[url]
             else:
-                remote_repository = clone_repository(
-                    url=url, path=get_cache_directory_for_repository(client=client, url=url), checkout_revision=ref
-                )
+                with communication.busy(msg="Cloning remote repository..."):
+                    remote_repository = clone_repository(
+                        url=url, path=get_cache_directory_for_repository(client=client, url=url), checkout_revision=ref
+                    )
                 remote_client = LocalClient(path=remote_repository.path)
                 visited_repos[url] = remote_repository, remote_client
 

renku/core/dataset/providers/renku.py

@@ -359,22 +359,23 @@ def _fetch_dataset(self, client_dispatcher: IClientDispatcher, database_dispatch
 
         urls = (self._project_url_ssh, self._project_url_http)
         # Clone the project
-        for url in urls:
-            try:
-                repository = clone_renku_repository(
-                    url=url,
-                    path=get_cache_directory_for_repository(client=client, url=url),
-                    gitlab_token=self._gitlab_token,
-                    deployment_hostname=parsed_uri.netloc,
-                    depth=None,
-                    reuse_existing_repository=True,
-                    use_renku_credentials=True,
-                )
-            except errors.GitError:
-                pass
-            else:
-                self._project_url = url
-                break
+        with communication.busy(msg="Cloning remote repository..."):
+            for url in urls:
+                try:
+                    repository = clone_renku_repository(
+                        url=url,
+                        path=get_cache_directory_for_repository(client=client, url=url),
+                        gitlab_token=self._gitlab_token,
+                        deployment_hostname=parsed_uri.netloc,
+                        depth=None,
+                        reuse_existing_repository=True,
+                        use_renku_credentials=True,
+                    )
+                except errors.GitError:
+                    pass
+                else:
+                    self._project_url = url
+                    break
 
         if self._project_url is None or repository is None:
             raise errors.ParameterError("Cannot clone remote projects:\n\t" + "\n\t".join(urls), param_hint=self._uri)

renku/core/session/session.py

@@ -21,8 +21,6 @@
 from itertools import chain
 from typing import Optional
 
-from yaspin import yaspin
-
 from renku.command.command_builder import inject
 from renku.core import errors
 from renku.core.interface.client_dispatcher import IClientDispatcher
@@ -94,7 +92,7 @@ def session_start(
                 abort=True,
             )
 
-            with yaspin(text="Building image"):
+            with communication.busy(msg="Building image"):
                 _ = provider_api.build_image(client.docker_path.parent, image_name, config)
     else:
         if not provider_api.find_image(image_name, config):

renku/core/util/communication.py

@@ -17,6 +17,7 @@
 # limitations under the License.
 """Communicator classes for printing output."""
 
+from contextlib import ExitStack, contextmanager
 from functools import wraps
 from threading import RLock
 
@@ -56,6 +57,14 @@ def has_prompt(self):
     def prompt(self, msg, type=None, default=None, **kwargs):
         """Show a message prompt."""
 
+    @contextmanager
+    def busy(self, msg):
+        """Indicate a busy status.
+
+        For instance, show a spinner in the CLI.
+        """
+        yield
+
 
 def lock_communication(method):
     """Ensure communicator is locked."""
@@ -177,6 +186,14 @@ def finalize_progress(self, name):
         for listener in self._listeners:
             listener.finalize_progress(name)
 
+    @contextmanager
+    def busy(self, msg):
+        """Show busy indicators."""
+        with ExitStack() as stack:
+            for listener in self._listeners:
+                stack.enter_context(listener.busy(msg))
+            yield
+
     @lock_communication
     def disable(self):
         """Disable all outputs; by default everything is enabled."""
@@ -243,7 +260,7 @@ def warn(msg):
 
 @ensure_manager
 def error(msg):
-    """Write an info message to all listeners."""
+    """Write an error message to all listeners."""
     _thread_local.communication_manager.error(msg)
 
 
@@ -283,6 +300,14 @@ def finalize_progress(name):
     _thread_local.communication_manager.finalize_progress(name)
 
 
+@ensure_manager
+@contextmanager
+def busy(msg):
+    """Indicate busy status to all listeners."""
+    with _thread_local.communication_manager.busy(msg):
+        yield
+
+
 @ensure_manager
 def get_listeners():
     """Return a list of subscribed listeners."""

renku/ui/cli/utils/callback.py

@@ -18,9 +18,11 @@
 """Communicator class for printing click output."""
 
 import sys
+from contextlib import contextmanager
 
 import click
 from tqdm import tqdm
+from yaspin import yaspin
 
 import renku.ui.cli.utils.color as color
 from renku.core.util.communication import CommunicationCallback
@@ -93,6 +95,12 @@ def finalize_progress(self, name):
         self._progress_bars[name].close()
         del self._progress_bars[name]
 
+    @contextmanager
+    def busy(self, msg):
+        """Indicate busy status using a spinner."""
+        with yaspin(text=msg):
+            yield
+
 
 class ClickCallback(StandardOutput):
     """CommunicationCallback implementation for ``click`` messages."""