improves error handling

Author: pcrespov

services/web/server/src/simcore_service_webserver/studies_dispatcher/_errors.py

@@ -25,3 +25,7 @@ class InvalidRedirectionParamsError(StudyDispatcherError):
 
 class GuestUsersLimitError(StudyDispatcherError):
     msg_template = "Maximum number of guests was reached. Please login with a registered user or try again later"
+
+
+class GuestUserNotAllowedError(StudyDispatcherError):
+    msg_template = "Guest users are not allowed to access this resource configuration."

services/web/server/src/simcore_service_webserver/studies_dispatcher/_redirects_handlers.py

@@ -17,13 +17,18 @@
 from servicelib.logging_errors import create_troubleshootting_log_kwargs
 
 from ..dynamic_scheduler import api as dynamic_scheduler_service
+from ..exception_handling import create_error_context_from_request
 from ..products import products_web
 from ..utils import compose_support_error_msg
 from ..utils_aiohttp import create_redirect_to_page_response, get_api_base_url
 from ._catalog import ValidService, validate_requested_service
-from ._constants import MSG_UNEXPECTED_DISPATCH_ERROR
+from ._constants import MSG_GUESTS_NOT_ALLOWED, MSG_UNEXPECTED_DISPATCH_ERROR
 from ._core import validate_requested_file, validate_requested_viewer
-from ._errors import InvalidRedirectionParamsError, StudyDispatcherError
+from ._errors import (
+    GuestUserNotAllowedError,
+    InvalidRedirectionParamsError,
+    StudyDispatcherError,
+)
 from ._models import FileParams, ServiceInfo, ServiceParams, ViewerInfo
 from ._projects import (
     get_or_create_project_with_file,
@@ -92,29 +97,63 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
             # NOTE: that response is a redirection that is reraised and not returned
             raise
 
-        except StudyDispatcherError as err:
+        except GuestUserNotAllowedError as err:
             raise _create_redirect_response_to_error_page(
                 request.app,
-                message=f"Sorry, we cannot dispatch your study: {err}",
-                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,  # 422
+                message=MSG_GUESTS_NOT_ALLOWED,
+                status_code=status.HTTP_401_UNAUTHORIZED,
             ) from err
 
-        except web.HTTPUnauthorized as err:
+        except StudyDispatcherError as err:
             raise _create_redirect_response_to_error_page(
                 request.app,
-                message=f"{err.text}. Please reload this page to login/register.",
-                status_code=err.status_code,
+                message=f"Sorry, we cannot dispatch your study: {err}",
+                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,  # 422
             ) from err
 
         except web.HTTPUnprocessableEntity as err:
+            # Validation error in query parameters
+            error_code = create_error_code(err)
+            user_error_msg = compose_support_error_msg(
+                msg="Invalid query parameters in link", error_code=error_code
+            )
+
+            _logger.exception(
+                **create_troubleshootting_log_kwargs(
+                    user_error_msg,
+                    error=err,
+                    error_code=error_code,
+                    error_context=create_error_context_from_request(request),
+                    tip="The link might be corrupted",
+                )
+            )
+
             raise _create_redirect_response_to_error_page(
                 request.app,
-                message=f"Invalid parameters in link: {err.text}",
-                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,  # 422
+                message=user_error_msg,
+                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
             ) from err
 
         except web.HTTPClientError as err:
-            _logger.exception("Client error with status code %d", err.status_code)
+            error_code = create_error_code(err)
+            user_error_msg = compose_support_error_msg(
+                msg="Fatal error while redirecting request", error_code=error_code
+            )
+
+            _logger.exception(
+                **create_troubleshootting_log_kwargs(
+                    user_error_msg,
+                    error=err,
+                    error_code=error_code,
+                    error_context={
+                        **create_error_context_from_request(request),
+                        "reason": err.reason,
+                        "status": err.status,
+                    },
+                    tip="The link might be corrupted",
+                )
+            )
+
             raise _create_redirect_response_to_error_page(
                 request.app,
                 message=err.reason,
@@ -132,7 +171,7 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
                     user_error_msg,
                     error=err,
                     error_code=error_code,
-                    error_context={"request": request},
+                    error_context=create_error_context_from_request(request),
                     tip="Unexpected failure while dispatching study",
                 )
             )

services/web/server/src/simcore_service_webserver/studies_dispatcher/_rest_handlers.py

@@ -1,6 +1,5 @@
-""" Handles requests to the Rest API
+"""Handles requests to the Rest API"""
 
-"""
 import logging
 from dataclasses import asdict
 
@@ -50,8 +49,8 @@ def _compose_service_only_dispatcher_prefix_url(
     request: web.Request, service_key: str, service_version: str
 ) -> HttpUrl:
     params = ViewerQueryParams(
-        viewer_key=ServiceKey(service_key),
-        viewer_version=ServiceVersion(service_version),
+        viewer_key=TypeAdapter(ServiceKey).validate_python(service_key),
+        viewer_version=TypeAdapter(ServiceVersion).validate_python(service_version),
     ).model_dump(exclude_none=True, exclude_unset=True)
     absolute_url = request.url.join(
         request.app.router["get_redirection_to_viewer"].url_for().with_query(**params)
@@ -202,8 +201,3 @@ async def list_default_viewers(request: Request):
         )
     ]
     return envelope_json_response(viewers)
-
-
-rest_handler_functions = {
-    fun.__name__: fun for fun in [list_default_viewers, list_viewers]
-}

services/web/server/src/simcore_service_webserver/studies_dispatcher/_users.py

@@ -37,8 +37,7 @@
 from ..security import security_service, security_web
 from ..users import users_service
 from ..users.exceptions import UserNotFoundError
-from ._constants import MSG_GUESTS_NOT_ALLOWED
-from ._errors import GuestUsersLimitError
+from ._errors import GuestUserNotAllowedError, GuestUsersLimitError
 from .settings import StudiesDispatcherSettings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)
@@ -187,7 +186,7 @@ async def get_or_create_guest_user(
         allow_anonymous_or_guest_users -- if True, it will create a temporary GUEST account
 
     Raises:
-        web.HTTPUnauthorized if ANONYMOUS users are not allowed (either w/o auth or as GUEST)
+        GuestUserNotAllowedError if ANONYMOUS users are not allowed (either w/o auth or as GUEST)
 
     """
     user = None
@@ -205,7 +204,11 @@ async def get_or_create_guest_user(
 
     if not allow_anonymous_or_guest_users and (not user or user.get("role") == GUEST):
         # NOTE: if allow_anonymous_users=False then GUEST users are NOT allowed!
-        raise web.HTTPUnauthorized(text=MSG_GUESTS_NOT_ALLOWED)
+        raise GuestUserNotAllowedError(
+            allow_anonymous_or_guest_users=allow_anonymous_or_guest_users,
+            user=user,
+            is_anonymous_user=is_anonymous_user,
+        )
 
     assert isinstance(user, dict)  # nosec