new entrypoint for batch deletion

Author: sanderegg

api/specs/web-server/_storage.py

@@ -81,6 +81,19 @@ async def compute_path_size(_path: Annotated[StoragePathComputeSizeParams, Depen
     """Compute the size of a path"""
 
 
+@router.post(
+    "/storage/locations/{location_id}/-/paths:batchDelete",
+    response_model=Envelope[TaskGet],
+    status_code=status.HTTP_202_ACCEPTED,
+    description="Deletes Paths",
+)
+async def batch_delete_paths(
+    _path: Annotated[StorageLocationPathParams, Depends()],
+    _body: Annotated[BatchDeletePathsBodyParams, Depends()],
+):
+    """deletes files/folders if user has the rights to"""
+
+
 @router.get(
     "/storage/locations/{location_id}/datasets",
     response_model=Envelope[list[DatasetMetaData]],
@@ -174,18 +187,6 @@ async def delete_file(location_id: LocationID, file_id: StorageFileIDStr):
     """deletes file if user has the rights to"""
 
 
-@router.post(
-    "/storage/locations/{location_id}/-/files:batchDelete",
-    status_code=status.HTTP_204_NO_CONTENT,
-    description="Deletes Files",
-)
-async def batch_delete_files(
-    _path: Annotated[StorageLocationPathParams, Depends()],
-    _body: Annotated[BatchDeletePathsBodyParams, Depends()],
-):
-    """deletes file if user has the rights to"""
-
-
 @router.post(
     "/storage/locations/{location_id}/files/{file_id}:abort",
     status_code=status.HTTP_204_NO_CONTENT,

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/paths.py

@@ -32,3 +32,23 @@ async def compute_path_size(
         path=path,
     )
     return async_job_rpc_get, job_id_data
+
+
+async def delete_paths(
+    client: RabbitMQRPCClient,
+    *,
+    user_id: UserID,
+    product_name: ProductName,
+    location_id: LocationID,
+    paths: set[Path],
+) -> tuple[AsyncJobGet, AsyncJobNameData]:
+    job_id_data = AsyncJobNameData(user_id=user_id, product_name=product_name)
+    async_job_rpc_get = await submit(
+        rabbitmq_rpc_client=client,
+        rpc_namespace=STORAGE_RPC_NAMESPACE,
+        method_name=RPCMethodName("delete_paths"),
+        job_id_data=job_id_data,
+        location_id=location_id,
+        paths=paths,
+    )
+    return async_job_rpc_get, job_id_data

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -6168,6 +6168,38 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_TaskGet_'
+  /v0/storage/locations/{location_id}/-/paths:batchDelete:
+    post:
+      tags:
+      - storage
+      summary: Batch Delete Paths
+      description: Deletes Paths
+      operationId: batch_delete_paths
+      parameters:
+      - name: location_id
+        in: path
+        required: true
+        schema:
+          type: integer
+          title: Location Id
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              uniqueItems: true
+              items:
+                type: string
+                format: path
+              title: Paths
+      responses:
+        '202':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Envelope_TaskGet_'
   /v0/storage/locations/{location_id}/datasets:
     get:
       tags:

services/web/server/src/simcore_service_webserver/storage/_rest.py

@@ -22,7 +22,9 @@
     LinkType,
 )
 from models_library.api_schemas_webserver.storage import (
+    BatchDeletePathsBodyParams,
     DataExportPost,
+    StorageLocationPathParams,
     StoragePathComputeSizeParams,
 )
 from models_library.projects_nodes_io import LocationID
@@ -42,6 +44,9 @@
 from servicelib.rabbitmq.rpc_interfaces.storage.paths import (
     compute_path_size as remote_compute_path_size,
 )
+from servicelib.rabbitmq.rpc_interfaces.storage.paths import (
+    delete_paths as remote_delete_paths,
+)
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.rest_responses import unwrap_envelope
 from yarl import URL
@@ -206,6 +211,41 @@ async def compute_path_size(request: web.Request) -> web.Response:
     )
 
 
+@routes.post(
+    f"{_storage_locations_prefix}/{{location_id}}/-/paths:batchDelete",
+    name="batch_delete_paths",
+)
+@login_required
+@permission_required("storage.files.*")
+async def batch_delete_paths(
+    request: web.Request,
+):
+    req_ctx = RequestContext.model_validate(request)
+    path_params = parse_request_path_parameters_as(StorageLocationPathParams, request)
+    body = await parse_request_body_as(BatchDeletePathsBodyParams, request)
+
+    rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
+    async_job, _ = await remote_delete_paths(
+        rabbitmq_rpc_client,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        location_id=path_params.location_id,
+        paths=body.paths,
+    )
+
+    _job_id = f"{async_job.job_id}"
+    return create_data_response(
+        TaskGet(
+            task_id=_job_id,
+            task_name=_job_id,
+            status_href=f"{request.url.with_path(str(request.app.router['get_async_job_status'].url_for(task_id=_job_id)))}",
+            abort_href=f"{request.url.with_path(str(request.app.router['abort_async_job'].url_for(task_id=_job_id)))}",
+            result_href=f"{request.url.with_path(str(request.app.router['get_async_job_result'].url_for(task_id=_job_id)))}",
+        ),
+        status=status.HTTP_202_ACCEPTED,
+    )
+
+
 @routes.get(
     _storage_locations_prefix + "/{location_id}/datasets", name="list_datasets_metadata"
 )

services/web/server/tests/unit/with_dbs/01/storage/test_storage.py

@@ -44,6 +44,7 @@
 )
 from models_library.api_schemas_webserver._base import OutputSchema
 from models_library.api_schemas_webserver.storage import (
+    BatchDeletePathsBodyParams,
     DataExportPost,
 )
 from models_library.generics import Envelope
@@ -190,6 +191,51 @@ async def test_compute_path_size(
         TypeAdapter(TaskGet).validate_python(data)
 
 
+@pytest.mark.parametrize(
+    "user_role,expected",
+    [
+        (UserRole.ANONYMOUS, status.HTTP_401_UNAUTHORIZED),
+        (UserRole.GUEST, status.HTTP_202_ACCEPTED),
+        (UserRole.USER, status.HTTP_202_ACCEPTED),
+        (UserRole.TESTER, status.HTTP_202_ACCEPTED),
+    ],
+)
+@pytest.mark.parametrize(
+    "backend_result_or_exception",
+    [
+        AsyncJobGet(job_id=AsyncJobId(f"{_faker.uuid4()}")),
+    ],
+    ids=lambda x: type(x).__name__,
+)
+async def test_batch_delete_paths(
+    client: TestClient,
+    logged_user: dict[str, Any],
+    expected: int,
+    location_id: LocationID,
+    faker: Faker,
+    create_storage_paths_rpc_client_mock: Callable[[str, Any], None],
+    backend_result_or_exception: Any,
+):
+    create_storage_paths_rpc_client_mock(
+        submit.__name__,
+        backend_result_or_exception,
+    )
+
+    body = BatchDeletePathsBodyParams(
+        paths={Path(f"{faker.file_path(absolute=False)}")}
+    )
+
+    assert client.app
+    url = client.app.router["batch_delete_paths"].url_for(
+        location_id=f"{location_id}",
+    )
+
+    resp = await client.post(f"{url}", json=body.model_dump(mode="json"))
+    data, error = await assert_status(resp, expected)
+    if not error:
+        TypeAdapter(TaskGet).validate_python(data)
+
+
 @pytest.mark.parametrize(
     "user_role,expected",
     [