domain models in folders

Author: pcrespov

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

@@ -1,7 +1,7 @@
 from datetime import datetime
-from typing import Annotated, NamedTuple, Self
+from typing import Annotated, Self
 
-from pydantic import ConfigDict, Field, PositiveInt, field_validator
+from pydantic import ConfigDict, Field, field_validator
 
 from ..access_rights import AccessRights
 from ..basic_types import IDStr
@@ -31,7 +31,7 @@ class FolderGet(OutputSchema):
     def from_domain_model(
         cls, folder_db: FolderDB, user_folder_access_rights: AccessRights
     ) -> Self:
-        return cls(
+        return cls.model_construct(
             folder_id=folder_db.folder_id,
             parent_folder_id=folder_db.parent_folder_id,
             name=folder_db.name,
@@ -45,11 +45,6 @@ def from_domain_model(
         )
 
 
-class FolderGetPage(NamedTuple):
-    items: list[FolderGet]
-    total: PositiveInt
-
-
 class FolderCreateBodyParams(InputSchema):
     name: IDStr
     parent_folder_id: FolderID | None = None

packages/models-library/src/models_library/folders.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from enum import auto
-from typing import TypeAlias
+from typing import NamedTuple, TypeAlias
 
 from pydantic import BaseModel, ConfigDict, PositiveInt, ValidationInfo, field_validator
 
@@ -52,7 +52,7 @@ class FolderDB(BaseModel):
 
     trashed: datetime | None
     trashed_by: UserID | None
-    trashed_by_primary_gid: GroupID | None
+    trashed_by_primary_gid: GroupID | None = None
     trashed_explicitly: bool
 
     user_id: UserID | None  # owner?
@@ -64,3 +64,8 @@ class UserFolderAccessRightsDB(FolderDB):
     my_access_rights: AccessRights
 
     model_config = ConfigDict(from_attributes=True)
+
+
+class Folder(NamedTuple):
+    folder_db: FolderDB
+    my_access_rights: AccessRights

services/web/server/src/simcore_service_webserver/folders/_folders_rest.py

@@ -4,9 +4,9 @@
 from models_library.api_schemas_webserver.folders_v2 import (
     FolderCreateBodyParams,
     FolderGet,
-    FolderGetPage,
     FolderReplaceBodyParams,
 )
+from models_library.folders import Folder
 from models_library.rest_ordering import OrderBy
 from models_library.rest_pagination import ItemT, Page
 from models_library.rest_pagination_utils import paginate_data
@@ -54,7 +54,7 @@ async def create_folder(request: web.Request):
     req_ctx = FoldersRequestContext.model_validate(request)
     body_params = await parse_request_body_as(FolderCreateBodyParams, request)
 
-    folder = await _folders_service.create_folder(
+    folder: Folder = await _folders_service.create_folder(
         request.app,
         user_id=req_ctx.user_id,
         name=body_params.name,
@@ -63,7 +63,10 @@ async def create_folder(request: web.Request):
         workspace_id=body_params.workspace_id,
     )
 
-    return envelope_json_response(folder, web.HTTPCreated)
+    return envelope_json_response(
+        FolderGet.from_domain_model(folder.folder_db, folder.my_access_rights),
+        web.HTTPCreated,
+    )
 
 
 @routes.get(f"/{VTAG}/folders", name="list_folders")
@@ -79,7 +82,7 @@ async def list_folders(request: web.Request):
     if not query_params.filters:
         query_params.filters = FolderFilters()
 
-    folders: FolderGetPage = await _folders_service.list_folders(
+    folders, total_count = await _folders_service.list_folders(
         app=request.app,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
@@ -93,9 +96,9 @@ async def list_folders(request: web.Request):
 
     page = Page[FolderGet].model_validate(
         paginate_data(
-            chunk=folders.items,
+            chunk=[FolderGet.from_domain_model(*f) for f in folders],
             request_url=request.url,
-            total=folders.total,
+            total=total_count,
             limit=query_params.limit,
             offset=query_params.offset,
         )
@@ -116,7 +119,7 @@ async def list_folders_full_search(request: web.Request):
     if not query_params.filters:
         query_params.filters = FolderFilters()
 
-    folders: FolderGetPage = await _folders_service.list_folders_full_depth(
+    folders, total_count = await _folders_service.list_folders_full_depth(
         app=request.app,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
@@ -129,9 +132,9 @@ async def list_folders_full_search(request: web.Request):
 
     page = Page[FolderGet].model_validate(
         paginate_data(
-            chunk=folders.items,
+            chunk=[FolderGet.from_domain_model(*f) for f in folders],
             request_url=request.url,
-            total=folders.total,
+            total=total_count,
             limit=query_params.limit,
             offset=query_params.offset,
         )
@@ -147,14 +150,15 @@ async def get_folder(request: web.Request):
     req_ctx = FoldersRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(FoldersPathParams, request)
 
-    folder: FolderGet = await _folders_service.get_folder(
+    folder: Folder = await _folders_service.get_folder(
         app=request.app,
         folder_id=path_params.folder_id,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
     )
-
-    return envelope_json_response(folder)
+    return envelope_json_response(
+        FolderGet.from_domain_model(folder.folder_db, folder.my_access_rights)
+    )
 
 
 @routes.put(
@@ -169,7 +173,7 @@ async def replace_folder(request: web.Request):
     path_params = parse_request_path_parameters_as(FoldersPathParams, request)
     body_params = await parse_request_body_as(FolderReplaceBodyParams, request)
 
-    folder = await _folders_service.update_folder(
+    folder: Folder = await _folders_service.update_folder(
         app=request.app,
         user_id=req_ctx.user_id,
         folder_id=path_params.folder_id,

services/web/server/src/simcore_service_webserver/folders/_folders_service.py

@@ -4,8 +4,7 @@
 
 from aiohttp import web
 from models_library.access_rights import AccessRights
-from models_library.api_schemas_webserver.folders_v2 import FolderGet, FolderGetPage
-from models_library.folders import FolderID, FolderQuery, FolderScope
+from models_library.folders import Folder, FolderID, FolderQuery, FolderScope
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.rest_ordering import OrderBy
@@ -36,7 +35,7 @@ async def create_folder(
     parent_folder_id: FolderID | None,
     product_name: ProductName,
     workspace_id: WorkspaceID | None,
-) -> FolderGet:
+) -> Folder:
     user = await get_user(app, user_id=user_id)
 
     workspace_is_private = True
@@ -86,15 +85,15 @@ async def create_folder(
         user_id=user_id if workspace_is_private else None,
         workspace_id=workspace_id,
     )
-    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
+    return Folder(folder_db=folder_db, my_access_rights=user_folder_access_rights)
 
 
 async def get_folder(
     app: web.Application,
     user_id: UserID,
     folder_id: FolderID,
     product_name: ProductName,
-) -> FolderGet:
+) -> Folder:
     folder_db = await folders_db.get(
         app, folder_id=folder_id, product_name=product_name
     )
@@ -119,7 +118,7 @@ async def get_folder(
         user_id=user_id if workspace_is_private else None,
         workspace_id=folder_db.workspace_id,
     )
-    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
+    return Folder(folder_db=folder_db, my_access_rights=user_folder_access_rights)
 
 
 async def list_folders(
@@ -132,7 +131,7 @@ async def list_folders(
     offset: NonNegativeInt,
     limit: int,
     order_by: OrderBy,
-) -> FolderGetPage:
+) -> tuple[list[Folder], int]:
     # NOTE: Folder access rights for listing are checked within the listing DB function.
 
     total_count, folders = await folders_db.list_(
@@ -157,15 +156,15 @@ async def list_folders(
         limit=limit,
         order_by=order_by,
     )
-    return FolderGetPage(
-        items=[
-            FolderGet.from_domain_model(
-                folder,
-                folder.my_access_rights,
+    return (
+        [
+            Folder(
+                folder_db=folder,
+                my_access_rights=folder.my_access_rights,
             )
             for folder in folders
         ],
-        total=total_count,
+        total_count,
     )
 
 
@@ -179,7 +178,7 @@ async def list_folders_full_depth(
     offset: NonNegativeInt,
     limit: int,
     order_by: OrderBy,
-) -> FolderGetPage:
+) -> tuple[list[Folder], int]:
     # NOTE: Folder access rights for listing are checked within the listing DB function.
 
     total_count, folders = await folders_db.list_(
@@ -194,15 +193,15 @@ async def list_folders_full_depth(
         limit=limit,
         order_by=order_by,
     )
-    return FolderGetPage(
-        items=[
-            FolderGet.from_domain_model(
-                folder,
-                folder.my_access_rights,
+    return (
+        [
+            Folder(
+                folder_db=folder,
+                my_access_rights=folder.my_access_rights,
             )
             for folder in folders
         ],
-        total=total_count,
+        total_count,
     )
 
 
@@ -214,7 +213,7 @@ async def update_folder(
     name: str,
     parent_folder_id: FolderID | None,
     product_name: ProductName,
-) -> FolderGet:
+) -> Folder:
     folder_db = await folders_db.get(
         app, folder_id=folder_id, product_name=product_name
     )
@@ -266,7 +265,7 @@ async def update_folder(
         parent_folder_id=parent_folder_id,
         product_name=product_name,
     )
-    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
+    return Folder(folder_db, user_folder_access_rights)
 
 
 async def delete_folder(

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

@@ -41,7 +41,7 @@ async def create_workspace_and_folder(
         product_name="osparc",
     )
 
-    folder = await create_folder(
+    folder, _ = await create_folder(
         client.app,
         user_id=logged_user["id"],
         name="a",

services/web/server/tests/unit/with_dbs/03/test_trash.py

@@ -331,7 +331,7 @@ async def test_trash_single_folder(client: TestClient, logged_user: UserInfoDict
     assert got.trashed_at
     assert trashing_at < got.trashed_at
     assert got.trashed_at < arrow.utcnow().datetime
-    assert got.trashed_by == logged_user["id"]
+    assert got.trashed_by == logged_user["primary_gid"]
     assert got.owner == logged_user["primary_gid"]
 
     # LIST trashed
@@ -460,7 +460,7 @@ async def test_trash_folder_with_content(
     data, _ = await assert_status(resp, status.HTTP_200_OK)
     got = ProjectGet.model_validate(data)
     assert got.trashed_at is not None
-    assert got.trashed_by == logged_user["primary_gid"]
+    assert got.trashed_by == logged_user["id"]
 
     # UNTRASH folder
     resp = await client.post(f"/v0/folders/{folder.folder_id}:untrash")