feat: add rpc interface

Author: giancarloromeo

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

@@ -55,3 +55,21 @@ async def start_export_data(
         export_as=export_as,
     )
     return async_job_rpc_get, job_filter
+
+
+async def start_search(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    user_id: UserID,
+    product_name: ProductName,
+    name_pattern: str,
+) -> tuple[AsyncJobGet, AsyncJobFilter]:
+    job_filter = get_async_job_filter(user_id=user_id, product_name=product_name)
+    async_job_rpc_get = await submit(
+        rabbitmq_rpc_client,
+        rpc_namespace=STORAGE_RPC_NAMESPACE,
+        method_name=TypeAdapter(RPCMethodName).validate_python("start_search"),
+        job_filter=job_filter,
+        name_pattern=name_pattern,
+    )
+    return async_job_rpc_get, job_filter

services/storage/src/simcore_service_storage/api/_worker_tasks/_simcore_s3.py

@@ -132,18 +132,18 @@ async def export_data_as_download_link(
     return PresignedLink(link=download_link)
 
 
-async def search_files(
+async def search(
     task: Task,
     task_id: TaskID,
     *,
     user_id: UserID,
     project_id: ProjectID | None,
-    filename_pattern: str,
+    name_pattern: str,
 ) -> list[FileMetaData]:
     with log_context(
         _logger,
         logging.INFO,
-        f"'{task_id}' search file {filename_pattern=}",
+        f"'{task_id}' search file {name_pattern=}",
     ):
         dsm = get_dsm_provider(get_app_server(task.app).app).get(
             SimcoreS3DataManager.get_location_id()
@@ -152,10 +152,10 @@ async def search_files(
         assert isinstance(dsm, SimcoreS3DataManager)  # nosec
 
         pages = []
-        async for page in dsm.search_files(
+        async for page in dsm.search(
             user_id=user_id,
-            filename_pattern=filename_pattern,
             project_id=project_id,
+            name_pattern=name_pattern,
         ):
             # TODO: publish temporary result
             pages.extend(page)

services/storage/src/simcore_service_storage/api/_worker_tasks/tasks.py

@@ -18,7 +18,7 @@
     deep_copy_files_from_project,
     export_data,
     export_data_as_download_link,
-    search_files,
+    search,
 )
 
 _logger = logging.getLogger(__name__)
@@ -39,4 +39,4 @@ def setup_worker_tasks(app: Celery) -> None:
         register_task(app, complete_upload_file)
         register_task(app, delete_paths)
         register_task(app, deep_copy_files_from_project)
-        register_task(app, search_files)
+        register_task(app, search)

services/storage/src/simcore_service_storage/api/rpc/_simcore_s3.py

@@ -14,7 +14,7 @@
     deep_copy_files_from_project,
     export_data,
     export_data_as_download_link,
-    search_files,
+    search,
 )
 
 router = RPCRouter()
@@ -68,13 +68,13 @@ async def start_export_data(
 
 
 @router.expose()
-async def start_search_files(
+async def start_search(
     task_manager: TaskManager,
     job_filter: AsyncJobFilter,
-    filename_pattern: str,
+    name_pattern: str,
     project_id: str | None = None,
 ) -> AsyncJobGet:
-    task_name = search_files.__name__
+    task_name = search.__name__
     task_filter = TaskFilter.model_validate(job_filter.model_dump())
     task_uuid = await task_manager.submit_task(
         task_metadata=TaskMetadata(
@@ -83,7 +83,7 @@ async def start_search_files(
         ),
         task_filter=task_filter,
         user_id=job_filter.user_id,
-        filename_pattern=filename_pattern,
+        name_pattern=name_pattern,
         project_id=project_id,
     )
     return AsyncJobGet(job_id=task_uuid, job_name=task_name)

services/storage/src/simcore_service_storage/simcore_s3_dsm.py

@@ -1047,11 +1047,11 @@ async def _search_project_s3_files(
             ):
                 return
 
-    async def search_files(
+    async def search(
         self,
         user_id: UserID,
         *,
-        filename_pattern: str,
+        name_pattern: str,
         project_id: ProjectID | None = None,
         items_per_page: NonNegativeInt = 100,
     ) -> AsyncGenerator[list[FileMetaData], None]:
@@ -1076,7 +1076,7 @@ async def search_files(
         # Search each accessible project
         for proj_id in accessible_projects_ids:
             async for page_results in self._search_project_s3_files(
-                proj_id, filename_pattern, user_id, items_per_page
+                proj_id, name_pattern, user_id, items_per_page
             ):
                 yield page_results
 

services/storage/tests/unit/test_simcore_s3_dsm.py

@@ -201,9 +201,9 @@ async def test_search_files(
 
     # Test 1: Search for all .txt files
     txt_results = []
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="*.txt",
+        name_pattern="*.txt",
         project_id=project_id,
         items_per_page=10,
     ):
@@ -216,9 +216,9 @@ async def test_search_files(
 
     # Test 2: Search with specific prefix pattern
     data_results = []
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="data_*",
+        name_pattern="data_*",
         project_id=project_id,
         items_per_page=10,
     ):
@@ -230,9 +230,9 @@ async def test_search_files(
 
     # Test 3: Search with pattern that matches multiple extensions
     temp_results = []
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="temp_*",
+        name_pattern="temp_*",
         project_id=project_id,
         items_per_page=10,
     ):
@@ -244,9 +244,9 @@ async def test_search_files(
 
     # Test 4: Search with pattern that doesn't match anything
     no_match_results = []
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="nonexistent_*",
+        name_pattern="nonexistent_*",
         project_id=project_id,
         items_per_page=10,
     ):
@@ -256,9 +256,9 @@ async def test_search_files(
 
     # Test 5: Search without project_id restriction (all accessible projects)
     all_results = []
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="*",
+        name_pattern="*",
         items_per_page=10,
     ):
         all_results.extend(page)
@@ -277,9 +277,9 @@ async def test_search_files(
     # Test 6: Test pagination with small page size
     paginated_results = []
     page_count = 0
-    async for page in simcore_s3_dsm.search_files(
+    async for page in simcore_s3_dsm.search(
         user_id=user_id,
-        filename_pattern="*",
+        name_pattern="*",
         project_id=project_id,
         items_per_page=2,  # Small page size to test pagination
     ):