Add has_function_id filter to function job collection filtering ✨

packages/models-library/src/models_library/api_schemas_api_server/functions.py

@@ -15,6 +15,7 @@
     FunctionJobCollection,
     FunctionJobCollectionID,
     FunctionJobCollectionIDNotFoundError,
+    FunctionJobCollectionsListFilters,
     FunctionJobCollectionStatus,
     FunctionJobID,
     FunctionJobIDNotFoundError,
@@ -53,6 +54,7 @@
     "FunctionJobCollectionID",
     "FunctionJobCollectionIDNotFoundError",
     "FunctionJobCollectionStatus",
+    "FunctionJobCollectionsListFilters",
     "FunctionJobID",
     "FunctionJobIDNotFoundError",
     "FunctionJobStatus",

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

@@ -18,6 +18,7 @@
     FunctionJobCollection,
     FunctionJobCollectionID,
     FunctionJobCollectionIDNotFoundError,
+    FunctionJobCollectionsListFilters,
     FunctionJobCollectionStatus,
     FunctionJobID,
     FunctionJobIDNotFoundError,
@@ -70,6 +71,7 @@
     "FunctionJobCollectionIDNotFoundError",
     "FunctionJobCollectionStatus",
     "FunctionJobCollectionStatus",
+    "FunctionJobCollectionsListFilters",
     "FunctionJobID",
     "FunctionJobID",
     "FunctionJobIDNotFoundError",

packages/models-library/src/models_library/functions.py

@@ -274,3 +274,14 @@ class FunctionJobCollectionDB(BaseModel):
 
 class RegisteredFunctionJobCollectionDB(FunctionJobCollectionDB):
     uuid: FunctionJobCollectionID
+
+
+class FunctionJobCollectionsListFilters(BaseModel):
+    """Filters for listing function job collections"""
+
+    has_function_id: Annotated[
+        str | None,
+        Field(
+            description="Filter by having a function ID in the collection",
+        ),
+    ] = None

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

@@ -9,6 +9,7 @@
     FunctionJob,
     FunctionJobCollection,
     FunctionJobCollectionID,
+    FunctionJobCollectionsListFilters,
     FunctionJobID,
     FunctionOutputSchema,
     RegisteredFunction,
@@ -146,12 +147,14 @@ async def list_function_job_collections(
     *,
     pagination_limit: int,
     pagination_offset: int,
+    filters: FunctionJobCollectionsListFilters | None = None,
 ) -> tuple[list[RegisteredFunctionJobCollection], PageMetaInfoLimitOffset]:
     result = await rabbitmq_rpc_client.request(
         WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("list_function_job_collections"),
         pagination_offset=pagination_offset,
         pagination_limit=pagination_limit,
+        filters=filters,
     )
     return TypeAdapter(
         tuple[list[RegisteredFunctionJobCollection], PageMetaInfoLimitOffset]

services/api-server/openapi.json

@@ -5695,6 +5695,24 @@
               "default": 0,
               "title": "Offset"
             }
