[DOP-31843] add last run for /jobs response (#387)

Author: TiGrib

data_rentgen/db/models/job.py

@@ -1,6 +1,8 @@
 # SPDX-FileCopyrightText: 2024-present MTS PJSC
 # SPDX-License-Identifier: Apache-2.0
 
+from typing import TYPE_CHECKING
+
 from sqlalchemy import BigInteger, Column, Computed, ForeignKey, Index, String, Table, column, func, select
 from sqlalchemy.dialects.postgresql import TSVECTOR
 from sqlalchemy.orm import Mapped, column_property, mapped_column, relationship
@@ -10,6 +12,9 @@
 from data_rentgen.db.models.location import Location
 from data_rentgen.db.models.tag_value import TagValue
 
+if TYPE_CHECKING:
+    from data_rentgen.db.models.run import Run
+
 JobTagValue: Table = Table(
     "job_tag_value",
     Base.metadata,
@@ -60,6 +65,19 @@ class Job(Base):
         doc="Job tag values",
     )
 
+    last_run: Mapped["Run | None"] = relationship(
+        "Run",
+        primaryjoin=(
+            "and_(Job.id == foreign(Run.job_id), "
+            "Run.id == select(Run.id).where(Run.job_id == Job.id)"
+            ".order_by(Run.created_at.desc(), Run.id.desc())"
+            ".limit(1).correlate_except(Run).scalar_subquery())"
+        ),
+        lazy="noload",
+        viewonly=True,
+        uselist=False,
+    )
+
     search_vector: Mapped[str] = mapped_column(
         TSVECTOR,
         Computed(

data_rentgen/db/repositories/job.py

@@ -27,7 +27,7 @@
 from sqlalchemy.dialects.postgresql import insert
 from sqlalchemy.orm import selectinload
 
-from data_rentgen.db.models import Address, Job, JobTagValue, Location, TagValue
+from data_rentgen.db.models import Address, Job, JobTagValue, Location, Run, TagValue
 from data_rentgen.db.repositories.base import Repository
 from data_rentgen.db.utils.search import make_tsquery, ts_match, ts_rank
 from data_rentgen.dto import JobDTO, PaginationDTO
@@ -165,6 +165,7 @@ async def paginate(
         options = [
             selectinload(Job.location).selectinload(Location.addresses),
             selectinload(Job.tag_values).selectinload(TagValue.tag),
+            selectinload(Job.last_run).selectinload(Run.started_by_user),
         ]
         return await self._paginate_by_query(
             query=query,

data_rentgen/server/schemas/v1/job.py

@@ -6,6 +6,7 @@
 
 from data_rentgen.server.schemas.v1.location import LocationResponseV1
 from data_rentgen.server.schemas.v1.pagination import PaginateQueryV1
+from data_rentgen.server.schemas.v1.run import RunResponseV1
 from data_rentgen.server.schemas.v1.tag import TagResponseV1
 
 
@@ -24,6 +25,7 @@ class JobDetailedResponseV1(BaseModel):
     id: str = Field(description="Job id", coerce_numbers_to_str=True)
     data: JobResponseV1 = Field(description="Job data")
     tags: list[TagResponseV1] = Field(default_factory=list, description="Job tags")
+    last_run: RunResponseV1 | None = Field(description="Last run of the job", default=None)
 
     model_config = ConfigDict(from_attributes=True)
 

data_rentgen/server/services/job.py

@@ -7,7 +7,7 @@
 
 from fastapi import Depends
 
-from data_rentgen.db.models import Location
+from data_rentgen.db.models import Location, Run
 from data_rentgen.dto.pagination import PaginationDTO
 from data_rentgen.server.services.tag import TagData, TagValueData
 from data_rentgen.services.uow import UnitOfWork
@@ -26,6 +26,7 @@ class JobServiceResult:
     id: int
     data: JobData
     tags: list[TagData]
+    last_run: Run | None
 
 
 class JobServicePaginatedResult(PaginationDTO[JobServiceResult]):
@@ -71,6 +72,7 @@ async def paginate(
                         type=job.type,
                         location=job.location,
                     ),
+                    last_run=job.last_run,
                     tags=[
                         TagData(
                             id=tag.id,

docs/changelog/next_release/387.improvement.rst

@@ -0,0 +1 @@
+Added ``last_run`` field to ``GET /v1/jobs`` endpoint response, showing the most recently started run for each job.

tests/test_server/test_jobs/test_get_jobs.py

@@ -4,10 +4,10 @@
 from httpx import AsyncClient
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from data_rentgen.db.models import Job
+from data_rentgen.db.models import Job, Run
 from tests.fixtures.mocks import MockedUser
-from tests.test_server.utils.convert_to_json import job_to_json, tag_values_to_json
-from tests.test_server.utils.enrich import enrich_jobs
+from tests.test_server.utils.convert_to_json import job_to_json, run_to_json, tag_values_to_json
+from tests.test_server.utils.enrich import enrich_jobs, enrich_runs
 
 pytestmark = [pytest.mark.server, pytest.mark.asyncio]
 
@@ -41,12 +41,50 @@ async def test_get_jobs_no_filters(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             }
             for job in sorted(jobs, key=lambda x: x.name)
         ],
     }
 
 
+async def test_get_jobs_with_last_run(
+    test_client: AsyncClient,
+    runs_with_same_job: list[Run],
+    async_session: AsyncSession,
+    mocked_user: MockedUser,
+):
+    last_run = max(runs_with_same_job, key=lambda x: x.created_at)
+    [last_run] = await enrich_runs([last_run], async_session)
+    [job] = await enrich_jobs([last_run.job], async_session)
+    response = await test_client.get(
+        "v1/jobs",
+        headers={"Authorization": f"Bearer {mocked_user.access_token}"},
+    )
+
+    assert response.status_code == HTTPStatus.OK, response.json()
+    assert response.json() == {
+        "meta": {
+            "page": 1,
+            "page_size": 20,
+            "total_count": 1,
+            "pages_count": 1,
+            "has_next": False,
+            "has_previous": False,
+            "next_page": None,
+            "previous_page": None,
+        },
+        "items": [
+            {
+                "id": str(job.id),
+                "data": job_to_json(job),
+                "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": run_to_json(last_run),
+            }
+        ],
+    }
+
+
 async def test_get_jobs_unauthorized(
     test_client: AsyncClient,
 ):

tests/test_server/test_jobs/test_get_jobs_by_id.py

@@ -71,6 +71,7 @@ async def test_get_jobs_by_one_id(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             },
         ],
     }
@@ -108,6 +109,7 @@ async def test_get_jobs_by_multiple_ids(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             }
             for job in sorted(selected_jobs, key=lambda x: x.name)
         ],

tests/test_server/test_jobs/test_get_jobs_by_location.py

@@ -46,6 +46,7 @@ async def test_get_jobs_by_location_id(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": [],
+                "last_run": None,
             }
             for job in [dag_job, task_job]
         ],
@@ -78,6 +79,7 @@ async def test_get_jobs_by_location_id(
                 "id": str(dag_job.id),
                 "data": job_to_json(dag_job),
                 "tags": tag_values_to_json(dag_job.tag_values) if dag_job.tag_values else [],
+                "last_run": None,
             },
         ],
     }
@@ -145,6 +147,7 @@ async def test_get_jobs_by_location_type(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             }
             for job in [dag_job, task_job]
         ],
@@ -177,6 +180,7 @@ async def test_get_jobs_by_location_type(
                 "id": str(dag_job.id),
                 "data": job_to_json(dag_job),
                 "tags": tag_values_to_json(dag_job.tag_values) if dag_job.tag_values else [],
+                "last_run": None,
             },
         ],
     }

tests/test_server/test_jobs/test_get_jobs_by_tag_value.py

@@ -47,6 +47,7 @@ async def test_get_jobs_by_one_id_with_tags(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(tag_values),
+                "last_run": None,
             },
         ],
     }
@@ -87,6 +88,7 @@ async def test_get_jobs_by_tag_value_id(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             },
         ],
     }
@@ -129,6 +131,7 @@ async def test_get_jobs_by_multiple_tag_value_ids(
                 "id": str(wanted_job.id),
                 "data": job_to_json(wanted_job),
                 "tags": tag_values_to_json(wanted_job.tag_values),
+                "last_run": None,
             },
         ],
     }

tests/test_server/test_jobs/test_get_jobs_by_type.py

@@ -59,6 +59,7 @@ async def test_get_jobs_by_job_type(
                 "id": str(job.id),
                 "data": job_to_json(job),
                 "tags": tag_values_to_json(job.tag_values) if job.tag_values else [],
+                "last_run": None,
             }
             for job in (dag_job, task_job)
         ],
@@ -91,6 +92,7 @@ async def test_get_jobs_by_job_type(
                 "id": str(dag_job.id),
                 "data": job_to_json(dag_job),
                 "tags": tag_values_to_json(dag_job.tag_values) if dag_job.tag_values else [],
+                "last_run": None,
             },
         ],
     }