@sanderegg review: refactor schemas

Author: pcrespov

api/specs/web-server/_nih_sparc.py

@@ -8,7 +8,7 @@
 from fastapi import APIRouter
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.studies_dispatcher._rest_handlers import (
+from simcore_service_webserver.studies_dispatcher._controller.rest.nih_schemas import (
     ServiceGet,
     Viewer,
 )

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/__init__.py

@@ -0,0 +1,65 @@
+"""Handles requests to the Rest API"""
+
+import logging
+
+from aiohttp import web
+from aiohttp.web import Request
+from pydantic import (
+    ValidationError,
+)
+
+from ...._meta import API_VTAG
+from ....products import products_web
+from ....utils_aiohttp import envelope_json_response
+from ..._catalog import iter_latest_product_services
+from ..._core import list_viewers_info
+from .nih_schemas import ServiceGet, Viewer
+
+_logger = logging.getLogger(__name__)
+
+
+routes = web.RouteTableDef()
+
+
+@routes.get(f"/{API_VTAG}/services", name="list_latest_services")
+async def list_latest_services(request: Request):
+    """Returns a list latest version of services"""
+    product_name = products_web.get_product_name(request)
+
+    services = []
+    async for service_data in iter_latest_product_services(
+        request.app, product_name=product_name
+    ):
+        try:
+            service = ServiceGet.create(service_data, request)
+            services.append(service)
+        except ValidationError as err:
+            _logger.debug("Invalid %s: %s", f"{service_data=}", err)
+
+    return envelope_json_response(services)
+
+
+@routes.get(f"/{API_VTAG}/viewers", name="list_viewers")
+async def list_viewers(request: Request):
+    # filter: file_type=*
+    file_type: str | None = request.query.get("file_type", None)
+
+    viewers = [
+        Viewer.create(request, viewer).model_dump()
+        for viewer in await list_viewers_info(request.app, file_type=file_type)
+    ]
+    return envelope_json_response(viewers)
+
+
+@routes.get(f"/{API_VTAG}/viewers/default", name="list_default_viewers")
+async def list_default_viewers(request: Request):
+    # filter: file_type=*
+    file_type: str | None = request.query.get("file_type", None)
+
+    viewers = [
+        Viewer.create(request, viewer).model_dump()
+        for viewer in await list_viewers_info(
+            request.app, file_type=file_type, only_default=True
+        )
+    ]
+    return envelope_json_response(viewers)

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/__init__.py

@@ -1,5 +1,3 @@
-"""Handles requests to the Rest API"""
-
 import logging
 from dataclasses import asdict
 
@@ -12,18 +10,13 @@
     ConfigDict,
     Field,
     TypeAdapter,
-    ValidationError,
     field_validator,
 )
 from pydantic.networks import HttpUrl
 
-from .._meta import API_VTAG
-from ..products import products_web
-from ..utils_aiohttp import envelope_json_response
-from ._catalog import ServiceMetaData, iter_latest_product_services
-from ._controller_rest_redirects import ViewerQueryParams
-from ._core import list_viewers_info
-from ._models import ViewerInfo
+from ..._catalog import ServiceMetaData
+from ..._models import ViewerInfo
+from .redirects_schemas import ViewerQueryParams
 
 _logger = logging.getLogger(__name__)
 
@@ -149,55 +142,3 @@ def remove_dot_prefix_from_extension(cls, v):
             }
         }
     )
-
-
-#
-# API Handlers
-#
-
-
-routes = web.RouteTableDef()
-
-
-@routes.get(f"/{API_VTAG}/services", name="list_latest_services")
-async def list_latest_services(request: Request):
-    """Returns a list latest version of services"""
-    product_name = products_web.get_product_name(request)
-
-    services = []
-    async for service_data in iter_latest_product_services(
-        request.app, product_name=product_name
-    ):
-        try:
-            service = ServiceGet.create(service_data, request)
-            services.append(service)
-        except ValidationError as err:
-            _logger.debug("Invalid %s: %s", f"{service_data=}", err)
-
-    return envelope_json_response(services)
-
-
-@routes.get(f"/{API_VTAG}/viewers", name="list_viewers")
-async def list_viewers(request: Request):
-    # filter: file_type=*
-    file_type: str | None = request.query.get("file_type", None)
-
-    viewers = [
-        Viewer.create(request, viewer).model_dump()
-        for viewer in await list_viewers_info(request.app, file_type=file_type)
-    ]
-    return envelope_json_response(viewers)
-
-
-@routes.get(f"/{API_VTAG}/viewers/default", name="list_default_viewers")
-async def list_default_viewers(request: Request):
-    # filter: file_type=*
-    file_type: str | None = request.query.get("file_type", None)
-
-    viewers = [
-        Viewer.create(request, viewer).model_dump()
-        for viewer in await list_viewers_info(
-            request.app, file_type=file_type, only_default=True
-        )
-    ]
-    return envelope_json_response(viewers)

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/nih.py

