feat: enrich solver functions response

Author: giancarloromeo

services/web/server/src/simcore_service_webserver/functions/_controller/_functions_rest.py

@@ -1,17 +1,25 @@
+from typing import Any
+
 from aiohttp import web
 from models_library.api_schemas_webserver.functions import (
     Function,
     FunctionToRegister,
     RegisteredFunction,
     RegisteredFunctionGet,
     RegisteredFunctionUpdate,
-    RegisteredProjectFunctionGet,
 )
 from models_library.api_schemas_webserver.users import MyFunctionPermissionsGet
-from models_library.functions import FunctionClass, RegisteredProjectFunction
+from models_library.functions import (
+    FunctionClass,
+    FunctionID,
+    RegisteredProjectFunction,
+    RegisteredSolverFunction,
+)
 from models_library.products import ProductName
+from models_library.projects import ProjectID
 from models_library.rest_pagination import Page
 from models_library.rest_pagination_utils import paginate_data
+from models_library.services_types import ServiceKey, ServiceVersion
 from models_library.users import UserID
 from pydantic import TypeAdapter
 from servicelib.aiohttp import status
@@ -29,6 +37,8 @@
 from ...security.decorators import permission_required
 from ...utils_aiohttp import create_json_response_from_page, envelope_json_response
 from .. import _functions_service
