updates invitations logs

Author: pcrespov

services/web/server/src/simcore_service_webserver/invitations/_core.py

@@ -2,14 +2,13 @@
 from contextlib import contextmanager
 from typing import Final
 
-from aiohttp import ClientError, ClientResponseError, web
+from aiohttp import ClientResponseError, web
 from models_library.api_schemas_invitations.invitations import (
     ApiInvitationContent,
     ApiInvitationContentAndLink,
     ApiInvitationInputs,
 )
 from models_library.emails import LowerCaseEmailStr
-from models_library.error_codes import create_error_code
 from pydantic import AnyHttpUrl, ValidationError, parse_obj_as
 from servicelib.aiohttp import status
 
@@ -35,31 +34,30 @@ def _handle_exceptions_as_invitations_errors():
     except ClientResponseError as err:
         # check possible errors
         if err.status == status.HTTP_422_UNPROCESSABLE_ENTITY:
-            error_code = create_error_code(err)
-            _logger.exception(
-                "Invitation request unexpectedly failed [%s]",
-                f"{error_code}",
-                extra={"error_code": error_code},
-            )
             raise InvalidInvitationError(
-                reason=f"Unexpected error [{error_code}]"
+                invitations_api_response={
+                    "err": err,
+                    "status": err.status,
+                    "message": err.message,
+                    "url": err.request_info.real_url,
+                },
             ) from err
 
         assert err.status >= status.HTTP_400_BAD_REQUEST  # nosec
-        # any other error status code
-        raise InvitationsServiceUnavailableError from err
 
-    except (ValidationError, ClientError) as err:
-        _logger.debug("Invitations error %s", f"{err}")
-        raise InvitationsServiceUnavailableError from err
+        # any other error status code
+        raise InvitationsServiceUnavailableError(
+            client_response_error=err,
+        ) from err
 
     except InvitationsError:
         # bypass: prevents that the Exceptions handler catches this exception
         raise
 
     except Exception as err:
-        _logger.exception("Unexpected error in invitations plugin")
-        raise InvitationsServiceUnavailableError from err
+        raise InvitationsServiceUnavailableError(
+            unexpected_error=err,
+        ) from err
 
 
 #

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

@@ -14,11 +14,8 @@ class InvitationsError(WebServerBaseError, ValueError):
 
 
 class InvalidInvitationError(InvitationsError):
-    msg_template = "Invalid invitation. {reason}"
+    msg_template = "Invalid invitation"
 
 
 class InvitationsServiceUnavailableError(InvitationsError):
-    msg_template = (
-        "Unable to process your invitation since the invitations service is currently unavailable. "
-        "Please try again later."
-    )
+    msg_template = "Cannot process invitations"

services/web/server/src/simcore_service_webserver/login/_registration.py

@@ -12,6 +12,7 @@
 from aiohttp import web
 from models_library.basic_types import IdInt
 from models_library.emails import LowerCaseEmailStr
+from models_library.error_codes import create_error_code
 from models_library.products import ProductName
 from pydantic import (
     BaseModel,
@@ -22,6 +23,7 @@
     parse_obj_as,
     validator,
 )
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from simcore_postgres_database.models.confirmations import ConfirmationAction
 from simcore_postgres_database.models.users import UserStatus
@@ -211,17 +213,36 @@ def _invitations_request_context(invitation_code: str) -> Iterator[URL]:
         yield url
 
     except (ValidationError, InvalidInvitationError) as err:
-        msg = f"{err}"
-        if isinstance(err, ValidationError):
-            msg = f"{InvalidInvitationError(reason='')}"
+        error_code = create_error_code(err)
+        front_end_msg = (
+            f"Invalid invitation. {MSG_INVITATIONS_CONTACT_SUFFIX} [{error_code}]"
+        )
+
+        _logger.exception(
+            **create_troubleshotting_log_kwargs(
+                front_end_msg,
+                exception=err,
+                tip="Something went wrong with the invitation",
+            )
+        )
         raise web.HTTPForbidden(
-            reason=f"{msg}. {MSG_INVITATIONS_CONTACT_SUFFIX}",
+            reason=front_end_msg,
             content_type=MIMETYPE_APPLICATION_JSON,
         ) from err
 
     except InvitationsServiceUnavailableError as err:
+        error_code = create_error_code(err)
+        front_end_msg = f"Unable to process your invitation since the invitations service is currently unavailable [{error_code}]"
+
+        _logger.exception(
+            **create_troubleshotting_log_kwargs(
+                front_end_msg,
+                exception=err,
+                tip="Something went wrong communicating the `invitations` service",
+            )
+        )
         raise web.HTTPServiceUnavailable(
-            reason=f"{err}",
+            reason=front_end_msg,
             content_type=MIMETYPE_APPLICATION_JSON,
         ) from err