[DOP-29112] rename filters

Author: TiGrib

data_rentgen/db/repositories/run.py

@@ -94,8 +94,8 @@ async def paginate(
         job_id: int | None,
         parent_run_id: UUID | None,
         search_query: str | None,
-        job_types: Collection[str],
-        statuses: Collection[str],
+        job_type: Collection[str],
+        status: Collection[str],
     ) -> PaginationDTO[Run]:
         # do not use `tuple_(Run.created_at, Run.id).in_(...),
         # as this is too complex filter for Postgres to make an optimal query plan
@@ -132,9 +132,9 @@ async def paginate(
             where.append(Run.job_id == job_id)
         if parent_run_id:
             where.append(Run.parent_run_id == parent_run_id)
-        if statuses:
-            serialize_statuses: Collection[RunStatus] = [RunStatus[status] for status in statuses]
-            where.append(Run.status == any_(serialize_statuses))  # type: ignore[arg-type]
+        if status:
+            serialize_status: Collection[RunStatus] = [RunStatus[status] for status in status]
+            where.append(Run.status == any_(serialize_status))  # type: ignore[arg-type]
 
         query: Select | CompoundSelect
         order_by: list[ColumnElement | SQLColumnExpression]
@@ -165,8 +165,8 @@ async def paginate(
             query = select(Run).where(*where)
             order_by = [Run.created_at.desc(), Run.id.desc()]
 
-        if job_types:
-            query = query.join(Job, Run.job_id == Job.id).where(Job.type == any_(job_types))  # type: ignore[arg-type]
+        if job_type:
+            query = query.join(Job, Run.job_id == Job.id).where(Job.type == any_(job_type))  # type: ignore[arg-type]
 
         options = [selectinload(Run.started_by_user)]
         return await self._paginate_by_query(

data_rentgen/server/api/v1/router/run.py

@@ -39,8 +39,8 @@ async def runs(
         job_id=query_args.job_id,
         parent_run_id=query_args.parent_run_id,
         search_query=query_args.search_query,
-        job_types=query_args.job_types,
-        statuses=query_args.statuses,
+        job_type=query_args.job_type,
+        status=query_args.status,
     )
     return PageResponseV1[RunDetailedResponseV1].from_pagination(pagination)
 

data_rentgen/server/schemas/v1/run.py

@@ -147,12 +147,12 @@ class RunsQueryV1(PaginateQueryV1):
         examples=["01913217-b761-7b1a-bb52-489da9c8b9c8"],
     )
 
-    job_types: list[str] = Field(
+    job_type: list[str] = Field(
         default_factory=list,
         description="Filter runs by type of a Job",
         examples=["SPARK_APPLICATION", "AIRFLOW_TASK"],
     )
-    statuses: list[RunStatusForQueryV1] = Field(default_factory=list, description="Filter runs by status")
+    status: list[RunStatusForQueryV1] = Field(default_factory=list, description="Filter runs by status")
 
     search_query: str | None = Field(
         default=None,

data_rentgen/server/services/run.py

@@ -80,8 +80,8 @@ async def paginate(
         job_id: int | None,
         parent_run_id: UUID | None,
         search_query: str | None,
-        job_types: Collection[str],
-        statuses: Collection[str],
+        job_type: Collection[str],
+        status: Collection[str],
     ) -> RunServicePaginatedResult:
         pagination = await self._uow.run.paginate(
             page=page,
@@ -92,8 +92,8 @@ async def paginate(
             job_id=job_id,
             parent_run_id=parent_run_id,
             search_query=search_query,
-            job_types=job_types,
-            statuses=statuses,
+            job_type=job_type,
+            status=status,
         )
         run_ids = [item.id for item in pagination.items]
         input_stats = await self._uow.input.get_stats_by_run_ids(run_ids)

docs/changelog/next_release/322.improvement.rst

@@ -0,0 +1,4 @@
+Add new query parameters for ``/api/v1/runs`` endpoint:
+
+- job_type: ``list[str]`` - filter by corresponding job type. For example ``SPARK_APLICATION``. You can use ``/api/v1/jobs/types`` to get all job types.
+- status:``list[RunStatus]`` - filter by runs statuses.

tests/test_server/fixtures/factories/run.py

@@ -195,10 +195,13 @@ async def runs_search(
         {"name": "airflow_dag_name", "type": "AIRFLOW_DAG"},
     ]
     runs_kwargs = [
-        {"external_id": "application_1638922609021_0001", "status": 3},
-        {"external_id": "application_1638922609021_0002", "status": 1},
-        {"external_id": "extract_task_0001", "status": 0},
-        {"external_id": "extract_task_0002", "status": 2},
+        {"external_id": "application_1638922609021_0001", "status": RunStatus.KILLED},
+        {
+            "external_id": "application_1638922609021_0002",
+            "status": RunStatus.SUCCEEDED,
+        },
+        {"external_id": "extract_task_0001", "status": RunStatus.STARTED},
+        {"external_id": "extract_task_0002", "status": RunStatus.FAILED},
     ]
     started_at = datetime.now(tz=UTC)
     async with async_session_maker() as async_session:

tests/test_server/test_runs/test_get_runs.py

@@ -36,8 +36,8 @@ async def test_get_runs_missing_fields(
                     "message": "Value error, input should contain either 'since', 'run_id', 'job_id', 'parent_run_id' or 'search_query' field",
                     "context": {},
                     "input": {
-                        "statuses": [],
-                        "job_types": [],
+                        "status": [],
+                        "job_type": [],
                         "page": 1,
                         "page_size": 20,
                         "run_id": [],

tests/test_server/test_runs/test_get_runs_by_job_id.py

@@ -38,8 +38,8 @@ async def test_get_runs_by_job_id_missing_since(
                     "message": "Value error, 'job_id' can be passed only with 'since'",
                     "context": {},
                     "input": {
-                        "statuses": [],
-                        "job_types": [],
+                        "status": [],
+                        "job_type": [],
                         "page": 1,
                         "page_size": 20,
                         "job_id": str(new_run.job_id),

tests/test_server/test_runs/test_get_runs_by_parent_run_id.py

@@ -38,8 +38,8 @@ async def test_get_runs_by_job_id_missing_since(
                     "message": "Value error, 'parent_run_id' can be passed only with 'since'",
                     "context": {},
                     "input": {
-                        "statuses": [],
-                        "job_types": [],
+                        "status": [],
+                        "job_type": [],
                         "page": 1,
                         "page_size": 20,
                         "parent_run_id": str(new_run.parent_run_id),

tests/test_server/test_runs/test_search_runs.py

@@ -37,8 +37,8 @@ async def test_search_runs_missing_since(
                     "message": "Value error, 'search_query' can be passed only with 'since'",
                     "context": {},
                     "input": {
-                        "statuses": [],
-                        "job_types": [],
+                        "status": [],
+                        "job_type": [],
                         "page": 1,
                         "page_size": 20,
                         "run_id": [],
@@ -200,7 +200,7 @@ async def test_search_runs_by_job_type(
         headers={"Authorization": f"Bearer {mocked_user.access_token}"},
         params={
             "since": since.isoformat(),
-            "job_types": ["SPARK_APPLICATION"],
+            "job_type": ["SPARK_APPLICATION"],
         },
     )
 
@@ -251,7 +251,6 @@ async def test_search_runs_by_status(
 ) -> None:
     runs = await enrich_runs(
         [
-            # runs sorted by id in descending order
             runs_search["extract_task_0001"],
             runs_search["application_1638922609021_0002"],
         ],
@@ -264,7 +263,7 @@ async def test_search_runs_by_status(
         headers={"Authorization": f"Bearer {mocked_user.access_token}"},
         params={
             "since": since.isoformat(),
-            "statuses": ["SUCCEEDED", "STARTED"],
+            "status": ["SUCCEEDED", "STARTED"],
         },
     )