rename

Author: pcrespov

services/api-server/src/simcore_service_api_server/errors/exception_handlers.py

@@ -9,11 +9,13 @@
 from ..models.custom_errors import CustomBaseError
 from ..services.log_streaming import LogDistributionBaseException
 from .custom_errors import custom_error_handler
-from .http_error import http_error_handler, make_http_error_handler_for_exception
+from .http_error import http_error_handler, make_handler_for_exception
 from .httpx_client_error import handle_httpx_client_exceptions
 from .log_handling_error import log_handling_error_handler
 from .validation_error import http422_error_handler
 
+MSG_INTERNAL_ERROR_USER_FRIENDLY_TEMPLATE = "Oops! Something went wrong, but we've noted it down and we'll sort it out ASAP. Thanks for your patience!"
+
 
 def setup(app: FastAPI):
     settings: ApplicationSettings = app.state.settings
@@ -28,18 +30,18 @@ def setup(app: FastAPI):
     # SEE https://docs.python.org/3/library/exceptions.html#exception-hierarchy
     app.add_exception_handler(
         NotImplementedError,
-        make_http_error_handler_for_exception(
+        make_handler_for_exception(
             NotImplementedError,
             status.HTTP_501_NOT_IMPLEMENTED,
-            detail_message="Endpoint not implemented",
+            error_message="This endpoint is still not implemented (under development)",
         ),
     )
     app.add_exception_handler(
         Exception,
-        make_http_error_handler_for_exception(
+        make_handler_for_exception(
             Exception,
             status.HTTP_500_INTERNAL_SERVER_ERROR,
-            detail_message="Unexpected error",
+            error_message=MSG_INTERNAL_ERROR_USER_FRIENDLY_TEMPLATE,
             add_exception_to_message=(settings.SC_BOOT_MODE == BootModeEnum.DEBUG),
             add_oec_to_message=True,
         ),

services/api-server/src/simcore_service_api_server/errors/http_error.py

@@ -1,3 +1,4 @@
+import logging
 from collections.abc import Callable
 
 from fastapi import HTTPException
@@ -8,6 +9,8 @@
 
 from ..models.schemas.errors import ErrorGet
 
+_logger = logging.getLogger(__file__)
+
 
 def create_error_json_response(*errors, status_code: int) -> JSONResponse:
     # NOTE: do not forget to add in the decorator `responses={ ???: {"model": ErrorGet} }`
@@ -20,11 +23,11 @@ async def http_error_handler(_: Request, exc: HTTPException) -> JSONResponse:
     return create_error_json_response(exc.detail, status_code=exc.status_code)
 
 
-def make_http_error_handler_for_exception(
+def make_handler_for_exception(
     exception_cls: type[BaseException],
     status_code: int,
     *,
-    detail_message: str,
+    error_message: str,
     add_exception_to_message: bool = False,
     add_oec_to_message: bool = False,
 ) -> Callable:
@@ -35,13 +38,22 @@ def make_http_error_handler_for_exception(
     SEE https://docs.python.org/3/library/exceptions.html#concrete-exceptions
     """
 
-    async def _http_error_handler(_: Request, error: BaseException) -> JSONResponse:
-        assert isinstance(error, exception_cls)  # nosec
-        details = detail_message
+    async def _http_error_handler(_: Request, exception: BaseException) -> JSONResponse:
+        assert isinstance(exception, exception_cls)  # nosec
+
+        msg = error_message
         if add_exception_to_message:
-            details += f"\n{error}"
+            msg += f" {exception}"
+
         if add_oec_to_message:
-            details += f"\n[OEC: {create_error_code(error)}]"
-        return create_error_json_response(details, status_code=status_code)
+            error_code = create_error_code(exception)
+            msg += f" [{error_code}]"
+            _logger.exception(
+                "Unexpected %s: %s",
+                exception.__class__.__name__,
+                msg,
+                extra={"error_code": error_code},
+            )
+        return create_error_json_response(msg, status_code=status_code)
 
     return _http_error_handler