+          },
+          {
+            "name": "has_function_id",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "Filter by having a function ID in the collection",
+              "title": "Has Function Id"
+            },
+            "description": "Filter by having a function ID in the collection"
           }
         ],
         "responses": {

services/api-server/src/simcore_service_api_server/api/dependencies/models_schemas_function_filters.py

@@ -0,0 +1,33 @@
+from typing import Annotated, Any
+
+from fastapi import Query
+from models_library.functions import FunctionJobCollectionsListFilters
+from pydantic.fields import FieldInfo
+
+
+def _get_query_params(field: FieldInfo) -> dict[str, Any]:
+    params = {}
+
+    if field.description:
+        params["description"] = field.description
+    if field.examples:
+        params["example"] = next(
+            (example for example in field.examples if "*" in example), field.examples[0]
+        )
+    return params
+
+
+def get_function_job_collections_filters(
+    # pylint: disable=unsubscriptable-object
+    has_function_id: Annotated[
+        str | None,
+        Query(
+            **_get_query_params(
+                FunctionJobCollectionsListFilters.model_fields["has_function_id"]
+            )
+        ),
+    ] = None,
+) -> FunctionJobCollectionsListFilters:
+    return FunctionJobCollectionsListFilters(
+        has_function_id=has_function_id,
+    )

services/api-server/src/simcore_service_api_server/api/routes/function_job_collections_routes.py

@@ -6,6 +6,7 @@
 from models_library.api_schemas_webserver.functions import (
     FunctionJobCollection,
     FunctionJobCollectionID,
+    FunctionJobCollectionsListFilters,
     FunctionJobCollectionStatus,
     RegisteredFunctionJob,
     RegisteredFunctionJobCollection,
@@ -17,6 +18,9 @@
 from ...services_http.director_v2 import DirectorV2Api
 from ...services_rpc.wb_api_server import WbApiRpcClient
 from ..dependencies.authentication import get_current_user_id
+from ..dependencies.models_schemas_function_filters import (
+    get_function_job_collections_filters,
+)
 from ..dependencies.services import get_api_client
 from ..dependencies.webserver_rpc import get_wb_api_rpc_client
 from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION, create_route_description
@@ -48,10 +52,14 @@
 async def list_function_job_collections(
     wb_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
     page_params: Annotated[PaginationParams, Depends()],
+    filters: Annotated[
+        FunctionJobCollectionsListFilters, Depends(get_function_job_collections_filters)
+    ],
 ):
     function_job_collection_list, meta = await wb_api_rpc.list_function_job_collections(
         pagination_offset=page_params.offset,
         pagination_limit=page_params.limit,
+        filters=filters,
     )
     return create_page(
         function_job_collection_list,

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

@@ -14,6 +14,7 @@
     FunctionJob,
     FunctionJobCollection,
     FunctionJobCollectionID,
+    FunctionJobCollectionsListFilters,
     FunctionJobID,
     FunctionOutputSchema,
     RegisteredFunction,
@@ -324,11 +325,13 @@ async def list_function_job_collections(
         *,
         pagination_offset: PageOffsetInt = 0,
         pagination_limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+        filters: FunctionJobCollectionsListFilters | None = None,
     ) -> tuple[list[RegisteredFunctionJobCollection], PageMetaInfoLimitOffset]:
         return await functions_rpc_interface.list_function_job_collections(
             self._client,
             pagination_offset=pagination_offset,
             pagination_limit=pagination_limit,
+            filters=filters,
         )
 
     async def run_function(

services/api-server/tests/unit/api_functions/conftest.py

@@ -16,6 +16,7 @@
     FunctionClass,
     FunctionIDNotFoundError,
     FunctionJob,
+    FunctionJobCollection,
     JSONFunctionInputSchema,
     JSONFunctionOutputSchema,
     ProjectFunction,
@@ -25,6 +26,7 @@
     RegisteredProjectFunction,
     RegisteredProjectFunctionJob,
 )
+from models_library.functions import RegisteredFunctionJobCollection
 from models_library.projects import ProjectID
 from pytest_mock import MockerFixture
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
@@ -98,7 +100,7 @@ def raise_function_id_not_found() -> FunctionIDNotFoundError:
 
 
 @pytest.fixture
-def sample_function(
+def mock_function(
     project_id: ProjectID,
     sample_input_schema: JSONFunctionInputSchema,
     sample_output_schema: JSONFunctionOutputSchema,
@@ -116,14 +118,14 @@ def sample_function(
 
 
 @pytest.fixture
-def sample_registered_function(sample_function: Function) -> RegisteredFunction:
-    return RegisteredProjectFunction(**{**sample_function.dict(), "uid": str(uuid4())})
+def mock_registered_function(mock_function: Function) -> RegisteredFunction:
+    return RegisteredProjectFunction(**{**mock_function.dict(), "uid": str(uuid4())})
 
 
 @pytest.fixture
-def sample_function_job(sample_registered_function: RegisteredFunction) -> FunctionJob:
+def mock_function_job(mock_registered_function: RegisteredFunction) -> FunctionJob:
     mock_function_job = {
-        "function_uid": sample_registered_function.uid,
+        "function_uid": mock_registered_function.uid,
         "title": "Test Function Job",
         "description": "A test function job",
         "inputs": {"key": "value"},
@@ -135,11 +137,35 @@ def sample_function_job(sample_registered_function: RegisteredFunction) -> Funct
 
 
 @pytest.fixture
-def sample_registered_function_job(
-    sample_function_job: FunctionJob,
+def mock_registered_function_job(
+    mock_function_job: FunctionJob,
 ) -> RegisteredFunctionJob:
     return RegisteredProjectFunctionJob(
-        **{**sample_function_job.dict(), "uid": str(uuid4())}
+        **{**mock_function_job.dict(), "uid": str(uuid4())}
+    )
+
+
+@pytest.fixture
+def mock_function_job_collection(
+    mock_registered_function_job: RegisteredFunctionJob,
+) -> FunctionJobCollection:
+    mock_function_job_collection = {
+        "title": "Test Function Job Collection",
+        "description": "A test function job collection",
+        "function_uid": mock_registered_function_job.function_uid,
+        "function_class": FunctionClass.PROJECT,
+        "project_id": str(uuid4()),
+        "function_job_ids": [mock_registered_function_job.uid for _ in range(5)],
+    }
+    return FunctionJobCollection(**mock_function_job_collection)
+
+
+@pytest.fixture
+def mock_registered_function_job_collection(
+    mock_function_job_collection: FunctionJobCollection,
+) -> RegisteredFunctionJobCollection:
+    return RegisteredFunctionJobCollection(
+        **{**mock_function_job_collection.model_dump(), "uid": str(uuid4())}
     )