@pcrespov add support_id to error model

Author: bisgaard-itis

services/api-server/src/simcore_service_api_server/exceptions/handlers/_handlers_backend_errors.py

@@ -1,8 +1,8 @@
 import logging
 
 from common_library.error_codes import create_error_code
-from fastapi import status
 from servicelib.logging_errors import create_troubleshootting_log_kwargs
+from servicelib.status_codes_utils import is_5xx_server_error
 from starlette.requests import Request
 from starlette.responses import JSONResponse
 
@@ -16,15 +16,17 @@ async def backend_error_handler(request: Request, exc: Exception) -> JSONRespons
     assert request  # nosec
     assert isinstance(exc, BaseBackEndError)
     user_error_msg = f"{exc}"
-    if not exc.status_code >= status.HTTP_500_INTERNAL_SERVER_ERROR:
-        oec = create_error_code(exc)
-        user_error_msg += f" [{oec}]"
+    support_id = None
+    if is_5xx_server_error(exc.status_code):
+        support_id = create_error_code(exc)
         _logger.exception(
             **create_troubleshootting_log_kwargs(
                 user_error_msg,
                 error=exc,
-                error_code=oec,
+                error_code=support_id,
                 tip="Unexpected error",
             )
         )
-    return create_error_json_response(user_error_msg, status_code=exc.status_code)
+    return create_error_json_response(
+        user_error_msg, status_code=exc.status_code, support_id=support_id
+    )

services/api-server/src/simcore_service_api_server/exceptions/handlers/_utils.py

@@ -1,6 +1,7 @@
 from collections.abc import Awaitable, Callable
 from typing import Any, TypeAlias
 
+from common_library.error_codes import ErrorCodeStr
 from fastapi.encoders import jsonable_encoder
 from fastapi.requests import Request
 from fastapi.responses import JSONResponse
@@ -13,13 +14,13 @@
 
 
 def create_error_json_response(
-    *errors: Any, status_code: int, **kwargs
+    *errors: Any, status_code: int, support_id: ErrorCodeStr | None = None, **kwargs
 ) -> JSONResponse:
     """
     Converts errors to Error response model defined in the OAS
     """
 
-    error_model = ErrorGet(errors=list(errors))
+    error_model = ErrorGet(errors=list(errors), support_id=support_id, **kwargs)
     return JSONResponse(
         content=jsonable_encoder(error_model),
         status_code=status_code,

services/api-server/src/simcore_service_api_server/models/schemas/errors.py

@@ -1,5 +1,6 @@
 from typing import Any
 
+from common_library.error_codes import ErrorCodeStr
 from pydantic import BaseModel, ConfigDict
 
 
@@ -10,6 +11,7 @@ class ErrorGet(BaseModel):
     #   - https://github.com/ITISFoundation/osparc-simcore/issues/2520
     #   - https://github.com/ITISFoundation/osparc-simcore/issues/2446
     errors: list[Any]
+    support_id: ErrorCodeStr | None = None
 
     model_config = ConfigDict(
         json_schema_extra={