feat: add function list

Author: giancarloromeo

api/specs/web-server/_functions.py

@@ -7,6 +7,7 @@
 
 from typing import Annotated
 
+from _common import as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.functions import (
     FunctionToRegister,
@@ -16,7 +17,9 @@
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.functions._controller._functions_rest_schemas import (
+    FunctionGetQueryParams,
     FunctionPathParams,
+    FunctionsListQueryParams,
 )
 
 router = APIRouter(
@@ -40,7 +43,9 @@ async def register_function(
     "/functions",
     response_model=Envelope[list[RegisteredFunctionGet]],
 )
-async def list_functions(): ...
+async def list_functions(
+    _query: Annotated[as_query(FunctionsListQueryParams), Depends()],
+): ...
 
 
 @router.get(
@@ -49,6 +54,7 @@ async def list_functions(): ...
 )
 async def get_function(
     _path: Annotated[FunctionPathParams, Depends()],
+    _query: Annotated[as_query(FunctionGetQueryParams), Depends()],
 ): ...
 
 

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -3348,44 +3348,66 @@ paths:
                 $ref: '#/components/schemas/EnvelopedError'
           description: Service Unavailable
   /v0/functions:
-    get:
-      tags:
-      - functions
-      summary: List Functions
-      operationId: list_functions
-      responses:
-        '200':
-          description: Successful Response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Envelope_list_Annotated_Union_RegisteredProjectFunctionGet__RegisteredSolverFunctionGet___FieldInfo_annotation_NoneType__required_True__discriminator__function_class_____'
     post:
       tags:
       - functions
       summary: Register Function
       operationId: register_function
       requestBody:
+        required: true
         content:
           application/json:
             schema:
               oneOf:
               - $ref: '#/components/schemas/ProjectFunctionToRegister'
               - $ref: '#/components/schemas/SolverFunctionToRegister'
-              title: ' Body'
               discriminator:
                 propertyName: functionClass
                 mapping:
                   PROJECT: '#/components/schemas/ProjectFunctionToRegister'
                   SOLVER: '#/components/schemas/SolverFunctionToRegister'
-        required: true
+              title: ' Body'
       responses:
         '200':
           description: Successful Response
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_Annotated_Union_RegisteredProjectFunctionGet__RegisteredSolverFunctionGet___FieldInfo_annotation_NoneType__required_True__discriminator__function_class____'
+    get:
+      tags:
+      - functions
+      summary: List Functions
+      operationId: list_functions
+      parameters:
+      - name: include_extras
+        in: query
+        required: false
+        schema:
+          type: boolean
+          default: false
+          title: Include Extras
+      - name: limit
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 20
+          title: Limit
+      - name: offset
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 0
+          title: Offset
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Envelope_list_Annotated_Union_RegisteredProjectFunctionGet__RegisteredSolverFunctionGet___FieldInfo_annotation_NoneType__required_True__discriminator__function_class_____'
   /v0/functions/{function_id}:
     get:
       tags:
@@ -3400,6 +3422,27 @@ paths:
           type: string
           format: uuid
           title: Function Id
+      - name: include_extras
+        in: query
+        required: false
+        schema:
+          type: boolean
+          default: false
+          title: Include Extras
+      - name: limit
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 20
+          title: Limit
+      - name: offset
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 0
+          title: Offset
       responses:
         '200':
           description: Successful Response

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

@@ -8,12 +8,15 @@
     RegisteredProjectFunctionGet,
 )
 from models_library.api_schemas_webserver.users import MyFunctionPermissionsGet
-from models_library.functions import FunctionClass
+from models_library.functions import FunctionClass, RegisteredProjectFunction
+from models_library.rest_pagination import Page
+from models_library.rest_pagination_utils import paginate_data
 from pydantic import TypeAdapter
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     handle_validation_as_http_error,
     parse_request_path_parameters_as,
+    parse_request_query_parameters_as,
 )
 
 from ..._meta import API_VTAG as VTAG
@@ -24,7 +27,11 @@
 from ...utils_aiohttp import envelope_json_response
 from .. import _functions_service
 from ._functions_rest_exceptions import handle_rest_requests_exceptions
