Refined target loader report and logging (#506)

* fix: Better task reporting (upload)

* style: Log tweak - re-upload is now an error

---------

Co-authored-by: Alan Christie <alan.christie@matildapeak.com>

Author: alanbchristie

viewer/target_loader.py

@@ -149,7 +149,7 @@ def log(self, level: Level, message: str) -> None:
             logger.info(msg)
 
         self.stack.append(UploadReportEntry(level=level, message=message))
-        self._update_task(message)
+        self._update_task(self.json())
 
     def final(self, message, success=True):
         self.upload_state = UploadState.SUCCESS
@@ -166,18 +166,19 @@ def json(self):
         return [str(k) for k in self.stack]
 
     def _update_task(self, message: str | list) -> None:
-        if self.task:
-            try:
-                logger.debug("taskstuff %s", dir(self.task))
-                self.task.update_state(
-                    state=self.upload_state,
-                    meta={
-                        "description": message,
-                    },
-                )
-            except AttributeError:
-                # no task passed to method, nothing to do
-                pass
+        if not self.task:
+            return
+        try:
+            logger.debug("taskstuff %s", dir(self.task))
+            self.task.update_state(
+                state=self.upload_state,
+                meta={
+                    "description": message,
+                },
+            )
+        except AttributeError:
+            # no task passed to method, nothing to do
+            pass
 
 
 def _validate_bundle_against_mode(config_yaml: Dict[str, Any]) -> Optional[str]:
@@ -441,6 +442,13 @@ def __init__(
         self.target = None
         self.project = None
 
+        # Initial (reassuring message)
+        bundle_filename = os.path.basename(self.bundle_path)
+        self.report.log(
+            Level.INFO,
+            f"Created TargetLoader for '{bundle_filename}' proposal_ref='{proposal_ref}'",
+        )
+
     @property
     def final_path(self) -> Path:
         return self._final_path
@@ -1256,7 +1264,7 @@ def process_bundle(self):
             # remove uploaded file
             Path(self.bundle_path).unlink()
             msg = f"{self.bundle_name} already uploaded"
-            self.report.final(msg, success=False)
+            self.report.log(Level.FATAL, msg)
             raise FileExistsError(msg)
 
         if project_created and committer.pk == settings.ANONYMOUS_USER:
@@ -1622,6 +1630,11 @@ def load_target(
         target_loader = TargetLoader(
             data_bundle, proposal_ref, tempdir, user_id=user_id, task=task
         )
+
+        # Decompression can take some time, so we want to report progress
+        bundle_filename = os.path.basename(data_bundle)
+        target_loader.report.log(Level.INFO, f"Decompressing '{bundle_filename}'")
+
         try:
             # archive is first extracted to temporary dir and moved later
             with tarfile.open(target_loader.bundle_path, "r") as archive:
@@ -1636,6 +1649,8 @@ def load_target(
             target_loader.experiment_upload.message = exc.args[0]
             raise FileNotFoundError(msg) from exc
 
+        target_loader.report.log(Level.INFO, f"Decompressed '{bundle_filename}'")
+
         try:
             with transaction.atomic():
                 target_loader.process_bundle()

viewer/views.py

@@ -1607,15 +1607,19 @@ def get(self, request, task_id, *args, **kwargs):
             elif isinstance(result.info, list):
                 messages = result.info
 
-        # The task is considered to have failed
-        # if the word 'FAILED' is in the last line of the message (regardless of case)
+        started = result.state != 'PENDING'
+        finished = result.ready()
         task_status = "UNKNOWN"
-        if result.ready() and messages:
+        if finished and messages:
+            # The task is considered to have failed if the word 'FAILED'
+            # is in the last line of the message (regardless of case)
             task_status = "FAILED" if 'failed' in messages[-1].lower() else "SUCCESS"
+        elif started:
+            task_status = "RUNNING"
 
         data = {
-            'started': result.state != 'PENDING',
-            'finished': result.ready(),
+            'started': started,
+            'finished': finished,
             'status': task_status,
             'messages': messages,
         }