✨ Add ServiceListFilters for service type filtering in paginated service queries

Author: pcrespov

packages/models-library/src/models_library/api_schemas_catalog/services.py

@@ -9,6 +9,7 @@
 from ..boot_options import BootOptions
 from ..emails import LowerCaseEmailStr
 from ..groups import GroupID
+from ..rest_filters import Filters
 from ..services_access import ServiceAccessRights, ServiceGroupAccessRightsV2
 from ..services_authoring import Author
 from ..services_enums import ServiceType
@@ -376,4 +377,13 @@ class MyServiceGet(CatalogOutputSchema):
     my_access_rights: ServiceGroupAccessRightsV2
 
 
+class ServiceListFilters(Filters):
+    service_type: Annotated[
+        ServiceType | None,
+        Field(
+            description="Filter only services of a given type. If None, then all types are returned"
+        ),
+    ] = None
+
+
 __all__: tuple[str, ...] = ("ServiceRelease",)

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

@@ -5,7 +5,11 @@
 # pylint: disable=unused-variable
 
 
-from models_library.api_schemas_catalog.services import LatestServiceGet, ServiceGetV2
+from models_library.api_schemas_catalog.services import (
+    LatestServiceGet,
+    ServiceGetV2,
+    ServiceListFilters,
+)
 from models_library.api_schemas_webserver.catalog import (
     CatalogServiceUpdate,
 )
@@ -29,10 +33,12 @@ async def list_services_paginated(
         user_id: UserID,
         limit: PageLimitInt,
         offset: NonNegativeInt,
+        filters: ServiceListFilters | None = None,
     ):
         assert rpc_client
         assert product_name
         assert user_id
