folders trashed-by

pcrespov · pcrespov · commit f70f1dcba5cb · 2025-01-17T18:17:24.000+01:00
diff --git a/packages/models-library/src/models_library/api_schemas_webserver/folders_v2.py b/packages/models-library/src/models_library/api_schemas_webserver/folders_v2.py
@@ -1,13 +1,12 @@
 from datetime import datetime
-from typing import NamedTuple
+from typing import Annotated, NamedTuple, Self
 
-from pydantic import ConfigDict, PositiveInt, field_validator
+from pydantic import ConfigDict, Field, PositiveInt, field_validator
 
 from ..access_rights import AccessRights
 from ..basic_types import IDStr
-from ..folders import FolderID
+from ..folders import FolderDB, FolderID
 from ..groups import GroupID
-from ..users import UserID
 from ..utils.common_validators import null_or_none_str_to_none_validator
 from ..workspaces import WorkspaceID
 from ._base import InputSchema, OutputSchema
@@ -17,16 +16,34 @@ class FolderGet(OutputSchema):
     folder_id: FolderID
     parent_folder_id: FolderID | None = None
     name: str
+
     created_at: datetime
     modified_at: datetime
     trashed_at: datetime | None
-    # NOTE: by design a folder is constraint to trashed_by == owner
-    # but we add this here for completeness
-    trashed_by: UserID | None
+    trashed_by: Annotated[
+        GroupID | None, Field(description="The primary gid of the user who trashed")
+    ]
     owner: GroupID
     workspace_id: WorkspaceID | None
     my_access_rights: AccessRights
 
+    @classmethod
+    def from_domain_model(
+        cls, folder_db: FolderDB, user_folder_access_rights: AccessRights
+    ) -> Self:
+        return cls(
+            folder_id=folder_db.folder_id,
+            parent_folder_id=folder_db.parent_folder_id,
+            name=folder_db.name,
+            created_at=folder_db.created,
+            modified_at=folder_db.modified,
+            trashed_at=folder_db.trashed,
+            trashed_by=folder_db.trashed_by_primary_gid,
+            owner=folder_db.created_by_gid,
+            workspace_id=folder_db.workspace_id,
+            my_access_rights=user_folder_access_rights,
+        )
+
 
 class FolderGetPage(NamedTuple):
     items: list[FolderGet]
diff --git a/packages/models-library/src/models_library/folders.py b/packages/models-library/src/models_library/folders.py
@@ -52,6 +52,7 @@ class FolderDB(BaseModel):
 
     trashed: datetime | None
     trashed_by: UserID | None
+    trashed_by_primary_gid: GroupID | None
     trashed_explicitly: bool
 
     user_id: UserID | None  # owner?
diff --git a/services/web/server/src/simcore_service_webserver/folders/_folders_repository.py b/services/web/server/src/simcore_service_webserver/folders/_folders_repository.py
@@ -28,6 +28,7 @@
 from simcore_postgres_database.models.folders_v2 import folders_v2
 from simcore_postgres_database.models.projects import projects
 from simcore_postgres_database.models.projects_to_folders import projects_to_folders
