Merge pull request #253 from ecmwf-projects/COPDS-2727-status-rejected

Support status "rejected"

Author: mcucchi9

cads_processing_api_service/clients.py

@@ -334,12 +334,13 @@ def get_jobs(
                 "processes shall be included in the response."
             ),
         ),
-        status: list[models.StatusCode] | None = fastapi.Query(
+        status: list[models.SearchableStatusCode] | None = fastapi.Query(
             [
-                ogc_api_processes_fastapi.models.StatusCode.accepted,
-                ogc_api_processes_fastapi.models.StatusCode.running,
-                ogc_api_processes_fastapi.models.StatusCode.successful,
-                ogc_api_processes_fastapi.models.StatusCode.failed,
+                models.StatusCode.accepted,
+                models.StatusCode.running,
+                models.StatusCode.successful,
+                models.StatusCode.failed,
+                models.StatusCode.rejected,
             ],
             description=(
                 "Job statuses. Only jobs with the specified statuses shall be included in "
@@ -677,7 +678,7 @@ def delete_job(
         self,
         job_id: str = fastapi.Path(..., description="Job identifier."),
         auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
-    ) -> ogc_api_processes_fastapi.models.StatusInfo:
+    ) -> models.StatusInfo:
         """Implement OGC API - Processes `DELETE /jobs/{job_id}` endpoint.
 
         Dismiss the job identifed by `job_id`.
@@ -691,7 +692,7 @@ def delete_job(
 
         Returns
         -------
-        ogc_api_processes_fastapi.models.StatusInfo
+        models.StatusInfo
             Job status information
         """
         structlog.contextvars.bind_contextvars(user_uid=auth_info.user_uid)

cads_processing_api_service/models.py

@@ -36,6 +36,16 @@ class StatusCode(str, enum.Enum):
     running = "running"
     successful = "successful"
     failed = "failed"
+    rejected = "rejected"
+    dismissed = "dismissed"
+
+
+class SearchableStatusCode(str, enum.Enum):
+    accepted = "accepted"
+    running = "running"
+    successful = "successful"
+    failed = "failed"
+    rejected = "rejected"
 
 
 class StatusInfoMetadata(pydantic.BaseModel):
@@ -48,6 +58,7 @@ class StatusInfoMetadata(pydantic.BaseModel):
 
 
 class StatusInfo(ogc_api_processes_fastapi.models.StatusInfo):
+    status: StatusCode  # type: ignore
     metadata: StatusInfoMetadata | None = None
 
 

cads_processing_api_service/utils.py

@@ -395,8 +395,7 @@ def apply_limit(
 
 def make_cursor(
     entries: (
-        list[ogc_api_processes_fastapi.models.StatusInfo]
-        | list[ogc_api_processes_fastapi.models.ProcessSummary]
+        list[models.StatusInfo] | list[ogc_api_processes_fastapi.models.ProcessSummary]
     ),
     sort_key: str,
     page: str,
@@ -413,8 +412,7 @@ def make_cursor(
 
 def make_pagination_query_params(
     entries: (
-        list[ogc_api_processes_fastapi.models.StatusInfo]
-        | list[ogc_api_processes_fastapi.models.ProcessSummary]
+        list[models.StatusInfo] | list[ogc_api_processes_fastapi.models.ProcessSummary]
     ),
     sort_key: str,
 ) -> ogc_api_processes_fastapi.models.PaginationQueryParameters:
@@ -521,13 +519,18 @@ def get_results_from_job(
             asset_value["file:local_path"], config.DownloadNodesSettings().download_node
         )
         results = {"asset": {"value": asset_value}}
-    elif job_status == "failed":
+    elif job_status in ("failed", "rejected"):
         error_messages = get_job_events(
             job=job, session=session, event_type="user_visible_error"
         )
         traceback = "\n".join([message[1] for message in error_messages])
+        match job_status:
+            case "failed":
+                exc_title = "The job has failed"
+            case "rejected":
+                exc_title = "The job has been rejected"
         raise ogc_api_processes_fastapi.exceptions.JobResultsFailed(
-            title="The job has failed.",
+            title=exc_title,  # type: ignore
             status_code=fastapi.status.HTTP_400_BAD_REQUEST,
             traceback=traceback,
         )