include filters in RPC API

Author: pcrespov

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

@@ -2,16 +2,36 @@
 from typing import Annotated, TypeAlias
 from uuid import uuid4
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, StringConstraints
 from pydantic.config import JsonDict
 
 from ...projects import NodesDict, ProjectID
-from ...projects_filters import ListProjectsMarkedAsJobFilter
 from ...projects_nodes import Node
 from ...rpc_pagination import PageRpc
 
-# NOTE: for now these interfaces are identical
-ListProjectsMarkedAsJobRpcFilter: TypeAlias = ListProjectsMarkedAsJobFilter
+
+class MetadataFilterItem(BaseModel):
+    name: Annotated[
+        str,
+        StringConstraints(min_length=1, max_length=255),
+        Field(description="Name fo the custom metadata field"),
+    ]
+    pattern: Annotated[
+        str,
+        StringConstraints(min_length=1, max_length=255),
+        Field(description="Exact value or glob pattern"),
+    ]
+
+
+class ListProjectsMarkedAsJobRpcFilter(BaseModel):
+    # NOTE: add here any early validation of filters e.g. incompatible filters etc
+    job_parent_resource_name_prefix: str | None
+    any_of_metadata: Annotated[
+        list[MetadataFilterItem] | None,
+        Field(description="Searchs for matches of any of the custom metadata fields"),
+    ] = None
+
+    # TODO: update interface to list_projects_marked_as_jobs
 
 
 class ProjectJobRpcGet(BaseModel):

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_rpc_server.py

@@ -9,6 +9,7 @@
 from models_library.projects import ProjectID
 from models_library.rest_pagination import PageOffsetInt
 from models_library.rpc.webserver.projects import (
+    ListProjectsMarkedAsJobRpcFilter,
     PageRpcProjectJobRpcGet,
     ProjectJobRpcGet,
 )
@@ -56,24 +57,24 @@ async def list_projects_marked_as_jobs(
         # pagination
         offset: PageOffsetInt = 0,
         limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
-        # filters
-        job_parent_resource_name_prefix: str | None = None,
+        filters: ListProjectsMarkedAsJobRpcFilter | None = None,
     ) -> PageRpcProjectJobRpcGet:
         assert rpc_client
         assert product_name
         assert user_id
 
-        if job_parent_resource_name_prefix:
-            assert not job_parent_resource_name_prefix.startswith("/")
-            assert not job_parent_resource_name_prefix.endswith("%")
-            assert not job_parent_resource_name_prefix.startswith("%")
+        if filters and filters.job_parent_resource_name_prefix:
+            assert not filters.job_parent_resource_name_prefix.startswith("/")
+            assert not filters.job_parent_resource_name_prefix.endswith("%")
+            assert not filters.job_parent_resource_name_prefix.startswith("%")
 
         items = [
             item
             for item in ProjectJobRpcGet.model_json_schema()["examples"]
-            if job_parent_resource_name_prefix is None
+            if filters is None
+            or filters.job_parent_resource_name_prefix is None
             or item.get("job_parent_resource_name").startswith(
-                job_parent_resource_name_prefix
+                filters.job_parent_resource_name_prefix
             )
         ]
 

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/projects.py

@@ -6,7 +6,10 @@
 from models_library.projects import ProjectID
 from models_library.rabbitmq_basic_types import RPCMethodName
 from models_library.rest_pagination import PageOffsetInt
-from models_library.rpc.webserver.projects import PageRpcProjectJobRpcGet
+from models_library.rpc.webserver.projects import (
+    ListProjectsMarkedAsJobRpcFilter,
+    PageRpcProjectJobRpcGet,
+)
 from models_library.rpc_pagination import (
     DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     PageLimitInt,
@@ -51,8 +54,7 @@ async def list_projects_marked_as_jobs(
     # pagination
     offset: PageOffsetInt = 0,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
-    # filters
-    job_parent_resource_name_prefix: str | None = None,
+    filters: ListProjectsMarkedAsJobRpcFilter | None = None,
 ) -> PageRpcProjectJobRpcGet:
     result = await rpc_client.request(
         WEBSERVER_RPC_NAMESPACE,
@@ -61,7 +63,7 @@ async def list_projects_marked_as_jobs(
         user_id=user_id,
         offset=offset,
         limit=limit,
-        job_parent_resource_name_prefix=job_parent_resource_name_prefix,
+        filters=filters,
     )
     assert TypeAdapter(PageRpcProjectJobRpcGet).validate_python(result)  # nosec
     return cast(PageRpcProjectJobRpcGet, result)

services/api-server/src/simcore_service_api_server/services_rpc/wb_api_server.py

@@ -11,6 +11,7 @@
 from models_library.resource_tracker_licensed_items_checkouts import (
     LicensedItemCheckoutID,
 )
+from models_library.rpc.webserver.projects import ListProjectsMarkedAsJobRpcFilter
 from models_library.services_types import ServiceRunID
 from models_library.users import UserID
 from models_library.wallets import WalletID
@@ -228,13 +229,17 @@ async def list_projects_marked_as_jobs(
         limit: int = 50,
         job_parent_resource_name_prefix: str | None = None,
     ):
+        filters = ListProjectsMarkedAsJobRpcFilter(
+            job_parent_resource_name_prefix=job_parent_resource_name_prefix
+        )
+
         return await projects_rpc.list_projects_marked_as_jobs(
             rpc_client=self._client,
             product_name=product_name,
             user_id=user_id,
             offset=offset,
             limit=limit,
-            job_parent_resource_name_prefix=job_parent_resource_name_prefix,
+            filters=filters,
         )
 
 

services/web/server/src/simcore_service_webserver/projects/_controller/projects_rpc.py

@@ -66,9 +66,6 @@ async def list_projects_marked_as_jobs(
     # pagination
     offset: PageOffsetInt,
     limit: PageLimitInt,
-    # filters
-    # TODO: replace by ListProjectsMarkedAsJobsFilter
-    job_parent_resource_name_prefix: str | None,
     filters: ListProjectsMarkedAsJobRpcFilter | None = None,
 ) -> PageRpcProjectJobRpcGet:
 
@@ -78,8 +75,17 @@ async def list_projects_marked_as_jobs(
         user_id=user_id,
         offset=offset,
         limit=limit,
-        filter_by_job_parent_resource_name_prefix=job_parent_resource_name_prefix,
-        filter_by_metadata_any_of=filters.any_of_metadata if filters else None,
+        filter_by_job_parent_resource_name_prefix=(
+            filters.job_parent_resource_name_prefix if filters else None
+        ),
+        filter_by_any_custom_metadata=(
+            [
+                {custom_metadata.name: custom_metadata.pattern}
+                for custom_metadata in filters.any_of_metadata
+            ]
+            if filters and filters.any_of_metadata
+            else None
+        ),
     )
 
     job_projects = [

services/web/server/tests/unit/with_dbs/02/test_projects_rpc.py

@@ -114,7 +114,7 @@ async def test_rpc_client_list_my_projects_marked_as_jobs(
         rpc_client=rpc_client,
         product_name=product_name,
         user_id=user_id,
-        job_parent_resource_name_prefix="solvers/solver123",
+        filters={"job_parent_resource_name_prefix": "solvers/solver123"},
     )
 
     assert page.meta.total == 1