rest model knows about domain model but not the opposite

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/workspaces.py

@@ -1,13 +1,14 @@
 from datetime import datetime
-from typing import NamedTuple
+from typing import Self
 
 from models_library.basic_types import IDStr
 from models_library.groups import GroupID
 from models_library.workspaces import WorkspaceID
-from pydantic import ConfigDict, PositiveInt
+from pydantic import ConfigDict
 
 from ..access_rights import AccessRights
 from ..users import UserID
+from ..workspaces import UserWorkspaceAccessRightsDB, WorkspaceID
 from ._base import InputSchema, OutputSchema
 
 
@@ -23,10 +24,20 @@ class WorkspaceGet(OutputSchema):
     my_access_rights: AccessRights
     access_rights: dict[GroupID, AccessRights]
 
-
-class WorkspaceGetPage(NamedTuple):
-    items: list[WorkspaceGet]
-    total: PositiveInt
+    @classmethod
+    def from_model(cls, workspace_db: UserWorkspaceAccessRightsDB) -> Self:
+        return cls(
+            workspace_id=workspace_db.workspace_id,
+            name=workspace_db.name,
+            description=workspace_db.description,
+            thumbnail=workspace_db.thumbnail,
+            created_at=workspace_db.created,
+            modified_at=workspace_db.modified,
+            trashed_at=workspace_db.trashed,
+            trashed_by=workspace_db.trashed_by if workspace_db.trashed else None,
+            my_access_rights=workspace_db.my_access_rights,
+            access_rights=workspace_db.access_rights,
+        )
 
 
 class WorkspaceCreateBodyParams(InputSchema):

services/web/server/src/simcore_service_webserver/workspaces/_workspaces_rest.py

@@ -4,12 +4,12 @@
 from models_library.api_schemas_webserver.workspaces import (
     WorkspaceCreateBodyParams,
     WorkspaceGet,
-    WorkspaceGetPage,
     WorkspaceReplaceBodyParams,
 )
 from models_library.rest_ordering import OrderBy
 from models_library.rest_pagination import Page
 from models_library.rest_pagination_utils import paginate_data
+from models_library.workspaces import UserWorkspaceAccessRightsDB
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
@@ -46,7 +46,7 @@ async def create_workspace(request: web.Request):
     req_ctx = WorkspacesRequestContext.model_validate(request)
     body_params = await parse_request_body_as(WorkspaceCreateBodyParams, request)
 
