cleanup api-server implementation

Author: bisgaard-itis

services/api-server/src/simcore_service_api_server/core/application.py

@@ -82,22 +82,36 @@ def init_app(settings: ApplicationSettings | None = None) -> FastAPI:
 
     setup_rabbitmq(app)
 
-    add_tracing = False
-    if app.state.settings.API_SERVER_TRACING:
-        add_tracing = True
-        setup_tracing(app, app.state.settings.API_SERVER_TRACING, APP_NAME)
+    if settings.API_SERVER_TRACING:
+        setup_tracing(app, settings.API_SERVER_TRACING, APP_NAME)
 
     if settings.API_SERVER_WEBSERVER:
-        webserver.setup(app, settings.API_SERVER_WEBSERVER, add_tracing=add_tracing)
+        webserver.setup(
+            app,
+            settings.API_SERVER_WEBSERVER,
+            tracing_settings=settings.API_SERVER_TRACING,
+        )
 
     if settings.API_SERVER_CATALOG:
-        catalog.setup(app, settings.API_SERVER_CATALOG, add_tracing=add_tracing)
+        catalog.setup(
+            app,
+            settings.API_SERVER_CATALOG,
+            tracing_settings=settings.API_SERVER_TRACING,
+        )
 
     if settings.API_SERVER_STORAGE:
-        storage.setup(app, settings.API_SERVER_STORAGE, add_tracing=add_tracing)
+        storage.setup(
+            app,
+            settings.API_SERVER_STORAGE,
+            tracing_settings=settings.API_SERVER_TRACING,
+        )
 
     if settings.API_SERVER_DIRECTOR_V2:
-        director_v2.setup(app, settings.API_SERVER_DIRECTOR_V2, add_tracing=add_tracing)
+        director_v2.setup(
+            app,
+            settings.API_SERVER_DIRECTOR_V2,
+            tracing_settings=settings.API_SERVER_TRACING,
+        )
 
     # setup app
     app.add_event_handler("startup", create_start_app_handler(app))

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

@@ -11,6 +11,7 @@
 from models_library.services import ServiceMetaDataPublished, ServiceType
 from pydantic import Extra, ValidationError, parse_obj_as, parse_raw_as
 from settings_library.catalog import CatalogSettings
