✨ Refactor director service API references to improve clarity and consistency

Author: pcrespov

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

@@ -1,6 +1,7 @@
 from typing import Final
 
 from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic.config import JsonDict
 from pydantic.types import ByteSize, NonNegativeInt
 
 from ..service_settings_labels import ContainerSpec
@@ -63,13 +64,14 @@ class ServiceExtras(BaseModel):
     service_build_details: ServiceBuildDetails | None = None
     container_spec: ContainerSpec | None = None
 
-    model_config = ConfigDict(
-        json_schema_extra={
-            "examples": [
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        examples = [
+            *(
                 {"node_requirements": node_example}
                 for node_example in NodeRequirements.model_json_schema()["examples"]
-            ]
-            + [
+            ),
+            *(
                 {
                     "node_requirements": node_example,
                     "service_build_details": {
@@ -79,8 +81,8 @@ class ServiceExtras(BaseModel):
                     },
                 }
                 for node_example in NodeRequirements.model_json_schema()["examples"]
-            ]
-            + [
+            ),
+            *(
                 {
                     "node_requirements": node_example,
                     "service_build_details": {
@@ -91,9 +93,11 @@ class ServiceExtras(BaseModel):
                     "container_spec": {"Command": ["run", "subcommand"]},
                 }
                 for node_example in NodeRequirements.model_json_schema()["examples"]
-            ]
-        }
-    )
+            ),
+        ]
+        schema.update({"examples": examples})
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
 
 
 CHARS_IN_VOLUME_NAME_BEFORE_DIR_NAME: Final[NonNegativeInt] = 89

services/catalog/src/simcore_service_catalog/api/rest/_services_extras.py

@@ -5,6 +5,7 @@
 from models_library.services import ServiceKey, ServiceVersion
 
 from ...clients.director import DirectorApi
+from ...service import services
 from .._dependencies.director import get_director_api
 
 router = APIRouter()
@@ -16,4 +17,7 @@ async def get_service_extras(
     service_version: ServiceVersion,
     director_client: Annotated[DirectorApi, Depends(get_director_api)],
 ) -> ServiceExtras:
-    return await director_client.get_service_extras(service_key, service_version)
+
+    return await services.get_service_extras(
+        director_client, service_key, service_version
+    )

services/catalog/src/simcore_service_catalog/clients/director.py

@@ -206,6 +206,8 @@ async def get_service_extras(
         service_key: ServiceKey,
         service_version: ServiceVersion,
     ) -> ServiceExtras:
+        # NOTE: SEE https://github.com/ITISFoundation/osparc-simcore/issues/7509
+
         # check physical node requirements
         # all nodes require "CPU"
         result: dict[str, Any] = {

services/catalog/src/simcore_service_catalog/service/services.py

@@ -7,6 +7,8 @@
     ServiceGetV2,
     ServiceUpdateV2,
 )
+from models_library.api_schemas_directorv2.services import ServiceExtras
+from models_library.basic_types import VersionStr
 from models_library.groups import GroupID
 from models_library.products import ProductName
 from models_library.rest_pagination import PageLimitInt, PageTotalCount
@@ -510,3 +512,11 @@ async def list_my_service_release_history(
     ]
 
     return total_count, items
+
+
+async def get_service_extras(
+    director_api: DirectorApi, service_key: ServiceKey, service_version: VersionStr
+) -> ServiceExtras:
+    return await director_api.get_service_extras(
+        service_key=service_key, service_version=service_version
+    )

services/catalog/tests/unit/conftest.py

@@ -280,14 +280,14 @@ async def rpc_client(
 
 
 @pytest.fixture
-def director_setup_disabled(mocker: MockerFixture) -> None:
+def director_lifespan_disabled(mocker: MockerFixture) -> None:
     mocker.patch.object(
         simcore_service_catalog.core.events, "director_lifespan", autospec=True
     )
 
 
 @pytest.fixture
-def director_service_openapi_specs(
+def director_rest_openapi_specs(
     osparc_simcore_services_dir: Path,
 ) -> dict[str, Any]:
     openapi_path = (
@@ -303,7 +303,7 @@ def director_service_openapi_specs(
 
 
 @pytest.fixture
-def expected_director_list_services(
+def expected_director_rest_api_list_services(
     user_email: EmailStr, user_first_name: str, user_last_name: str
 ) -> list[dict[str, Any]]:
     """This fixture has at least TWO purposes:
@@ -367,9 +367,9 @@ def expected_director_list_services(
 
 
 @pytest.fixture
-def mocked_director_service_api_base(
+def mocked_director_rest_api_base(
     app_settings: ApplicationSettings,
-    director_service_openapi_specs: dict[str, Any],
+    director_rest_openapi_specs: dict[str, Any],
 ) -> Iterator[respx.MockRouter]:
     """
     BASIC fixture to mock director service API
@@ -382,7 +382,7 @@ def mocked_director_service_api_base(
     ), "Check dependency on fixture `director_setup_disabled`"
 
     # NOTE: this MUST be in sync with services/director/src/simcore_service_director/api/v0/openapi.yaml
-    openapi = director_service_openapi_specs
+    openapi = director_rest_openapi_specs
     assert Version(openapi["info"]["version"]) == Version("0.1.0")
 
     with respx.mock(
@@ -445,10 +445,10 @@ def mock_service_extras() -> ServiceExtras:
 
 
 @pytest.fixture
-def mocked_director_service_api(
-    mocked_director_service_api_base: respx.MockRouter,
-    director_service_openapi_specs: dict[str, Any],
-    expected_director_list_services: list[dict[str, Any]],
+def mocked_director_rest_api(
+    mocked_director_rest_api_base: respx.MockRouter,
+    director_rest_openapi_specs: dict[str, Any],
+    expected_director_rest_api_list_services: list[dict[str, Any]],
     get_mocked_service_labels: Callable[[str, str], dict],
     mock_service_extras: ServiceExtras,
 ) -> respx.MockRouter:
@@ -458,14 +458,14 @@ def mocked_director_service_api(
     To customize the  mock responses use `mocked_director_service_api_base` instead
     """
     # alias
-    openapi = director_service_openapi_specs
-    respx_mock = mocked_director_service_api_base
+    openapi = director_rest_openapi_specs
+    respx_mock = mocked_director_rest_api_base
 
     def _search(service_key, service_version):
         try:
             return next(
                 s
-                for s in expected_director_list_services
+                for s in expected_director_rest_api_list_services
                 if (s["key"] == service_key and s["version"] == service_version)
             )
         except StopIteration:
@@ -475,7 +475,7 @@ def _search(service_key, service_version):
     assert openapi["paths"].get("/services")
 
     respx_mock.get(path__regex=r"/services$", name="list_services").respond(
-        status.HTTP_200_OK, json={"data": expected_director_list_services}
+        status.HTTP_200_OK, json={"data": expected_director_rest_api_list_services}
     )
 
     # GET

services/catalog/tests/unit/test_api_rest.py

@@ -12,7 +12,7 @@ def test_sync_client(
     repository_lifespan_disabled: None,
     rabbitmq_and_rpc_setup_disabled: None,
     background_task_lifespan_disabled: None,
-    director_setup_disabled: None,
+    director_lifespan_disabled: None,
     client: TestClient,
 ):
 
@@ -27,7 +27,7 @@ async def test_async_client(
     repository_lifespan_disabled: None,
     rabbitmq_and_rpc_setup_disabled: None,
     background_task_lifespan_disabled: None,
-    director_setup_disabled: None,
+    director_lifespan_disabled: None,
     aclient: httpx.AsyncClient,
 ):
     response = await aclient.get("/v0/")

services/catalog/tests/unit/test_clients_director.py

@@ -36,8 +36,8 @@ async def test_director_client_high_level_api(
     repository_lifespan_disabled: None,
     background_task_lifespan_disabled: None,
     rabbitmq_and_rpc_setup_disabled: None,
-    expected_director_list_services: list[dict[str, Any]],
-    mocked_director_service_api: MockRouter,
+    expected_director_rest_api_list_services: list[dict[str, Any]],
+    mocked_director_rest_api: MockRouter,
     app: FastAPI,
 ):
     # gets director client as used in handlers
@@ -50,7 +50,9 @@ async def test_director_client_high_level_api(
     assert await director_api.is_responsive()
 
     # GET
-    expected_service = ServiceMetaDataPublished(**expected_director_list_services[0])
+    expected_service = ServiceMetaDataPublished(
+        **expected_director_rest_api_list_services[0]
+    )
     assert (
         await director_api.get_service(expected_service.key, expected_service.version)
         == expected_service
@@ -62,13 +64,13 @@ async def test_director_client_low_level_api(
     repository_lifespan_disabled: None,
     background_task_lifespan_disabled: None,
     rabbitmq_and_rpc_setup_disabled: None,
-    mocked_director_service_api: MockRouter,
-    expected_director_list_services: list[dict[str, Any]],
+    mocked_director_rest_api: MockRouter,
+    expected_director_rest_api_list_services: list[dict[str, Any]],
     app: FastAPI,
 ):
     director_api = get_director_api(app)
 
-    expected_service = expected_director_list_services[0]
+    expected_service = expected_director_rest_api_list_services[0]
     key = expected_service["key"]
     version = expected_service["version"]
 

services/catalog/tests/unit/test_service_manifest.py

@@ -34,7 +34,7 @@ def app_environment(
 async def test_services_manifest_api(
     repository_lifespan_disabled: None,
     rabbitmq_and_rpc_setup_disabled: None,
-    mocked_director_service_api: MockRouter,
+    mocked_director_rest_api: MockRouter,
     app: FastAPI,
 ):
     director_api = get_director_api(app)
@@ -44,7 +44,7 @@ async def test_services_manifest_api(
 
     # LIST
     all_services_map = await manifest.get_services_map(director_api)
-    assert mocked_director_service_api["list_services"].called
+    assert mocked_director_rest_api["list_services"].called
 
     for service in all_services_map.values():
         if is_function_service(service.key):
@@ -67,7 +67,7 @@ async def test_services_manifest_api(
 
         assert service == expected_service
         if not is_function_service(service.key):
-            assert mocked_director_service_api["get_service"].called
+            assert mocked_director_rest_api["get_service"].called
 
     # BATCH
     for expected_services in toolz.partition(2, all_services_map.values()):

services/catalog/tests/unit/test_utils_service_extras.py

@@ -18,7 +18,7 @@ def mock_engine(app: FastAPI) -> None:
 
 async def test_get_service_extras(
     repository_lifespan_disabled: None,
-    mocked_director_service_api: MockRouter,
+    mocked_director_rest_api: MockRouter,
     rabbitmq_and_rpc_setup_disabled: None,
     background_task_lifespan_disabled: None,
     mock_engine: None,

services/catalog/tests/unit/test_utils_service_labels.py

@@ -17,7 +17,7 @@ def mock_engine(app: FastAPI) -> None:
 
 async def test_get_service_labels(
     repository_lifespan_disabled: None,
-    mocked_director_service_api: MockRouter,
+    mocked_director_rest_api: MockRouter,
     rabbitmq_and_rpc_setup_disabled: None,
     background_task_lifespan_disabled: None,
     mock_engine: None,