♻️🐛 Fix: Prevent aiohttp.http_exceptions.LineTooLong and improve diagnostics (#8174)

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/rest_middlewares.py

@@ -118,7 +118,7 @@ def handle_aiohttp_web_http_error(
     exception.content_type = MIMETYPE_APPLICATION_JSON
     if exception.reason:
         exception.set_status(
-            exception.status, safe_status_message(message=exception.reason)
+            exception.status, reason=safe_status_message(message=exception.reason)
         )
 
     if not exception.text or not is_enveloped_from_text(exception.text):
@@ -165,7 +165,7 @@ def _handle_aiohttp_web_http_successful(
     exception.content_type = MIMETYPE_APPLICATION_JSON
     if exception.reason:
         exception.set_status(
-            exception.status, safe_status_message(message=exception.reason)
+            exception.status, reason=safe_status_message(message=exception.reason)
         )
 
     if exception.text and not is_enveloped_from_text(exception.text):

services/web/server/src/simcore_service_webserver/api_keys/_service.py

@@ -77,7 +77,9 @@ async def get_api_key(
     if api_key is not None:
         return api_key
 
-    raise ApiKeyNotFoundError(api_key_id=api_key_id)
+    raise ApiKeyNotFoundError(
+        api_key_id=api_key_id, product_name=product_name, user_id=user_id
+    )
 
 
 async def list_api_keys(

services/web/server/src/simcore_service_webserver/api_keys/errors.py

@@ -1,13 +1,14 @@
 from ..errors import WebServerBaseError
 
 
-class ApiKeysValueError(WebServerBaseError, ValueError):
-    ...
+class ApiKeysValueError(WebServerBaseError, ValueError): ...
 
 
 class ApiKeyDuplicatedDisplayNameError(ApiKeysValueError):
-    msg_template = "API Key with display name '{display_name}' already exists. {reason}"
+    msg_template = (
+        "API Key with display name '{display_name}' already exists: {details}"
+    )
 
 
 class ApiKeyNotFoundError(ApiKeysValueError):
-    msg_template = "API Key with ID '{api_key_id}' not found. {reason}"
+    msg_template = "API Key with ID '{api_key_id}' not found: {details}"

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

@@ -4,6 +4,7 @@
 import aiohttp
 from aiohttp import ClientSession, ClientTimeout, web
 from servicelib.aiohttp import status
+from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from tenacity import retry
 from tenacity.before_sleep import before_sleep_log
 from tenacity.stop import stop_after_attempt
@@ -36,13 +37,14 @@
 
 
 def _get_exception_from(
-    status_code: int, on_error: _StatusToExceptionMapping | None, reason: str, url: URL
+    status_code: int, on_error: _StatusToExceptionMapping | None, details: str, url: URL
 ):
     if on_error and status_code in on_error:
-        exc, exc_ctx = on_error[status_code]
-        return exc(**exc_ctx, status=status_code, reason=reason)
+        exc_cls, exc_ctx = on_error[status_code]
+        return exc_cls(**exc_ctx, status=status_code, details=details)
+
     # default
-    return DirectorV2ServiceError(status=status_code, reason=reason, url=url)
+    return DirectorV2ServiceError(status=status_code, details=details, url=url)
 
 
 @retry(**DEFAULT_RETRY_POLICY)
@@ -61,13 +63,13 @@ async def _make_request(
     ) as response:
         payload: dict[str, Any] | list[dict[str, Any]] | None | str = (
             await response.json()
-            if response.content_type == "application/json"
+            if response.content_type == MIMETYPE_APPLICATION_JSON
             else await response.text()
         )
 
         if response.status != expected_status.status_code:
             raise _get_exception_from(
-                response.status, on_error, reason=f"{payload}", url=url
+                response.status, on_error, details=f"{payload}", url=url
             )
         return payload
 
@@ -99,13 +101,13 @@ async def request_director_v2(
     except TimeoutError as err:
         raise DirectorV2ServiceError(
             status=status.HTTP_503_SERVICE_UNAVAILABLE,
-            reason=f"request to director-v2 timed-out: {err}",
+            details=f"request to director-v2 timed-out: {err}",
             url=url,
         ) from err
 
     except aiohttp.ClientError as err:
         raise DirectorV2ServiceError(
             status=status.HTTP_503_SERVICE_UNAVAILABLE,
-            reason=f"request to director-v2 service unexpected error {err}",
+            details=f"request to director-v2 service unexpected error {err}",
             url=url,
         ) from err

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

@@ -95,7 +95,7 @@ async def _handler_director_service_error_as_503_or_4xx(
     WalletNotEnoughCreditsError: HttpErrorInfo(
         status.HTTP_402_PAYMENT_REQUIRED,
         user_message(
-            "Your wallet does not have sufficient credits to run this computation. {reason}",
+            "Your wallet does not have sufficient credits to run this computation: {details}",
             _version=1,
         ),
     ),

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

@@ -95,7 +95,7 @@ async def start_computation(request: web.Request) -> web.Response:
         now = datetime.now(UTC)
         if now - created_at > timedelta(minutes=5):
             raise web.HTTPBadRequest(
-                reason=(
+                text=(
                     "This client generated collection is not new, "
                     "it was created more than 5 minutes ago. "
                     "Therefore, the client is probably wrongly generating it."

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

@@ -8,12 +8,12 @@
 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}'"
+    msg_template = "Unexpected error: director-v2 returned '{status}', details '{details}' after calling '{url}'"
 
-    def __init__(self, *, status: int, reason: str, **ctx: Any) -> None:
+    def __init__(self, *, status: int, details: str, **ctx: Any) -> None:
         super().__init__(**ctx)
         self.status = status
-        self.reason = reason
+        self.details = details
 
 
 class ComputationNotFoundError(DirectorV2ServiceError):

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

@@ -145,7 +145,7 @@ def create_http_error_exception_handlers_map() -> ExceptionHandlersMap:
     """
     exc_handlers_map: ExceptionHandlersMap = {
         exc_type: create_exception_handler_from_http_info(
-            status_code=code, msg_template="{reason}"
+            status_code=code, msg_template="{text}"
         )
         for code, exc_type in _STATUS_CODE_TO_HTTP_ERRORS.items()
     }

services/web/server/src/simcore_service_webserver/folders/_common/exceptions_handlers.py

@@ -56,11 +56,11 @@
     ),
     FolderValueNotPermittedError: HttpErrorInfo(
         status.HTTP_409_CONFLICT,
-        user_message("The folder operation cannot be completed: {reason}", _version=1),
+        user_message("The folder operation cannot be completed: {details}", _version=1),
     ),
     FoldersValueError: HttpErrorInfo(
         status.HTTP_409_CONFLICT,
-        user_message("The folder configuration is invalid: {reason}", _version=1),
+        user_message("The folder configuration is invalid: {details}", _version=1),
     ),
     ProjectInvalidRightsError: HttpErrorInfo(
         status.HTTP_403_FORBIDDEN,

services/web/server/src/simcore_service_webserver/folders/_folders_repository.py

@@ -338,7 +338,7 @@ async def get(
         row = result.first()
         if row is None:
             raise FolderAccessForbiddenError(
-                reason=f"Folder {folder_id} does not exist.",
+                details=f"Folder {folder_id} does not exist.",
             )
         return FolderDB.model_validate(row)
 
@@ -369,7 +369,7 @@ async def get_for_user_or_workspace(
         row = await result.first()
         if row is None:
             raise FolderAccessForbiddenError(
-                reason=f"User does not have access to the folder {folder_id}. Or folder does not exist.",
+                details=f"User does not have access to the folder {folder_id}. Or folder does not exist.",
             )
         return FolderDB.model_validate(row)
 
@@ -421,7 +421,7 @@ async def update(
         result = await conn.stream(query)
         row = await result.first()
         if row is None:
-            raise FolderNotFoundError(reason=f"Folder {folders_id_or_ids} not found.")
+            raise FolderNotFoundError(details=f"Folder {folders_id_or_ids} not found.")
         return FolderDB.model_validate(row)