cleanup

Author: pcrespov

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

@@ -1,11 +1,12 @@
-from .exception_handling_base import exception_handling_decorator
+from .exception_handling_base import ExceptionHandlersMap, exception_handling_decorator
 from .exception_handling_factory import (
     ExceptionToHttpErrorMap,
     HttpErrorInfo,
     to_exceptions_handlers_map,
 )
 
 __all__: tuple[str, ...] = (
+    "ExceptionHandlersMap",
     "ExceptionToHttpErrorMap",
     "HttpErrorInfo",
     "exception_handling_decorator",

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

@@ -44,10 +44,8 @@ def _sort_exceptions_by_specificity(
 
 
 class ExceptionHandlingContextManager(AbstractAsyncContextManager):
-    """
-
-    Essentially a dynamic try-except context manager to
-    handle exceptions raised by a aiohttp handler, i.e. roughly
+    """Essentially a dynamic try-except context manager to
+    handle exceptions raised by a web handler, i.e.
     ```
         try:
 
@@ -121,7 +119,10 @@ def get_response(self):
 def exception_handling_decorator(
     exception_handlers_map: dict[type[BaseException], AiohttpExceptionHandler]
 ):
-    """ """
+    """Creates a decorator to handle all registered exceptions raised in a given route handler
+
+    SEE usage example in test_exception_handling
+    """
 
     def _decorator(handler: WebHandler):
         @functools.wraps(handler)
@@ -145,6 +146,9 @@ async def _wrapper(request: web.Request) -> web.StreamResponse:
 def exception_handling_middleware(
     exception_handlers_map: dict[type[BaseException], AiohttpExceptionHandler]
 ) -> WebMiddleware:
+    """
+    Creates a middleware to handle all registered exceptions raised in any app's route
+    """
     _handle_excs = exception_handling_decorator(
         exception_handlers_map=exception_handlers_map
     )

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

@@ -7,25 +7,62 @@
 
 from collections.abc import Callable
 
+import pytest
 from aiohttp import web
+from models_library.rest_error import ErrorGet
 from servicelib.aiohttp import status
-from simcore_service_webserver.exception_handling import exception_handling_decorator
+from simcore_service_webserver.exception_handling import (
+    ExceptionHandlersMap,
+    HttpErrorInfo,
+    exception_handling_decorator,
+    to_exceptions_handlers_map,
+)
+
+
+@pytest.fixture
+def exception_handlers_map(build_method: str) -> ExceptionHandlersMap:
+    """
+    Two different ways to build the exception_handlers_map
+    """
+    exception_handlers_map: ExceptionHandlersMap = {}
+
+    if build_method == "custom":
+
+        async def _value_error_as_422(
+            request: web.Request, exception: BaseException
+        ) -> web.Response:
+            # custom exception handler
+            return web.json_response(
+                reason=f"{build_method=}", status=status.HTTP_422_UNPROCESSABLE_ENTITY
+            )
+
+        exception_handlers_map = {
+            ValueError: _value_error_as_422,
+        }
+
+    elif build_method == "http_map":
+        exception_handlers_map = to_exceptions_handlers_map(
+            {
+                ValueError: HttpErrorInfo(
+                    status.HTTP_422_UNPROCESSABLE_ENTITY, f"{build_method=}"
+                )
+            }
+        )
+    else:
+        pytest.fail(f"Undefined {build_method=}")
 
+    return exception_handlers_map
 
-async def test_handling_exceptions_decorating_a_route(aiohttp_client: Callable):
 
-    # custom exception handler
-    async def _value_error_as_422(
-        request: web.Request, exception: BaseException
-    ) -> web.Response:
-        return web.json_response(status=status.HTTP_422_UNPROCESSABLE_ENTITY)
+@pytest.mark.parametrize("build_method", ["custom", "http_map"])
+async def test_handling_exceptions_decorating_a_route(
+    aiohttp_client: Callable,
+    exception_handlers_map: ExceptionHandlersMap,
+    build_method: str,
+):
 
     # 1. create decorator
-    exc_handling = exception_handling_decorator(
-        exception_handlers_map={
-            ValueError: _value_error_as_422,
-        }
-    )
+    exc_handling = exception_handling_decorator(exception_handlers_map)
 
     # adding new routes
     routes = web.RouteTableDef()
@@ -61,6 +98,10 @@ async def _handler(request: web.Request):
     # handled non-HTTPException exception
     resp = await client.get("/ValueError")
     assert resp.status == status.HTTP_422_UNPROCESSABLE_ENTITY
+    if build_method == "http_map":
+        body = await resp.json()
+        error = ErrorGet.model_validate(body["error"])
+        assert error.message == f"{build_method=}"
 
     # undhandled non-HTTPException
     resp = await client.get("/IndexError")