+from simcore_postgres_database.models.users import users
 from simcore_postgres_database.utils_repos import (
     pass_or_acquire_connection,
     transaction_context,
@@ -48,7 +49,7 @@
 _unset: Final = UnSet()
 
 
-_SELECTION_ARGS = (
+_FOLDERS_SELECTION_COLS = (
     folders_v2.c.folder_id,
     folders_v2.c.name,
     folders_v2.c.parent_folder_id,
@@ -91,7 +92,7 @@ async def create(
                 created=func.now(),
                 modified=func.now(),
             )
-            .returning(*_SELECTION_ARGS)
+            .returning(*_FOLDERS_SELECTION_COLS)
         )
         row = await result.first()
         return FolderDB.model_validate(row)
@@ -109,7 +110,7 @@ def _create_private_workspace_query(
         )
         return (
             select(
-                *_SELECTION_ARGS,
+                *_FOLDERS_SELECTION_COLS,
                 func.json_build_object(
                     "read",
                     sa.text("true"),
@@ -146,7 +147,8 @@ def _create_shared_workspace_query(
 
         shared_workspace_query = (
             select(
-                *_SELECTION_ARGS, workspace_access_rights_subquery.c.my_access_rights
+                *_FOLDERS_SELECTION_COLS,
+                workspace_access_rights_subquery.c.my_access_rights,
             )
             .select_from(
                 folders_v2.join(
@@ -270,21 +272,28 @@ async def list_(  # pylint: disable=too-many-arguments,too-many-branches
         return cast(int, total_count), folders
 
 
+def _create_base_select_query(folder_id: FolderID, product_name: ProductName):
+    return (
+        select(
+            *_FOLDERS_SELECTION_COLS,
+            users.c.primary_gid.label("trashed_by_primary_gid"),
+        )
+        .select_from(folders_v2.outerjoin(users, folders_v2.c.trashed_by == users.c.id))
+        .where(
+            (folders_v2.c.product_name == product_name)
+            & (folders_v2.c.folder_id == folder_id)
+        )
+    )
+
+
 async def get(
     app: web.Application,
     connection: AsyncConnection | None = None,
     *,
     folder_id: FolderID,
     product_name: ProductName,
 ) -> FolderDB:
-    query = (
-        select(*_SELECTION_ARGS)
-        .select_from(folders_v2)
-        .where(
-            (folders_v2.c.product_name == product_name)
-            & (folders_v2.c.folder_id == folder_id)
-        )
-    )
+    query = _create_base_select_query(folder_id=folder_id, product_name=product_name)
 
     async with pass_or_acquire_connection(get_asyncpg_engine(app), connection) as conn:
         result = await conn.execute(query)
@@ -309,16 +318,10 @@ async def get_for_user_or_workspace(
         user_id is not None and workspace_id is not None
     ), "Both user_id and workspace_id cannot be provided at the same time. Please provide only one."
 
-    query = (
-        select(*_SELECTION_ARGS)
-        .select_from(folders_v2)
-        .where(
-            (folders_v2.c.product_name == product_name)
-            & (folders_v2.c.folder_id == folder_id)
-        )
-    )
+    query = _create_base_select_query(folder_id=folder_id, product_name=product_name)
 
     if user_id:
+        # ownership
         query = query.where(folders_v2.c.user_id == user_id)
     else:
         query = query.where(folders_v2.c.workspace_id == workspace_id)
@@ -366,7 +369,7 @@ async def update(
     query = (
         (folders_v2.update().values(modified=func.now(), **updated))
         .where(folders_v2.c.product_name == product_name)
-        .returning(*_SELECTION_ARGS)
+        .returning(*_FOLDERS_SELECTION_COLS)
     )
 
     if isinstance(folders_id_or_ids, set):
@@ -583,4 +586,4 @@ async def get_folders_recursively(
         # Step 4: Execute the query to get all descendants
         final_query = select(folder_hierarchy_cte)
         result = await conn.stream(final_query)
-        return [FolderID(row[0]) async for row in result]
+        return cast(list[FolderID], [row.folder_id async for row in result])
diff --git a/services/web/server/src/simcore_service_webserver/folders/_folders_service.py b/services/web/server/src/simcore_service_webserver/folders/_folders_service.py
@@ -86,18 +86,7 @@ async def create_folder(
         user_id=user_id if workspace_is_private else None,
         workspace_id=workspace_id,
     )
-    return FolderGet(
-        folder_id=folder_db.folder_id,
-        parent_folder_id=folder_db.parent_folder_id,
-        name=folder_db.name,
-        created_at=folder_db.created,
-        modified_at=folder_db.modified,
-        trashed_at=folder_db.trashed,
-        trashed_by=folder_db.trashed_by,
-        owner=folder_db.created_by_gid,
-        workspace_id=workspace_id,
-        my_access_rights=user_folder_access_rights,
-    )
+    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
 
 
 async def get_folder(
@@ -130,18 +119,7 @@ async def get_folder(
         user_id=user_id if workspace_is_private else None,
         workspace_id=folder_db.workspace_id,
     )
-    return FolderGet(
-        folder_id=folder_db.folder_id,
-        parent_folder_id=folder_db.parent_folder_id,
-        name=folder_db.name,
-        created_at=folder_db.created,
-        modified_at=folder_db.modified,
-        trashed_at=folder_db.trashed,
-        trashed_by=folder_db.trashed_by,
-        owner=folder_db.created_by_gid,
-        workspace_id=folder_db.workspace_id,
-        my_access_rights=user_folder_access_rights,
-    )
+    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
 
 
 async def list_folders(
@@ -181,17 +159,9 @@ async def list_folders(
     )
     return FolderGetPage(
         items=[
-            FolderGet(
-                folder_id=folder.folder_id,
-                parent_folder_id=folder.parent_folder_id,
-                name=folder.name,
-                created_at=folder.created,
-                modified_at=folder.modified,
-                trashed_at=folder.trashed,
-                trashed_by=folder.trashed_by,
-                owner=folder.created_by_gid,
-                workspace_id=folder.workspace_id,
-                my_access_rights=folder.my_access_rights,
+            FolderGet.from_domain_model(
+                folder,
+                folder.my_access_rights,
             )
             for folder in folders
         ],
@@ -226,17 +196,9 @@ async def list_folders_full_depth(
     )
     return FolderGetPage(
         items=[
-            FolderGet(
-                folder_id=folder.folder_id,
-                parent_folder_id=folder.parent_folder_id,
-                name=folder.name,
-                created_at=folder.created,
-                modified_at=folder.modified,
-                trashed_at=folder.trashed,
-                trashed_by=folder.trashed_by,
-                owner=folder.created_by_gid,
-                workspace_id=folder.workspace_id,
-                my_access_rights=folder.my_access_rights,
+            FolderGet.from_domain_model(
+                folder,
+                folder.my_access_rights,
             )
             for folder in folders
         ],
@@ -304,18 +266,7 @@ async def update_folder(
         parent_folder_id=parent_folder_id,
         product_name=product_name,
     )
-    return FolderGet(
-        folder_id=folder_db.folder_id,
-        parent_folder_id=folder_db.parent_folder_id,
-        name=folder_db.name,
-        created_at=folder_db.created,
-        modified_at=folder_db.modified,
-        trashed_at=folder_db.trashed,
-        trashed_by=folder_db.trashed_by,
-        owner=folder_db.created_by_gid,
-        workspace_id=folder_db.workspace_id,
-        my_access_rights=user_folder_access_rights,
-    )
+    return FolderGet.from_domain_model(folder_db, user_folder_access_rights)
 
 
 async def delete_folder(
diff --git a/services/web/server/src/simcore_service_webserver/workspaces/_trash_services.py b/services/web/server/src/simcore_service_webserver/workspaces/_trash_services.py
@@ -12,8 +12,7 @@
 from ..db.plugin import get_asyncpg_engine
 from ..folders._trash_service import trash_folder, untrash_folder
 from ..projects._trash_service import trash_project, untrash_project
-from ._workspaces_repository import update_workspace
-from ._workspaces_service import check_user_workspace_access
+from . import _workspaces_repository, _workspaces_service
 
 _logger = logging.getLogger(__name__)
 
@@ -25,7 +24,7 @@ async def _check_exists_and_access(
     user_id: UserID,
     workspace_id: WorkspaceID,
 ):
-    await check_user_workspace_access(
+    await _workspaces_service.check_user_workspace_access(
         app=app,
         user_id=user_id,
         workspace_id=workspace_id,
@@ -50,7 +49,7 @@ async def trash_workspace(
 
     async with transaction_context(get_asyncpg_engine(app)) as connection:
         # EXPLICIT trash
-        await update_workspace(
+        await _workspaces_repository.update_workspace(
             app,
             connection,
             product_name=product_name,
@@ -59,10 +58,9 @@ async def trash_workspace(
         )
 
         # IMPLICIT trash
-        child_folders: list[FolderID] = (
-            []
+        child_folders: list[FolderID] = [
             # NOTE: follows up with https://github.com/ITISFoundation/osparc-simcore/issues/7034
-        )
+        ]
 
         for folder_id in child_folders:
             await trash_folder(
@@ -73,10 +71,9 @@ async def trash_workspace(
                 force_stop_first=force_stop_first,
             )
 
-        child_projects: list[ProjectID] = (
-            []
+        child_projects: list[ProjectID] = [
             # NOTE: follows up with https://github.com/ITISFoundation/osparc-simcore/issues/7034
-        )
+        ]
 
         for project_id in child_projects:
             await trash_project(
@@ -102,18 +99,17 @@ async def untrash_workspace(
 
     async with transaction_context(get_asyncpg_engine(app)) as connection:
         # EXPLICIT UNtrash
-        await update_workspace(
+        await _workspaces_repository.update_workspace(
             app,
             connection,
             product_name=product_name,
             workspace_id=workspace_id,
             updates=WorkspaceUpdates(trashed=None, trashed_by=None),
         )
 
-        child_folders: list[FolderID] = (
-            []
+        child_folders: list[FolderID] = [
             # NOTE: follows up with https://github.com/ITISFoundation/osparc-simcore/issues/7034
-        )
+        ]
 
         for folder_id in child_folders:
             await untrash_folder(
@@ -123,10 +119,9 @@ async def untrash_workspace(
                 folder_id=folder_id,
             )
 
-        child_projects: list[ProjectID] = (
-            []
+        child_projects: list[ProjectID] = [
             # NOTE: follows up with https://github.com/ITISFoundation/osparc-simcore/issues/7034
-        )
+        ]
 
         for project_id in child_projects:
             await untrash_project(
diff --git a/services/web/server/tests/unit/with_dbs/03/test_trash.py b/services/web/server/tests/unit/with_dbs/03/test_trash.py
@@ -448,19 +448,19 @@ async def test_trash_folder_with_content(
     data, _ = await assert_status(resp, status.HTTP_200_OK)
     got = FolderGet.model_validate(data)
     assert got.trashed_at is not None
-    assert got.trashed_by == logged_user["id"]
+    assert got.trashed_by == logged_user["primary_gid"]
 
     resp = await client.get(f"/v0/folders/{subfolder.folder_id}")
     data, _ = await assert_status(resp, status.HTTP_200_OK)
     got = FolderGet.model_validate(data)
     assert got.trashed_at is not None
-    assert got.trashed_by == logged_user["id"]
+    assert got.trashed_by == logged_user["primary_gid"]
 
     resp = await client.get(f"/v0/projects/{project_uuid}")
     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["id"]
+    assert got.trashed_by == logged_user["primary_gid"]
 
     # UNTRASH folder
     resp = await client.post(f"/v0/folders/{folder.folder_id}:untrash")
