✨ Trash projects (#6579)

Author: pcrespov

.env-devel

@@ -309,6 +309,7 @@ LOGIN_ACCOUNT_DELETION_RETENTION_DAYS=31
 LOGIN_REGISTRATION_CONFIRMATION_REQUIRED=0
 LOGIN_REGISTRATION_INVITATION_REQUIRED=0
 PROJECTS_INACTIVITY_INTERVAL=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

api/specs/web-server/_projects_crud.py

@@ -83,6 +83,7 @@ async def list_projects(
             example='{"field": "last_change_date", "direction": "desc"}',
         ),
     ] = '{"field": "last_change_date", "direction": "desc"}',
+    filters: Annotated[Json | None, Query()] = None,
 ):
     ...
 

api/specs/web-server/_trash.py

@@ -0,0 +1,61 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+
+from enum import Enum
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
+from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.projects._trash_handlers import (
+    ProjectPathParams,
+    RemoveQueryParams,
+)
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}",
+    tags=["trash"],
+)
+
+
+@router.delete(
+    "/trash",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+def empty_trash():
+    ...
+
+
+_extra_tags: list[str | Enum] = ["projects"]
+
+
+@router.post(
+    "/projects/{project_id}:trash",
+    tags=_extra_tags,
+    status_code=status.HTTP_204_NO_CONTENT,
+    responses={
+        status.HTTP_404_NOT_FOUND: {"description": "Not such a project"},
+        status.HTTP_409_CONFLICT: {
+            "description": "Project is in use and cannot be trashed"
+        },
+        status.HTTP_503_SERVICE_UNAVAILABLE: {"description": "Trash service error"},
+    },
+)
+def trash_project(
+    _p: Annotated[ProjectPathParams, Depends()],
+    _q: Annotated[RemoveQueryParams, Depends()],
+):
+    ...
+
+
+@router.post(
+    "/projects/{project_id}:untrash",
+    tags=_extra_tags,
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+def untrash_project(
+    _p: Annotated[ProjectPathParams, Depends()],
+):
+    ...

api/specs/web-server/openapi.py

@@ -55,6 +55,7 @@
         "_resource_usage",
         "_statics",
         "_storage",
+        "_trash",
         "_version_control",
         "_workspaces",
         # maintenance ----

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

@@ -1,14 +1,14 @@
 from datetime import datetime
 from typing import NamedTuple
 
-from models_library.access_rights import AccessRights
-from models_library.basic_types import IDStr
-from models_library.folders import FolderID
-from models_library.users import GroupID
-from models_library.utils.common_validators import null_or_none_str_to_none_validator
-from models_library.workspaces import WorkspaceID
 from pydantic import Extra, PositiveInt, validator
 
+from ..access_rights import AccessRights
+from ..basic_types import IDStr
+from ..folders import FolderID
+from ..users import GroupID
+from ..utils.common_validators import null_or_none_str_to_none_validator
+from ..workspaces import WorkspaceID
 from ._base import InputSchema, OutputSchema
 
 

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

@@ -5,6 +5,7 @@
 
 """
 
+from datetime import datetime
 from typing import Any, Literal, TypeAlias
 
 from models_library.folders import FolderID
@@ -85,6 +86,7 @@ class ProjectGet(OutputSchema):
     permalink: ProjectPermalink = FieldNotRequired()
     workspace_id: WorkspaceID | None
     folder_id: FolderID | None
+    trashed_at: datetime | None
 
     _empty_description = validator("description", allow_reuse=True, pre=True)(
         none_to_empty_str_pre_validator

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

@@ -186,6 +186,11 @@ class Project(BaseProjectModel):
         alias="folderId",
     )
 
+    trashed_at: datetime | None = Field(
+        default=None,
+        alias="trashedAt",
+    )
+
     class Config:
         description = "Document that stores metadata, pipeline and UI setup of a study"
         title = "osparc-simcore project"

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

@@ -1,7 +1,22 @@
-from pydantic import BaseModel
+from typing import Generic, TypeVar
+
+from pydantic import BaseModel, Field, Json
+from pydantic.generics import GenericModel
 
 
 class Filters(BaseModel):
-    """inspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.
+    """
     Encoded as JSON. Each available filter can have its own logic (should be well documented)
+    Inspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.
     """
+
+
+# Custom filter
+FilterT = TypeVar("FilterT", bound=Filters)
+
+
+class FiltersQueryParameters(GenericModel, Generic[FilterT]):
+    filters: Json[FilterT] | None = Field(  # pylint: disable=unsubscriptable-object
+        default=None,
+        description="Custom filter query parameter encoded as JSON",
+    )

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

@@ -1,8 +1,10 @@
 from typing import TypeAlias
 
+from models_library.basic_types import IDStr
 from pydantic import BaseModel, ConstrainedStr, Field, PositiveInt
 
 UserID: TypeAlias = PositiveInt
+UserNameID: TypeAlias = IDStr
 GroupID: TypeAlias = PositiveInt
 
 

packages/models-library/tests/test_rest_filters.py

@@ -0,0 +1,65 @@
+import logging
+
+import pytest
+from models_library.rest_filters import Filters, FiltersQueryParameters
+from pydantic import Extra, ValidationError
+
+
+# 1. create filter model
+class CustomFilter(Filters):
+    is_trashed: bool | None = None
+    is_hidden: bool | None = None
+
+
+class CustomFilterStrict(CustomFilter):
+    class Config(CustomFilter.Config):
+        extra = Extra.forbid
+
+
+def test_custom_filter_query_parameters():
+
+    # 2. use generic as query parameters
+    logging.info(
+        "json schema is for the query \n %s",
+        FiltersQueryParameters[CustomFilter].schema_json(indent=1),
+    )
+
+    # lets filter only is_trashed and unset is_hidden
+    custom_filter = CustomFilter(is_trashed=True)
+    assert custom_filter.json() == '{"is_trashed": true, "is_hidden": null}'
+
+    # default to None (optional)
+    query_param = FiltersQueryParameters[CustomFilter]()
+    assert query_param.filters is None
+
+
+@pytest.mark.parametrize(
+    "url_query_value,expects",
+    [
+        ('{"is_trashed": true, "is_hidden": null}', CustomFilter(is_trashed=True)),
+        ('{"is_trashed": true}', CustomFilter(is_trashed=True)),
+        (None, None),
+    ],
+)
+def test_valid_filter_queries(
+    url_query_value: str | None, expects: CustomFilter | None
+):
+    query_param = FiltersQueryParameters[CustomFilter](filters=url_query_value)
+    assert query_param.filters == expects
+
+
+def test_invalid_filter_query_is_ignored():
+    # NOTE: invalid filter get ignored!
+    url_query_value = '{"undefined_filter": true, "is_hidden": true}'
+
+    query_param = FiltersQueryParameters[CustomFilter](filters=url_query_value)
+    assert query_param.filters == CustomFilter(is_hidden=True)
+
+
+@pytest.mark.xfail
+def test_invalid_filter_query_fails():
+    # NOTE: this should fail according to pydantic manual but it does not
+    url_query_value = '{"undefined_filter": true, "is_hidden": true}'
+
+    with pytest.raises(ValidationError):
+        FiltersQueryParameters[CustomFilterStrict](filters=url_query_value)