Feat/fastapi loggin route error detail

agave/fastapi/middlewares/loggin_route.py

@@ -16,16 +16,16 @@
 logger = logging.getLogger(__name__)
 
 
-def get_status_code_exception(exc: Exception) -> int:
+def get_exception_status_and_detail(exc: Exception) -> tuple[int, str]:
     if isinstance(exc, HTTPException):
-        return exc.status_code
+        return exc.status_code, str(exc.detail)
     if isinstance(exc, RequestValidationError):
-        return 422
+        return 422, str(exc.errors())
     if isinstance(exc, AgaveError):
-        return exc.status_code
+        return exc.status_code, str(exc.error)
     if isinstance(exc, CuencaError):
-        return exc.status_code
-    return 500
+        return exc.status_code, str(exc)
+    return 500, str(exc)
 
 
 class LoggingRoute(APIRoute):
@@ -65,8 +65,12 @@ async def logging_route_handler(request: Request) -> Response:
             try:
                 response = await original_route_handler(request)
             except Exception as exc:
+                status_code, error_detail = get_exception_status_and_detail(
+                    exc
+                )
                 log_data['response'] = {
-                    'status_code': get_status_code_exception(exc)
+                    'status_code': status_code,
+                    'error': error_detail,
                 }
                 raise
             else:

agave/version.py

@@ -1 +1 @@
-__version__ = '1.5.1'
+__version__ = '1.5.2'

tests/fastapi/test_loggin_route.py

@@ -1,3 +1,5 @@
+import ast
+import json
 import logging
 from tempfile import TemporaryFile
 
@@ -95,8 +97,11 @@ def test_logger_create_resource_bad_request(
     log_output = caplog.text
     log_data = extract_log_data(log_output)
 
-    assert log_data[0]['request']['body'] == request_data
-    assert log_data[0]['response']['status_code'] == 422
+    assert request_data == log_data[0]['request']['body']
+    assert response.status_code == log_data[0]['response']['status_code']
+    parsed_error = ast.literal_eval(log_data[0]['response']['error'])
+    normalized_error = json.loads(json.dumps(parsed_error))
+    assert response.json()['detail'] == normalized_error
 
 
 def test_logger_test_logger_retrieve_resource_not_found(
@@ -117,7 +122,8 @@ def test_logger_test_logger_retrieve_resource_not_found(
     log_data = extract_log_data(log_output)
 
     assert log_data[0]['request']['url'].endswith(f"/accounts/{resource_id}")
-    assert log_data[0]['response']['status_code'] == 404
+    assert response.status_code == log_data[0]['response']['status_code']
+    assert response.json()['error'] == log_data[0]['response']['error']
 
 
 def test_logger_upload_resource(fastapi_client: TestClient, caplog) -> None:
@@ -278,6 +284,7 @@ def test_logger_internal_server_error(
 
     assert log_data[0]['request']['body'] == request_data
     assert log_data[0]['response']['status_code'] == 500
+    assert log_data[0]['response']['error'] == 'Intentional server error'
 
 
 def test_logger_bad_request(fastapi_client: TestClient, caplog) -> None:
@@ -292,7 +299,9 @@ def test_logger_bad_request(fastapi_client: TestClient, caplog) -> None:
     log_output = caplog.text
     log_data = extract_log_data(log_output)
 
-    assert log_data[0]['request']['body'] == request_data
+    assert request_data == log_data[0]['request']['body']
+    assert response.status_code == log_data[0]['response']['status_code']
+    assert response.json()['detail'] == log_data[0]['response']['error']
 
 
 def test_logger_unauthorized(fastapi_client: TestClient, caplog) -> None:
@@ -307,4 +316,6 @@ def test_logger_unauthorized(fastapi_client: TestClient, caplog) -> None:
     log_output = caplog.text
     log_data = extract_log_data(log_output)
 
-    assert log_data[0]['request']['body'] == request_data
+    assert request_data == log_data[0]['request']['body']
+    assert response.status_code == log_data[0]['response']['status_code']
+    assert response.json()['error'] == log_data[0]['response']['error']