adapts folders

Author: pcrespov

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

@@ -29,16 +29,23 @@ class FolderGet(OutputSchema):
 
     @classmethod
     def from_domain_model(
-        cls, folder_db: FolderDB, user_folder_access_rights: AccessRights
+        cls,
+        folder_db: FolderDB,
+        trashed_by_primary_gid: GroupID | None,
+        user_folder_access_rights: AccessRights,
     ) -> Self:
-        return cls.model_construct(
+        if (folder_db.trashed_by is None) ^ (trashed_by_primary_gid is None):
+            msg = f"Incompatible inputs: {folder_db.trashed_by=} but not {trashed_by_primary_gid=}"
+            raise ValueError(msg)
+
+        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,
+            trashed_by=trashed_by_primary_gid,
             owner=folder_db.created_by_gid,
             workspace_id=folder_db.workspace_id,
             my_access_rights=user_folder_access_rights,

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

@@ -36,11 +36,6 @@ def validate_folder_id(cls, value, info: ValidationInfo):
         return value
 
 
-#
-# DB
-#
-
-
 class FolderDB(BaseModel):
     folder_id: FolderID
     name: str
@@ -52,20 +47,20 @@ class FolderDB(BaseModel):
 
     trashed: datetime | None
     trashed_by: UserID | None
-    trashed_by_primary_gid: GroupID | None = None
     trashed_explicitly: bool
 
     user_id: UserID | None  # owner?
     workspace_id: WorkspaceID | None
     model_config = ConfigDict(from_attributes=True)
 
 
-class UserFolderAccessRightsDB(FolderDB):
+class UserFolder(FolderDB):
     my_access_rights: AccessRights
 
     model_config = ConfigDict(from_attributes=True)
 
 
-class Folder(NamedTuple):
+class FolderTuple(NamedTuple):
     folder_db: FolderDB
+    trashed_by_primary_gid: GroupID | None
     my_access_rights: AccessRights

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

@@ -16,7 +16,7 @@
     FolderID,
     FolderQuery,
     FolderScope,
-    UserFolderAccessRightsDB,
+    UserFolder,
 )
 from models_library.groups import GroupID
 from models_library.products import ProductName
@@ -30,6 +30,7 @@
 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 (
+    get_columns_from_db_model,
     pass_or_acquire_connection,
     transaction_context,
 )
@@ -49,19 +50,7 @@
 _unset: Final = UnSet()
 
 
-_FOLDERS_SELECTION_COLS = (
-    folders_v2.c.folder_id,
-    folders_v2.c.name,
-    folders_v2.c.parent_folder_id,
-    folders_v2.c.created_by_gid,
-    folders_v2.c.created,
-    folders_v2.c.modified,
-    folders_v2.c.trashed,
-    folders_v2.c.trashed_by,
-    folders_v2.c.trashed_explicitly,
-    folders_v2.c.user_id,
-    folders_v2.c.workspace_id,
-)
+_FOLDER_DB_MODEL_COLS = get_columns_from_db_model(folders_v2, FolderDB)
 
 
 async def create(
@@ -92,7 +81,7 @@ async def create(
                 created=func.now(),
                 modified=func.now(),
             )
-            .returning(*_FOLDERS_SELECTION_COLS)
+            .returning(*_FOLDER_DB_MODEL_COLS)
         )
         row = await result.first()
         return FolderDB.model_validate(row)
