Merge pull request #255 from ecmwf-projects/COPDS-2777-dep-exc-logs

Ensure dependencies exceptions are correctly logged

Author: mcucchi9

cads_processing_api_service/clients.py

@@ -89,7 +89,9 @@ def get_processes(
         ),
         cursor: str | None = fastapi.Query(None, include_in_schema=False),
         back: bool | None = fastapi.Query(None, include_in_schema=False),
-        portals: tuple[str] | None = fastapi.Depends(utils.get_portals),
+        portals: tuple[str] | None = fastapi.Depends(
+            exceptions.exception_logger(utils.get_portals)
+        ),
     ) -> ogc_api_processes_fastapi.models.ProcessList:
         """Implement OGC API - Processes `GET /processes` endpoint.
 
@@ -146,7 +148,9 @@ def get_process(
         self,
         response: fastapi.Response,
         process_id: str = fastapi.Path(..., description="Process identifier."),
-        portals: tuple[str] | None = fastapi.Depends(utils.get_portals),
+        portals: tuple[str] | None = fastapi.Depends(
+            exceptions.exception_logger(utils.get_portals)
+        ),
     ) -> ogc_api_processes_fastapi.models.ProcessDescription:
         """Implement OGC API - Processes `GET /processes/{process_id}` endpoint.
 
@@ -200,7 +204,9 @@ def post_process_execution(
         request: fastapi.Request,
         process_id: str = fastapi.Path(..., description="Process identifier."),
         execution_content: models.Execute = fastapi.Body(...),
-        auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+        auth_info: models.AuthInfo = fastapi.Depends(
+            exceptions.exception_logger(auth.get_auth_info)
+        ),
     ) -> models.StatusInfo:
         """Implement OGC API - Processes `POST /processes/{process_id}/execution` endpoint.
 
@@ -355,7 +361,9 @@ def get_jobs(
         ),
         cursor: str | None = fastapi.Query(None, include_in_schema=False),
         back: bool | None = fastapi.Query(None, include_in_schema=False),
-        auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+        auth_info: models.AuthInfo = fastapi.Depends(
+            exceptions.exception_logger(auth.get_auth_info)
+        ),
     ) -> models.JobList:
         """Implement OGC API - Processes `GET /jobs` endpoint.
 
@@ -488,7 +496,9 @@ def get_job(
             alias="logStartTime",
             description="Datetime of the first log message to be returned.",
         ),
-        auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+        auth_info: models.AuthInfo = fastapi.Depends(
+            exceptions.exception_logger(auth.get_auth_info)
+        ),
     ) -> models.StatusInfo:
         """Implement OGC API - Processes `GET /jobs/{job_id}` endpoint.
 
@@ -614,7 +624,9 @@ def get_job(
     def get_job_results(
         self,
         job_id: str = fastapi.Path(..., description="Job identifier."),
-        auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+        auth_info: models.AuthInfo = fastapi.Depends(
+            exceptions.exception_logger(auth.get_auth_info)
+        ),
     ) -> ogc_api_processes_fastapi.models.Results:
         """Implement OGC API - Processes `GET /jobs/{job_id}/results` endpoint.
 
@@ -677,7 +689,9 @@ def get_job_results(
     def delete_job(
         self,
         job_id: str = fastapi.Path(..., description="Job identifier."),
-        auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+        auth_info: models.AuthInfo = fastapi.Depends(
+            exceptions.exception_logger(auth.get_auth_info)
+        ),
     ) -> models.StatusInfo:
         """Implement OGC API - Processes `DELETE /jobs/{job_id}` endpoint.
 

cads_processing_api_service/endpoints.py

@@ -30,7 +30,9 @@
 def apply_constraints(
     process_id: str = fastapi.Path(..., description="Process identifier."),
     execution_content: models.Execute = fastapi.Body(...),
-    portals: tuple[str] | None = fastapi.Depends(utils.get_portals),
+    portals: tuple[str] | None = fastapi.Depends(
+        exceptions.exception_logger(utils.get_portals)
+    ),
 ) -> dict[str, Any]:
     request = execution_content.model_dump()
     table = cads_catalogue.database.Resource
@@ -66,7 +68,9 @@ def estimate_cost(
     ),
     mandatory_inputs: bool = fastapi.Query(False, include_in_schema=False),
     execution_content: models.Execute = fastapi.Body(...),
-    portals: tuple[str] | None = fastapi.Depends(utils.get_portals),
+    portals: tuple[str] | None = fastapi.Depends(
+        exceptions.exception_logger(utils.get_portals)
+    ),
 ) -> models.RequestCost:
     """
     Estimate the cost with the highest cost/limit ratio of the request.
@@ -144,7 +148,9 @@ def get_api_request(
 @exceptions.exception_logger
 def delete_jobs(
     request: models.DeleteJobs = fastapi.Body(...),
-    auth_info: models.AuthInfo = fastapi.Depends(auth.get_auth_info),
+    auth_info: models.AuthInfo = fastapi.Depends(
+        exceptions.exception_logger(auth.get_auth_info)
+    ),
 ) -> models.JobList:
     """Delete jobs from the processing queue.
 

cads_processing_api_service/exceptions.py

@@ -66,6 +66,13 @@ class RateLimitExceeded(ogc_api_processes_fastapi.exceptions.OGCAPIException):
 
 
 def exception_logger(f: Callable[..., Any]) -> Callable[..., Any]:
+    """Log exceptions raised by the decorated function.
+
+    Using this instead of logging exceptions in the exceptions handler avoids
+    including starlette-related tracebacks in the logs, which are not useful
+    and typically very long.
+    """
+
     @functools.wraps(f)
     def wrapper(*args: Any, **kwargs: Any) -> Any:
         try: