refactor to use custom setting var name

Author: Andrei Neagu

packages/service-library/src/servicelib/docker_utils.py

@@ -4,7 +4,7 @@
 from dataclasses import dataclass
 from datetime import datetime
 from functools import cached_property
-from typing import Any, Final, Literal
+from typing import Any, AsyncContextManager, Final, Literal
 
 import aiodocker
 import aiohttp
@@ -287,44 +287,56 @@ async def pull_image(
             )
 
 
-@asynccontextmanager
-async def lifespan_remote_docker_client(app: FastAPI) -> AsyncIterator[None]:
-    """Ensures `setup` and `teardown` for the docker client.
+def get_lifespan_remote_docker_client(
+    docker_api_proxy_settings_property_name: str,
+) -> Callable[[FastAPI], AsyncContextManager[None]]:
+    """Ensures `setup` and `teardown` for the remote docker client.
 
-    NOTE: the `DockerApiProxysettings` must be placed as `DOCKER_API_PROXY`
-    on the Application's Settings object
+    Arguments:
+        docker_api_proxy_settings_property_name -- if the name is `PROP_NAME`
+        then it should be accessible as `app.state.settings.PROP_NAME`
+
+    Returns:
+        docker client lifespan manager
     """
-    settings: DockerApiProxysettings = app.state.settings.DOCKER_API_PROXY
-
-    session: ClientSession | None = None
-    if settings.DOCKER_API_PROXY_USER and settings.DOCKER_API_PROXY_PASSWORD:
-        session = ClientSession(
-            auth=aiohttp.BasicAuth(
-                login=settings.DOCKER_API_PROXY_USER,
-                password=settings.DOCKER_API_PROXY_PASSWORD.get_secret_value(),
-            )
+
+    @asynccontextmanager
+    async def _(app: FastAPI) -> AsyncIterator[None]:
+        settings: DockerApiProxysettings = getattr(
+            app.state.settings, docker_api_proxy_settings_property_name
         )
 
-    async with AsyncExitStack() as exit_stack:
+        session: ClientSession | None = None
         if settings.DOCKER_API_PROXY_USER and settings.DOCKER_API_PROXY_PASSWORD:
-            await exit_stack.enter_async_context(
-                ClientSession(
-                    auth=aiohttp.BasicAuth(
-                        login=settings.DOCKER_API_PROXY_USER,
-                        password=settings.DOCKER_API_PROXY_PASSWORD.get_secret_value(),
+            session = ClientSession(
+                auth=aiohttp.BasicAuth(
+                    login=settings.DOCKER_API_PROXY_USER,
+                    password=settings.DOCKER_API_PROXY_PASSWORD.get_secret_value(),
+                )
+            )
+
+        async with AsyncExitStack() as exit_stack:
+            if settings.DOCKER_API_PROXY_USER and settings.DOCKER_API_PROXY_PASSWORD:
+                await exit_stack.enter_async_context(
+                    ClientSession(
+                        auth=aiohttp.BasicAuth(
+                            login=settings.DOCKER_API_PROXY_USER,
+                            password=settings.DOCKER_API_PROXY_PASSWORD.get_secret_value(),
+                        )
                     )
                 )
+
+            client = await exit_stack.enter_async_context(
+                aiodocker.Docker(url=settings.base_url, session=session)
             )
 
-        client = await exit_stack.enter_async_context(
-            aiodocker.Docker(url=settings.base_url, session=session)
-        )
+            app.state.remote_docker_client = client
 
-        app.state.remote_docker_client = client
+            yield
 
-        yield
+    return _
 
 
 def get_remote_docker_client(app: FastAPI) -> aiodocker.Docker:
-    client: aiodocker.Docker = app.state.remote_docker_client
-    return client
+    assert isinstance(app.state.remote_docker_client, aiodocker.Docker)  # nosec
+    return app.state.remote_docker_client

services/docker-api-proxy/tests/integration/conftest.py

@@ -11,8 +11,8 @@
 from pydantic import Field
 from pytest_simcore.helpers.monkeypatch_envs import EnvVarsDict, setenvs_from_dict
 from servicelib.docker_utils import (
+    get_lifespan_remote_docker_client,
     get_remote_docker_client,
-    lifespan_remote_docker_client,
 )
 from servicelib.fastapi.lifespan_utils import combine_lfiespan_context_managers
 from settings_library.application import BaseApplicationSettings
@@ -40,7 +40,9 @@ class ApplicationSetting(BaseApplicationSettings):
         ]
 
     app = FastAPI(
-        lifespan=combine_lfiespan_context_managers(lifespan_remote_docker_client)
+        lifespan=combine_lfiespan_context_managers(
+            get_lifespan_remote_docker_client("DOCKER_API_PROXY")
+        )
     )
     app.state.settings = ApplicationSetting.create_from_envs()
 

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/core/application.py

@@ -1,4 +1,6 @@
 from fastapi import FastAPI
+from servicelib.docker_utils import get_lifespan_remote_docker_client
+from servicelib.fastapi.lifespan_utils import combine_lfiespan_context_managers
 from servicelib.fastapi.openapi import override_fastapi_openapi_method
 from servicelib.fastapi.profiler_middleware import ProfilerMiddleware
 from servicelib.fastapi.prometheus_instrumentation import (
@@ -41,6 +43,9 @@ def create_app(settings: ApplicationSettings | None = None) -> FastAPI:
             "/doc" if app_settings.DYNAMIC_SCHEDULER_SWAGGER_API_DOC_ENABLED else None
         ),
         redoc_url=None,  # default disabled, see below
+        lifespan=combine_lfiespan_context_managers(
+            get_lifespan_remote_docker_client("DYNAMIC_SCHEDULER_DOCKER_API_PROXY")
+        ),
     )
     override_fastapi_openapi_method(app)
 

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/core/settings.py

@@ -7,6 +7,7 @@
 from settings_library.basic_types import LogLevel, VersionTag
 from settings_library.director_v0 import DirectorV0Settings
 from settings_library.director_v2 import DirectorV2Settings
+from settings_library.docker_api_proxy import DockerApiProxysettings
 from settings_library.http_client_request import ClientRequestSettings
 from settings_library.rabbit import RabbitSettings
 from settings_library.redis import RedisSettings
@@ -152,6 +153,11 @@ class ApplicationSettings(_BaseApplicationSettings):
         description="settings for opentelemetry tracing",
     )
 
+    DYNAMIC_SCHEDULER_DOCKER_API_PROXY: Annotated[
+        DockerApiProxysettings,
+        Field(json_schema_extra={"auto_default_from_env": True}),
+    ]
+
     @field_validator("DYNAMIC_SCHEDULER_UI_MOUNT_PATH", mode="before")
     @classmethod
     def _ensure_ends_with_slash(cls, v: str) -> str: