_messenger.py: Make `timed_suspendable` public and use it in job.pybschubert/timed-suspendable

This reduces the amount of code duplication

2 files changed, 39 insertions, 50 deletions

diff --git a/src/buildstream/_messenger.py b/src/buildstream/_messenger.py
index 3a32a2467..805f56b5b 100644
--- a/src/buildstream/_messenger.py
+++ b/src/buildstream/_messenger.py
@@ -160,7 +160,7 @@ class Messenger:
     #
     @contextmanager
     def timed_activity(self, activity_name, *, element_name=None, detail=None, silent_nested=False):
-        with self._timed_suspendable() as timedata:
+        with self.timed_suspendable() as timedata:
             try:
                 # Push activity depth for status messages
                 message = Message(MessageType.START, activity_name, detail=detail, element_name=element_name)
@@ -204,7 +204,7 @@ class Messenger:
         if not full_name:
             full_name = activity_name
 
-        with self._timed_suspendable() as timedata:
+        with self.timed_suspendable() as timedata:
             try:
                 message = Message(MessageType.START, activity_name, element_name=element_name)
                 self.message(message)
@@ -326,6 +326,34 @@ class Messenger:
     def get_log_filename(self):
         return self._log_filename
 
+    # timed_suspendable()
+    #
+    # A contextmanager that allows an activity to be suspended and can
+    # adjust for clock drift caused by suspending
+    #
+    # Yields:
+    #    TimeData: An object that contains the time the activity started
+    #
+    @contextmanager
+    def timed_suspendable(self):
+        # Note: timedata needs to be in a namedtuple so that values can be
+        # yielded that will change
+        timedata = _TimeData(start_time=datetime.datetime.now())
+        stopped_time = None
+
+        def stop_time():
+            nonlocal stopped_time
+            stopped_time = datetime.datetime.now()
+
+        def resume_time():
+            nonlocal timedata
+            nonlocal stopped_time
+            sleep_time = datetime.datetime.now() - stopped_time
+            timedata.start_time += sleep_time
+
+        with _signals.suspendable(stop_time, resume_time):
+            yield timedata
+
     # _record_message()
     #
     # Records the message if recording is enabled
@@ -388,31 +416,3 @@ class Messenger:
         if self._render_status_cb and now >= self._next_render:
             self._render_status_cb()
             self._next_render = now + _RENDER_INTERVAL
-
-    # _timed_suspendable()
-    #
-    # A contextmanager that allows an activity to be suspended and can
-    # adjust for clock drift caused by suspending
-    #
-    # Yields:
-    #    TimeData: An object that contains the time the activity started
-    #
-    @contextmanager
-    def _timed_suspendable(self):
-        # Note: timedata needs to be in a namedtuple so that values can be
-        # yielded that will change
-        timedata = _TimeData(start_time=datetime.datetime.now())
-        stopped_time = None
-
-        def stop_time():
-            nonlocal stopped_time
-            stopped_time = datetime.datetime.now()
-
-        def resume_time():
-            nonlocal timedata
-            nonlocal stopped_time
-            sleep_time = datetime.datetime.now() - stopped_time
-            timedata.start_time += sleep_time
-
-        with _signals.suspendable(stop_time, resume_time):
-            yield timedata
diff --git a/src/buildstream/_scheduler/jobs/job.py b/src/buildstream/_scheduler/jobs/job.py
index 7ea87dc62..33aeebf29 100644
--- a/src/buildstream/_scheduler/jobs/job.py
+++ b/src/buildstream/_scheduler/jobs/job.py
@@ -675,41 +675,30 @@ class ChildJob:
         self._pipe_w = pipe_w
         self._messenger.set_message_handler(self._child_message_handler)
 
-        starttime = datetime.datetime.now()
-        stopped_time = None
-
-        def stop_time():
-            nonlocal stopped_time
-            stopped_time = datetime.datetime.now()
-
-        def resume_time():
-            nonlocal stopped_time
-            nonlocal starttime
-            starttime += datetime.datetime.now() - stopped_time
-
         # Graciously handle sigterms.
         def handle_sigterm():
             self._child_shutdown(_ReturnCode.TERMINATED)
 
         # Time, log and and run the action function
         #
-        with _signals.terminator(handle_sigterm), _signals.suspendable(
-            stop_time, resume_time
-        ), self._messenger.recorded_messages(self._logfile, self._logdir) as filename:
-
+        with _signals.terminator(
+            handle_sigterm
+        ), self._messenger.timed_suspendable() as timeinfo, self._messenger.recorded_messages(
+            self._logfile, self._logdir
+        ) as filename:
             self.message(MessageType.START, self.action_name, logfile=filename)
 
             try:
                 # Try the task action
                 result = self.child_process()  # pylint: disable=assignment-from-no-return
             except SkipJob as e:
-                elapsed = datetime.datetime.now() - starttime
+                elapsed = datetime.datetime.now() - timeinfo.start_time
                 self.message(MessageType.SKIPPED, str(e), elapsed=elapsed, logfile=filename)
 
                 # Alert parent of skip by return code
                 self._child_shutdown(_ReturnCode.SKIPPED)
             except BstError as e:
-                elapsed = datetime.datetime.now() - starttime
+                elapsed = datetime.datetime.now() - timeinfo.start_time
                 retry_flag = e.temporary
 
                 if retry_flag and (self._tries <= self._max_retries):
@@ -739,7 +728,7 @@ class ChildJob:
                 # send the traceback and formatted exception back to the frontend
                 # and print it to the log file.
                 #
-                elapsed = datetime.datetime.now() - starttime
+                elapsed = datetime.datetime.now() - timeinfo.start_time
                 detail = "An unhandled exception occured:\n\n{}".format(traceback.format_exc())
 
                 self.message(MessageType.BUG, self.action_name, elapsed=elapsed, detail=detail, logfile=filename)
@@ -751,7 +740,7 @@ class ChildJob:
                 self._send_message(_MessageType.CHILD_DATA, self.child_process_data())
                 self._child_send_result(result)
 
-                elapsed = datetime.datetime.now() - starttime
+                elapsed = datetime.datetime.now() - timeinfo.start_time
                 self.message(MessageType.SUCCESS, self.action_name, elapsed=elapsed, logfile=filename)
 
                 # Shutdown needs to stay outside of the above context manager,