+        assert filters is None, "filters not mocked yet"
 
         items = TypeAdapter(list[LatestServiceGet]).validate_python(
             LatestServiceGet.model_json_schema()["examples"],
@@ -97,12 +103,14 @@ async def list_my_service_history_paginated(
         service_key: ServiceKey,
         offset: PageOffsetInt,
         limit: PageLimitInt,
+        filters: ServiceListFilters | None = None,
     ) -> PageRpc[ServiceRelease]:
 
         assert rpc_client
         assert product_name
         assert user_id
         assert service_key
+        assert filters is None, "filters not mocked yet"
 
         items = TypeAdapter(list[ServiceRelease]).validate_python(
             ServiceRelease.model_json_schema()["examples"],

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/catalog/services.py

@@ -10,6 +10,7 @@
     PageRpcLatestServiceGet,
     PageRpcServiceRelease,
     ServiceGetV2,
+    ServiceListFilters,
     ServiceRelease,
     ServiceUpdateV2,
 )
@@ -24,10 +25,10 @@
 from models_library.services_types import ServiceKey, ServiceVersion
 from models_library.users import UserID
 from pydantic import TypeAdapter, validate_call
-from servicelib.logging_utils import log_decorator
-from servicelib.rabbitmq._constants import RPC_REQUEST_DEFAULT_TIMEOUT_S
 
+from ....logging_utils import log_decorator
 from ..._client_rpc import RabbitMQRPCClient
+from ..._constants import RPC_REQUEST_DEFAULT_TIMEOUT_S
 
 _logger = logging.getLogger(__name__)
 
@@ -39,6 +40,7 @@ async def list_services_paginated(  # pylint: disable=too-many-arguments
     user_id: UserID,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
+    filters: ServiceListFilters | None = None,
 ) -> PageRpcLatestServiceGet:
     """
     Raises:
@@ -52,6 +54,7 @@ async def _call(
         user_id: UserID,
         limit: PageLimitInt,
         offset: PageOffsetInt,
+        filters: ServiceListFilters | None = None,
     ):
         return await rpc_client.request(
             CATALOG_RPC_NAMESPACE,
@@ -60,11 +63,16 @@ async def _call(
             user_id=user_id,
             limit=limit,
             offset=offset,
+            filters=filters,
             timeout_s=40 * RPC_REQUEST_DEFAULT_TIMEOUT_S,
         )
 
     result = await _call(
-        product_name=product_name, user_id=user_id, limit=limit, offset=offset
+        product_name=product_name,
+        user_id=user_id,
+        limit=limit,
+        offset=offset,
+        filters=filters,
     )
     assert (  # nosec
         TypeAdapter(PageRpc[LatestServiceGet]).validate_python(result) is not None
@@ -249,6 +257,7 @@ async def list_my_service_history_paginated(  # pylint: disable=too-many-argumen
     service_key: ServiceKey,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
+    filters: ServiceListFilters | None = None,
 ) -> PageRpcServiceRelease:
     """
     Raises:
@@ -262,6 +271,7 @@ async def _call(
         service_key: ServiceKey,
         limit: PageLimitInt,
         offset: PageOffsetInt,
+        filters: ServiceListFilters | None,
     ):
         return await rpc_client.request(
             CATALOG_RPC_NAMESPACE,
@@ -273,6 +283,7 @@ async def _call(
             service_key=service_key,
             limit=limit,
             offset=offset,
+            filters=filters,
         )
 
     result = await _call(
@@ -281,6 +292,7 @@ async def _call(
         service_key=service_key,
         limit=limit,
         offset=offset,
+        filters=filters,
     )
 
     assert (  # nosec

services/catalog/src/simcore_service_catalog/api/rpc/_services.py

@@ -8,6 +8,7 @@
     PageRpcLatestServiceGet,
     PageRpcServiceRelease,
     ServiceGetV2,
+    ServiceListFilters,
     ServiceUpdateV2,
 )
 from models_library.products import ProductName
@@ -23,8 +24,9 @@
     CatalogForbiddenError,
     CatalogItemNotFoundError,
 )
-from simcore_service_catalog.repository.groups import GroupsRepository
 
+from ...models.services_db import ServiceFiltersDB
+from ...repository.groups import GroupsRepository
 from ...repository.services import ServicesRepository
 from ...service import catalog_services
 from .._dependencies.director import get_director_client
@@ -55,6 +57,16 @@ async def _wrapper(app: FastAPI, **kwargs):
     return _wrapper
 
 
+def _type_adapter_to_domain(
+    filters: ServiceListFilters | None,
+) -> ServiceFiltersDB | None:
+    return (
+        ServiceFiltersDB.model_validate(filters, from_attributes=True)
+        if filters
+        else None
+    )
+
+
 @router.expose(reraise_if_error_type=(CatalogForbiddenError, ValidationError))
 @_profile_rpc_call
 @validate_call(config={"arbitrary_types_allowed": True})
@@ -65,6 +77,7 @@ async def list_services_paginated(
     user_id: UserID,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
+    filters: ServiceListFilters | None = None,
 ) -> PageRpcLatestServiceGet:
     assert app.state.engine  # nosec
 
@@ -75,6 +88,7 @@ async def list_services_paginated(
         user_id=user_id,
         limit=limit,
         offset=offset,
+        filters=_type_adapter_to_domain(filters),
     )
 
     assert len(items) <= total_count  # nosec
@@ -234,6 +248,7 @@ async def list_my_service_history_paginated(
     service_key: ServiceKey,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
+    filters: ServiceListFilters | None = None,
 ) -> PageRpcServiceRelease:
     assert app.state.engine  # nosec
 
@@ -244,6 +259,7 @@ async def list_my_service_history_paginated(
         service_key=service_key,
         limit=limit,
         offset=offset,
+        filters=_type_adapter_to_domain(filters),
     )
 
     assert len(items) <= total_count  # nosec

services/catalog/tests/unit/with_dbs/test_api_rpc.py

@@ -109,7 +109,7 @@ async def background_sync_task_mocked(
     await services_db_tables_injector(fake_data_for_services)
 
 
-async def test_rpc_catalog_with_no_services_returns_empty_page(
+async def test_rpc_list_services_paginated_with_no_services_returns_empty_page(
     background_sync_task_mocked: None,
     mocked_director_rest_api: MockRouter,
     rpc_client: RabbitMQRPCClient,
@@ -484,7 +484,7 @@ async def test_rpc_batch_get_my_services(
     assert my_services[1].release.version == other_service_version
 
 
-async def test_rpc_get_my_service_history(
+async def test_rpc_list_my_service_history_paginated(
     background_sync_task_mocked: None,
     mocked_director_rest_api: MockRouter,
     rpc_client: RabbitMQRPCClient,
@@ -553,3 +553,61 @@ async def test_rpc_get_my_service_history(
     assert len(release_history) == 2
     assert release_history[0].version == service_version_2, "expected newest first"
     assert release_history[1].version == service_version_1
+
+
+async def test_rpc_list_services_paginated_with_filters(
+    background_sync_task_mocked: None,
+    mocked_director_rest_api: MockRouter,
+    rpc_client: RabbitMQRPCClient,
+    product_name: ProductName,
+    user_id: UserID,
+    app: FastAPI,
+    create_fake_service_data: Callable,
+    services_db_tables_injector: Callable,
+):
+    assert app
+
+    # Create fake services with different types
+    service_key_1 = "simcore/services/comp/test-filter-service-1"
+    service_key_2 = "simcore/services/frontend/test-filter-service-2"
+    service_version = "1.0.0"
+
+    fake_services = [
+        create_fake_service_data(
+            service_key_1,
+            service_version,
+            team_access=None,
+            everyone_access=None,
+            product=product_name,
+            service_type="computational",
+        ),
+        create_fake_service_data(
+            service_key_2,
+            service_version,
+            team_access=None,
+            everyone_access=None,
+            product=product_name,
+            service_type="frontend",
+        ),
+    ]
+
+    # Inject fake services into the database
+    await services_db_tables_injector(fake_services)
+
+    # Apply a filter to match only computational services
+    filters = {"service_type": "computational"}
+    page = await list_services_paginated(
+        rpc_client,
+        product_name=product_name,
+        user_id=user_id,
+        filters=filters,
+    )
+
+    # Validate the response
+    assert len(page.data) == 1
+    assert page.data[0].key == service_key_1
+    assert page.data[0].service_type == "computational"
+    assert page.meta.total == 1
+    assert page.meta.count == 1
+    assert page.links.next is None
+    assert page.links.prev is None