🐛 refactor: replace get_services_for_user_in_product with list_user_services_with_versions for improved clarity and caching

Author: pcrespov

services/web/server/src/simcore_service_webserver/catalog/_catalog_rest_client_service.py

@@ -2,7 +2,7 @@
 
 import logging
 import urllib.parse
-from collections.abc import Callable, Iterator
+from collections.abc import Iterator
 from contextlib import contextmanager
 from typing import Any, Final
 
@@ -30,20 +30,11 @@
 from yarl import URL
 
 from .._meta import api_version_prefix
+from ._models import ServiceKeyVersionDict
 from .settings import CatalogSettings, get_plugin_settings
 
 _logger = logging.getLogger(__name__)
 
-# Cache settings
-_SECOND = 1  # in seconds
-_MINUTE = 60 * _SECOND
-_CACHE_TTL: Final = 1 * _MINUTE
-
-
-def _create_service_cache_key(_f: Callable[..., Any], *_args, **kw):
-    assert len(_args) == 1, f"Expected only app, got {_args}"  # nosec
-    return f"get_service_{kw['user_id']}_{kw['service_key']}_{kw['service_version']}_{kw['product_name']}"
-
 
 @contextmanager
 def _handle_client_exceptions(app: web.Application) -> Iterator[ClientSession]:
@@ -96,10 +87,24 @@ def to_backend_service(rel_url: URL, origin: URL, version_prefix: str) -> URL:
     return origin.with_path(new_path).with_query(rel_url.query)
 
 
-async def get_services_for_user_in_product(
-    app: web.Application, user_id: UserID, product_name: str, *, only_key_versions: bool
-) -> list[dict]:
+# Cache settings for services rest API
+_SECOND = 1  # in seconds
+_MINUTE = 60 * _SECOND
+_CACHE_TTL: Final = 1 * _MINUTE
+
+
+@cached(
+    ttl=_CACHE_TTL,
+    key_builder=lambda _f, *_args, **kw: f"get_services_for_user_in_product_{kw['user_id']}_{kw['product_name']}",
+    cache=Cache.MEMORY,
+)
+async def list_user_services_with_versions(
+    app: web.Application, *, user_id: UserID, product_name: str
+) -> list[ServiceKeyVersionDict]:
+
     settings: CatalogSettings = get_plugin_settings(app)
+    only_key_versions = True
+
     url = (URL(settings.api_base_url) / "services").with_query(
         {"user_id": user_id, "details": f"{not only_key_versions}"}
     )
@@ -115,13 +120,18 @@ async def get_services_for_user_in_product(
                     user_id,
                 )
                 return []
-            body: list[dict] = await response.json()
-            return body
+            services: list[dict] = await response.json()
+
+            # This reduces the size cached in the memory
+            return [
+                ServiceKeyVersionDict(key=service["key"], version=service["version"])
+                for service in services
+            ]
 
 
 @cached(
     ttl=_CACHE_TTL,
-    key_builder=_create_service_cache_key,
+    key_builder=lambda _f, *_args, **kw: f"get_service_{kw['user_id']}_{kw['service_key']}_{kw['service_version']}_{kw['product_name']}",
     cache=Cache.MEMORY,
     # SEE https://github.com/ITISFoundation/osparc-simcore/pull/7802
 )

services/web/server/src/simcore_service_webserver/catalog/_models.py

@@ -1 +1,6 @@
-# NOTE: missing. @bisgaard-itis will follow up here
+from typing import TypedDict
+
+
+class ServiceKeyVersionDict(TypedDict):
+    key: str
+    version: str

services/web/server/src/simcore_service_webserver/catalog/catalog_service.py

@@ -2,19 +2,21 @@
     get_service,
     get_service_access_rights,
     get_service_resources,
-    get_services_for_user_in_product,
     is_catalog_service_responsive,
+    list_user_services_with_versions,
     to_backend_service,
 )
+from ._models import ServiceKeyVersionDict
 from ._service import batch_get_my_services
 
 __all__: tuple[str, ...] = (
     "batch_get_my_services",
     "get_service",
     "get_service_access_rights",
     "get_service_resources",
-    "get_services_for_user_in_product",
+    "list_user_services_with_versions",
     "is_catalog_service_responsive",
     "to_backend_service",
+    "ServiceKeyVersionDict",
 )
 # nopycln: file

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

@@ -120,9 +120,9 @@ async def list_projects(  # pylint: disable=too-many-arguments
 ) -> tuple[list[ProjectDict], int]:
     db = ProjectDBAPI.get_from_app_context(app)
 
-    user_available_services: list[dict] = (
-        await catalog_service.get_services_for_user_in_product(
-            app, user_id, product_name, only_key_versions=True
+    user_available_services: list[ServiceKeyVersionDict] = (
+        await catalog_service.list_user_services_with_versions(
+            app, user_id=user_id, product_name=product_name
         )
     )
 
@@ -204,9 +204,9 @@ async def list_projects_full_depth(
 ) -> tuple[list[ProjectDict], int]:
     db = ProjectDBAPI.get_from_app_context(app)
 
-    user_available_services: list[dict] = (
-        await catalog_service.get_services_for_user_in_product(
-            app, user_id, product_name, only_key_versions=True
+    user_available_services: list[ServiceKeyVersionDict] = (
+        await catalog_service.list_user_services_with_versions(
+            app, user_id=user_id, product_name=product_name
         )
     )
 

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

@@ -190,7 +190,7 @@ def is_graph_equal(
 
 
 def are_project_services_available(
-    project: dict[str, Any], available_services: list[dict[str, Any]]
+    project: dict[str, Any], available_services: list[dict[str, str]]
 ) -> bool:
     if not project["workbench"]:
         # empty project

services/web/server/tests/unit/with_dbs/01/test_catalog_rest_client.py

@@ -15,8 +15,8 @@
 )
 from simcore_service_webserver.catalog.catalog_service import (
     get_service_access_rights,
-    get_services_for_user_in_product,
     is_catalog_service_responsive,
+    list_user_services_with_versions,
 )
 
 
@@ -62,11 +62,10 @@ async def test_get_services_for_user_in_product(
         status=backend_status_code,
     )
     assert client.app
-    _ = await get_services_for_user_in_product(
+    await list_user_services_with_versions(
         app=client.app,
         user_id=logged_user["id"],
         product_name="osparc",
-        only_key_versions=False,
     )