fix(api): split up worker name and job name to avoid logging false failures

api/onnx_web/chain/correct_gfpgan.py

@@ -53,7 +53,7 @@ class CorrectGFPGANStage(BaseStage):
 
     def run(
         self,
-        job: WorkerContext,
+        worker: WorkerContext,
         server: ServerContext,
         stage: StageParams,
         _params: ImageParams,
@@ -70,7 +70,7 @@ class CorrectGFPGANStage(BaseStage):
             return sources
 
         logger.info("correcting faces with GFPGAN model: %s", upscale.correction_model)
-        device = job.get_device()
+        device = worker.get_device()
         gfpgan = self.load(server, stage, upscale, device)
 
         outputs = []

api/onnx_web/worker/context.py

@@ -15,7 +15,8 @@ ProgressCallback = Callable[[int, int, Any], None]
 
 class WorkerContext:
     cancel: "Value[bool]"
-    job: str
+    job: Optional[str]
+    name: str
     pending: "Queue[JobCommand]"
     active_pid: "Value[int]"
     progress: "Queue[ProgressCommand]"
@@ -26,7 +27,7 @@ class WorkerContext:
 
     def __init__(
         self,
-        job: str,
+        name: str,
         device: DeviceParams,
         cancel: "Value[bool]",
         logs: "Queue[str]",
@@ -35,7 +36,7 @@ class WorkerContext:
         active_pid: "Value[int]",
         idle: "Value[bool]",
     ):
-        self.job = job
+        self.name = name
         self.device = device
         self.cancel = cancel
         self.progress = progress
@@ -96,56 +97,65 @@ class WorkerContext:
             self.idle.value = idle
 
     def set_progress(self, progress: int) -> None:
+        if self.job is None:
+            raise RuntimeError("no job on which to set progress")
+
         if self.is_cancelled():
             raise RuntimeError("job has been cancelled")
-        else:
-            logger.debug("setting progress for job %s to %s", self.job, progress)
-            self.last_progress = ProgressCommand(
-                self.job,
-                self.device.device,
-                False,
-                progress,
-                self.is_cancelled(),
-                False,
-            )
 
-            self.progress.put(
+        logger.debug("setting progress for job %s to %s", self.job, progress)
-                self.last_progress,
-                block=False,
-            )
-
-    def finish(self) -> None:
-        logger.debug("setting finished for job %s", self.job)
         self.last_progress = ProgressCommand(
             self.job,
             self.device.device,
-            True,
+            False,
-            self.get_progress(),
+            progress,
             self.is_cancelled(),
             False,
         )
+
         self.progress.put(
             self.last_progress,
             block=False,
         )
 
-    def fail(self) -> None:
+    def finish(self) -> None:
-        logger.warning("setting failure for job %s", self.job)
+        if self.job is None:
-        try:
+            logger.warning("setting finished without an active job")
+        else:
+            logger.debug("setting finished for job %s", self.job)
             self.last_progress = ProgressCommand(
                 self.job,
                 self.device.device,
                 True,
                 self.get_progress(),
                 self.is_cancelled(),
-                True,
+                False,
             )
             self.progress.put(
                 self.last_progress,
                 block=False,
             )
-        except Exception:
+
-            logger.exception("error setting failure on job %s", self.job)
+    def fail(self) -> None:
+        if self.job is None:
+            logger.warning("setting failure without an active job")
+        else:
+            logger.warning("setting failure for job %s", self.job)
+            try:
+                self.last_progress = ProgressCommand(
+                    self.job,
+                    self.device.device,
+                    True,
+                    self.get_progress(),
+                    self.is_cancelled(),
+                    True,
+                )
+                self.progress.put(
+                    self.last_progress,
+                    block=False,
+                )
+            except Exception:
+                logger.exception("error setting failure on job %s", self.job)
 
 
 class JobStatus: