[DOP-34830] Add job to GET /v1/runs response

Author: dolfinus

data_rentgen/db/repositories/run.py

@@ -17,7 +17,7 @@
 from sqlalchemy.dialects.postgresql import insert
 from sqlalchemy.orm import aliased, selectinload
 
-from data_rentgen.db.models import Job, Run, RunStartReason, RunStatus, User
+from data_rentgen.db.models import Job, Location, Run, RunStartReason, RunStatus, User
 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 PaginationDTO, RunDTO
@@ -33,6 +33,7 @@
         Run.created_at <= bindparam("until"),
         Run.id == any_(bindparam("run_ids")),
     )
+    .options(selectinload(Run.job).joinedload(Job.location).selectinload(Location.addresses))
     .options(selectinload(Run.started_by_user))
 )
 
@@ -43,6 +44,7 @@
         Run.created_at >= bindparam("since"),
         Run.job_id == any_(bindparam("job_ids")),
     )
+    .options(selectinload(Run.job).joinedload(Job.location).selectinload(Location.addresses))
     .options(selectinload(Run.started_by_user))
 )
 
@@ -253,7 +255,10 @@ async def paginate(  # noqa: PLR0912, C901, PLR0915
             # place the most recent runs on top
             order_by = [desc("search_rank"), desc("created_at"), desc("id")]
 
-        options = [selectinload(Run.started_by_user)]
+        options = [
+            selectinload(Run.job).joinedload(Job.location).selectinload(Location.addresses),
+            selectinload(Run.started_by_user),
+        ]
         return await self._paginate_by_query(
             query=query,
             order_by=order_by,

data_rentgen/server/schemas/v1/job.py

@@ -6,24 +6,12 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from data_rentgen.server.schemas.v1.location import LocationResponseV1
+from data_rentgen.server.schemas.v1.job_response import JobResponseV1
 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
 
 
-class JobResponseV1(BaseModel):
-    """Job response"""
-
-    id: str = Field(description="Job id", coerce_numbers_to_str=True)
-    parent_job_id: str | None = Field(description="Parent job id", coerce_numbers_to_str=True, default=None)
-    location: LocationResponseV1 = Field(description="Corresponding Location")
-    name: str = Field(description="Job name")
-    type: str = Field(description="Job type")
-
-    model_config = ConfigDict(from_attributes=True)
-
-
 class JobDetailedResponseV1(BaseModel):
     id: str = Field(description="Job id", coerce_numbers_to_str=True)
     data: JobResponseV1 = Field(description="Job data")

data_rentgen/server/schemas/v1/job_response.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2024-present MTS PJSC
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from data_rentgen.server.schemas.v1.location import LocationResponseV1
+
+
+class JobResponseV1(BaseModel):
+    """Job response"""
+
+    id: str = Field(description="Job id", coerce_numbers_to_str=True)
+    parent_job_id: str | None = Field(description="Parent job id", coerce_numbers_to_str=True, default=None)
+    location: LocationResponseV1 = Field(description="Corresponding Location")
+    name: str = Field(description="Job name")
+    type: str = Field(description="Job type")
+
+    model_config = ConfigDict(from_attributes=True)

data_rentgen/server/schemas/v1/run.py

@@ -17,6 +17,7 @@
     model_validator,
 )
 
+from data_rentgen.server.schemas.v1.job_response import JobResponseV1
 from data_rentgen.server.schemas.v1.pagination import PaginateQueryV1
 from data_rentgen.server.schemas.v1.user import UserResponseV1
 
@@ -125,6 +126,7 @@ class RunDetailedResponseV1(BaseModel):
 
     id: UUID = Field(description="Run id")
     data: RunResponseV1 = Field(description="Run data")
+    job: JobResponseV1 = Field(description="Job the run is belongs to")
     statistics: RunStatisticsReponseV1 = Field(description="Run statistics")
 
     model_config = ConfigDict(from_attributes=True)

data_rentgen/server/services/run.py

@@ -9,7 +9,7 @@
 from fastapi import Depends
 from sqlalchemy import Row
 
-from data_rentgen.db.models import Run, RunStatus
+from data_rentgen.db.models import Job, Run, RunStatus
 from data_rentgen.dto.pagination import PaginationDTO
 from data_rentgen.services.uow import UnitOfWork
 
@@ -59,6 +59,7 @@ class RunServiceStatistics:
 class RunServicePageItem:
     id: UUID
     data: Run
+    job: Job
     statistics: RunServiceStatistics
 
 
@@ -120,6 +121,7 @@ async def paginate(
                 RunServicePageItem(
                     id=run.id,
                     data=run,
+                    job=run.job,
                     statistics=RunServiceStatistics(
                         inputs=RunServiceIOStatistics.from_row(input_stats.get(run.id)),
                         outputs=RunServiceIOStatistics.from_row(output_stats.get(run.id)),

docs/changelog/next_release/411.feature.rst

@@ -0,0 +1,65 @@
+Add ``job`` to ``GET /v1/runs`` response.
+
+Before:
+
+.. code:: 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": "01908224-8410-79a2-8de6-a769ad6944c9",
+                "data": {
+                    "id": "01908224-8410-79a2-8de6-a769ad6944c9",
+                    "created_at": "2024-07-05T09:05:49.584000",
+                    "job_id": "123",
+                    ...
+                },
+                "statistics": { ... }
+            }
+        ]
+    }
+
+
+After:
+
+.. code:: 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": "01908224-8410-79a2-8de6-a769ad6944c9",
+                "data": {
+                    "id": "01908224-8410-79a2-8de6-a769ad6944c9",
+                    "created_at": "2024-07-05T09:05:49.584000",
+                    "job_id": "123",
+                    ...
+                },
+                "job": {
+                    "id": "123",
+                    "name": "myjob",
+                    ...
+                },
+                "statistics": { ... }
+            }
+        ]
+    }