-from ._functions_rest_schemas import FunctionPathParams
+from ._functions_rest_schemas import (
+    FunctionGetQueryParams,
+    FunctionPathParams,
+    FunctionsListQueryParams,
+)
 
 routes = web.RouteTableDef()
 
@@ -68,7 +75,68 @@ async def register_function(request: web.Request) -> web.Response:
 @permission_required("function.read")
 @handle_rest_requests_exceptions
 async def list_functions(request: web.Request) -> web.Response:
-    raise NotImplementedError
+    query_params: FunctionsListQueryParams = parse_request_query_parameters_as(
+        FunctionsListQueryParams, request
+    )
+
+    req_ctx = AuthenticatedRequestContext.model_validate(request)
+    functions, page_meta_info = await _functions_service.list_functions(
+        request.app,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        pagination_limit=query_params.limit,
+        pagination_offset=query_params.offset,
+    )
+
+    chunk = []
+
+    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 = await _projects_service.batch_get_projects(
+            request.app,
+            project_uuids=project_ids,
+        )
+        projects_map = {f"{p.uuid}": p for p in projects}
+
+        for function in functions:
+            if (
+                query_params.include_extras
+                and function.function_class == FunctionClass.PROJECT
+            ):
+                assert isinstance(function, RegisteredProjectFunction)  # nosec
+                project = projects_map.get(f"{function.project_id}")
+                if project:
+                    chunk.append(
+                        TypeAdapter(RegisteredProjectFunctionGet).validate_python(
+                            function.model_dump(mode="json")
+                            | {
+                                "thumbnail": project.thumbnail,
+                                "template_id": project.id,
+                            }
+                        )
+                    )
+            else:
+                chunk.append(
+                    TypeAdapter(RegisteredFunctionGet).validate_python(
+                        function.model_dump(mode="json")
+                    )
+                )
+
+    page = Page[RegisteredFunctionGet].model_validate(
+        paginate_data(
+            chunk=chunk,
+            request_url=request.url,
+            total=page_meta_info.total,
+            limit=query_params.limit,
+            offset=query_params.offset,
+        )
+    )
+    return envelope_json_response(page)
 
 
 @routes.get(
@@ -82,6 +150,10 @@ async def get_function(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(FunctionPathParams, request)
     function_id = path_params.function_id
 
+    query_params: FunctionGetQueryParams = parse_request_query_parameters_as(
+        FunctionGetQueryParams, request
+    )
+
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     registered_function: RegisteredFunction = await _functions_service.get_function(
         app=request.app,
@@ -90,7 +162,10 @@ async def get_function(request: web.Request) -> web.Response:
         product_name=req_ctx.product_name,
     )
 
-    if registered_function.function_class == FunctionClass.PROJECT:
+    if (
+        query_params.include_extras
+        and registered_function.function_class == FunctionClass.PROJECT
+    ):
         assert isinstance(registered_function, RegisteredProjectFunctionGet)  # nosec
 
         project_dict = await _projects_service.get_project_for_user(

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

@@ -1,4 +1,5 @@
 from models_library.functions import FunctionID
+from models_library.rest_pagination import PageQueryParameters
 from pydantic import BaseModel, ConfigDict
 
 from ...models import AuthenticatedRequestContext
@@ -11,4 +12,14 @@ class FunctionPathParams(BaseModel):
     model_config = ConfigDict(populate_by_name=True, extra="forbid")
 
 
+class _FunctionQueryParams(BaseModel):
+    include_extras: bool = False
+
+
+class FunctionGetQueryParams(PageQueryParameters, _FunctionQueryParams): ...
+
+
+class FunctionsListQueryParams(PageQueryParameters, _FunctionQueryParams): ...
+
+
 __all__: tuple[str, ...] = ("AuthenticatedRequestContext",)

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

@@ -276,7 +276,9 @@ async def batch_get_project_name(
 
 
 async def batch_get_projects(
-    app: web.Application, project_uuids: list[ProjectID]
+    app: web.Application,
+    *,
+    project_uuids: list[ProjectID],
 ) -> list[ProjectDBGet]:
     return await _projects_repository.batch_get_projects(
         app=app,