+from .._services_metadata import service as _services_metadata_service
+from .._services_metadata.service import ServiceMetadata
 from ._functions_rest_exceptions import handle_rest_requests_exceptions
 from ._functions_rest_schemas import (
     FunctionGetQueryParams,
@@ -39,30 +49,76 @@
 routes = web.RouteTableDef()
 
 
-async def _add_extras_to_project_function(
-    function: RegisteredProjectFunction,
+async def _build_function_access_rights_dict(
     app: web.Application,
     user_id: UserID,
     product_name: ProductName,
-) -> dict:
-    assert isinstance(function, RegisteredProjectFunction)  # nosec
+    function_id: FunctionID,
+) -> dict[str, Any]:
+    access_rights = await _functions_service.get_function_user_permissions(
+        app=app,
+        user_id=user_id,
+        product_name=product_name,
+        function_id=function_id,
+    )
+
+    return {
+        "access_rights": access_rights.model_dump(),
+    }
 
+
+async def _build_project_function_extras_dict(
+    app: web.Application,
+    *,
+    user_id: UserID,
+    function: RegisteredProjectFunction,
+) -> dict[str, Any]:
     project_dict = await _projects_service.get_project_for_user(
         app=app,
         project_uuid=f"{function.project_id}",
         user_id=user_id,
     )
 
-    function_with_extras = function.model_dump(mode="json") | {
-        "access_rights": await _functions_service.get_function_user_permissions(
-            app,
+    return {
+        "thumbnail": project_dict.get("thumbnail", None),
+    }
+
+
+async def _build_function_extras(
+    app: web.Application, user_id: UserID, *, function: RegisteredFunction
+) -> dict[str, Any]:
+    extras: dict[str, Any] = {}
+    if function.function_class == FunctionClass.PROJECT:
+        assert isinstance(function, RegisteredProjectFunction)
+        extras |= await _build_project_function_extras_dict(
+            function=function,
+            app=app,
             user_id=user_id,
-            product_name=product_name,
-            function_id=function.uid,
+        )
+    elif function.function_class == FunctionClass.SOLVER:
+        assert isinstance(function, RegisteredSolverFunction)
+        extras |= await _build_solver_function_extras_dict(
+            app,
+            function=function,
+        )
+    return extras
+
+
+async def _build_solver_function_extras_dict(
+    app: web.Application,
+    *,
+    function: RegisteredSolverFunction,
+) -> dict[str, Any]:
+    services_metadata = await _services_metadata_service.get_service_metadata(
+        app,
+        key=function.solver_key,
+        version=function.solver_version,
+    )
+    return {
+        "thumbnail": (
+            f"{services_metadata.thumbnail}" if services_metadata.thumbnail else None
         ),
-        "thumbnail": project_dict.get("thumbnail", None),
     }
-    return function_with_extras
 
 
 @routes.post(f"/{VTAG}/functions", name="register_function")
@@ -117,55 +173,76 @@ async def list_functions(request: web.Request) -> web.Response:
     )
 
     chunk: list[RegisteredFunctionGet] = []
-    projects_map: dict[str, ProjectDBGet | None] = (
+
+    projects_cache: dict[ProjectID, ProjectDBGet] = {}
+    service_metadata_cache: dict[tuple[ServiceKey, ServiceVersion], ServiceMetadata] = (
         {}
-    )  # ProjectDBGet has to be renamed at some point!
+    )
 
     if query_params.include_extras:
-        project_ids = []
-        for function in functions:
-            if function.function_class == FunctionClass.PROJECT:
-                assert isinstance(function, RegisteredProjectFunction)
-                project_ids.append(function.project_id)
-
-        projects_map = {
-            f"{p.uuid}": p
-            for p in await _projects_service.batch_get_projects(
+        if any(
+            function.function_class == FunctionClass.PROJECT for function in functions
+        ):
+            project_uuids = [
+                function.project_id
+                for function in functions
+                if function.function_class == FunctionClass.PROJECT
+            ]
+            projects_cache = await _projects_service.batch_get_projects(
                 request.app,
-                project_uuids=project_ids,
+                project_uuids=project_uuids,
             )
-        }
-
-    for function in functions:
-        if (
-            query_params.include_extras
-            and function.function_class == FunctionClass.PROJECT
+        if any(
+            function.function_class == FunctionClass.SOLVER for function in functions
         ):
-            assert isinstance(function, RegisteredProjectFunction)  # nosec
-            if project := projects_map.get(f"{function.project_id}"):
-                chunk.append(
-                    TypeAdapter(RegisteredProjectFunctionGet).validate_python(
-                        function.model_dump(mode="json")
-                        | {
-                            "access_rights": await _functions_service.get_function_user_permissions(
-                                request.app,
-                                user_id=req_ctx.user_id,
-                                product_name=req_ctx.product_name,
-                                function_id=function.uid,
-                            ),
-                            "thumbnail": (
-                                f"{project.thumbnail}" if project.thumbnail else None
-                            ),
-                        }
-                    )
-                )
-        else:
-            chunk.append(
-                TypeAdapter(RegisteredFunctionGet).validate_python(
-                    function.model_dump(mode="json")
+            service_keys_and_versions = [
+                (function.solver_key, function.solver_version)
+                for function in functions
+                if function.function_class == FunctionClass.SOLVER
+            ]
+            service_metadata_cache = (
+                await _services_metadata_service.batch_get_service_metadata(
+                    app=request.app, keys_and_versions=service_keys_and_versions
                 )
             )
 
+    for function in functions:
+        access_rights = await _build_function_access_rights_dict(
+            request.app,
+            user_id=req_ctx.user_id,
+            product_name=req_ctx.product_name,
+            function_id=function.uid,
+        )
+
+        extras: dict[str, Any] = {}
+        if query_params.include_extras:
+            if function.function_class == FunctionClass.PROJECT:
+                assert isinstance(function, RegisteredProjectFunction)  # nosec
+                if project := projects_cache.get(function.project_id):
+                    extras = {
+                        "thumbnail": (
+                            f"{project.thumbnail}" if project.thumbnail else None
+                        ),
+                    }
+            elif function.function_class == FunctionClass.SOLVER:
+                assert isinstance(function, RegisteredSolverFunction)
+                if service_metadata := service_metadata_cache.get(
+                    (function.solver_key, function.solver_version)
+                ):
+                    extras = {
+                        "thumbnail": (
+                            f"{service_metadata.thumbnail}"
+                            if service_metadata.thumbnail
+                            else None
+                        ),
+                    }
+
+        chunk.append(
+            TypeAdapter(RegisteredFunctionGet).validate_python(
+                function.model_dump() | access_rights | extras
+            )
+        )
+
     page = Page[RegisteredFunctionGet].model_validate(
         paginate_data(
             chunk=chunk,
@@ -194,33 +271,29 @@ async def get_function(request: web.Request) -> web.Response:
     )
 
     req_ctx = AuthenticatedRequestContext.model_validate(request)
-    registered_function: RegisteredFunction = await _functions_service.get_function(
+    function = await _functions_service.get_function(
         app=request.app,
         function_id=function_id,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
     )
 
-    if (
-        query_params.include_extras
-        and registered_function.function_class == FunctionClass.PROJECT
-    ):
-        function_with_extras = await _add_extras_to_project_function(
-            function=registered_function,
-            app=request.app,
-            user_id=req_ctx.user_id,
-            product_name=req_ctx.product_name,
-        )
+    access_rights = await _build_function_access_rights_dict(
+        request.app,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        function_id=function_id,
+    )
 
-        return envelope_json_response(
-            TypeAdapter(RegisteredProjectFunctionGet).validate_python(
-                function_with_extras
-            )
-        )
+    extras = (
+        await _build_function_extras(request.app, req_ctx.user_id, function=function)
+        if query_params.include_extras
+        else {}
+    )
 
     return envelope_json_response(
         TypeAdapter(RegisteredFunctionGet).validate_python(
-            registered_function.model_dump(mode="json")
+            function.model_dump() | access_rights | extras
         )
     )
 
@@ -245,34 +318,30 @@ async def update_function(request: web.Request) -> web.Response:
     )
     req_ctx = AuthenticatedRequestContext.model_validate(request)
 
-    updated_function = await _functions_service.update_function(
+    function = await _functions_service.update_function(
         request.app,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
         function_id=function_id,
         function=function_update,
     )
 
-    if (
-        query_params.include_extras
-        and updated_function.function_class == FunctionClass.PROJECT
-    ):
-        function_with_extras = await _add_extras_to_project_function(
-            function=updated_function,
-            app=request.app,
-            user_id=req_ctx.user_id,
-            product_name=req_ctx.product_name,
-        )
+    access_rights = await _build_function_access_rights_dict(
+        request.app,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        function_id=function_id,
+    )
 
-        return envelope_json_response(
-            TypeAdapter(RegisteredProjectFunctionGet).validate_python(
-                function_with_extras
-            )
-        )
+    extras = (
+        await _build_function_extras(request.app, req_ctx.user_id, function=function)
+        if query_params.include_extras
+        else {}
+    )
 
     return envelope_json_response(
         TypeAdapter(RegisteredFunctionGet).validate_python(
-            updated_function.model_dump(mode="json")
+            function.model_dump() | access_rights | extras
         )
     )
 

services/web/server/src/simcore_service_webserver/functions/_services_metadata/__init__.py

@@ -0,0 +1,5 @@
+from common_library.errors_classes import OsparcErrorMixin
+
+
+class ServiceMetadataNotFoundError(OsparcErrorMixin, Exception):
+    msg_template = "Service metadata for key {key} and version {version} not found"

services/web/server/src/simcore_service_webserver/functions/_services_metadata/_errors.py

@@ -0,0 +1,8 @@
+from models_library.services_types import ServiceKey, ServiceVersion
+from pydantic import BaseModel, HttpUrl
+
+
+class ServiceMetadata(BaseModel):
+    key: ServiceKey
+    version: ServiceVersion
+    thumbnail: HttpUrl | None