adds project trash

Author: pcrespov

api/specs/web-server/_trash.py

@@ -7,12 +7,8 @@
 from enum import Enum
 
 from fastapi import APIRouter
-from models_library.api_schemas_webserver.folders import FolderGet
-from models_library.api_schemas_webserver.projects import ProjectGet
-from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.folders._folders_handlers import FolderID
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -34,7 +30,6 @@ def empty_trash():
 
 @router.post(
     "/projects/{project_uuid}:trash",
-    response_model=Envelope[ProjectGet],
     tags=_extra_tags,
 )
 def trash_project(
@@ -48,27 +43,3 @@ def untrash_project(
     project_uuid: ProjectID,
 ):
     ...
-
-
-### Folders
-
-_extra_tags = ["folders"]
-
-
-@router.post(
-    "/folders/{folder_id}:trash", response_model=Envelope[FolderGet], tags=_extra_tags
-)
-def trash_folder(
-    folder_id: FolderID,
-):
-    ...
-
-
-@router.post("/folders/{folder_id}:untrash", tags=_extra_tags)
-def untrash_folder(
-    folder_id: FolderID,
-):
-    ...
-
-
-## TODO: workspaces

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

@@ -146,6 +146,11 @@ class ProjectPatch(InputSchema):
     quality: dict[str, Any] = FieldNotRequired()
 
 
+class ProjectPatchExtended(ProjectPatch):
+    # Only used internally
+    trashed_at: datetime | None = None
+
+
 __all__: tuple[str, ...] = (
     "EmptyModel",
     "ProjectCopyOverride",

services/web/server/src/simcore_service_webserver/projects/_trash_api.py

@@ -0,0 +1,34 @@
+import arrow
+from aiohttp import web
+from models_library.api_schemas_webserver.projects import ProjectPatchExtended
+from models_library.products import ProductName
+from models_library.projects import ProjectID
+from models_library.users import UserID
+
+from . import projects_api
+
+
+async def empty_trash(app: web.Application, product_name: ProductName, user_id: UserID):
+    # filter trashed=True and set them to False
+    raise NotImplementedError
+
+
+async def update_project(
+    app: web.Application,
+    *,
+    product_name: ProductName,
+    user_id: UserID,
+    project_id: ProjectID,
+    trashed: bool,
+):
+    # FIXME: can you trash something that is running?
+
+    await projects_api.patch_project(
+        app,
+        user_id=user_id,
+        product_name=product_name,
+        project_uuid=project_id,
+        project_patch=ProjectPatchExtended(
+            trashed_at=arrow.utcnow().datetime if trashed else None
+        ),
+    )

services/web/server/src/simcore_service_webserver/projects/_trash_handlers.py

@@ -0,0 +1,95 @@
+import functools
+
+from aiohttp import web
+from servicelib.aiohttp import status
+from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
+from servicelib.aiohttp.typing_extension import Handler
+from simcore_postgres_database.utils_tags import (
+    TagNotFoundError,
+    TagOperationNotAllowedError,
+)
+
+from .._meta import API_VTAG as VTAG
+from ..login.decorators import get_user_id, login_required
+from ..products.api import get_product_name
+from ..projects._common_models import ProjectPathParams
+from ..security.decorators import permission_required
+from . import _trash_api
+
+
+def _handle_trash_exceptions(handler: Handler):
+    @functools.wraps(handler)
+    async def wrapper(request: web.Request) -> web.StreamResponse:
+        try:
+            return await handler(request)
+
+        except TagNotFoundError as exc:
+            raise web.HTTPNotFound(reason=f"{exc}") from exc
+
+        except TagOperationNotAllowedError as exc:
+            raise web.HTTPForbidden(reason=f"{exc}") from exc
+
+    return wrapper
+
+
+routes = web.RouteTableDef()
+
+
+@routes.delete(f"/{VTAG}/trash", name="empty_trash")
+@login_required
+@permission_required("project.delete")
+@_handle_trash_exceptions
+async def empty_trash(request: web.Request):
+    user_id = get_user_id(request)
+    product_name = get_product_name(request)
+
+    await _trash_api.empty_trash(
+        request.app, product_name=product_name, user_id=user_id
+    )
+
+    return web.json_response(status=status.HTTP_204_NO_CONTENT)
+
+
+#
+# Projects
+#
+
+
+@routes.post(f"/{VTAG}/projects/{{project_id}}:trash", name="trash_project")
+@login_required
+@permission_required("project.delete")
+@_handle_trash_exceptions
+async def trash_project(request: web.Request):
+    user_id = get_user_id(request)
+    product_name = get_product_name(request)
+    path_params = parse_request_path_parameters_as(ProjectPathParams, request)
+
+    await _trash_api.update_project(
+        request.app,
+        product_name=product_name,
+        user_id=user_id,
+        project_id=path_params.project_id,
+        trashed=True,
+    )
+
+    return web.json_response(status=status.HTTP_204_NO_CONTENT)
+
+
+@routes.post(f"/{VTAG}/projects/{{project_uuid}}:untrash", name="untrash_project")
+@login_required
+@permission_required("project.delete")
+@_handle_trash_exceptions
+async def untrash_project(request: web.Request):
+    user_id = get_user_id(request)
+    product_name = get_product_name(request)
+    path_params = parse_request_path_parameters_as(ProjectPathParams, request)
+
+    await _trash_api.update_project(
+        request.app,
+        product_name=product_name,
+        user_id=user_id,
+        project_id=path_params.project_id,
+        trashed=False,
+    )
+
+    return web.json_response(status=status.HTTP_204_NO_CONTENT)

services/web/server/src/simcore_service_webserver/projects/plugin.py

@@ -20,6 +20,7 @@
     _projects_nodes_pricing_unit_handlers,
     _states_handlers,
     _tags_handlers,
+    _trash_handlers,
     _wallets_handlers,
     _workspaces_handlers,
 )
@@ -61,5 +62,6 @@ def setup_projects(app: web.Application) -> bool:
     app.router.add_routes(_folders_handlers.routes)
     app.router.add_routes(_projects_nodes_pricing_unit_handlers.routes)
     app.router.add_routes(_workspaces_handlers.routes)
+    app.router.add_routes(_trash_handlers.routes)
 
     return True

services/web/server/src/simcore_service_webserver/projects/projects_api.py

@@ -30,7 +30,10 @@
     DynamicServiceStart,
     DynamicServiceStop,
 )
-from models_library.api_schemas_webserver.projects import ProjectPatch
+from models_library.api_schemas_webserver.projects import (
+    ProjectPatch,
+    ProjectPatchExtended,
+)
 from models_library.api_schemas_webserver.projects_nodes import NodePatch
 from models_library.basic_types import KeyIDStr
 from models_library.errors import ErrorDict
@@ -249,7 +252,7 @@ async def patch_project(
     *,
     user_id: UserID,
     project_uuid: ProjectID,
-    project_patch: ProjectPatch,
+    project_patch: ProjectPatch | ProjectPatchExtended,
     product_name: ProductName,
 ):
     _project_patch_exclude_unset: dict[str, Any] = jsonable_encoder(