♻️ web-server: preparation of trash plugin ⚠️

.env-devel

@@ -334,7 +334,6 @@ LOGIN_ACCOUNT_DELETION_RETENTION_DAYS=31
 LOGIN_REGISTRATION_CONFIRMATION_REQUIRED=0
 LOGIN_REGISTRATION_INVITATION_REQUIRED=0
 PROJECTS_INACTIVITY_INTERVAL=00:00:20
-PROJECTS_TRASH_RETENTION_DAYS=7
 PROJECTS_MAX_COPY_SIZE_BYTES=30Gib
 PROJECTS_MAX_NUM_RUNNING_DYNAMIC_NODES=5
 REST_SWAGGER_API_DOC_ENABLED=1
@@ -353,6 +352,7 @@ TRACING_OPENTELEMETRY_COLLECTOR_EXPORTER_ENDPOINT=http://jaeger:4318
 TRACING_OPENTELEMETRY_COLLECTOR_PORT=4318
 TRACING_OPENTELEMETRY_COLLECTOR_SAMPLING_PERCENTAGE=100
 TRAEFIK_SIMCORE_ZONE=internal_simcore_stack
+TRASH_RETENTION_DAYS=7
 TWILIO_ACCOUNT_SID=DUMMY
 TWILIO_AUTH_TOKEN=DUMMY
 TWILIO_COUNTRY_CODES_W_ALPHANUMERIC_SID_SUPPORT=["41"]

api/specs/web-server/_folders.py

@@ -19,14 +19,14 @@
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.folders._exceptions_handlers import _TO_HTTP_ERROR_MAP
-from simcore_service_webserver.folders._models import (
+from simcore_service_webserver.folders._common.exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
+from simcore_service_webserver.folders._common.models import (
     FolderSearchQueryParams,
     FoldersListQueryParams,
     FoldersPathParams,
-)
-from simcore_service_webserver.folders._workspaces_handlers import (
-    _FolderWorkspacesPathParams,
+    FolderWorkspacesPathParams,
 )
 
 router = APIRouter(
@@ -109,6 +109,6 @@ async def delete_folder(
     tags=["workspaces"],
 )
 async def move_folder_to_workspace(
-    _path: Annotated[_FolderWorkspacesPathParams, Depends()],
+    _path: Annotated[FolderWorkspacesPathParams, Depends()],
 ):
     ...

api/specs/web-server/_trash.py

@@ -10,12 +10,12 @@
 from fastapi import APIRouter, Depends, status
 from models_library.trash import RemoveQueryParams
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.folders._models import (
+from simcore_service_webserver.folders._common.models import (
     FoldersPathParams,
     FolderTrashQueryParams,
 )
-from simcore_service_webserver.projects._trash_handlers import ProjectPathParams
-from simcore_service_webserver.workspaces._models import (
+from simcore_service_webserver.projects._trash_rest import ProjectPathParams
+from simcore_service_webserver.workspaces._common.models import (
     WorkspacesPathParams,
     WorkspaceTrashQueryParams,
 )

api/specs/web-server/_workspaces.py

@@ -19,14 +19,16 @@
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.folders._exceptions_handlers import _TO_HTTP_ERROR_MAP
-from simcore_service_webserver.workspaces._groups_api import WorkspaceGroupGet
-from simcore_service_webserver.workspaces._models import (
+from simcore_service_webserver.folders._common.exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
+from simcore_service_webserver.workspaces._common.models import (
     WorkspacesGroupsBodyParams,
     WorkspacesGroupsPathParams,
     WorkspacesListQueryParams,
     WorkspacesPathParams,
 )
+from simcore_service_webserver.workspaces._groups_service import WorkspaceGroupGet
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",

packages/common-library/src/common_library/exclude.py

@@ -8,6 +8,10 @@ class UnSet:
 UnSet.VALUE = UnSet()
 
 
+def is_unset(v: Any) -> bool:
+    return isinstance(v, UnSet)
+
+
 def as_dict_exclude_unset(**params) -> dict[str, Any]:
     return {k: v for k, v in params.items() if not isinstance(v, UnSet)}
 

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

@@ -6,8 +6,9 @@
 """
 
 from datetime import datetime
-from typing import Annotated, Any, Literal, TypeAlias
+from typing import Annotated, Any, Literal, Self, TypeAlias
 
+from common_library.dict_tools import remap_keys
 from models_library.folders import FolderID
 from models_library.utils._original_fastapi_encoders import jsonable_encoder
 from models_library.workspaces import WorkspaceID
@@ -95,6 +96,7 @@ class ProjectGet(OutputSchema):
     permalink: ProjectPermalink | None = None
     workspace_id: WorkspaceID | None
     folder_id: FolderID | None
+
     trashed_at: datetime | None
 
     _empty_description = field_validator("description", mode="before")(
@@ -103,6 +105,15 @@ class ProjectGet(OutputSchema):
 
     model_config = ConfigDict(frozen=False)
 
+    @classmethod
+    def from_model(cls, project_data: dict[str, Any]) -> Self:
+        return cls.model_validate(
+            remap_keys(
+                project_data,
+                rename={"trashed": "trashed_at"},
+            )
+        )
+
 
 TaskProjectGet: TypeAlias = TaskGet
 
@@ -160,6 +171,9 @@ class ProjectPatch(InputSchema):
     ] = Field(default=None)
     quality: dict[str, Any] | None = Field(default=None)
 
+    def to_model(self) -> dict[str, Any]:
+        return self.model_dump(exclude_unset=True, by_alias=False)
+
 
 __all__: tuple[str, ...] = (
     "EmptyModel",

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):

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

@@ -64,7 +64,7 @@ class FolderDB(BaseModel):
         ...,
         description="Timestamp of last modification",
     )
-    trashed_at: datetime | None = Field(
+    trashed: datetime | None = Field(
         ...,
     )
 

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

@@ -20,6 +20,7 @@
 from .projects_nodes_io import NodeIDStr
 from .projects_state import ProjectState
 from .projects_ui import StudyUI
+from .users import UserID
 from .utils.common_validators import (
     empty_str_to_none_pre_validator,
     none_to_empty_str_pre_validator,
@@ -182,10 +183,10 @@ class Project(BaseProjectModel):
         alias="folderId",
     )
 
-    trashed_at: datetime | None = Field(
-        default=None,
-        alias="trashedAt",
-    )
-    trashed_explicitly: bool = Field(default=False, alias="trashedExplicitly")
+    trashed: datetime | None = None
+    trashed_by: Annotated[UserID | None, Field(alias="trashedBy")] = None
+    trashed_explicitly: Annotated[bool, Field(alias="trashedExplicitly")] = False
 
-    model_config = ConfigDict(title="osparc-simcore project", extra="forbid")
+    model_config = ConfigDict(
+        extra="forbid",
+    )

packages/postgres-database/src/simcore_postgres_database/migration/versions/f19905923355_adds_trashed_by_column.py

@@ -0,0 +1,84 @@
+"""Adds trashed by column
+
+Revision ID: f19905923355
+Revises: 307017ee1a49
+Create Date: 2025-01-10 16:43:21.559138+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "f19905923355"
+down_revision = "307017ee1a49"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+
+    with op.batch_alter_table("folders_v2") as batch_op:
+        batch_op.alter_column(
+            "trashed_at",
+            new_column_name="trashed",
+            comment="The date and time when the folders was marked as trashed. Null if the folders has not been trashed [default].",
+        )
+        batch_op.add_column(
+            sa.Column(
+                "trashed_by",
+                sa.BigInteger(),
+                nullable=True,
+                comment="User who trashed the folders, or null if not trashed or user is unknown.",
+            )
+        )
+        batch_op.create_foreign_key(
+            "fk_folders_trashed_by_user_id",
+            "users",
+            ["trashed_by"],
+            ["id"],
+            onupdate="CASCADE",
+            ondelete="SET NULL",
+        )
+
+    with op.batch_alter_table("projects") as batch_op:
+        batch_op.alter_column(
+            "trashed_at",
+            new_column_name="trashed",
+            comment="The date and time when the projects was marked as trashed. Null if the projects has not been trashed [default].",
+        )
+        batch_op.add_column(
+            sa.Column(
+                "trashed_by",
+                sa.BigInteger(),
+                nullable=True,
+                comment="User who trashed the projects, or null if not trashed or user is unknown.",
+            )
+        )
+        batch_op.create_foreign_key(
+            "fk_projects_trashed_by_user_id",
+            "users",
+            ["trashed_by"],
+            ["id"],
+            onupdate="CASCADE",
+            ondelete="SET NULL",
+        )
+
+
+def downgrade():
+    with op.batch_alter_table("projects") as batch_op:
+        batch_op.drop_constraint("fk_projects_trashed_by_user_id", type_="foreignkey")
+        batch_op.drop_column("trashed_by")
+        batch_op.alter_column(
+            "trashed",
+            new_column_name="trashed_at",
+            comment="The date and time when the project was marked as trashed. Null if the project has not been trashed [default].",
+        )
+
+    with op.batch_alter_table("folders_v2") as batch_op:
+        batch_op.drop_constraint("fk_folders_trashed_by_user_id", type_="foreignkey")
+        batch_op.drop_column("trashed_by")
+        batch_op.alter_column(
+            "trashed",
+            new_column_name="trashed_at",
+            comment="The date and time when the folder was marked as trashed. Null if the folder has not been trashed [default].",
+        )

packages/postgres-database/src/simcore_postgres_database/models/folders_v2.py

@@ -1,8 +1,15 @@
 import sqlalchemy as sa
 from sqlalchemy.sql import expression
 
-from ._common import RefActions, column_created_datetime, column_modified_datetime
+from ._common import (
+    RefActions,
+    column_created_datetime,
+    column_modified_datetime,
+    column_trashed_by_user,
+    column_trashed_datetime,
+)
 from .base import metadata
+from .users import users
 from .workspaces import workspaces
 
 folders_v2 = sa.Table(
@@ -75,13 +82,8 @@
     ),
     column_created_datetime(timezone=True),
     column_modified_datetime(timezone=True),
-    sa.Column(
-        "trashed_at",
-        sa.DateTime(timezone=True),
-        nullable=True,
-        comment="The date and time when the folder was marked as trashed."
-        "Null if the folder has not been trashed [default].",
-    ),
+    column_trashed_datetime("folders"),
+    column_trashed_by_user("folders", users_table=users),
     sa.Column(
         "trashed_explicitly",
         sa.Boolean,