error handling

Author: pcrespov

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

@@ -12,7 +12,7 @@
 
 from ..director_v2 import api as director_v2_api
 from . import projects_api
-from .exceptions import ProjectLockError, StopProjectBeforeTrashError
+from .exceptions import ProjectLockError, ProjectRunningConflictError, ProjectStopError
 from .models import ProjectPatchExtended
 from .settings import get_plugin_settings
 
@@ -49,28 +49,43 @@ async def trash_project(
     user_id: UserID,
     project_id: ProjectID,
     trashed: bool,
+    forced: bool = True,
 ):
     if trashed:
         # stop first
-        try:
-            await projects_api.remove_project_dynamic_services(
-                user_id=user_id,
-                project_uuid=f"{project_id}",
-                app=app,
-                simcore_user_agent=UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE,
-                notify_users=False,
-            )
 
-            await director_v2_api.delete_pipeline(
-                app, user_id=user_id, project_id=project_id
+        if forced:
+            try:
+                await projects_api.remove_project_dynamic_services(
+                    user_id=user_id,
+                    project_uuid=f"{project_id}",
+                    app=app,
+                    simcore_user_agent=UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE,
+                    notify_users=False,
+                )
+
+                await director_v2_api.delete_pipeline(
+                    app, user_id=user_id, project_id=project_id
+                )
+            except (DirectorServiceError, ProjectLockError) as exc:
+                raise ProjectStopError(
+                    project_uuid=project_id,
+                    user_id=user_id,
+                    product_name=product_name,
+                    from_err=exc,
+                ) from exc
+        else:
+
+            running = await director_v2_api.is_pipeline_running(
+                app=app, user_id=user_id, project_id=project_id
             )
-        except (DirectorServiceError, ProjectLockError) as exc:
-            raise StopProjectBeforeTrashError(
-                project_uuid=project_id,
-                user_id=user_id,
-                product_name=product_name,
-                from_err=exc,
-            ) from exc
+            # NOTE: must do here as well for dynamic services but needs refactoring!
+            if running:
+                raise ProjectRunningConflictError(
+                    project_uuid=project_id,
+                    user_id=user_id,
+                    product_name=product_name,
+                )
 
     # mark as trash
     await projects_api.patch_project(

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

@@ -1,20 +1,94 @@
+import functools
+import logging
+from typing import NamedTuple
+
 from aiohttp import web
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
+from servicelib.aiohttp.typing_extension import Handler
+from servicelib.aiohttp.web_exceptions_extension import get_http_error_class_or_none
+from servicelib.logging_errors import create_troubleshotting_log_kwargs
+from servicelib.status_codes_utils import is_5xx_server_error
 
 from .._meta import API_VTAG as VTAG
 from ..login.decorators import get_user_id, login_required
 from ..products.api import get_product_name
 from ..projects._common_models import ProjectPathParams
 from ..security.decorators import permission_required
 from . import _trash_api
+from .exceptions import ProjectRunningConflictError, ProjectStopError, ProjectTrashError
+
+_logger = logging.getLogger(__name__)
+
+
+class HttpErrorInfo(NamedTuple):
+    status_code: int
+    msg_template: str
+
+
+_TO_HTTP_ERROR_MAP: dict[type[Exception], HttpErrorInfo] = {
+    ProjectRunningConflictError: HttpErrorInfo(
+        status.HTTP_409_CONFLICT,
+        "Current study is in use and cannot be trashed [{project_uuid}]",
+    ),
+    ProjectStopError: HttpErrorInfo(
+        status.HTTP_503_SERVICE_UNAVAILABLE,
+        "Something went wrong while stopping services before trashing. Aborting trash.",
+    ),
+}
+
+
+class _DefaultDict(dict):
+    def __missing__(self, key):
+        return f"'{key}=?'"
+
+
+def _handle_request_exceptions(handler: Handler):
+    @functools.wraps(handler)
+    async def _wrapper(request: web.Request) -> web.StreamResponse:
+        try:
+            return await handler(request)
+
+        except ProjectTrashError as exc:
+            for exc_cls, http_error_info in _TO_HTTP_ERROR_MAP.items():
+                if isinstance(exc, exc_cls):
+
+                    # safe formatting
+                    user_msg = http_error_info.msg_template.format_map(
+                        _DefaultDict(getattr(exc, "__dict__", {}))
+                    )
+
+                    http_error_cls = get_http_error_class_or_none(
+                        http_error_info.status_code
+                    )
+                    assert http_error_cls  # nosec
+
+                    if is_5xx_server_error(http_error_info.status_code):
+                        _logger.exception(
+                            **create_troubleshotting_log_kwargs(
+                                user_msg,
+                                error=exc,
+                                error_context={
+                                    "request": request,
+                                    "request.remote": f"{request.remote}",
+                                    "request.method": f"{request.method}",
+                                    "request.path": f"{request.path}",
+                                },
+                            )
+                        )
+                    raise http_error_cls(reason=user_msg) from exc
+            raise
+
+    return _wrapper
+
 
 routes = web.RouteTableDef()
 
 
 @routes.delete(f"/{VTAG}/trash", name="empty_trash")
 @login_required
 @permission_required("project.delete")
+@_handle_request_exceptions
 async def empty_trash(request: web.Request):
     user_id = get_user_id(request)
     product_name = get_product_name(request)
@@ -26,14 +100,10 @@ async def empty_trash(request: web.Request):
     return web.json_response(status=status.HTTP_204_NO_CONTENT)
 
 
-#
-# Projects
-#
-
-
 @routes.post(f"/{VTAG}/projects/{{project_id}}:trash", name="trash_project")
 @login_required
 @permission_required("project.delete")
+@_handle_request_exceptions
 async def trash_project(request: web.Request):
     user_id = get_user_id(request)
     product_name = get_product_name(request)
@@ -53,6 +123,7 @@ async def trash_project(request: web.Request):
 @routes.post(f"/{VTAG}/projects/{{project_id}}:untrash", name="untrash_project")
 @login_required
 @permission_required("project.delete")
+@_handle_request_exceptions
 async def untrash_project(request: web.Request):
     user_id = get_user_id(request)
     product_name = get_product_name(request)

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

@@ -82,10 +82,16 @@ class ProjectTrashError(BaseProjectError):
     ...
 
 
-class StopProjectBeforeTrashError(ProjectTrashError):
+class ProjectStopError(ProjectTrashError):
     msg_template = "Failed to  services in '{project_uuid}' before trashing"
 
 
+class ProjectRunningConflictError(ProjectTrashError):
+    msg_template = (
+        "Cannot trash running project '{project_uuid}' except if forced option is on"
+    )
+
+
 class NodeNotFoundError(BaseProjectError):
     msg_template = "Node '{node_uuid}' not found in project '{project_uuid}'"