✨ Refactor RPC route registration to use a higher-order function for improved flexibility

Author: pcrespov

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

@@ -7,3 +7,14 @@
 WEBSERVER_RPC_NAMESPACE: Final[RPCNamespace] = TypeAdapter(
     RPCNamespace
 ).validate_python("webserver")
+
+
+def get_webserver_rpc_namespace(webserver_host: str) -> RPCNamespace:
+    """
+    Returns the RPC namespace to select among the different webserver services
+
+    e.g. webserver, wb-api-server, wb-garbage-collector, etc.
+
+    On the service side, this is defined in settings.WEBSERVER_HOST
+    """
+    return TypeAdapter(RPCNamespace).validate_python(webserver_host)

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

@@ -1,5 +1,4 @@
 from aiohttp import web
-from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
 from models_library.functions import (
     Function,
     FunctionID,
@@ -31,7 +30,7 @@
 from models_library.users import UserID
 from servicelib.rabbitmq import RPCRouter
 
-from ...rabbitmq import get_rabbitmq_rpc_server
+from ...rabbitmq import create_register_rpc_routes_on_startup
 from .. import _functions_repository, _functions_service
 
 router = RPCRouter()
@@ -352,6 +351,4 @@ async def get_function_output_schema(
     )
 
 
-async def register_rpc_routes_on_startup(app: web.Application):
-    rpc_server = get_rabbitmq_rpc_server(app)
-    await rpc_server.register_router(router, WEBSERVER_RPC_NAMESPACE, app)
+register_rpc_routes_on_startup = create_register_rpc_routes_on_startup(router)

services/web/server/src/simcore_service_webserver/projects/_controller/projects_rpc.py

@@ -1,5 +1,4 @@
 from aiohttp import web
-from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.rest_pagination import PageLimitInt, PageOffsetInt
@@ -16,7 +15,7 @@
     ProjectNotFoundRpcError,
 )
 
-from ...rabbitmq import get_rabbitmq_rpc_server
+from ...rabbitmq import create_register_rpc_routes_on_startup
 from .. import _jobs_service
 from ..exceptions import ProjectInvalidRightsError, ProjectNotFoundError
 
@@ -111,6 +110,4 @@ async def list_projects_marked_as_jobs(
     return page
 
 
-async def register_rpc_routes_on_startup(app: web.Application):
-    rpc_server = get_rabbitmq_rpc_server(app)
-    await rpc_server.register_router(router, WEBSERVER_RPC_NAMESPACE, app)
+register_rpc_routes_on_startup = create_register_rpc_routes_on_startup(router)

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

@@ -3,6 +3,7 @@
 from typing import Final, cast
 
 from aiohttp import web
+from models_library.api_schemas_webserver import get_webserver_rpc_namespace
 from models_library.errors import RABBITMQ_CLIENT_UNHEALTHY_MSG
 from servicelib.aiohttp.application_keys import (
     APP_RABBITMQ_CLIENT_KEY,
@@ -13,9 +14,11 @@
 from servicelib.rabbitmq import (
     RabbitMQClient,
     RabbitMQRPCClient,
+    RPCRouter,
     wait_till_rabbitmq_responsive,
 )
 
+from .application_settings import get_application_settings
 from .rabbitmq_settings import RabbitSettings, get_plugin_settings
 from .rest.healthcheck import HealthCheck, HealthCheckError
 
@@ -94,3 +97,24 @@ def get_rabbitmq_client(app: web.Application) -> RabbitMQClient:
 
 def get_rabbitmq_rpc_server(app: web.Application) -> RabbitMQRPCClient:
     return cast(RabbitMQRPCClient, app[APP_RABBITMQ_RPC_SERVER_KEY])
+
+
+def create_register_rpc_routes_on_startup(router: RPCRouter):
+    """
+    This high-order function allows for more flexible router registration
+    by accepting a router instance and returning an on-startup event handler.
+
+    Args:
+        router: The RPCRouter instance containing the routes to register
+
+    """
+
+    async def _on_startup(app: web.Application):
+        rpc_server = get_rabbitmq_rpc_server(app)
+        settings = get_application_settings(app)
+
+        assert settings.WEBSERVER_HOST  # nosec
+        rpc_namespace = get_webserver_rpc_namespace(settings.WEBSERVER_HOST)
+        await rpc_server.register_router(router, rpc_namespace, app)
+
+    return _on_startup