+from settings_library.tracing import TracingSettings
 from simcore_service_api_server.exceptions.backend_errors import (
     ListSolversOrStudiesError,
     SolverOrStudyNotFoundError,
@@ -209,7 +210,9 @@ async def get_latest_release(
 # MODULES APP SETUP -------------------------------------------------------------
 
 
-def setup(app: FastAPI, settings: CatalogSettings, add_tracing: bool = False) -> None:
+def setup(
+    app: FastAPI, settings: CatalogSettings, tracing_settings: TracingSettings | None
+) -> None:
     if not settings:
         settings = CatalogSettings()
 
@@ -218,5 +221,5 @@ def setup(app: FastAPI, settings: CatalogSettings, add_tracing: bool = False) ->
         CatalogApi,
         api_baseurl=settings.api_base_url,
         service_name="catalog",
-        add_tracing=add_tracing,
+        tracing_settings=tracing_settings,
     )

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

@@ -9,6 +9,7 @@
 from models_library.projects_pipeline import ComputationTask
 from models_library.projects_state import RunningState
 from pydantic import AnyHttpUrl, AnyUrl, BaseModel, Field, PositiveInt, parse_raw_as
+from settings_library.tracing import TracingSettings
 from simcore_service_api_server.exceptions.backend_errors import (
     JobNotFoundError,
     LogFileNotFoundError,
@@ -192,13 +193,13 @@ async def get_computation_logs(
 
 
 def setup(
-    app: FastAPI, settings: DirectorV2Settings, add_tracing: bool = False
+    app: FastAPI, settings: DirectorV2Settings, tracing_settings: TracingSettings | None
 ) -> None:
     setup_client_instance(
         app,
         DirectorV2Api,
         # WARNING: it has /v0 and /v2 prefixes
         api_baseurl=settings.base_url,
         service_name="director_v2",
-        add_tracing=add_tracing,
+        tracing_settings=tracing_settings,
     )

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

@@ -14,6 +14,7 @@
 from models_library.basic_types import SHA256Str
 from models_library.generics import Envelope
 from pydantic import AnyUrl, PositiveInt
+from settings_library.tracing import TracingSettings
 from starlette.datastructures import URL
 
 from ..core.settings import StorageSettings
@@ -209,7 +210,9 @@ async def create_soft_link(
 # MODULES APP SETUP -------------------------------------------------------------
 
 
-def setup(app: FastAPI, settings: StorageSettings, add_tracing: bool = False) -> None:
+def setup(
+    app: FastAPI, settings: StorageSettings, tracing_settings: TracingSettings | None
+) -> None:
     if not settings:
         settings = StorageSettings()
 
@@ -218,7 +221,7 @@ def setup(app: FastAPI, settings: StorageSettings, add_tracing: bool = False) ->
         StorageApi,
         api_baseurl=settings.api_base_url,
         service_name="storage",
-        add_tracing=add_tracing,
+        tracing_settings=tracing_settings,
     )
 
 

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

@@ -48,6 +48,7 @@
     X_SIMCORE_PARENT_NODE_ID,
     X_SIMCORE_PARENT_PROJECT_UUID,
 )
+from settings_library.tracing import TracingSettings
 from simcore_service_api_server.exceptions.backend_errors import (
     ConfigurationError,
     ForbiddenWalletError,
@@ -588,26 +589,30 @@ async def get_service_pricing_plan(
 # MODULES APP SETUP -------------------------------------------------------------
 
 
-def setup(app: FastAPI, settings: WebServerSettings, add_tracing: bool = False) -> None:
+def setup(
+    app: FastAPI,
+    webserver_settings: WebServerSettings,
+    tracing_settings: TracingSettings | None,
+) -> None:
 
     setup_client_instance(
         app,
         WebserverApi,
-        api_baseurl=settings.api_base_url,
+        api_baseurl=webserver_settings.api_base_url,
         service_name="webserver",
-        add_tracing=add_tracing,
+        tracing_settings=tracing_settings,
     )
     setup_client_instance(
         app,
         LongRunningTasksClient,
         api_baseurl="",
         service_name="long_running_tasks_client",
-        add_tracing=add_tracing,
+        tracing_settings=tracing_settings,
     )
 
     def _on_startup() -> None:
         # normalize & encrypt
-        secret_key = settings.WEBSERVER_SESSION_SECRET_KEY.get_secret_value()
+        secret_key = webserver_settings.WEBSERVER_SESSION_SECRET_KEY.get_secret_value()
         app.state.webserver_fernet = fernet.Fernet(secret_key)
 
     async def _on_shutdown() -> None:

services/api-server/src/simcore_service_api_server/utils/client_base.py

@@ -5,6 +5,7 @@
 from fastapi import FastAPI
 from httpx import AsyncClient
 from servicelib.fastapi.tracing import setup_httpx_client_tracing
+from settings_library.tracing import TracingSettings
 
 from .app_data import AppDataMixin
 
@@ -44,16 +45,15 @@ def setup_client_instance(
     api_cls: type[BaseServiceClientApi],
     api_baseurl,
     service_name: str,
-    add_tracing: bool = False,
+    tracing_settings: TracingSettings | None,
     **extra_fields,
 ) -> None:
     """Helper to add init/cleanup of ServiceClientApi instances in the app lifespam"""
 
     assert issubclass(api_cls, BaseServiceClientApi)  # nosec
-
     # NOTE: this term is mocked in tests. If you need to modify pay attention to the mock
     client = AsyncClient(base_url=api_baseurl)
-    if add_tracing:
+    if tracing_settings:
         setup_httpx_client_tracing(client)
 
     # events

services/api-server/tests/unit/test_utils_client_base.py

@@ -43,6 +43,7 @@ class TheClientApi(BaseServiceClientApi):
         service_name="the_service",
         health_check_path="/health",
         x=42,
+        tracing_settings=None,
     )
     assert not TheClientApi.get_instance(app)