@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,29 @@
+import logging
+
+from aiohttp import web
+
+from ...login.decorators import login_required
+from .._controller.rest.redirects import get_redirection_to_viewer
+from ..settings import StudiesDispatcherSettings
+from .rest.nih import routes as nih_routes
+from .rest.redirects import get_redirection_to_viewer
+
+_logger = logging.getLogger(__name__)
+
+
+def setup_controller(app: web.Application, settings: StudiesDispatcherSettings):
+    # routes
+    redirect_handler = get_redirection_to_viewer
+    if settings.is_login_required():
+        redirect_handler = login_required(get_redirection_to_viewer)
+
+        _logger.info(
+            "'%s' config explicitly disables anonymous users from this feature",
+            __name__,
+        )
+
+    app.router.add_routes(
+        [web.get("/view", redirect_handler, name="get_redirection_to_viewer")]
+    )
+
+    app.router.add_routes(nih_routes)

services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller/rest/__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/nih.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)