json-error

Author: pcrespov

packages/models-library/src/models_library/rest_error.py

@@ -0,0 +1,30 @@
+from typing import Annotated
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .basic_types import IDStr
+
+
+class ErrorGet(BaseModel):
+    msg: Annotated[
+        str, Field(min_length=5, description="Message displayed to the user")
+    ]
+    support_id: Annotated[
+        IDStr | None,
+        Field(description="ID to track the incident during support", alias="supportId"),
+    ] = None
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra="ignore",  # Used to prune extra fields from internal data
+        frozen=True,
+        json_schema_extra={
+            "examples": [
+                {"msg": "Sorry you do not have sufficient access rights for product"},
+                {
+                    "msg": "Opps this error was unexpected. We are working on that!",
+                    "supportId": "OEC:12346789",
+                },
+            ]
+        },
+    )

services/web/server/src/simcore_service_webserver/exceptions_handlers_http_error_map.py

@@ -3,6 +3,10 @@
 from typing import NamedTuple, TypeAlias
 
 from aiohttp import web
+from common_library.error_codes import create_error_code
+from common_library.json_serialization import json_dumps
+from models_library.basic_types import IDStr
+from models_library.rest_error import ErrorGet
 from servicelib.aiohttp.web_exceptions_extension import get_all_aiohttp_http_exceptions
 from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from servicelib.status_codes_utils import is_5xx_server_error
@@ -68,11 +72,15 @@ async def _exception_handler(
             _DefaultDict(getattr(exception, "__dict__", {}))
         )
 
+        error = ErrorGet(msg=user_msg)
+
         if is_5xx_server_error(status_code):
+            oec = create_error_code(exception)
             _logger.exception(
                 **create_troubleshotting_log_kwargs(
                     user_msg,
                     error=exception,
+                    error_code=oec,
                     error_context={
                         "request": request,
                         "request.remote": f"{request.remote}",
@@ -81,16 +89,11 @@ async def _exception_handler(
                     },
                 )
             )
+            error = ErrorGet(msg=user_msg, support_id=IDStr(oec))
 
-        # TODO: make this part customizable? e.g. so we can inject e.g. oec?
-        # TODO: connect with ErrorModel
         return web.json_response(
-            {
-                "error": {
-                    "msg": user_msg,
-                }
-            },
-            status=status_code,
+            data={"error": error.model_dump(exclude_unset=True, mode="json")},
+            dumps=json_dumps,
         )
 
     return _exception_handler

services/web/server/tests/unit/isolated/test_exceptions_handlers.py

@@ -12,6 +12,7 @@
 from aiohttp import web
 from aiohttp.test_utils import make_mocked_request
 from servicelib.aiohttp import status
+from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from simcore_service_webserver.errors import WebServerBaseError
 from simcore_service_webserver.exceptions_handlers import (
     ExceptionToHttpErrorMap,
@@ -94,7 +95,8 @@ async def test_factory__create_exception_handler_from_http_error(
     response = await one_error_to_404(fake_request, caught)
     assert response.status == status.HTTP_404_NOT_FOUND
     assert response.text is not None
-    assert "one error message" in response.text
+    assert "one error message" in response.reason
+    assert response.content_type == MIMETYPE_APPLICATION_JSON
 
 
 async def test_factory__create_exception_handler_from_http_error_map(
@@ -111,12 +113,10 @@ async def test_factory__create_exception_handler_from_http_error_map(
     )
 
     # Converts exception in map
-    with pytest.raises(web.HTTPBadRequest) as exc_info:
-        await exc_handler(fake_request, OneError())
 
-    got_exc = exc_info.value
-    assert isinstance(got_exc, web.HTTPBadRequest)
-    assert got_exc.reason == "Error One mapped to 400"
+    response = await exc_handler(fake_request, OneError())
+    assert response.status == status.HTTP_400_BAD_REQUEST
+    assert response.reason == "Error One mapped to 400"
 
     # By-passes exceptions not listed
     err = RuntimeError()