♻️ Enhances various error messages on webserver (#7860)

Author: pcrespov

packages/service-library/src/servicelib/logging_errors.py

@@ -27,12 +27,22 @@ def create_troubleshotting_log_message(
         error_context -- Additional context surrounding the exception, such as environment variables or function-specific data. This can be derived from exc.error_context() (relevant when using the OsparcErrorMixin)
         tip -- Helpful suggestions or possible solutions explaining why the error may have occurred and how it could potentially be resolved
     """
+
+    def _collect_causes(exc: BaseException) -> str:
+        causes = []
+        current = exc.__cause__
+        while current is not None:
+            causes.append(f"[{type(current).__name__}]'{current}'")
+            current = getattr(current, "__cause__", None)
+        return " <- ".join(causes)
+
     debug_data = json_dumps(
         {
             "exception_type": f"{type(error)}",
             "exception_details": f"{error}",
             "error_code": error_code,
             "context": error_context,
+            "causes": _collect_causes(error),
             "tip": tip,
         },
         default=representation_encoder,

services/web/server/src/simcore_service_webserver/application.py

@@ -85,11 +85,11 @@ def create_application() -> web.Application:
     # core modules
     setup_app_tracing(app)  # WARNING: must be UPPERMOST middleware
     setup_db(app)
-    setup_long_running_tasks(app)
     setup_redis(app)
     setup_session(app)
     setup_security(app)
     setup_rest(app)
+    setup_long_running_tasks(app)
     setup_rabbitmq(app)
 
     # front-end products

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

@@ -106,10 +106,12 @@ async def batch_get_my_services(
             product_name=product_name,
             ids=services_ids,
         )
+
     except RPCServerError as err:
         raise CatalogNotAvailableError(
             user_id=user_id,
             product_name=product_name,
+            services_ids=services_ids,
         ) from err
 
 

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

@@ -15,6 +15,7 @@
 from pydantic import TypeAdapter
 from pydantic.types import PositiveInt
 from servicelib.aiohttp import status
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from servicelib.logging_utils import log_decorator
 from simcore_postgres_database.utils_groups_extra_properties import (
     GroupExtraProperties,
@@ -76,10 +77,12 @@ async def create_or_update_pipeline(
         return computation_task_out
 
     except DirectorV2ServiceError as exc:
-        _logger.error(  # noqa: TRY400
-            "could not create pipeline from project %s: %s",
-            project_id,
-            exc,
+        _logger.exception(
+            **create_troubleshotting_log_kwargs(
+                f"Could not create pipeline from project {project_id}",
+                error=exc,
+                error_context={**body, "backend_url": backend_url},
+            )
         )
     return None
 

services/web/server/src/simcore_service_webserver/groups/_classifiers_service.py

@@ -1,11 +1,11 @@
 """
-    - Every group has a set of "official" classifiers and its users tag studies with them
-    - Classifiers can be defined in two ways:
-        1. a static bundle that is stored in group_classifiers.c.bundle
-        2. using research resources from scicrunch.org (see group_classifiers.c.uses_scicrunch )
-    - The API Classifiers model returned in
-        1. is the bundle
-        2. a dynamic tree built from validated RRIDs (in ResearchResourceRepository)
+- Every group has a set of "official" classifiers and its users tag studies with them
+- Classifiers can be defined in two ways:
+    1. a static bundle that is stored in group_classifiers.c.bundle
+    2. using research resources from scicrunch.org (see group_classifiers.c.uses_scicrunch )
+- The API Classifiers model returned in
+    1. is the bundle
+    2. a dynamic tree built from validated RRIDs (in ResearchResourceRepository)
 """
 
 import logging
@@ -23,6 +23,7 @@
     ValidationError,
     field_validator,
 )
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from simcore_postgres_database.models.classifiers import group_classifiers
 
 from ..db.plugin import get_database_engine
@@ -97,12 +98,15 @@ async def get_classifiers_from_bundle(self, gid: int) -> dict[str, Any]:
                     exclude_unset=True, exclude_none=True
                 )
             except ValidationError as err:
-                _logger.error(
-                    "DB corrupt data in 'groups_classifiers' table. "
-                    "Invalid classifier for gid=%d: %s. "
-                    "Returning empty bundle.",
-                    gid,
-                    err,
+                _logger.exception(
+                    **create_troubleshotting_log_kwargs(
+                        f"DB corrupt data in 'groups_classifiers' table. Invalid classifier for gid={gid}. Returning empty bundle.",
+                        error=err,
+                        error_context={
+                            "gid": gid,
+                            "bundle": bundle,
+                        },
+                    )
                 )
         return {}
 

services/web/server/src/simcore_service_webserver/projects/_projects_service.py

@@ -1426,7 +1426,10 @@ async def _open_project() -> bool:
                     >= max_number_of_studies_per_user
                 ):
                     raise ProjectTooManyProjectOpenedError(
-                        max_num_projects=max_number_of_studies_per_user
+                        max_num_projects=max_number_of_studies_per_user,
+                        user_id=user_id,
+                        project_uuid=project_uuid,
+                        client_session_id=client_session_id,
                     )
 
                 # Assign project_id to current_session

services/web/server/src/simcore_service_webserver/resource_manager/user_sessions.py

@@ -226,7 +226,7 @@ def managed_resource(
         registry = UserSessionResourcesRegistry(int(user_id), client_session_id, app)
         yield registry
     except Exception:
-        _logger.exception(
+        _logger.debug(
             "Error in web-socket for user:%s, session:%s",
             user_id,
             client_session_id,

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

@@ -47,26 +47,30 @@ def map_to_scicrunch_error(rrid: str, error_code: int, message: str) -> Scicrunc
         <= status.HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
     ), error_code  # nosec
 
-    custom_error = ScicrunchError(reason="Unexpected error in scicrunch.org")
+    custom_error = ScicrunchError(
+        reason="Unexpected error in scicrunch.org", original_message=message
+    )
 
     if error_code == web_exceptions.HTTPBadRequest.status_code:
-        custom_error = InvalidRRIDError(rrid=rrid)
+        custom_error = InvalidRRIDError(rrid=rrid, original_message=message)
 
     elif error_code == web_exceptions.HTTPNotFound.status_code:
-        custom_error = InvalidRRIDError(msg_template=f"Did not find any '{rrid}'")
+        custom_error = InvalidRRIDError(
+            msg_template=f"Did not find any '{rrid}'", original_message=message
+        )
 
     elif error_code == web_exceptions.HTTPUnauthorized.status_code:
         custom_error = ScicrunchConfigError(
             reason="osparc was not authorized to access scicrunch.org."
-            "Please check API access tokens."
+            "Please check API access tokens.",
+            original_message=message,
         )
 
     elif (
         error_code >= status.HTTP_500_INTERNAL_SERVER_ERROR
     ):  # scicrunch.org server error
         custom_error = ScicrunchServiceError(
-            reason="scicrunch.org cannot perform our requests"
+            reason="scicrunch.org cannot perform our requests", original_message=message
         )
 
-    _logger.error("%s: %s", custom_error, message)
     return custom_error

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

@@ -19,6 +19,7 @@
 from models_library.projects_nodes_io import DownloadLink, NodeID, PortLink
 from models_library.services import ServiceKey, ServiceVersion
 from pydantic import AnyUrl, HttpUrl, TypeAdapter
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
 from servicelib.logging_utils import log_decorator
 
 from ..projects._projects_repository_legacy import ProjectDBAPI
@@ -281,16 +282,24 @@ async def get_or_create_project_with_file_and_service(
         if is_valid:
             exists = True
         else:
+            http_500_error = web.HTTPInternalServerError()
             _logger.error(
-                "Project %s exists but does not seem to be a viewer generated by this module."
-                " user: %s, viewer:%s, download_link:%s",
-                project_uid,
-                user,
-                viewer,
-                download_link,
+                **create_troubleshotting_log_kwargs(
+                    f"Project {project_uid} exists but does not seem to be a viewer generated by this module.",
+                    error=http_500_error,
+                    error_context={
+                        "user": user,
+                        "viewer": viewer,
+                        "download_link": download_link,
+                        "project_db_workbench_keys": list(
+                            project_db.get("workbench", {}).keys()
+                        ),
+                        "expected_keys": [file_picker_id, service_id],
+                    },
+                )
             )
             # FIXME: CANNOT GUARANTEE!!, DELETE?? ERROR?? and cannot be viewed until verified?
-            raise web.HTTPInternalServerError
+            raise http_500_error
 
     except (ProjectNotFoundError, ProjectInvalidRightsError):
         exists = False