@@ -110,7 +99,7 @@ def _create_private_workspace_query(
         )
         return (
             select(
-                *_FOLDERS_SELECTION_COLS,
+                *_FOLDER_DB_MODEL_COLS,
                 func.json_build_object(
                     "read",
                     sa.text("true"),
@@ -147,7 +136,7 @@ def _create_shared_workspace_query(
 
         shared_workspace_query = (
             select(
-                *_FOLDERS_SELECTION_COLS,
+                *_FOLDER_DB_MODEL_COLS,
                 workspace_access_rights_subquery.c.my_access_rights,
             )
             .select_from(
@@ -191,7 +180,7 @@ async def list_(  # pylint: disable=too-many-arguments,too-many-branches
     limit: int,
     # order
     order_by: OrderBy,
-) -> tuple[int, list[UserFolderAccessRightsDB]]:
+) -> tuple[int, list[UserFolder]]:
     """
     folder_query - Used to filter in which folder we want to list folders.
     trashed - If set to true, it returns folders **explicitly** trashed, if false then non-trashed folders.
@@ -266,23 +255,16 @@ async def list_(  # pylint: disable=too-many-arguments,too-many-branches
         total_count = await conn.scalar(count_query)
 
         result = await conn.stream(list_query)
-        folders: list[UserFolderAccessRightsDB] = [
-            UserFolderAccessRightsDB.model_validate(row) async for row in result
+        folders: list[UserFolder] = [
+            UserFolder.model_validate(row) async for row in result
         ]
         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)
-        )
+def _create_base_select_query(folder_id: FolderID, product_name: ProductName) -> Select:
+    return select(*_FOLDER_DB_MODEL_COLS,).where(
+        (folders_v2.c.product_name == product_name)
+        & (folders_v2.c.folder_id == folder_id)
     )
 
 
@@ -369,7 +351,7 @@ async def update(
     query = (
         (folders_v2.update().values(modified=func.now(), **updated))
         .where(folders_v2.c.product_name == product_name)
-        .returning(*_FOLDERS_SELECTION_COLS)
+        .returning(*_FOLDER_DB_MODEL_COLS)
     )
 
     if isinstance(folders_id_or_ids, set):
@@ -587,3 +569,48 @@ async def get_folders_recursively(
         final_query = select(folder_hierarchy_cte)
         result = await conn.stream(final_query)
         return cast(list[FolderID], [row.folder_id async for row in result])
+
+
+async def get_trashed_by_primary_gid(
+    app: web.Application,
+    connection: AsyncConnection | None = None,
+    *,
+    folder_id: FolderID,
+) -> GroupID | None:
+    query = (
+        sa.select(
+            users.c.primary_gid.label("trashed_by_primary_gid"),
+        )
+        .select_from(projects.outerjoin(users, projects.c.trashed_by == users.c.id))
+        .where(folders_v2.c.folder_id == folder_id)
+    )
+
+    async with pass_or_acquire_connection(get_asyncpg_engine(app), connection) as conn:
+        result = await conn.execute(query)
+        row = result.first()
+        return row.trashed_by_primary_gid if row else None
+
+
+async def batch_get_trashed_by_primary_gid(
+    app: web.Application,
+    connection: AsyncConnection | None = None,
+    *,
+    folders_ids: list[FolderID],
+) -> list[GroupID | None]:
+
+    query = (
+        sa.select(
+            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.folder_id.in_(folders_ids))
+    ).order_by(
+        *[
+            folders_v2.c.folder_id == _id for _id in folders_ids
+        ]  # Preserves the order of folders_ids
+    )
+
+    async with pass_or_acquire_connection(get_asyncpg_engine(app), connection) as conn:
+        result = await conn.execute(query)
+        rows = result.fetchall()
+        return [row.trashed_by_primary_gid for row in rows]

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

@@ -6,7 +6,7 @@
     FolderGet,
     FolderReplaceBodyParams,
 )
-from models_library.folders import Folder
+from models_library.folders import FolderTuple
 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: Folder = await _folders_service.create_folder(
+    folder: FolderTuple = await _folders_service.create_folder(
         request.app,
         user_id=req_ctx.user_id,
         name=body_params.name,
@@ -64,7 +64,11 @@ async def create_folder(request: web.Request):
     )
 
     return envelope_json_response(
-        FolderGet.from_domain_model(folder.folder_db, folder.my_access_rights),
+        FolderGet.from_domain_model(
+            folder.folder_db,
+            trashed_by_primary_gid=None,
+            user_folder_access_rights=folder.my_access_rights,
+        ),
         web.HTTPCreated,
     )
 
@@ -150,14 +154,18 @@ async def get_folder(request: web.Request):
     req_ctx = FoldersRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(FoldersPathParams, request)
 
-    folder: Folder = await _folders_service.get_folder(
+    folder: FolderTuple = 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(
-        FolderGet.from_domain_model(folder.folder_db, folder.my_access_rights)
+        FolderGet.from_domain_model(
+            folder.folder_db,
+            folder.trashed_by_primary_gid,
+            user_folder_access_rights=folder.my_access_rights,
+        )
     )
 
 
@@ -173,7 +181,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: Folder = await _folders_service.update_folder(
+    folder: FolderTuple = await _folders_service.update_folder(
         app=request.app,
         user_id=req_ctx.user_id,
         folder_id=path_params.folder_id,
@@ -182,7 +190,11 @@ async def replace_folder(request: web.Request):
         product_name=req_ctx.product_name,
     )
     return envelope_json_response(
-        FolderGet.from_domain_model(folder.folder_db, folder.my_access_rights)
+        FolderGet.from_domain_model(
+            folder.folder_db,
+            folder.trashed_by_primary_gid,
+            user_folder_access_rights=folder.my_access_rights,
+        )
     )