@@ -15,36 +15,36 @@
 from servicelib.aiohttp.typing_extension import Handler
 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 ._controller_rest_redirects_schemas import (
-    FileQueryParams,
-    RedirectionQueryParams,
-    ServiceAndFileParams,
-    ServiceQueryParams,
-)
-from ._core import validate_requested_file, validate_requested_viewer
-from ._errors import (
+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 ..._core import validate_requested_file, validate_requested_viewer
+from ..._errors import (
     FileToLargeError,
     GuestUserNotAllowedError,
     GuestUsersLimitError,
     IncompatibleServiceError,
     InvalidRedirectionParamsError,
     ProjectWorkbenchMismatchError,
 )
-from ._models import ServiceInfo, ViewerInfo
-from ._projects import (
+from ..._models import ServiceInfo, ViewerInfo
+from ..._projects import (
     get_or_create_project_with_file,
     get_or_create_project_with_file_and_service,
     get_or_create_project_with_service,
 )
-from ._users import UserInfo, ensure_authentication, get_or_create_guest_user
-from .settings import get_plugin_settings
+from ..._users import UserInfo, ensure_authentication, get_or_create_guest_user
+from ...settings import get_plugin_settings
+from .redirects_schemas import (
+    FileQueryParams,
+    RedirectionQueryParams,
+    ServiceAndFileParams,
+    ServiceQueryParams,
+)
 
 _logger = logging.getLogger(__name__)
 

services/web/server/src/simcore_service_webserver/studies_dispatcher/_rest_handlers.py renamed to services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/nih_schemas.py

@@ -4,7 +4,7 @@
 from models_library.services import ServiceKey, ServiceVersion
 from pydantic import BaseModel, ConfigDict, field_validator
 
-from ._models import FileParams, ServiceParams, ViewerInfo
+from ..._models import FileParams, ServiceParams, ViewerInfo
 
 
 class ServiceQueryParams(ServiceParams):

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller_rest_redirects.py renamed to services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/redirects.py

@@ -5,8 +5,8 @@
 
 from ..login.decorators import login_required
 from ..products.plugin import setup_products
-from . import _rest_handlers
-from ._controller_rest_redirects import get_redirection_to_viewer
+from ._controller.rest import nih as _controller_rest_nih
+from ._controller.rest.redirects import get_redirection_to_viewer
 from ._projects_permalinks import setup_projects_permalinks
 from ._studies_access import get_redirection_to_study_page
 from .settings import StudiesDispatcherSettings, get_plugin_settings
@@ -62,6 +62,6 @@ def setup_studies_dispatcher(app: web.Application) -> bool:
         [web.get("/view", redirect_handler, name="get_redirection_to_viewer")]
     )
 
-    app.router.add_routes(_rest_handlers.routes)
+    app.router.add_routes(_controller_rest_nih.routes)
 
     return True

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller_rest_redirects_schemas.py renamed to services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/redirects_schemas.py

@@ -13,7 +13,7 @@
 from models_library.utils.pydantic_tools_extension import parse_obj_or_none
 from pydantic import ByteSize, TypeAdapter
 from servicelib.aiohttp.requests_validation import parse_request_query_parameters_as
-from simcore_service_webserver.studies_dispatcher._controller_rest_redirects_schemas import (
+from simcore_service_webserver.studies_dispatcher._controller.rest.redirects_schemas import (
     FileQueryParams,
     ServiceAndFileParams,
 )

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

@@ -34,8 +34,10 @@
 from settings_library.rabbit import RabbitSettings
 from settings_library.redis import RedisSettings
 from settings_library.utils_session import DEFAULT_SESSION_COOKIE_NAME
+from simcore_service_webserver.studies_dispatcher._controller.rest.nih_schemas import (
+    ServiceGet,
+)
 from simcore_service_webserver.studies_dispatcher._core import ViewerInfo
-from simcore_service_webserver.studies_dispatcher._rest_handlers import ServiceGet
 from sqlalchemy.sql import text
 from yarl import URL