tests/test_server/fixtures/factories/run.py

@@ -159,6 +159,7 @@ async def runs_with_same_parent(
     request: pytest.FixtureRequest,
     async_session_maker: Callable[[], AbstractAsyncContextManager[AsyncSession]],
     user: User,
+    job: Job,
 ) -> AsyncGenerator[list[Run], None]:
     size, params = request.param
     started_at = datetime.now(tz=UTC)
@@ -169,6 +170,7 @@ async def runs_with_same_parent(
             await create_run(
                 async_session,
                 run_kwargs={
+                    "job_id": job.id,
                     "parent_run_id": parent_run_id,
                     # To be sure runs has different timestamps
                     "created_at": started_at + timedelta(seconds=s),

tests/test_server/test_runs/test_get_runs.py

@@ -9,7 +9,7 @@
 from data_rentgen.db.models.run import Run
 from data_rentgen.utils.uuid import generate_new_uuid
 from tests.fixtures.mocks import MockedUser
-from tests.test_server.utils.convert_to_json import run_to_json
+from tests.test_server.utils.convert_to_json import job_to_json, run_to_json
 from tests.test_server.utils.enrich import enrich_runs
 
 pytestmark = [pytest.mark.server, pytest.mark.asyncio]
@@ -119,6 +119,7 @@ async def test_get_runs_with_since(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -179,6 +180,7 @@ async def test_get_runs_with_until(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -243,6 +245,7 @@ async def test_get_runs_with_job_type(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -292,6 +295,7 @@ async def test_get_runs_with_job_type(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -356,6 +360,7 @@ async def test_get_runs_with_status(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -404,6 +409,7 @@ async def test_get_runs_with_status(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -469,6 +475,7 @@ async def test_get_runs_with_started_at(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -535,6 +542,7 @@ async def test_get_runs_with_ended_at(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -601,6 +609,7 @@ async def test_get_runs_with_location_id(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -650,6 +659,7 @@ async def test_get_runs_with_location_id(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -715,6 +725,7 @@ async def test_get_runs_with_started_by_user(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -764,6 +775,7 @@ async def test_get_runs_with_started_by_user(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,

tests/test_server/test_runs/test_get_runs_by_id.py

@@ -7,7 +7,7 @@
 
 from data_rentgen.db.models import Run
 from tests.fixtures.mocks import MockedUser
-from tests.test_server.utils.convert_to_json import run_to_json
+from tests.test_server.utils.convert_to_json import job_to_json, run_to_json
 from tests.test_server.utils.enrich import enrich_runs
 from tests.test_server.utils.lineage_result import LineageResult
 
@@ -71,6 +71,7 @@ async def test_get_runs_by_one_id(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -124,6 +125,7 @@ async def test_get_runs_by_multiple_ids(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -222,6 +224,7 @@ async def test_get_runs_by_multiple_ids_with_stats(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": input_stats[run.id],
                     "outputs": output_stats[run.id],

tests/test_server/test_runs/test_get_runs_by_job_id.py

@@ -7,7 +7,7 @@
 
 from data_rentgen.db.models import Job, Run
 from tests.fixtures.mocks import MockedUser
-from tests.test_server.utils.convert_to_json import run_to_json
+from tests.test_server.utils.convert_to_json import job_to_json, run_to_json
 from tests.test_server.utils.enrich import enrich_runs
 
 pytestmark = [pytest.mark.server, pytest.mark.asyncio]
@@ -126,6 +126,7 @@ async def test_get_runs_by_job_id(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,
@@ -187,6 +188,7 @@ async def test_get_runs_by_job_id_with_until(
             {
                 "id": str(run.id),
                 "data": run_to_json(run),
+                "job": job_to_json(run.job),
                 "statistics": {
                     "inputs": {
                         "total_datasets": 0,