-    workspace: WorkspaceGet = await _workspaces_service.create_workspace(
+    workspace: UserWorkspaceAccessRightsDB = await _workspaces_service.create_workspace(
         request.app,
         user_id=req_ctx.user_id,
         name=body_params.name,
@@ -55,7 +55,7 @@ async def create_workspace(request: web.Request):
         product_name=req_ctx.product_name,
     )
 
-    return envelope_json_response(workspace, web.HTTPCreated)
+    return envelope_json_response(WorkspaceGet.from_model(workspace), web.HTTPCreated)
 
 
 @routes.get(f"/{VTAG}/workspaces", name="list_workspaces")
@@ -72,7 +72,7 @@ async def list_workspaces(request: web.Request):
         query_params.filters = WorkspacesFilters()
 
     assert query_params.filters
-    workspaces: WorkspaceGetPage = await _workspaces_service.list_workspaces(
+    total_count, workspaces = await _workspaces_service.list_workspaces(
         app=request.app,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
@@ -85,9 +85,9 @@ async def list_workspaces(request: web.Request):
 
     page = Page[WorkspaceGet].model_validate(
         paginate_data(
-            chunk=workspaces.items,
+            chunk=[WorkspaceGet.from_model(w) for w in workspaces],
             request_url=request.url,
-            total=workspaces.total,
+            total=total_count,
             limit=query_params.limit,
             offset=query_params.offset,
         )
@@ -106,14 +106,14 @@ async def get_workspace(request: web.Request):
     req_ctx = WorkspacesRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(WorkspacesPathParams, request)
 
-    workspace: WorkspaceGet = await _workspaces_service.get_workspace(
+    workspace = await _workspaces_service.get_workspace(
         app=request.app,
         workspace_id=path_params.workspace_id,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
     )
 
-    return envelope_json_response(workspace)
+    return envelope_json_response(WorkspaceGet.from_model(workspace))
 
 
 @routes.put(
@@ -128,14 +128,14 @@ async def replace_workspace(request: web.Request):
     path_params = parse_request_path_parameters_as(WorkspacesPathParams, request)
     body_params = await parse_request_body_as(WorkspaceReplaceBodyParams, request)
 
-    workspace: WorkspaceGet = await _workspaces_service.update_workspace(
+    workspace = await _workspaces_service.update_workspace(
         app=request.app,
         user_id=req_ctx.user_id,
         workspace_id=path_params.workspace_id,
         product_name=req_ctx.product_name,
         **body_params.model_dump(),
     )
-    return envelope_json_response(workspace)
+    return envelope_json_response(WorkspaceGet.from_model(workspace))
 
 
 @routes.delete(

services/web/server/src/simcore_service_webserver/workspaces/_workspaces_service.py

@@ -3,10 +3,6 @@
 import logging
 
 from aiohttp import web
-from models_library.api_schemas_webserver.workspaces import (
-    WorkspaceGet,
-    WorkspaceGetPage,
-)
 from models_library.products import ProductName
 from models_library.rest_ordering import OrderBy
 from models_library.users import UserID
@@ -25,21 +21,6 @@
 _logger = logging.getLogger(__name__)
 
 
-def _to_api_model(workspace_db: UserWorkspaceAccessRightsDB) -> WorkspaceGet:
-    return WorkspaceGet(
-        workspace_id=workspace_db.workspace_id,
-        name=workspace_db.name,
-        description=workspace_db.description,
-        thumbnail=workspace_db.thumbnail,
-        created_at=workspace_db.created,
-        modified_at=workspace_db.modified,
-        trashed_at=workspace_db.trashed,
-        trashed_by=workspace_db.trashed_by if workspace_db.trashed else None,
-        my_access_rights=workspace_db.my_access_rights,
-        access_rights=workspace_db.access_rights,
-    )
-
-
 async def create_workspace(
     app: web.Application,
     *,
@@ -48,7 +29,7 @@ async def create_workspace(
     description: str | None,
     thumbnail: str | None,
     product_name: ProductName,
-) -> WorkspaceGet:
+) -> UserWorkspaceAccessRightsDB:
     user = await get_user(app, user_id=user_id)
 
     created_workspace_db = await db.create_workspace(
@@ -59,13 +40,12 @@ async def create_workspace(
         description=description,
         thumbnail=thumbnail,
     )
-    workspace_db = await db.get_workspace_for_user(
+    return await db.get_workspace_for_user(
         app,
         user_id=user_id,
         workspace_id=created_workspace_db.workspace_id,
         product_name=product_name,
     )
-    return _to_api_model(workspace_db)
 
 
 async def get_workspace(
@@ -74,15 +54,14 @@ async def get_workspace(
     user_id: UserID,
     workspace_id: WorkspaceID,
     product_name: ProductName,
-) -> WorkspaceGet:
-    workspace_db = await check_user_workspace_access(
+) -> UserWorkspaceAccessRightsDB:
+    return await check_user_workspace_access(
         app=app,
         user_id=user_id,
         workspace_id=workspace_id,
         product_name=product_name,
         permission="read",
     )
-    return _to_api_model(workspace_db)
 
 
 async def list_workspaces(
@@ -95,7 +74,7 @@ async def list_workspaces(
     offset: NonNegativeInt,
     limit: int,
     order_by: OrderBy,
-) -> WorkspaceGetPage:
+) -> tuple[int, list[UserWorkspaceAccessRightsDB]]:
     total_count, workspaces = await db.list_workspaces_for_user(
         app,
         user_id=user_id,
@@ -107,10 +86,7 @@ async def list_workspaces(
         order_by=order_by,
     )
 
-    return WorkspaceGetPage(
-        items=[_to_api_model(workspace_db) for workspace_db in workspaces],
-        total=total_count,
-    )
+    return total_count, workspaces
 
 
 async def update_workspace(
@@ -120,7 +96,7 @@ async def update_workspace(
     user_id: UserID,
     workspace_id: WorkspaceID,
     **updates,
-) -> WorkspaceGet:
+) -> UserWorkspaceAccessRightsDB:
 
     await check_user_workspace_access(
         app=app,
@@ -135,13 +111,12 @@ async def update_workspace(
         product_name=product_name,
         updates=WorkspaceUpdateDB(**updates),
     )
-    workspace_db = await db.get_workspace_for_user(
+    return await db.get_workspace_for_user(
         app,
         user_id=user_id,
         workspace_id=workspace_id,
         product_name=product_name,
     )
-    return _to_api_model(workspace_db)
 
 
 async def delete_workspace(

services/web/server/tests/unit/with_dbs/02/test_projects_crud_handlers__clone_in_workspace_and_folder.py

@@ -3,9 +3,8 @@
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
 
-from collections.abc import Iterator
 from copy import deepcopy
-from typing import Any
+from typing import Any, AsyncIterator
 
 import pytest
 import sqlalchemy as sa
@@ -30,7 +29,9 @@
 @pytest.fixture
 async def create_workspace_and_folder(
     client: TestClient, logged_user: UserInfoDict, postgres_db: sa.engine.Engine
-) -> Iterator[tuple[WorkspaceID, FolderID]]:
+) -> AsyncIterator[tuple[WorkspaceID, FolderID]]:
+    assert client.app
+
     workspace = await create_workspace(
         client.app,
         user_id=logged_user["id"],