Add example functions section to api-server (#7398)

Author: bisgaard-itis

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

@@ -0,0 +1,22 @@
+import logging
+
+from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
+from models_library.rabbitmq_basic_types import RPCMethodName
+from pydantic import TypeAdapter
+
+from .....logging_utils import log_decorator
+from .....rabbitmq import RabbitMQRPCClient
+
+_logger = logging.getLogger(__name__)
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+async def ping(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+) -> str:
+    result = await rabbitmq_rpc_client.request(
+        WEBSERVER_RPC_NAMESPACE,
+        TypeAdapter(RPCMethodName).validate_python("ping"),
+    )
+    assert isinstance(result, str)  # nosec
+    return result

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

@@ -6,6 +6,7 @@
 from .routes import credits as _credits
 from .routes import (
     files,
+    functions,
     health,
     licensed_items,
     meta,
@@ -44,6 +45,7 @@ def create_router(settings: ApplicationSettings):
     router.include_router(
         licensed_items.router, tags=["licensed-items"], prefix="/licensed-items"
     )
+    router.include_router(functions.router, tags=["functions"], prefix="/functions")
 
     # NOTE: multiple-files upload is currently disabled
     # Web form to upload files at http://localhost:8000/v0/upload-form-view

services/api-server/src/simcore_service_api_server/api/root.py

@@ -0,0 +1,17 @@
+from typing import Annotated
+
+from fastapi import APIRouter, Depends
+
+from ...services_rpc.wb_api_server import WbApiRpcClient
+from ..dependencies.webserver_rpc import (
+    get_wb_api_rpc_client,
+)
+
+router = APIRouter()
+
+
+@router.post("/ping", include_in_schema=False)
+async def ping(
+    wb_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
+):
+    return await wb_api_rpc.ping()

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

@@ -26,6 +26,9 @@
 from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
     NotEnoughAvailableSeatsError,
 )
+from servicelib.rabbitmq.rpc_interfaces.webserver.functions.functions import (
+    ping as _ping,
+)
 from servicelib.rabbitmq.rpc_interfaces.webserver.licenses.licensed_items import (
     checkout_licensed_item_for_wallet as _checkout_licensed_item_for_wallet,
 )
@@ -194,6 +197,9 @@ async def release_licensed_item_for_wallet(
             num_of_seats=licensed_item_checkout_get.num_of_seats,
         )
 
+    async def ping(self) -> str:
+        return await _ping(self._client)
+
 
 def setup(app: FastAPI, rabbitmq_rmp_client: RabbitMQRPCClient):
     wb_api_rpc_client = WbApiRpcClient(_client=rabbitmq_rmp_client)

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

@@ -140,6 +140,7 @@ services:
       WEBSERVER_LOGLEVEL: DEBUG
       WEBSERVER_PROFILING: ${WEBSERVER_PROFILING}
       WEBSERVER_REMOTE_DEBUGGING_PORT: 3000
+      WEBSERVER_FUNCTIONS: ${WEBSERVER_FUNCTIONS}
 
 
   wb-api-server:

services/docker-compose.devel.yml

@@ -136,6 +136,7 @@ services:
   webserver:
     environment: &webserver_environment_local
       <<: *common_environment
+      WEBSERVER_FUNCTIONS: ${WEBSERVER_FUNCTIONS}
     ports:
       - "8080"
       - "3001:3000"

services/docker-compose.local.yml

@@ -3,7 +3,7 @@
   "info": {
     "title": "simcore_service_storage",
     "description": "Service that manages osparc storage backend",
-    "version": "0.6.0"
+    "version": "0.7.0"
   },
   "paths": {
     "/v0/": {

services/storage/openapi.json

@@ -22,6 +22,7 @@
 from .email.plugin import setup_email
 from .exporter.plugin import setup_exporter
 from .folders.plugin import setup_folders
+from .functions.plugin import setup_functions
 from .garbage_collector.plugin import setup_garbage_collector
 from .groups.plugin import setup_groups
 from .invitations.plugin import setup_invitations
@@ -133,6 +134,9 @@ def create_application() -> web.Application:
     # folders
     setup_folders(app)
 
+    # functions
+    setup_functions(app)
+
     # projects
     setup_projects(app)
 

services/web/server/src/simcore_service_webserver/application.py

@@ -105,6 +105,14 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
         bool, Field(description="Enables credit computation features.")
     ] = False
 
+    WEBSERVER_FUNCTIONS: Annotated[
+        bool,
+        Field(
+            validation_alias=AliasChoices("WEBSERVER_FUNCTIONS"),
+            json_schema_extra={_X_DEV_FEATURE_FLAG: True},
+        ),
+    ] = False
+
     WEBSERVER_LOGLEVEL: Annotated[
         LogLevel,
         Field(