refactor: update custom metadata handling to use NameValueTuple

Author: pcrespov

services/api-server/src/simcore_service_api_server/_service_jobs.py

@@ -15,6 +15,7 @@
 from models_library.users import UserID
 from pydantic import HttpUrl
 from servicelib.logging_utils import log_context
+from simcore_service_api_server.models.basic_types import NameValueTuple
 
 from .models.schemas.jobs import Job, JobInputs
 from .models.schemas.programs import Program
@@ -41,7 +42,7 @@ async def list_jobs(
         self,
         job_parent_resource_name: str,
         *,
-        filter_any_custom_metadata: list[dict[str, str]] | None = None,
+        filter_any_custom_metadata: list[NameValueTuple] | None = None,
         pagination_offset: PageOffsetInt = 0,
         pagination_limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:

services/api-server/src/simcore_service_api_server/_service_solvers.py

@@ -12,6 +12,7 @@
 from models_library.services_enums import ServiceType
 from models_library.users import UserID
 from pydantic import NonNegativeInt, PositiveInt
+from simcore_service_api_server.models.basic_types import NameValueTuple
 
 from ._service_jobs import JobService
 from ._service_utils import check_user_product_consistency
@@ -92,7 +93,7 @@ async def list_jobs(
         *,
         filter_by_solver_key: SolverKeyId | None = None,
         filter_by_solver_version: VersionStr | None = None,
-        filter_any_custom_metadata: list[dict[str, str]] | None = None,
+        filter_any_custom_metadata: list[NameValueTuple] | None = None,
         pagination_offset: PageOffsetInt = 0,
         pagination_limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:

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

@@ -25,7 +25,7 @@
 from ...exceptions.custom_errors import InsufficientCreditsError, MissingWalletError
 from ...exceptions.service_errors_utils import DEFAULT_BACKEND_SERVICE_STATUS_CODES
 from ...models.api_resources import parse_resources_ids
-from ...models.basic_types import LogStreamingResponse, VersionStr
+from ...models.basic_types import LogStreamingResponse, NameValueTuple, VersionStr
 from ...models.domain.files import File as DomainFile
 from ...models.pagination import Page, PaginationParams
 from ...models.schemas.errors import ErrorGet
@@ -147,7 +147,7 @@ async def list_all_solvers_jobs(
     jobs, meta = await solver_service.list_jobs(
         filter_any_custom_metadata=(
             [
-                {filter_metadata.name: filter_metadata.pattern}
+                NameValueTuple(filter_metadata.name, filter_metadata.pattern)
                 for filter_metadata in filter_job_metadata_params.any
             ]
             if filter_job_metadata_params

services/api-server/src/simcore_service_api_server/models/basic_types.py

@@ -1,4 +1,4 @@
-from typing import Annotated, TypeAlias
+from typing import Annotated, NamedTuple, TypeAlias
 
 from fastapi.responses import StreamingResponse
 from models_library.basic_regex import SIMPLE_VERSION_RE
@@ -13,3 +13,8 @@
 
 class LogStreamingResponse(StreamingResponse):
     media_type = "application/x-ndjson"
+
+
+class NameValueTuple(NamedTuple):
+    name: str
+    value: str

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

@@ -70,6 +70,7 @@
 from servicelib.rabbitmq.rpc_interfaces.webserver.licenses.licensed_items import (
     release_licensed_item_for_wallet as _release_licensed_item_for_wallet,
 )
+from simcore_service_api_server.models.basic_types import NameValueTuple
 
 from ..exceptions.backend_errors import (
     CanNotCheckoutServiceIsNotRunningError,
@@ -250,15 +251,14 @@ async def list_projects_marked_as_jobs(
         pagination_offset: int = 0,
         pagination_limit: int = 50,
         filter_by_job_parent_resource_name_prefix: str | None,
-        filter_any_custom_metadata: list[dict[str, str]] | None,
+        filter_any_custom_metadata: list[NameValueTuple] | None,
     ):
         filters = ListProjectsMarkedAsJobRpcFilters(
             job_parent_resource_name_prefix=filter_by_job_parent_resource_name_prefix,
             any_custom_metadata=(
                 [
                     MetadataFilterItem(name=name, pattern=pattern)
-                    for field_match in filter_any_custom_metadata
-                    for name, pattern in field_match.items()
+                    for name, pattern in filter_any_custom_metadata
                 ]
                 if filter_any_custom_metadata
                 else None

services/api-server/tests/unit/service/test_service_studies.py

@@ -28,7 +28,9 @@ async def test_list_jobs_no_study_id(
 
     # Verify proper prefix was used
     assert (
-        mocked_rpc_client.request.call_args.kwargs["job_parent_resource_name_prefix"]
+        mocked_rpc_client.request.call_args.kwargs[
+            "filters"
+        ].job_parent_resource_name_prefix
         == "study"
     )
 
@@ -49,7 +51,9 @@ async def test_list_jobs_with_study_id(
 
     # Verify proper prefix was used with study ID
     assert (
-        mocked_rpc_client.request.call_args.kwargs["job_parent_resource_name_prefix"]
+        mocked_rpc_client.request.call_args.kwargs[
+            "filters"
+        ].job_parent_resource_name_prefix
         == f"study/{study_id}"
     )
 

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

@@ -80,7 +80,7 @@ async def list_projects_marked_as_jobs(
         ),
         filter_any_custom_metadata=(
             [
-                {custom_metadata.name: custom_metadata.pattern}
+                (custom_metadata.name, custom_metadata.pattern)
                 for custom_metadata in filters.any_custom_metadata
             ]
             if filters and filters.any_custom_metadata

services/web/server/src/simcore_service_webserver/projects/_jobs_repository.py

@@ -38,7 +38,7 @@ def _apply_job_parent_resource_name_filter(
 
 
 def _apply_custom_metadata_filter(
-    query: sa.sql.Select, any_metadata_fields: list[dict[str, str]]
+    query: sa.sql.Select, any_metadata_fields: list[tuple[str, str]]
 ) -> sa.sql.Select:
     """Apply metadata filters to query.
 
@@ -48,16 +48,13 @@ def _apply_custom_metadata_filter(
     assert any_metadata_fields  # nosec
 
     metadata_fields_ilike = []
-    for field in any_metadata_fields:
-        for key, pattern in field.items():
-            # Use ->> operator to extract the text value from JSONB
-            # Then apply ILIKE for case-insensitive pattern matching
-            sql_pattern = pattern.replace(
-                "*", "%"
-            )  # Convert glob-like pattern to SQL LIKE
-            metadata_fields_ilike.append(
-                projects_metadata.c.custom[key].astext.ilike(sql_pattern)
-            )
+    for key, pattern in any_metadata_fields:
+        # Use ->> operator to extract the text value from JSONB
+        # Then apply ILIKE for case-insensitive pattern matching
+        sql_pattern = pattern.replace("*", "%")  # Convert glob-like pattern to SQL LIKE
+        metadata_fields_ilike.append(
+            projects_metadata.c.custom[key].astext.ilike(sql_pattern)
+        )
 
     return query.where(sa.or_(*metadata_fields_ilike))
 
@@ -95,7 +92,7 @@ async def list_projects_marked_as_jobs(
         pagination_offset: int,
         pagination_limit: int,
         filter_by_job_parent_resource_name_prefix: str | None = None,
-        filter_any_custom_metadata: list[dict[str, str]] | None = None,
+        filter_any_custom_metadata: list[tuple[str, str]] | None = None,
     ) -> tuple[int, list[ProjectJobDBGet]]:
         """Lists projects marked as jobs for a specific user and product
 

services/web/server/src/simcore_service_webserver/projects/_jobs_service.py

@@ -57,7 +57,7 @@ async def list_my_projects_marked_as_jobs(
     pagination_offset: int = 0,
     pagination_limit: int = 10,
     filter_by_job_parent_resource_name_prefix: str | None = None,
-    filter_any_custom_metadata: list[dict[str, str]] | None = None,
+    filter_any_custom_metadata: list[tuple[str, str]] | None = None,
 ) -> tuple[int, list[ProjectJobDBGet]]:
     """
     Lists paginated projects marked as jobs for the given user and product.

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

@@ -237,7 +237,7 @@ async def test_filter_projects_by_metadata(
     )
 
     # 3. Filter by exact metadata
-    filter_exact = [{"test_key": "test_value"}]
+    filter_exact = [("test_key", "test_value")]
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
@@ -249,7 +249,10 @@ async def test_filter_projects_by_metadata(
     assert result[0].uuid == project_uuid
 
     # 4. Filter by multiple metadata keys in one dict (AND condition)
-    filter_multiple_keys = [{"category": "simulation", "status": "completed"}]
+    filter_multiple_keys = [
+        ("category", "simulation"),
+        ("status", "completed"),
+    ]
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
@@ -262,8 +265,8 @@ async def test_filter_projects_by_metadata(
 
     # 5. Filter by alternative metadata (OR condition)
     filter_alternative = [
-        {"status": "completed"},
-        {"status": "pending"},
+        ("status", "completed"),
+        ("status", "pending"),
     ]
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
@@ -276,7 +279,7 @@ async def test_filter_projects_by_metadata(
     assert result[0].uuid == project_uuid
 
     # 6. Filter by non-matching metadata
-    filter_non_matching = [{"status": "failed"}]
+    filter_non_matching = [("status", "failed")]
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
@@ -288,7 +291,7 @@ async def test_filter_projects_by_metadata(
 
     # 7. Filter by wildcard pattern (requires SQL LIKE syntax)
     # This assumes the implementation supports wildcards in metadata values
-    filter_wildcard = [{"test_key": "test_*"}]
+    filter_wildcard = [("test_key", "test_*")]
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
@@ -305,7 +308,7 @@ async def test_filter_projects_by_metadata(
         product_name=osparc_product_name,
         user_id=user_id,
         filter_by_job_parent_resource_name_prefix="test/resource",
-        filter_any_custom_metadata=[{"category": "simulation"}],
+        filter_any_custom_metadata=[("category", "simulation")],
     )
     assert total_count == 1
     assert len(result) == 1
@@ -317,7 +320,7 @@ async def test_filter_projects_by_metadata(
         product_name=osparc_product_name,
         user_id=user_id,
         filter_by_job_parent_resource_name_prefix="non-matching",
-        filter_any_custom_metadata=[{"category": "simulation"}],
+        filter_any_custom_metadata=[("category", "simulation")],
     )
     assert total_count == 0
     assert len(result) == 0