@sanderegg review: refactor schemas

Author: pcrespov

services/web/server/src/simcore_service_webserver/studies_dispatcher/_redirects_handlers.py renamed to services/web/server/src/simcore_service_webserver/studies_dispatcher/_controller_rest_redirects.py

@@ -2,17 +2,14 @@
 
 import functools
 import logging
-import urllib.parse
-from typing import TypeAlias
 
 from aiohttp import web
 from common_library.error_codes import create_error_code
 from common_library.user_messages import user_message
 from models_library.function_services_catalog._utils import ServiceNotFound
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
-from models_library.services import ServiceKey, ServiceVersion
-from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
+from pydantic import ValidationError
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import parse_request_query_parameters_as
 from servicelib.aiohttp.typing_extension import Handler
@@ -25,6 +22,12 @@
 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 (
     FileToLargeError,
@@ -34,7 +37,7 @@
     InvalidRedirectionParamsError,
     ProjectWorkbenchMismatchError,
 )
-from ._models import FileParams, ServiceInfo, ServiceParams, ViewerInfo
+from ._models import ServiceInfo, ViewerInfo
 from ._projects import (
     get_or_create_project_with_file,
     get_or_create_project_with_file_and_service,
@@ -218,64 +221,6 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
     return wrapper
 
 
-#
-# API ScheMAS
-#
-
-
-class ServiceQueryParams(ServiceParams):
-    model_config = ConfigDict(extra="forbid")
-
-
-class FileQueryParams(FileParams):
-    model_config = ConfigDict(extra="forbid")
-
-    @field_validator("file_type")
-    @classmethod
-    def _ensure_extension_upper_and_dotless(cls, v):
-        # NOTE: see filetype constraint-check
-        if v and isinstance(v, str):
-            w = urllib.parse.unquote(v)
-            return w.upper().lstrip(".")
-        return v
-
-
-class ServiceAndFileParams(FileQueryParams, ServiceParams): ...
-
-
-class ViewerQueryParams(BaseModel):
-    file_type: str | None = None
-    viewer_key: ServiceKey
-    viewer_version: ServiceVersion
-
-    @staticmethod
-    def from_viewer(viewer: ViewerInfo) -> "ViewerQueryParams":
-        # can safely construct w/o validation from a viewer
-        return ViewerQueryParams.model_construct(
-            file_type=viewer.filetype,
-            viewer_key=viewer.key,
-            viewer_version=viewer.version,
-        )
-
-    @field_validator("file_type")
-    @classmethod
-    def _ensure_extension_upper_and_dotless(cls, v):
-        # NOTE: see filetype constraint-check
-        if v and isinstance(v, str):
-            w = urllib.parse.unquote(v)
-            return w.upper().lstrip(".")
-        return v
-
-
-RedirectionQueryParams: TypeAlias = (
-    # NOTE: Extra.forbid in FileQueryParams, ServiceQueryParams avoids bad casting when
-    # errors in ServiceAndFileParams
-    ServiceAndFileParams
-    | FileQueryParams
-    | ServiceQueryParams
-)
-
-
 #
 # API HANDLERS
 #

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

@@ -0,0 +1,60 @@
+import urllib.parse
+from typing import TypeAlias
+
+from models_library.services import ServiceKey, ServiceVersion
+from pydantic import BaseModel, ConfigDict, field_validator
+
+from ._models import FileParams, ServiceParams, ViewerInfo
+
+
+class ServiceQueryParams(ServiceParams):
+    model_config = ConfigDict(extra="forbid")
+
+
+class FileQueryParams(FileParams):
+    model_config = ConfigDict(extra="forbid")
+
+    @field_validator("file_type")
+    @classmethod
+    def _ensure_extension_upper_and_dotless(cls, v):
+        # NOTE: see filetype constraint-check
+        if v and isinstance(v, str):
+            w = urllib.parse.unquote(v)
+            return w.upper().lstrip(".")
+        return v
+
+
+class ServiceAndFileParams(FileQueryParams, ServiceParams): ...
+
+
+class ViewerQueryParams(BaseModel):
+    file_type: str | None = None
+    viewer_key: ServiceKey
+    viewer_version: ServiceVersion
+
+    @staticmethod
+    def from_viewer(viewer: ViewerInfo) -> "ViewerQueryParams":
+        # can safely construct w/o validation from a viewer
+        return ViewerQueryParams.model_construct(
+            file_type=viewer.filetype,
+            viewer_key=viewer.key,
+            viewer_version=viewer.version,
+        )
+
+    @field_validator("file_type")
+    @classmethod
+    def _ensure_extension_upper_and_dotless(cls, v):
+        # NOTE: see filetype constraint-check
+        if v and isinstance(v, str):
+            w = urllib.parse.unquote(v)
+            return w.upper().lstrip(".")
+        return v
+
+
+RedirectionQueryParams: TypeAlias = (
+    # NOTE: Extra.forbid in FileQueryParams, ServiceQueryParams avoids bad casting when
+    # errors in ServiceAndFileParams
+    ServiceAndFileParams
+    | FileQueryParams
+    | ServiceQueryParams
+)

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

@@ -21,9 +21,9 @@
 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 ._redirects_handlers import ViewerQueryParams
 
 _logger = logging.getLogger(__name__)
 

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

@@ -6,8 +6,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 ._projects_permalinks import setup_projects_permalinks
-from ._redirects_handlers import get_redirection_to_viewer
 from ._studies_access import get_redirection_to_study_page
 from .settings import StudiesDispatcherSettings, get_plugin_settings
 

services/web/server/tests/unit/isolated/test_studies_dispatcher_models.py

@@ -13,14 +13,14 @@
 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 (
+    FileQueryParams,
+    ServiceAndFileParams,
+)
 from simcore_service_webserver.studies_dispatcher._models import (
     FileParams,
     ServiceParams,
 )
-from simcore_service_webserver.studies_dispatcher._redirects_handlers import (
-    FileQueryParams,
-    ServiceAndFileParams,
-)
 from yarl import URL
 
 _SIZEBYTES = TypeAdapter(ByteSize).validate_python("3MiB")
@@ -79,9 +79,7 @@ def test_download_link_validators_2(file_and_service_params: dict[str, Any]):
     assert params.download_link
 
     assert params.download_link.host
-    assert params.download_link.host.endswith(
-        "s3.amazonaws.com"
-    )
+    assert params.download_link.host.endswith("s3.amazonaws.com")
 
     query = parse_qs(params.download_link.query)
     assert {"AWSAccessKeyId", "Signature", "Expires", "x-amz-request-payer"} == set(