🐛 Fixes extra long error/debug message in the front-end (#7761)

Author: pcrespov

api/specs/web-server/_projects_states.py

@@ -13,7 +13,7 @@
 from pydantic import ValidationError
 from servicelib.aiohttp import status
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.director_v2.exceptions import DirectorServiceError
+from simcore_service_webserver.director_v2.exceptions import DirectorV2ServiceError
 from simcore_service_webserver.projects._controller.projects_states_rest import (
     ProjectPathParams,
     _OpenProjectQuery,
@@ -62,7 +62,7 @@ def to_desc(exceptions: list[type[Exception]] | type[Exception]):
             "description": to_desc([ValidationError])
         },
         status.HTTP_503_SERVICE_UNAVAILABLE: {
-            "description": to_desc([DirectorServiceError])
+            "description": to_desc([DirectorV2ServiceError])
         },
     },
 )

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -6073,7 +6073,7 @@ paths:
         '422':
           description: ValidationError
         '503':
-          description: DirectorServiceError
+          description: DirectorV2ServiceError
   /v0/projects/{project_id}:close:
     post:
       tags:

services/web/server/src/simcore_service_webserver/director_v2/_client_base.py

@@ -10,7 +10,7 @@
 from tenacity.wait import wait_random
 from yarl import URL
 
-from .exceptions import DirectorServiceError
+from .exceptions import DirectorV2ServiceError
 from .settings import get_client_session
 
 log = logging.getLogger(__name__)
@@ -30,7 +30,9 @@
 DataBody: TypeAlias = DataType | list[DataType] | None
 
 
