_stream.py: Make `_enqueue_plan` a timed activitybschubert/notify-prepare-plan

This enqueue_plan can take a long time, as it triggers a verification
of the 'cached' state for sources in some cases, which can take a long
time.

2 files changed, 10 insertions, 2 deletions

diff --git a/src/buildstream/_scheduler/queues/queue.py b/src/buildstream/_scheduler/queues/queue.py
index f5aa2ca4c..e05d95188 100644
--- a/src/buildstream/_scheduler/queues/queue.py
+++ b/src/buildstream/_scheduler/queues/queue.py
@@ -174,13 +174,17 @@ class Queue:
     #
     # Args:
     #    elts (list): A list of Elements
+    #    task (Task): The task to add progress to for the UI, if any
     #
-    def enqueue(self, elts):
+    def enqueue(self, elts, task=None):
         if not elts:
             return
 
         # Obtain immediate element status
         for elt in elts:
+            if task:
+                task.add_current_progress()
+
             if self._required_element_check and not elt._is_required():
                 elt._set_required_callback(self._enqueue_element)
             else:
diff --git a/src/buildstream/_stream.py b/src/buildstream/_stream.py
index af0537fe1..0a055a76d 100644
--- a/src/buildstream/_stream.py
+++ b/src/buildstream/_stream.py
@@ -1299,7 +1299,11 @@ class Stream:
     #
     def _enqueue_plan(self, plan, *, queue=None):
         queue = queue or self.queues[0]
-        queue.enqueue(plan)
+
+        with self._context.messenger.simple_task("Preparing work plan") as task:
+            task.set_maximum_progress(len(plan))
+            queue.enqueue(plan, task)
+
         self.session_elements += plan
 
     # _failure_retry()