♻️ Refactor catalog domain in webserver

api/specs/web-server/_catalog.py

@@ -15,7 +15,7 @@
 from models_library.generics import Envelope
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.catalog._handlers import (
+from simcore_service_webserver.catalog._controller_rest import (
     ListServiceParams,
     ServicePathParams,
     _FromServiceOutputParams,

services/web/server/src/simcore_service_webserver/catalog/client.py → services/web/server/src/simcore_service_webserver/catalog/_catalog_rest_client.py

@@ -1,7 +1,5 @@
-""" Requests to catalog service API
+"""Requests to catalog service API"""
 
-"""
-import asyncio
 import logging
 import urllib.parse
 from collections.abc import Iterator
@@ -47,7 +45,7 @@ def _handle_client_exceptions(app: web.Application) -> Iterator[ClientSession]:
             reason=MSG_CATALOG_SERVICE_UNAVAILABLE
         ) from err
 
-    except (asyncio.TimeoutError, ClientConnectionError) as err:
+    except (TimeoutError, ClientConnectionError) as err:
         _logger.debug("Request to catalog service failed: %s", err)
         raise web.HTTPServiceUnavailable(
             reason=MSG_CATALOG_SERVICE_UNAVAILABLE

services/web/server/src/simcore_service_webserver/catalog/_handlers.py → services/web/server/src/simcore_service_webserver/catalog/_controller_rest.py

@@ -1,4 +1,4 @@
-""" rest api handlers
+"""rest api handlers
 
 - Take into account that part of the API is also needed in the public API so logic
 should live in the catalog service in his final version
@@ -7,7 +7,6 @@
 
 import asyncio
 import logging
-import urllib.parse
 from typing import Final
 
 from aiohttp import web
@@ -26,7 +25,7 @@
     ServiceResourcesDict,
     ServiceResourcesDictHelpers,
 )
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import BaseModel, Field
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
@@ -39,9 +38,12 @@
 from ..resource_usage.service import get_default_service_pricing_plan
 from ..security.decorators import permission_required
 from ..utils_aiohttp import envelope_json_response
-from . import _api, _handlers_errors, client
-from ._api import CatalogRequestContext
-from .exceptions import DefaultPricingUnitForServiceNotFoundError
+from . import _catalog_rest_client, _service
+from ._exceptions import (
+    DefaultPricingUnitForServiceNotFoundError,
+    reraise_catalog_exceptions_as_http_errors,
+)
+from ._models import CatalogRequestContext, ListServiceParams, ServicePathParams
 
 _logger = logging.getLogger(__name__)
 
@@ -51,41 +53,20 @@
 routes = RouteTableDef()
 
 
-class ServicePathParams(BaseModel):
-    service_key: ServiceKey
-    service_version: ServiceVersion
-    model_config = ConfigDict(
-        populate_by_name=True,
-        extra="forbid",
-    )
-
-    @field_validator("service_key", mode="before")
-    @classmethod
-    def ensure_unquoted(cls, v):
-        # NOTE: this is needed as in pytest mode, the aiohttp server does not seem to unquote automatically
-        if v is not None:
-            return urllib.parse.unquote(v)
-        return v
-
-
-class ListServiceParams(PageQueryParameters):
-    ...
-
-
 @routes.get(
     f"{VTAG}/catalog/services/-/latest",
     name="list_services_latest",
 )
 @login_required
 @permission_required("services.catalog.*")
-@_handlers_errors.reraise_catalog_exceptions_as_http_errors
+@reraise_catalog_exceptions_as_http_errors
 async def list_services_latest(request: Request):
     request_ctx = CatalogRequestContext.create(request)
     query_params: ListServiceParams = parse_request_query_parameters_as(
         ListServiceParams, request
     )
 
-    page_items, page_meta = await _api.list_latest_services(
+    page_items, page_meta = await _service.list_latest_services(
         request.app,
         user_id=request_ctx.user_id,
         product_name=request_ctx.product_name,
@@ -116,15 +97,15 @@ async def list_services_latest(request: Request):
 )
 @login_required
 @permission_required("services.catalog.*")
-@_handlers_errors.reraise_catalog_exceptions_as_http_errors
+@reraise_catalog_exceptions_as_http_errors
 async def get_service(request: Request):
     request_ctx = CatalogRequestContext.create(request)
     path_params = parse_request_path_parameters_as(ServicePathParams, request)
 
     assert request_ctx  # nosec
     assert path_params  # nosec
 
-    service = await _api.get_service_v2(
+    service = await _service.get_service_v2(
         request.app,
         user_id=request_ctx.user_id,
         product_name=request_ctx.product_name,
@@ -142,7 +123,7 @@ async def get_service(request: Request):
 )
 @login_required
 @permission_required("services.catalog.*")
-@_handlers_errors.reraise_catalog_exceptions_as_http_errors
+@reraise_catalog_exceptions_as_http_errors
 async def update_service(request: Request):
     request_ctx = CatalogRequestContext.create(request)
     path_params = parse_request_path_parameters_as(ServicePathParams, request)
@@ -154,7 +135,7 @@ async def update_service(request: Request):
     assert path_params  # nosec
     assert update  # nosec
 
-    updated = await _api.update_service_v2(
+    updated = await _service.update_service_v2(
         request.app,
         user_id=request_ctx.user_id,
         product_name=request_ctx.product_name,
@@ -178,7 +159,7 @@ async def list_service_inputs(request: Request):
     path_params = parse_request_path_parameters_as(ServicePathParams, request)
 
     # Evaluate and return validated model
-    response_model = await _api.list_service_inputs(
+    response_model = await _service.list_service_inputs(
         path_params.service_key, path_params.service_version, ctx
     )
 
@@ -203,7 +184,7 @@ async def get_service_input(request: Request):
     path_params = parse_request_path_parameters_as(_ServiceInputsPathParams, request)
 
     # Evaluate and return validated model
-    response_model = await _api.get_service_input(
+    response_model = await _service.get_service_input(
         path_params.service_key,
         path_params.service_version,
         path_params.input_key,
@@ -236,7 +217,7 @@ async def get_compatible_inputs_given_source_output(request: Request):
     )
 
     # Evaluate and return validated model
-    data = await _api.get_compatible_inputs_given_source_output(
+    data = await _service.get_compatible_inputs_given_source_output(
         path_params.service_key,
         path_params.service_version,
         query_params.from_service_key,
@@ -261,7 +242,7 @@ async def list_service_outputs(request: Request):
     path_params = parse_request_path_parameters_as(ServicePathParams, request)
 
     # Evaluate and return validated model
-    response_model = await _api.list_service_outputs(
+    response_model = await _service.list_service_outputs(
         path_params.service_key, path_params.service_version, ctx
     )
 
@@ -286,7 +267,7 @@ async def get_service_output(request: Request):
     path_params = parse_request_path_parameters_as(_ServiceOutputsPathParams, request)
 
     # Evaluate and return validated model
-    response_model = await _api.get_service_output(
+    response_model = await _service.get_service_output(
         path_params.service_key,
         path_params.service_version,
         path_params.output_key,
@@ -323,7 +304,7 @@ async def get_compatible_outputs_given_target_input(request: Request):
         _ToServiceInputsParams, request
     )
 
-    data = await _api.get_compatible_outputs_given_target_input(
+    data = await _service.get_compatible_outputs_given_target_input(
         path_params.service_key,
         path_params.service_version,
         query_params.to_service_key,
@@ -351,11 +332,13 @@ async def get_service_resources(request: Request):
     """
     ctx = CatalogRequestContext.create(request)
     path_params = parse_request_path_parameters_as(ServicePathParams, request)
-    service_resources: ServiceResourcesDict = await client.get_service_resources(
-        request.app,
-        user_id=ctx.user_id,
-        service_key=path_params.service_key,
-        service_version=path_params.service_version,
+    service_resources: ServiceResourcesDict = (
+        await _catalog_rest_client.get_service_resources(
+            request.app,
+            user_id=ctx.user_id,
+            service_key=path_params.service_key,
+            service_version=path_params.service_version,
+        )
     )
 
     data = ServiceResourcesDictHelpers.create_jsonable(service_resources)
@@ -370,7 +353,7 @@ async def get_service_resources(request: Request):
 )
 @login_required
 @permission_required("services.catalog.*")
-@_handlers_errors.reraise_catalog_exceptions_as_http_errors
+@reraise_catalog_exceptions_as_http_errors
 async def get_service_pricing_plan(request: Request):
     ctx = CatalogRequestContext.create(request)
     path_params = parse_request_path_parameters_as(ServicePathParams, request)

services/web/server/src/simcore_service_webserver/catalog/exceptions.py → services/web/server/src/simcore_service_webserver/catalog/_exceptions.py

@@ -1,11 +1,36 @@
 """Defines the different exceptions that may arise in the catalog subpackage"""
 
+import functools
+
+from aiohttp import web
+from servicelib.aiohttp.typing_extension import Handler
 from servicelib.rabbitmq.rpc_interfaces.catalog.errors import (
     CatalogForbiddenError,
     CatalogItemNotFoundError,
 )
 
 from ..errors import WebServerBaseError
+from ..resource_usage.errors import DefaultPricingPlanNotFoundError
+
+
+def reraise_catalog_exceptions_as_http_errors(handler: Handler):
+    @functools.wraps(handler)
+    async def _wrapper(request: web.Request) -> web.StreamResponse:
+        try:
+
+            return await handler(request)
+
+        except (
+            CatalogItemNotFoundError,
+            DefaultPricingPlanNotFoundError,
+            DefaultPricingUnitForServiceNotFoundError,
+        ) as exc:
+            raise web.HTTPNotFound(reason=f"{exc}") from exc
+
+        except CatalogForbiddenError as exc:
+            raise web.HTTPForbidden(reason=f"{exc}") from exc
+
+    return _wrapper
 
 
 class BaseCatalogError(WebServerBaseError):

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

@@ -1,17 +1,30 @@
 import logging
+import urllib.parse
 from collections.abc import Callable
 from dataclasses import dataclass
 from typing import Any, Final
 
-from aiocache import cached  # type: ignore[import-untyped]
+from aiocache import cached
+from aiohttp import web
+from aiohttp.web import Request
 from models_library.api_schemas_webserver.catalog import (
     ServiceInputGet,
     ServiceInputKey,
     ServiceOutputGet,
     ServiceOutputKey,
 )
-from models_library.services import BaseServiceIOModel
+from models_library.rest_pagination import PageQueryParameters
+from models_library.services import BaseServiceIOModel, ServiceKey, ServiceVersion
+from models_library.users import UserID
 from pint import PintError, Quantity, UnitRegistry
+from pydantic import (  # type: ignore[import-untyped]
+    BaseModel,
+    ConfigDict,
+    field_validator,
+)
+from servicelib.aiohttp.requests_validation import handle_validation_as_http_error
+
+from ..constants import RQ_PRODUCT_KEY, RQT_USERID_KEY
 
 _logger = logging.getLogger(__name__)
 
@@ -131,3 +144,46 @@ async def from_catalog_service_api_model(
             )
 
         return port
+
+
+class CatalogRequestContext(BaseModel):
+    app: web.Application
+    user_id: UserID
+    product_name: str
+    unit_registry: UnitRegistry
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    @classmethod
+    def create(cls, request: Request) -> "CatalogRequestContext":
+        with handle_validation_as_http_error(
+            error_msg_template="Invalid request",
+            resource_name=request.rel_url.path,
+            use_error_v1=True,
+        ):
+            assert request.app  # nosec
+            return cls(
+                app=request.app,
+                user_id=request[RQT_USERID_KEY],
+                product_name=request[RQ_PRODUCT_KEY],
+                unit_registry=request.app[UnitRegistry.__name__],
+            )
+
+
+class ServicePathParams(BaseModel):
+    service_key: ServiceKey
+    service_version: ServiceVersion
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra="forbid",
+    )
+
+    @field_validator("service_key", mode="before")
+    @classmethod
+    def ensure_unquoted(cls, v):
+        # NOTE: this is needed as in pytest mode, the aiohttp server does not seem to unquote automatically
+        if v is not None:
+            return urllib.parse.unquote(v)
+        return v
+
+
+class ListServiceParams(PageQueryParameters): ...