✨ Refactor: Update RPC API route setup to use async iterator for improved lifespan management

Author: pcrespov

services/catalog/src/simcore_service_catalog/api/rpc/routes.py

@@ -1,6 +1,8 @@
 import logging
+from collections.abc import AsyncIterator
 
 from fastapi import FastAPI
+from fastapi_lifespan_manager import State
 from models_library.api_schemas_catalog import CATALOG_RPC_NAMESPACE
 
 from ...services.rabbitmq import get_rabbitmq_rpc_server
@@ -9,9 +11,11 @@
 _logger = logging.getLogger(__name__)
 
 
-def setup_rpc_api_routes(app: FastAPI) -> None:
-    async def _on_startup() -> None:
-        rpc_server = get_rabbitmq_rpc_server(app)
-        await rpc_server.register_router(_services.router, CATALOG_RPC_NAMESPACE, app)
-
-    app.add_event_handler("startup", _on_startup)
+async def setup_rpc_api_routes(app: FastAPI) -> AsyncIterator[State]:
+    rpc_server = get_rabbitmq_rpc_server(app)
+    await rpc_server.register_router(_services.router, CATALOG_RPC_NAMESPACE, app)
+    try:
+        yield {}
+    finally:
+        # No specific cleanup required for now
+        pass

services/catalog/src/simcore_service_catalog/core/application.py

@@ -14,7 +14,6 @@
     SUMMARY,
 )
 from ..api.rest.routes import setup_rest_api_routes
-from ..api.rpc.routes import setup_rpc_api_routes
 from ..exceptions.handlers import setup_exception_handlers
 from . import events
 from .settings import ApplicationSettings
@@ -70,7 +69,6 @@ def create_app() -> FastAPI:
 
     # ROUTES
     setup_rest_api_routes(app, vtag=API_VTAG)
-    setup_rpc_api_routes(app)
 
     # EXCEPTIONS
     setup_exception_handlers(app)

services/catalog/src/simcore_service_catalog/core/events.py

@@ -14,6 +14,7 @@
 from servicelib.fastapi.tracing import initialize_tracing
 
 from .._meta import APP_FINISHED_BANNER_MSG, APP_NAME, APP_STARTED_BANNER_MSG
+from ..api.rpc.routes import setup_rpc_api_routes
 from ..db.events import setup_database
 from ..services.director import setup_director
 from ..services.function_services import setup_function_services
@@ -73,6 +74,9 @@ def create_app_lifespan():
     # - rabbitmq lifespan
     app_lifespan.add(setup_rabbitmq)
 
+    # - rpc api routes lifespan
+    app_lifespan.add(setup_rpc_api_routes)
+
     # - director lifespan
     app_lifespan.add(setup_director)