Add functions rest api inside webserver ✨ ♻️

api/specs/web-server/_functions.py

@@ -0,0 +1,53 @@
+# pylint: disable=protected-access
+# pylint: disable=redefined-outer-name
+# pylint: disable=too-many-arguments
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
+
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
+from models_library.api_schemas_webserver.functions import (
+    FunctionToRegister,
+    RegisteredFunctionGet,
+)
+from models_library.generics import Envelope
+from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.functions._controller._functions_rest_schemas import (
+    FunctionPathParams,
+)
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}",
+    tags=[
+        "functions",
+    ],
+)
+
+
+@router.post(
+    "/functions",
+    response_model=Envelope[RegisteredFunctionGet],
+)
+async def register_function(
+    _body: FunctionToRegister,
+) -> Envelope[RegisteredFunctionGet]: ...
+
+
+@router.get(
+    "/functions/{function_id}",
+    response_model=Envelope[RegisteredFunctionGet],
+)
+async def get_function(
+    _path: Annotated[FunctionPathParams, Depends()],
+): ...
+
+
+@router.delete(
+    "/projects/{function_id}",
+    status_code=status.HTTP_204_NO_CONTENT,
+)
+async def delete_function(
+    _path: Annotated[FunctionPathParams, Depends()],
+): ...

packages/models-library/src/models_library/api_schemas_api_server/functions.py

@@ -0,0 +1,38 @@
+# pylint: disable=unused-import
+
+from ..functions import (  # noqa: F401
+    Function,
+    FunctionClass,
+    FunctionClassSpecificData,
+    FunctionID,
+    FunctionIDNotFoundError,
+    FunctionInputs,
+    FunctionInputSchema,
+    FunctionInputsList,
+    FunctionInputsValidationError,
+    FunctionJob,
+    FunctionJobClassSpecificData,
+    FunctionJobCollection,
+    FunctionJobCollectionID,
+    FunctionJobCollectionIDNotFoundError,
+    FunctionJobCollectionStatus,
+    FunctionJobID,
+    FunctionJobIDNotFoundError,
+    FunctionJobStatus,
+    FunctionOutputs,
+    FunctionOutputSchema,
+    FunctionSchemaClass,
+    JSONFunctionInputSchema,
+    JSONFunctionOutputSchema,
+    ProjectFunction,
+    ProjectFunctionJob,
+    RegisteredFunction,
+    RegisteredFunctionJob,
+    RegisteredFunctionJobCollection,
+    RegisteredProjectFunction,
+    RegisteredProjectFunctionJob,
+    SolverFunction,
+    SolverFunctionJob,
+    UnsupportedFunctionClassError,
+    UnsupportedFunctionFunctionJobClassCombinationError,
+)

packages/models-library/src/models_library/api_schemas_webserver/functions.py

@@ -0,0 +1,69 @@
+# pylint: disable=unused-import
+
+from typing import Annotated, TypeAlias
+
+from pydantic import Field
+
+from ..functions import (  # noqa: F401
+    Function,
+    FunctionBase,
+    FunctionClass,
+    FunctionClassSpecificData,
+    FunctionID,
+    FunctionIDNotFoundError,
+    FunctionInputs,
+    FunctionInputSchema,
+    FunctionInputsList,
+    FunctionInputsValidationError,
+    FunctionJob,
+    FunctionJobClassSpecificData,
+    FunctionJobCollection,
+    FunctionJobCollectionID,
+    FunctionJobCollectionIDNotFoundError,
+    FunctionJobCollectionStatus,
+    FunctionJobID,
+    FunctionJobIDNotFoundError,
+    FunctionJobStatus,
+    FunctionOutputs,
+    FunctionOutputSchema,
+    FunctionSchemaClass,
+    JSONFunctionInputSchema,
+    JSONFunctionOutputSchema,
+    ProjectFunction,
+    ProjectFunctionJob,
+    RegisteredFunction,
+    RegisteredFunctionBase,
+    RegisteredFunctionJob,
+    RegisteredFunctionJobCollection,
+    RegisteredProjectFunction,
+    RegisteredProjectFunctionJob,
+    RegisteredSolverFunction,
+    SolverFunction,
+    SolverFunctionJob,
+    UnsupportedFunctionClassError,
+    UnsupportedFunctionFunctionJobClassCombinationError,
+)
+from ._base import InputSchema, OutputSchema
+
+
+class RegisteredSolverFunctionGet(RegisteredSolverFunction, OutputSchema): ...
+
+
+class RegisteredProjectFunctionGet(RegisteredProjectFunction, OutputSchema): ...
+
+
+class SolverFunctionToRegister(SolverFunction, InputSchema): ...
+
+
+class ProjectFunctionToRegister(ProjectFunction, InputSchema): ...
+
+
+FunctionToRegister: TypeAlias = Annotated[
+    ProjectFunctionToRegister | SolverFunctionToRegister,
+    Field(discriminator="function_class"),
+]
+
+RegisteredFunctionGet: TypeAlias = Annotated[
+    RegisteredProjectFunctionGet | RegisteredSolverFunctionGet,
+    Field(discriminator="function_class"),
+]

