error handling in states rest

Author: pcrespov

services/web/server/src/simcore_service_webserver/projects/_common/exception_handlers.py

@@ -22,12 +22,14 @@
     ProjectDeleteError,
     ProjectGroupNotFoundError,
     ProjectInDebtCanNotChangeWalletError,
+    ProjectInDebtCanNotOpenError,
     ProjectInvalidRightsError,
     ProjectInvalidUsageError,
     ProjectNodeRequiredInputsNotSetError,
     ProjectNotFoundError,
     ProjectOwnerNotFoundInTheProjectAccessRightsError,
     ProjectStartsTooManyDynamicNodesError,
+    ProjectTooManyProjectOpenedError,
     WrongTagIdsInQueryError,
 )
 
@@ -77,6 +79,10 @@
         status.HTTP_400_BAD_REQUEST,
         "Project owner identifier was not found in the project's access-rights field",
     ),
+    ProjectTooManyProjectOpenedError: HttpErrorInfo(
+        status.HTTP_409_CONFLICT,
+        "You cannot open more than {max_num_projects} study/ies at once. Please close another study and retry.",
+    ),
     WorkspaceAccessForbiddenError: HttpErrorInfo(
         status.HTTP_403_FORBIDDEN,
         "Access to workspace forbidden: {reason}",
@@ -109,6 +115,10 @@
         status.HTTP_402_PAYMENT_REQUIRED,
         "Unable to change the credit account linked to the project. The project is embargoed because the last transaction of {debt_amount} resulted in the credit account going negative.",
     ),
+    ProjectInDebtCanNotOpenError: HttpErrorInfo(
+        status.HTTP_402_PAYMENT_REQUIRED,
+        "Unable to open the project. The project is embargoed because the last transaction of {debt_amount} resulted in the credit account going negative.",
+    ),
     ProjectStartsTooManyDynamicNodesError: HttpErrorInfo(
         status.HTTP_409_CONFLICT,
         "The maximal amount of concurrently running dynamic services was reached. Please manually stop a service and retry.",

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

@@ -1,7 +1,6 @@
 """handlers for project states"""
 
 import contextlib
-import functools
 import json
 import logging
 
@@ -14,7 +13,6 @@
     parse_request_path_parameters_as,
     parse_request_query_parameters_as,
 )
-from servicelib.aiohttp.typing_extension import Handler
 from servicelib.aiohttp.web_exceptions_extension import HTTPLockedError
 from servicelib.common_headers import (
     UNDEFINED_DEFAULT_SIMCORE_USER_AGENT_VALUE,
@@ -28,63 +26,21 @@
 from ..login.decorators import login_required
 from ..notifications import project_logs
 from ..products.api import Product, get_current_product
-from ..resource_usage.errors import DefaultPricingPlanNotFoundError
 from ..security.decorators import permission_required
 from ..users import api
-from ..users.exceptions import UserDefaultWalletNotFoundError
 from ..utils_aiohttp import envelope_json_response
-from ..wallets.errors import WalletNotEnoughCreditsError
 from . import api as projects_api
 from . import projects_service
+from ._common.exception_handlers import handle_plugin_requests_exceptions
 from ._common.models import ProjectPathParams, RequestContext
-from .exceptions import (
-    DefaultPricingUnitNotFoundError,
-    ProjectInDebtCanNotChangeWalletError,
-    ProjectInDebtCanNotOpenError,
-    ProjectInvalidRightsError,
-    ProjectNotFoundError,
-    ProjectStartsTooManyDynamicNodesError,
-    ProjectTooManyProjectOpenedError,
-)
+from .exceptions import ProjectStartsTooManyDynamicNodesError
 
 _logger = logging.getLogger(__name__)
 
 
 routes = web.RouteTableDef()
 
 
-def _handle_project_exceptions(handler: Handler):
-    """Transforms common project errors -> http errors"""
-
-    @functools.wraps(handler)
-    async def _wrapper(request: web.Request) -> web.StreamResponse:
-        try:
-            return await handler(request)
-
-        except (
-            ProjectNotFoundError,
-            UserDefaultWalletNotFoundError,
-            DefaultPricingPlanNotFoundError,
-            DefaultPricingUnitNotFoundError,
-        ) as exc:
-            raise web.HTTPNotFound(reason=f"{exc}") from exc
-
-        except ProjectInvalidRightsError as exc:
-            raise web.HTTPForbidden(reason=f"{exc}") from exc
-
-        except ProjectTooManyProjectOpenedError as exc:
-            raise web.HTTPConflict(reason=f"{exc}") from exc
-
-        except (
-            WalletNotEnoughCreditsError,
-            ProjectInDebtCanNotChangeWalletError,
-            ProjectInDebtCanNotOpenError,
-        ) as exc:
-            raise web.HTTPPaymentRequired(reason=f"{exc}") from exc
-
-    return _wrapper
-
-
 #
 # open project: custom methods https://google.aip.dev/136
 #
@@ -97,7 +53,7 @@ class _OpenProjectQuery(BaseModel):
 @routes.post(f"/{VTAG}/projects/{{project_id}}:open", name="open_project")
 @login_required
 @permission_required("project.open")
-@_handle_project_exceptions
+@handle_plugin_requests_exceptions
 async def open_project(request: web.Request) -> web.Response:
     req_ctx = RequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
@@ -208,7 +164,7 @@ async def open_project(request: web.Request) -> web.Response:
 @routes.post(f"/{VTAG}/projects/{{project_id}}:close", name="close_project")
 @login_required
 @permission_required("project.close")
-@_handle_project_exceptions
+@handle_plugin_requests_exceptions
 async def close_project(request: web.Request) -> web.Response:
     req_ctx = RequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
@@ -247,6 +203,7 @@ async def close_project(request: web.Request) -> web.Response:
 @routes.get(f"/{VTAG}/projects/{{project_id}}/state", name="get_project_state")
 @login_required
 @permission_required("project.read")
+@handle_plugin_requests_exceptions
 async def get_project_state(request: web.Request) -> web.Response:
     req_ctx = RequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)