-_StatusToExceptionMapping = dict[int, tuple[type[DirectorServiceError], dict[str, Any]]]
+_StatusToExceptionMapping = dict[
+    int, tuple[type[DirectorV2ServiceError], dict[str, Any]]
+]
 
 
 def _get_exception_from(
@@ -40,7 +42,7 @@ def _get_exception_from(
         exc, exc_ctx = on_error[status_code]
         return exc(**exc_ctx, status=status_code, reason=reason)
     # default
-    return DirectorServiceError(status=status_code, reason=reason, url=url)
+    return DirectorV2ServiceError(status=status_code, reason=reason, url=url)
 
 
 @retry(**DEFAULT_RETRY_POLICY)
@@ -95,14 +97,14 @@ async def request_director_v2(
         return payload
 
     except TimeoutError as err:
-        raise DirectorServiceError(
+        raise DirectorV2ServiceError(
             status=status.HTTP_503_SERVICE_UNAVAILABLE,
             reason=f"request to director-v2 timed-out: {err}",
             url=url,
         ) from err
 
     except aiohttp.ClientError as err:
-        raise DirectorServiceError(
+        raise DirectorV2ServiceError(
             status=status.HTTP_503_SERVICE_UNAVAILABLE,
             reason=f"request to director-v2 service unexpected error {err}",
             url=url,

services/web/server/src/simcore_service_webserver/director_v2/_controller/_rest_exceptions.py

@@ -1,37 +1,80 @@
+import logging
+
 from aiohttp import web
+from common_library.error_codes import create_error_code
+from models_library.rest_error import ErrorGet
+from servicelib import status_codes_utils
 from servicelib.aiohttp import status
-from servicelib.aiohttp.rest_responses import create_http_error
-from servicelib.aiohttp.web_exceptions_extension import get_http_error_class_or_none
-from simcore_service_webserver.director_v2.exceptions import DirectorServiceError
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
 
+from ...constants import MSG_TRY_AGAIN_OR_SUPPORT
 from ...exception_handling import (
     ExceptionHandlersMap,
     ExceptionToHttpErrorMap,
     HttpErrorInfo,
+    create_error_context_from_request,
+    create_error_response,
     exception_handling_decorator,
     to_exceptions_handlers_map,
 )
 from ...users.exceptions import UserDefaultWalletNotFoundError
 from ...wallets.errors import WalletNotEnoughCreditsError
+from ..exceptions import DirectorV2ServiceError
 
 _exceptions_handlers_map: ExceptionHandlersMap = {}
 
 
-async def _handler_director_service_error(
+_logger = logging.getLogger(__name__)
+
+
+async def _handler_director_service_error_as_503_or_4xx(
     request: web.Request, exception: Exception
 ) -> web.Response:
-    assert request  # nosec
+    assert isinstance(exception, DirectorV2ServiceError)  # nosec
+    assert status_codes_utils.is_error(
+        exception.status
+    ), f"DirectorV2ServiceError must be an error, got {exception=}"  # nosec
+
+    if status_codes_utils.is_5xx_server_error(exception.status):
+        # NOTE: All directorv2 5XX are mapped to 503
+        status_code = status.HTTP_503_SERVICE_UNAVAILABLE
+        user_msg = (
+            # Most likely the director service is down or misconfigured so the user is asked to try again later.
+            "This service is temporarily unavailable. The incident was logged and will be investigated. "
+            + MSG_TRY_AGAIN_OR_SUPPORT
+        )
 
-    assert isinstance(exception, DirectorServiceError)  # nosec
-    return create_http_error(
-        exception,
-        reason=exception.reason,
-        http_error_cls=get_http_error_class_or_none(exception.status)
-        or web.HTTPServiceUnavailable,
-    )
+        # Log for further investigation
+        oec = create_error_code(exception)
+        _logger.exception(
+            **create_troubleshotting_log_kwargs(
+                user_msg,
+                error=exception,
+                error_code=oec,
+                error_context={
+                    **create_error_context_from_request(request),
+                    "error_code": oec,
+                },
+            )
+        )
+        error = ErrorGet.model_construct(
+            message=user_msg, support_id=oec, status=status_code
+        )
 
+    else:
+        # NOTE: All directorv2 4XX are mapped one-to-one
+        assert status_codes_utils.is_4xx_client_error(
+            exception.status
+        ), f"DirectorV2ServiceError must be a client error, got {exception=}"  # nosec
 
-_exceptions_handlers_map[DirectorServiceError] = _handler_director_service_error
+        error = ErrorGet(status=exception.status, message="{exception}")
+
+    return create_error_response(error, status_code=error.status)
+
+
+_exceptions_handlers_map[DirectorV2ServiceError] = (
+    _handler_director_service_error_as_503_or_4xx
+)
 
 
 _TO_HTTP_ERROR_MAP: ExceptionToHttpErrorMap = {

services/web/server/src/simcore_service_webserver/director_v2/_director_v2_service.py

@@ -31,7 +31,7 @@
 from ..users.exceptions import UserDefaultWalletNotFoundError
 from ..wallets import api as wallets_service
 from ._client_base import DataType, request_director_v2
-from .exceptions import ComputationNotFoundError, DirectorServiceError
+from .exceptions import ComputationNotFoundError, DirectorV2ServiceError
 from .settings import DirectorV2Settings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)
@@ -75,7 +75,7 @@ async def create_or_update_pipeline(
         assert isinstance(computation_task_out, dict)  # nosec
         return computation_task_out
 
-    except DirectorServiceError as exc:
+    except DirectorV2ServiceError as exc:
         _logger.error(  # noqa: TRY400
             "could not create pipeline from project %s: %s",
             project_id,
@@ -117,7 +117,7 @@ async def get_computation_task(
         _logger.debug("found computation task: %s", f"{task_out=}")
 
         return task_out
-    except DirectorServiceError as exc:
+    except DirectorV2ServiceError as exc:
         if exc.status == status.HTTP_404_NOT_FOUND:
             # the pipeline might not exist and that is ok
             return None

services/web/server/src/simcore_service_webserver/director_v2/director_v2_service.py

@@ -12,12 +12,12 @@
     is_pipeline_running,
     stop_pipeline,
 )
-from .exceptions import DirectorServiceError
+from .exceptions import DirectorV2ServiceError
 
 # director-v2 module internal API
 __all__: tuple[str, ...] = (
     "AbstractProjectRunPolicy",
-    "DirectorServiceError",
+    "DirectorV2ServiceError",
     "create_or_update_pipeline",
     "delete_pipeline",
     "get_batch_tasks_outputs",

services/web/server/src/simcore_service_webserver/director_v2/exceptions.py

@@ -5,7 +5,7 @@
 from ..errors import WebServerBaseError
 
 
-class DirectorServiceError(WebServerBaseError, RuntimeError):
+class DirectorV2ServiceError(WebServerBaseError, RuntimeError):
     """Basic exception for errors raised by director-v2"""
 
     msg_template = "Unexpected error: director-v2 returned '{status}', reason '{reason}' after calling '{url}'"
@@ -16,5 +16,5 @@ def __init__(self, *, status: int, reason: str, **ctx: Any) -> None:
         self.reason = reason
 
 
-class ComputationNotFoundError(DirectorServiceError):
+class ComputationNotFoundError(DirectorV2ServiceError):
     msg_template = "Computation '{project_id}' not found"

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

@@ -1,10 +1,18 @@
 from ._base import ExceptionHandlersMap, exception_handling_decorator
-from ._factory import ExceptionToHttpErrorMap, HttpErrorInfo, to_exceptions_handlers_map
+from ._factory import (
+    ExceptionToHttpErrorMap,
+    HttpErrorInfo,
+    create_error_context_from_request,
+    create_error_response,
+    to_exceptions_handlers_map,
+)
 
 __all__: tuple[str, ...] = (
     "ExceptionHandlersMap",
     "ExceptionToHttpErrorMap",
     "HttpErrorInfo",
+    "create_error_context_from_request",
+    "create_error_response",
     "exception_handling_decorator",
     "to_exceptions_handlers_map",
 )

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

@@ -1,5 +1,5 @@
 import logging
-from typing import NamedTuple, TypeAlias
+from typing import Any, NamedTuple, TypeAlias
 
 from aiohttp import web
 from common_library.error_codes import create_error_code
@@ -35,6 +35,15 @@ class HttpErrorInfo(NamedTuple):
 ExceptionToHttpErrorMap: TypeAlias = dict[type[Exception], HttpErrorInfo]
 
 
+def create_error_context_from_request(request: web.Request) -> dict[str, Any]:
+    return {
+        "request": request,
+        "request.remote": f"{request.remote}",
+        "request.method": f"{request.method}",
+        "request.path": f"{request.path}",
+    }
+
+
 def create_error_response(error: ErrorGet, status_code: int) -> web.Response:
     assert is_error(status_code), f"{status_code=} must be an error [{error=}]"  # nosec
 
@@ -85,20 +94,19 @@ async def _exception_handler(
 
         if is_5xx_server_error(status_code):
             oec = create_error_code(exception)
+            error_context = {
+                # NOTE: `error_context` is also used to substitute f-string tokens
+                # in the `user_msg`
+                **create_error_context_from_request(request),
+                "error_code": oec,
+            }
+
             _logger.exception(
                 **create_troubleshotting_log_kwargs(
                     user_msg,
                     error=exception,
                     error_code=oec,
-                    error_context={
-                        # NOTE: context is also used to substitute tokens in the error message
-                        # e.g. "support error is {error_code}"
-                        "request": request,
-                        "request.remote": f"{request.remote}",
-                        "request.method": f"{request.method}",
-                        "request.path": f"{request.path}",
-                        "error_code": oec,
-                    },
+                    error_context=error_context,
                 )
             )
             error = ErrorGet.model_construct(

services/web/server/src/simcore_service_webserver/projects/_controller/projects_states_rest.py

@@ -20,7 +20,7 @@
 from simcore_postgres_database.webserver_models import ProjectType
 
 from ..._meta import API_VTAG as VTAG
-from ...director_v2.exceptions import DirectorServiceError
+from ...director_v2.exceptions import DirectorV2ServiceError
 from ...login.decorators import login_required
 from ...notifications import project_logs
 from ...products import products_web
@@ -141,7 +141,7 @@ async def open_project(request: web.Request) -> web.Response:
 
         return envelope_json_response(ProjectGet.from_domain_model(project))
 
-    except DirectorServiceError as exc:
+    except DirectorV2ServiceError as exc:
         # there was an issue while accessing the director-v2/director-v0
         # ensure the project is closed again
         await _projects_service.try_close_project_for_user(