🎨Director-v0: set default timeout to 20s and potentially allow setting it up (#7460)

Author: sanderegg

packages/service-library/src/servicelib/fastapi/client_session.py

@@ -1,12 +1,20 @@
+import datetime
+
 import httpx
 from fastapi import FastAPI
 
 
-def setup_client_session(app: FastAPI, *, max_keepalive_connections: int = 20) -> None:
+def setup_client_session(
+    app: FastAPI,
+    *,
+    default_timeout: datetime.timedelta = datetime.timedelta(seconds=20),
+    max_keepalive_connections: int = 20
+) -> None:
     async def on_startup() -> None:
         session = httpx.AsyncClient(
             transport=httpx.AsyncHTTPTransport(http2=True),
             limits=httpx.Limits(max_keepalive_connections=max_keepalive_connections),
+            timeout=default_timeout.total_seconds(),
         )
         app.state.aiohttp_client_session = session
 

services/director/src/simcore_service_director/core/application.py

@@ -56,6 +56,7 @@ def create_app(settings: ApplicationSettings) -> FastAPI:
     setup_client_session(
         app,
         max_keepalive_connections=settings.DIRECTOR_REGISTRY_CLIENT_MAX_KEEPALIVE_CONNECTIONS,
+        default_timeout=settings.DIRECTOR_REGISTRY_CLIENT_TIMEOUT,
     )
     setup_registry(app)
 

services/director/src/simcore_service_director/core/settings.py

@@ -112,10 +112,21 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
         ),
     )
 
-    DIRECTOR_REGISTRY_CLIENT_MAX_KEEPALIVE_CONNECTIONS: NonNegativeInt = 0
+    DIRECTOR_REGISTRY_CLIENT_MAX_KEEPALIVE_CONNECTIONS: NonNegativeInt = 5
+    DIRECTOR_REGISTRY_CLIENT_TIMEOUT: datetime.timedelta = datetime.timedelta(
+        seconds=20
+    )
     DIRECTOR_REGISTRY_CLIENT_MAX_CONCURRENT_CALLS: PositiveInt = 20
     DIRECTOR_REGISTRY_CLIENT_MAX_NUMBER_OF_RETRIEVED_OBJECTS: PositiveInt = 30
 
+    @field_validator("DIRECTOR_REGISTRY_CLIENT_TIMEOUT")
+    @classmethod
+    def _check_positive(cls, value: datetime.timedelta) -> datetime.timedelta:
+        if value.total_seconds() < 0:
+            msg = "DIRECTOR_REGISTRY_CLIENT_TIMEOUT must be positive"
+            raise ValueError(msg)
+        return value
+
     @field_validator("DIRECTOR_GENERIC_RESOURCE_PLACEMENT_CONSTRAINTS_SUBSTITUTIONS")
     @classmethod
     def _validate_substitutions(cls, v):

services/director/tests/unit/test_core_settings.py

@@ -4,7 +4,10 @@
 # pylint: disable=too-many-arguments
 
 
+import datetime
+
 import pytest
+from pydantic import ValidationError
 from pytest_simcore.helpers.monkeypatch_envs import (
     setenvs_from_dict,
     setenvs_from_envfile,
@@ -37,6 +40,16 @@ def test_valid_web_application_settings(app_environment: EnvVarsDict):
     )
 
 
+def test_invalid_client_timeout_raises(
+    app_environment: EnvVarsDict, monkeypatch: pytest.MonkeyPatch
+):
+    monkeypatch.setenv(
+        "DIRECTOR_REGISTRY_CLIENT_TIMEOUT", f"{datetime.timedelta(seconds=-10)}"
+    )
+    with pytest.raises(ValidationError):
+        ApplicationSettings.create_from_envs()
+
+
 def test_docker_container_env_sample(monkeypatch: pytest.MonkeyPatch):
     monkeypatch.delenv("DIRECTOR_DEFAULT_MAX_MEMORY", raising=False)