Fix a bug that prevents terminal status from being reported by the agent (kevoreilly#2753)

Updates the POST /status endpoint to unset the async subprocess if the new status is terminal. This makes GET /status report the final analysis state, rather than the child process state.

Author: josh-feather

agent/agent.py

@@ -92,6 +92,8 @@ def _missing_(cls, value):
         return None
 
 
+TERMINAL_STATUSES = [Status.COMPLETE, Status.FAILED, Status.EXCEPTION]
+
 AGENT_BROWSER_EXT_PATH = ""
 AGENT_BROWSER_LOCK = Lock()
 ANALYZER_FOLDER = ""
@@ -494,6 +496,11 @@ def put_status():
     except ValueError:
         return json_error(400, "No valid status has been provided")
 
+    # If the new status is terminal, unset the async subprocess so /status reports
+    # the final analysis state rather than the child process state.
+    if status in TERMINAL_STATUSES:
+        state["async_subprocess"] = None
+
     state["status"] = status
     state["description"] = request.form.get("description")
     return json_success("Analysis status updated")

agent/test_agent.py

@@ -639,6 +639,34 @@ def test_async_failure(self):
         js = self.confirm_status(str(agent.Status.FAILED))
         assert "process_id" not in js
 
+    def test_async_manual_status_override(self):
+        """Test that a manual status update overrides an in-progress async process."""
+        # Upload a Python file that sleeps for a short period, to ensure the
+        # async subprocess is running while we override the status.
+        file_contents = (
+            "import time",
+            "time.sleep(10)",
+        )
+
+        filepath = self.store_file(file_contents)
+        form = {"filepath": filepath, "async": 1}
+
+        execpy_resp = self.post_form("execpy", form)
+        assert execpy_resp.get("message") == "Successfully spawned command"
+
+        # While the subprocess is running, the status should initially be RUNNING.
+        self.confirm_status(str(agent.Status.RUNNING))
+
+        # Manually override the status to COMPLETE via POST /status.
+        override_form = {
+            "status": str(agent.Status.COMPLETE),
+            "description": "beep boop"
+        }
+        status_resp = self.post_form("status", override_form)
+        assert status_resp.get("message") == "Analysis status updated"
+
+        self.confirm_status(str(agent.Status.COMPLETE))
+
     def test_execute(self):
         """Test executing the 'date' command."""
         if sys.platform == "win32":