updates listing

Author: pcrespov

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

@@ -171,7 +171,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-class ServiceGetV2Base(CatalogOutputSchema):
+class _BaseServiceGetV2(CatalogOutputSchema):
     # Model used in catalog's rpc and rest interfaces
     key: ServiceKey
     version: ServiceVersion
@@ -205,8 +205,14 @@ class ServiceGetV2Base(CatalogOutputSchema):
     classifiers: list[str] | None = []
     quality: dict[str, Any] = {}
 
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+        alias_generator=snake_to_camel,
+    )
 
-class ServiceGetV2(ServiceGetV2Base):
+
+class ServiceGetV2(_BaseServiceGetV2):
     # Model used in catalog's rpc and rest interfaces
     history: Annotated[
         list[ServiceRelease],
@@ -278,14 +284,11 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
         )
 
     model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-        alias_generator=snake_to_camel,
         json_schema_extra=_update_json_schema_extra,
     )
 
 
-class ServiceItemList(ServiceGetV2Base):
+class ServiceItemList(_BaseServiceGetV2):
     release: ServiceRelease
     history: Annotated[
         list[ServiceRelease],

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

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import TypeAlias
+from typing import Annotated, TypeAlias
 
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -8,51 +8,50 @@
 
 
 class CompatibleService(BaseModel):
-    key: ServiceKey | None = Field(
-        default=None,
-        description="If None, it refer to current service. Used only for inter-service compatibility",
-    )
+    key: Annotated[
+        ServiceKey | None,
+        Field(
+            description="If None, it refer to current service. Used only for inter-service compatibility"
+        ),
+    ] = None
     version: ServiceVersion
 
 
 class Compatibility(BaseModel):
-    # NOTE: as an object it is more maintainable than a list
-    can_update_to: CompatibleService = Field(
-        ..., description="Latest compatible service at this moment"
-    )
+    can_update_to: Annotated[
+        CompatibleService, Field(description="Latest compatible service at this moment")
+    ]
 
     model_config = ConfigDict(alias_generator=snake_to_camel, populate_by_name=True)
 
 
 class ServiceRelease(BaseModel):
-    # from ServiceMetaDataPublished
     version: ServiceVersion
-    version_display: str | None = Field(
-        default=None, description="If None, then display `version`"
-    )
-    released: datetime | None = Field(
-        default=None, description="When provided, it indicates the release timestamp"
-    )
-    retired: datetime | None = Field(
-        default=None,
-        description="whether this service is planned to be retired. "
-        "If None, the service is still active. "
-        "If now<retired then the service is deprecated. "
-        "If retired<now then the service is retired and should not be used. ",
-    )
-    compatibility: Compatibility | None = Field(
-        default=None, description="Compatibility with other releases at this moment"
-    )
+    version_display: Annotated[
+        str | None, Field(description="If None, then display `version`")
+    ] = None
+    released: Annotated[
+        datetime | None,
+        Field(description="When provided, it indicates the release timestamp"),
+    ] = None
+    retired: Annotated[
+        datetime | None,
+        Field(
+            description="whether this service is planned to be retired. If None, the service is still active. If now<retired then the service is deprecated. If retired<now then the service is retired and should not be used."
+        ),
+    ] = None
+    compatibility: Annotated[
+        Compatibility | None,
+        Field(description="Compatibility with other releases at this moment"),
+    ] = None
 
     model_config = ConfigDict(
         alias_generator=snake_to_camel,
         populate_by_name=True,
         json_schema_extra={
             "examples": [
                 # minimal
-                {
-                    "version": "0.9.0",
-                },
+                {"version": "0.9.0"},
                 # complete
                 {
                     "version": "0.9.1",

services/catalog/src/simcore_service_catalog/services/services_api.py

@@ -3,6 +3,7 @@
 from models_library.api_schemas_catalog.services import (
     MyServiceGet,
     ServiceGetV2,
+    ServiceItemList,
     ServiceUpdateV2,
 )
 from models_library.groups import GroupID
@@ -88,7 +89,7 @@ async def list_services_paginated(
     user_id: UserID,
     limit: PageLimitInt | None,
     offset: NonNegativeInt = 0,
-) -> tuple[NonNegativeInt, list[ServiceGetV2]]:
+) -> tuple[NonNegativeInt, list[ServiceItemList]]:
 
     # defines the order
     total_count, services = await repo.list_latest_services(
@@ -120,26 +121,45 @@ async def list_services_paginated(
 
     items = [
         _db_to_api_model(
-            service_db=s, access_rights_db=ar, service_manifest=sm, compatibility_map=cm
+            service_db=sc,
+            access_rights_db=ar,
+            service_manifest=sm,
+            compatibility_map=cm,
         )
-        for s in services
+        for sc in services
         if (
-            (ar := access_rights.get((s.key, s.version)))
-            and (sm := service_manifest.get((s.key, s.version)))
+            (ar := access_rights.get((sc.key, sc.version)))
+            and (sm := service_manifest.get((sc.key, sc.version)))
             and (
                 # NOTE: This operation might be resource-intensive.
                 # It is temporarily implemented on a trial basis.
                 cm := await evaluate_service_compatibility_map(
                     repo,
                     product_name=product_name,
                     user_id=user_id,
-                    service_release_history=s.history,
+                    service_release_history=sc.history,
                 )
             )
         )
     ]
 
-    return total_count, items
+    def _get_release(item: ServiceGetV2) -> ServiceRelease:
+        for rs in item.history:
+            if rs.version == item.version:
+                return rs
+        return ServiceRelease(
+            version=item.version, version_display=item.version_display, released=None
+        )
+
+    return total_count, [
+        ServiceItemList.model_validate(
+            {
+                **it.model_dump(exclude_unset=True, by_alias=True),
+                "release": _get_release(it),
+            }
+        )
+        for it in items
+    ]
 
 
 async def get_service(

services/catalog/tests/unit/conftest.py

@@ -34,7 +34,6 @@
 pytest_plugins = [
     "pytest_simcore.cli_runner",
     "pytest_simcore.docker_compose",
-    "pytest_simcore.simcore_catalog_service",
     "pytest_simcore.docker_registry",
     "pytest_simcore.docker_swarm",
     "pytest_simcore.environment_configs",

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

@@ -89,7 +89,10 @@ async def background_sync_task_mocked(
     services_db_tables_injector: Callable,
     fake_services_data: list,
 ) -> None:
-    # inject db services (typically done by the sync background task)
+    """
+    Emulates a sync backgroundtask that injects
+    some services in the db
+    """
     await services_db_tables_injector(fake_services_data)
 
 
@@ -150,7 +153,7 @@ async def test_list_services_paginated(
             service_version=item.version,
         )
 
-        assert got == item
+        assert got.model_dump() == item.model_dump(exclude={"release"})
 
     # since it is cached, it should only call it `limit` times
     assert mocked_director_service_api["get_service"].call_count == limit