packages/models-library/src/models_library/api_schemas_webserver/functions_wb_schema.py → packages/models-library/src/models_library/functions.py

@@ -8,7 +8,7 @@
 from models_library.services_types import ServiceKey, ServiceVersion
 from pydantic import BaseModel, Field
 
-from ..projects import ProjectID
+from .projects import ProjectID
 
 FunctionID: TypeAlias = UUID
 FunctionJobID: TypeAlias = UUID

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/functions/functions_rpc_interface.py

@@ -1,7 +1,7 @@
 import logging
 
 from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_webserver.functions import (
     Function,
     FunctionID,
     FunctionInputs,

services/api-server/src/simcore_service_api_server/api/routes/function_job_collections_routes.py

@@ -3,7 +3,7 @@
 
 from fastapi import APIRouter, Depends, status
 from fastapi_pagination.api import create_page
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_webserver.functions import (
     FunctionJobCollection,
     FunctionJobCollectionID,
     FunctionJobCollectionStatus,

services/api-server/src/simcore_service_api_server/api/routes/function_jobs_routes.py

@@ -2,7 +2,7 @@
 
 from fastapi import APIRouter, Depends, status
 from fastapi_pagination.api import create_page
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_webserver.functions import (
     Function,
     FunctionClass,
     FunctionJob,

services/api-server/src/simcore_service_api_server/api/routes/functions_routes.py

@@ -5,7 +5,7 @@
 from fastapi import APIRouter, Depends, Request, status
 from fastapi_pagination.api import create_page
 from jsonschema import ValidationError
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_api_server.functions import (
     Function,
     FunctionClass,
     FunctionID,

services/api-server/src/simcore_service_api_server/services_rpc/wb_api_server.py

@@ -6,7 +6,7 @@
 
 from fastapi import FastAPI
 from fastapi_pagination import create_page
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_api_server.functions import (
     Function,
     FunctionID,
     FunctionInputs,

services/api-server/tests/unit/api_functions/conftest.py

@@ -11,7 +11,7 @@
 
 import pytest
 from fastapi import FastAPI
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_webserver.functions import (
     Function,
     FunctionClass,
     FunctionIDNotFoundError,

services/api-server/tests/unit/api_functions/test_api_routers_functions.py

@@ -7,7 +7,7 @@
 
 import pytest
 from httpx import AsyncClient
-from models_library.api_schemas_webserver.functions_wb_schema import (
+from models_library.api_schemas_webserver.functions import (
     FunctionIDNotFoundError,
     FunctionJobCollection,
     ProjectFunction,

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

@@ -0,0 +1,77 @@
+from aiohttp import web
+from fastapi import status
+from models_library.api_schemas_webserver.functions import (
+    Function,
+    FunctionToRegister,
+    RegisteredFunctionGet,
+)
+from pydantic import TypeAdapter
+from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
+from servicelib.rabbitmq import RPCRouter
+from simcore_service_webserver.utils_aiohttp import envelope_json_response
+
+from ..._meta import API_VTAG as VTAG
+from .. import _functions_service
+from ._functions_rest_exceptions import handle_rest_requests_exceptions
+from ._functions_rest_schemas import FunctionPathParams
+
+router = RPCRouter()
+
+routes = web.RouteTableDef()
+
+
+@routes.post(f"/{VTAG}/functions", name="register_function")
+@handle_rest_requests_exceptions
+async def register_function(request: web.Request) -> web.Response:
+    function_to_register = TypeAdapter(FunctionToRegister).validate_python(
+        await request.json()
+    )
+
+    registered_function = await _functions_service.register_function(
+        app=request.app,
+        function=TypeAdapter(Function).validate_python(function_to_register),
+    )
+
+    return envelope_json_response(
+        TypeAdapter(RegisteredFunctionGet).validate_python(
+            registered_function.model_dump(mode="json")
+        )
+    )
+
+
+@routes.get(
+    f"/{VTAG}/functions/{{function_id}}",
+    name="get_function",
+)
+@handle_rest_requests_exceptions
+async def get_function(request: web.Request) -> web.Response:
+    path_params = parse_request_path_parameters_as(FunctionPathParams, request)
+    function_id = path_params.function_id
+
+    registered_function = await _functions_service.get_function(
+        app=request.app,
+        function_id=function_id,
+    )
+
+    return envelope_json_response(
+        TypeAdapter(RegisteredFunctionGet).validate_python(
+            registered_function.model_dump(mode="json")
+        )
+    )
+
+
+@routes.delete(
+    f"/{VTAG}/functions/{{function_id}}",
+    name="delete_function",
+)
+@handle_rest_requests_exceptions
+async def delete_function(request: web.Request) -> web.Response:
+    path_params = parse_request_path_parameters_as(FunctionPathParams, request)
+    function_id = path_params.function_id
+
+    await _functions_service.delete_function(
+        app=request.app,
+        function_id=function_id,
+    )
+
+    return web.Response(status=status.HTTP_204_NO_CONTENT)