If checkSuite is completed, we should stop tracking the queued job (#45)

* If checkSuit is completed, we should stop tracking the queued job

Author: gerardsegarra

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v5.0.0
   hooks:
   - id: trailing-whitespace
   - id: check-docstring-first
@@ -11,11 +11,6 @@ repos:
   - id: check-yaml
   - id: debug-statements
   - id: end-of-file-fixer
-- repo: https://github.com/myint/docformatter
-  rev: v1.7.5
-  hooks:
-  - id: docformatter
-    args: [--in-place]
 - repo: https://github.com/asottile/pyupgrade
   rev: v3.15.2
   hooks:

src/app.py

@@ -136,7 +136,10 @@ def monitor_jobs():
 
         for job_data in jobs_data["nodes"]:
             job = job_handler.queued.get(job_data["id"])
-            if job_data["status"] != "QUEUED":
+            if (
+                job_data.get("checkSuite", {}).get("status") == "COMPLETED"
+                or job_data["status"] != "QUEUED"
+            ):
                 job = job_handler.queued.pop(job_data["id"], None)
                 app.logger.info(
                     f"Job {job_data['id']} is no longer queued {job_data['status']}"

src/query_graphql.py

@@ -32,6 +32,7 @@ def query_jobs(node_id_list: List[str]):
                   name
                 }
                 checkSuite {
+                  status
                   workflowRun {
                     event
                     runNumber

tests/test_app.py

@@ -68,12 +68,14 @@ def test_monitor_jobs(
             {
                 "id": "workflow_id_queued",
                 "status": "QUEUED",
+                "checkSuite": {"status": "IN_PROGRESS"},
                 "startedAt": "2024-04-29T12:43:16Z",
                 "completedAt": None,
             },
             {
                 "id": "workflow_id_in_progress",
                 "status": "IN_PROGRESS",
+                "checkSuite": {"status": "IN_PROGRESS"},
                 "startedAt": "2024-04-29T12:43:32Z",
                 "completedAt": None,
             },
@@ -86,3 +88,31 @@ def test_monitor_jobs(
     assert in_progress_job.status == "in_progress"
     assert in_progress_job.in_progress_at is not None
     send_queued_metric_mock.assert_called()
+
+
+@patch("jobs.Job.send_queued_metric")
+@patch("app.query_jobs")
+def test_monitor_jobs_completed_suit(
+    query_jobs_mock, send_queued_metric_mock, queued_job
+):
+    app.job_handler = JobEventsHandler()
+    app.job_handler.queued = {
+        "workflow_id_queued": queued_job,
+    }
+
+    query_jobs_mock.return_value = {
+        "nodes": [
+            {
+                "id": "workflow_id_queued",
+                "status": "QUEUED",
+                "checkSuite": {"status": "COMPLETED"},
+                "startedAt": "2024-04-29T12:43:16Z",
+                "completedAt": None,
+            }
+        ]
+    }
+
+    monitor_jobs()
+
+    assert "workflow_id_queued" not in app.job_handler.queued
+    send_queued_metric_mock.assert_called()