improves exception handling

Author: pcrespov

services/invitations/src/simcore_service_invitations/api/_invitations.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Annotated
 
-from fastapi import APIRouter, Depends, HTTPException, status
+from fastapi import APIRouter, Depends
 from fastapi.security import HTTPBasicCredentials
 from models_library.api_schemas_invitations.invitations import (
     ApiEncryptedInvitation,
@@ -12,7 +12,7 @@
 
 from ..core.settings import ApplicationSettings
 from ..services.invitations import (
-    InvalidInvitationCodeError,
+    InvitationContent,
     create_invitation_link_and_content,
     extract_invitation_code_from_query,
     extract_invitation_content,
@@ -71,18 +71,10 @@ async def extracts_invitation_from_code(
 ):
     """Decrypts the invitation code and returns its content"""
 
-    try:
-        invitation = extract_invitation_content(
-            invitation_code=extract_invitation_code_from_query(
-                encrypted.invitation_url
-            ),
-            secret_key=settings.INVITATIONS_SECRET_KEY.get_secret_value().encode(),
-            default_product=settings.INVITATIONS_DEFAULT_PRODUCT,
-        )
-    except InvalidInvitationCodeError as err:
-        raise HTTPException(
-            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
-            detail=INVALID_INVITATION_URL_MSG,
-        ) from err
+    invitation: InvitationContent = extract_invitation_content(
+        invitation_code=extract_invitation_code_from_query(encrypted.invitation_url),
+        secret_key=settings.INVITATIONS_SECRET_KEY.get_secret_value().encode(),
+        default_product=settings.INVITATIONS_DEFAULT_PRODUCT,
+    )
 
     return invitation

services/invitations/src/simcore_service_invitations/core/application.py

@@ -15,6 +15,7 @@
     SUMMARY,
 )
 from ..api.routes import setup_api_routes
+from . import exceptions_handlers
 from .settings import ApplicationSettings
 
 
@@ -43,7 +44,7 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
         setup_tracing(app, app.state.settings.INVITATIONS_TRACING, APP_NAME)
 
     # ERROR HANDLERS
-    # ... add here ...
+    exceptions_handlers.setup(app)
 
     # EVENTS
     async def _on_startup() -> None:

services/invitations/src/simcore_service_invitations/core/exceptions_handlers.py

@@ -0,0 +1,39 @@
+import logging
+
+from fastapi import FastAPI, Request, status
+from fastapi.responses import JSONResponse
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
+
+from ..services.invitations import InvalidInvitationCodeError
+
+_logger = logging.getLogger(__name__)
+
+INVALID_INVITATION_URL_MSG = "Invalid invitation link"
+
+
+def handle_invalid_invitation_code_error(request: Request, exception: Exception):
+    assert isinstance(exception, InvalidInvitationCodeError)  # nosec
+    user_msg = INVALID_INVITATION_URL_MSG
+    _logger.warning(
+        **create_troubleshotting_log_kwargs(
+            user_msg,
+            error=exception,
+            error_context={
+                "request": f"{request}",
+                "request.method": f"{request.method}",
+                "request.path": f"{request.url.path}",
+            },
+            tip="Some invitation link is invalid. Note that the encryption key for generation/check must be the same!",
+        )
+    )
+
+    return JSONResponse(
+        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+        content={"detail": INVALID_INVITATION_URL_MSG},
+    )
+
+
+def setup(app: FastAPI):
+    app.add_exception_handler(
+        InvalidInvitationCodeError, handle_invalid_invitation_code_error
+    )

services/invitations/src/simcore_service_invitations/services/invitations.py

@@ -118,15 +118,16 @@ def create_invitation_link_and_content(
 def extract_invitation_code_from_query(invitation_url: HttpUrl) -> str:
     """Parses url and extracts invitation code from url's query"""
     if not invitation_url.fragment:
-        raise InvalidInvitationCodeError
+        msg = "Invalid link format: fragment missing"
+        raise InvalidInvitationCodeError(msg)
 
     try:
         query_params = dict(parse.parse_qsl(URL(invitation_url.fragment).query))
         invitation_code: str = query_params["invitation"]
         return invitation_code
     except KeyError as err:
-        _logger.debug("Invalid invitation: %s", err)
-        raise InvalidInvitationCodeError from err
+        msg = "Invalid link format: fragment misses `invitation` link"
+        raise InvalidInvitationCodeError(msg) from err
 
 
 def decrypt_invitation(
@@ -167,5 +168,5 @@ def extract_invitation_content(
         return content
 
     except (InvalidToken, ValidationError, binascii.Error) as err:
-        _logger.debug("Invalid code: %s", err)
-        raise InvalidInvitationCodeError from err
+        msg = "Failed while decripting"
+        raise InvalidInvitationCodeError(msg) from err