feat: add web server rest

Author: giancarloromeo

api/specs/web-server/_storage.py

@@ -27,6 +27,7 @@
     ListPathsQueryParams,
     StorageLocationPathParams,
     StoragePathComputeSizeParams,
+    SearchBodyParams
 )
 from models_library.generics import Envelope
 from models_library.projects_nodes_io import LocationID
@@ -236,3 +237,16 @@ async def is_completed_upload_file(
 )
 async def export_data(export_data: DataExportPost, location_id: LocationID):
     """Trigger data export. Returns async job id for getting status and results"""
+
+
+@router.post(
+    "/storage/locations/{location_id}/search",
+    response_model=Envelope[TaskGet],
+    name="search",
+    description="Starts a files/folders search",
+)
+async def search(
+    _path: Annotated[StorageLocationPathParams, Depends()],
+    _body: SearchBodyParams,
+):
+    """Trigger search. Returns async job id for getting status and results"""

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

@@ -42,3 +42,7 @@ class BatchDeletePathsBodyParams(InputSchema):
 
 class DataExportPost(InputSchema):
     paths: list[PathToExport]
+
+
+class SearchBodyParams(InputSchema):
+    name_pattern: str

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

@@ -7568,6 +7568,33 @@ paths:
               schema:
                 $ref: '#/components/schemas/EnvelopedError'
           description: Internal Server Error
+  /v0/storage/locations/{location_id}/search:
+    post:
+      tags:
+      - storage
+      summary: Search
+      description: Search
+      operationId: search
+      parameters:
+      - name: location_id
+        in: path
+        required: true
+        schema:
+          type: integer
+          title: Location Id
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SearchBodyParams'
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Envelope_TaskGet_'
   /v0/trash:empty:
     post:
       tags:
@@ -16423,6 +16450,15 @@ components:
         \ - A worker has picked up the task and is executing it\n- SUCCESS - Task\
         \ finished successfully\n- FAILED - Task finished with an error\n- ABORTED\
         \ - Task was aborted before completion"
+    SearchBodyParams:
+      properties:
+        namePattern:
+          type: string
+          title: Namepattern
+      type: object
+      required:
+      - namePattern
+      title: SearchBodyParams
     SelectBox:
       properties:
         structure:

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

@@ -22,6 +22,7 @@
 from models_library.api_schemas_webserver.storage import (
     BatchDeletePathsBodyParams,
     DataExportPost,
+    SearchBodyParams,
     StorageLocationPathParams,
     StoragePathComputeSizeParams,
 )
@@ -44,7 +45,7 @@
 from servicelib.rabbitmq.rpc_interfaces.storage.paths import (
     delete_paths as remote_delete_paths,
 )
-from servicelib.rabbitmq.rpc_interfaces.storage.simcore_s3 import start_export_data
+from servicelib.rabbitmq.rpc_interfaces.storage.simcore_s3 import start_export_data, start_search
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.rest_responses import unwrap_envelope
 from yarl import URL
@@ -509,3 +510,45 @@ def allow_only_simcore(cls, v: int) -> int:
         ),
         status=status.HTTP_202_ACCEPTED,
     )
+
+
+@routes.post(
+    _storage_locations_prefix + "/{location_id}/search", name="search"
+)
+@login_required
+@permission_required("storage.files.*")
+@handle_export_data_exceptions
+async def search(request: web.Request) -> web.Response:
+    class _PathParams(BaseModel):
+        location_id: LocationID
+
+        @field_validator("location_id")
+        @classmethod
+        def allow_only_simcore(cls, v: int) -> int:
+            if v != 0:
+                msg = f"Only simcore (location_id='0'), provided location_id='{v}' is not allowed"
+                raise ValueError(msg)
+            return v
+
+    rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
+    _req_ctx = AuthenticatedRequestContext.model_validate(request)
+    _ = parse_request_path_parameters_as(_PathParams, request)
+    search_body = await parse_request_body_as(
+        model_schema_cls=SearchBodyParams, request=request
+    )
+    async_job_rpc_get, _ = await start_search(
+        rabbitmq_rpc_client=rabbitmq_rpc_client,
+        user_id=_req_ctx.user_id,
+        product_name=_req_ctx.product_name,
+        name_pattern=search_body.name_pattern,
+    )
+    _job_id = f"{async_job_rpc_get.job_id}"
+    return create_data_response(
+        TaskGet(
+            task_id=_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['cancel_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,
+    )