tweaks

Author: davidzhao

livekit-api/livekit/api/__init__.py

@@ -38,7 +38,7 @@
 
 from .twirp_client import TwirpError, TwirpErrorCode
 from .livekit_api import LiveKitAPI
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from .access_token import (
     InferenceGrants,
     ObservabilityGrants,
@@ -67,5 +67,5 @@
     "WebhookReceiver",
     "TwirpError",
     "TwirpErrorCode",
-    "FailoverConfig",
+    "FailoverOptions",
 ]

livekit-api/livekit/api/_failover.py

@@ -33,7 +33,7 @@
 _DEFAULT_BACKOFF_BASE = 0.2
 
 
-class FailoverConfig(TypedDict, total=False):
+class FailoverOptions(TypedDict, total=False):
     """Region-failover tuning, passed as the ``failover`` argument. Use it as a
     plain dict, e.g. ``failover={"max_attempts": 5}``. All keys are optional.
 
@@ -49,7 +49,7 @@ class FailoverConfig(TypedDict, total=False):
     backoff_base: float
 
 
-def failover_attempts(failover: Optional[FailoverConfig], host: Optional[str]) -> int:
+def failover_attempts(failover: Optional[FailoverOptions], host: Optional[str]) -> int:
     """Total request attempts including the initial one; 1 means no failover.
 
     With no config (``None``) failover is enabled only for LiveKit Cloud hosts.
@@ -60,7 +60,7 @@ def failover_attempts(failover: Optional[FailoverConfig], host: Optional[str]) -
     return max(1, failover.get("max_attempts", _DEFAULT_MAX_ATTEMPTS))
 
 
-def failover_backoff_base(failover: Optional[FailoverConfig]) -> float:
+def failover_backoff_base(failover: Optional[FailoverOptions]) -> float:
     return (failover or {}).get("backoff_base", _DEFAULT_BACKOFF_BASE)
 
 
@@ -143,7 +143,13 @@ async def _fetch(
         fetch_headers = {
             k: v for k, v in headers.items() if k.lower() not in ("content-type", "content-length")
         }
-        async with session.get(f"{origin}/settings/regions", headers=fetch_headers) as resp:
+        # Short timeout so a slow/unreachable discovery endpoint doesn't stall
+        # the failover path.
+        async with session.get(
+            f"{origin}/settings/regions",
+            headers=fetch_headers,
+            timeout=aiohttp.ClientTimeout(total=2),
+        ) as resp:
             if resp.status != 200:
                 raise RuntimeError(f"region discovery failed: {resp.status}")
             ttl = _parse_max_age(resp.headers.get("Cache-Control"))

livekit-api/livekit/api/_service.py

@@ -3,7 +3,7 @@
 import aiohttp
 from abc import ABC
 from .twirp_client import TwirpClient
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Optional
 from .access_token import AccessToken, VideoGrants, SIPGrants
 
@@ -17,7 +17,7 @@ def __init__(
         host: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         self._client = TwirpClient(session, host, "livekit", failover=failover)
         self.api_key = api_key

livekit-api/livekit/api/agent_dispatch_service.py

@@ -8,7 +8,7 @@
     ListAgentDispatchResponse,
 )
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from .access_token import VideoGrants
 
 SVC = "AgentDispatchService"
@@ -33,7 +33,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)
 

livekit-api/livekit/api/connector_service.py

@@ -17,7 +17,7 @@
     ConnectTwilioCallResponse,
 )
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Optional
 from .access_token import VideoGrants
 
@@ -43,7 +43,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)
 

livekit-api/livekit/api/egress_service.py

@@ -13,7 +13,7 @@
     ListEgressResponse,
 )
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Optional
 from .access_token import VideoGrants
 
@@ -41,7 +41,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)
 

livekit-api/livekit/api/ingress_service.py

@@ -8,7 +8,7 @@
     ListIngressResponse,
 )
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Optional
 from .access_token import VideoGrants
 
@@ -36,7 +36,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)
 

livekit-api/livekit/api/livekit_api.py

@@ -6,7 +6,7 @@
 from .sip_service import SipService
 from .agent_dispatch_service import AgentDispatchService
 from .connector_service import ConnectorService
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Any, Optional
 
 
@@ -32,7 +32,7 @@ def __init__(
         *,
         timeout: Optional[aiohttp.ClientTimeout] = None,
         session: Optional[aiohttp.ClientSession] = None,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         """Create a new LiveKitAPI instance.
 

livekit-api/livekit/api/room_service.py

@@ -25,7 +25,7 @@
 )
 from livekit.protocol.models import Room, ParticipantInfo
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from typing import Optional
 from .access_token import VideoGrants
 
@@ -53,7 +53,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)
 

livekit-api/livekit/api/sip_service.py

@@ -35,7 +35,7 @@
     SIPTransport,
 )
 from ._service import Service
-from ._failover import FailoverConfig
+from ._failover import FailoverOptions
 from .access_token import VideoGrants, SIPGrants
 
 SVC = "SIP"
@@ -60,7 +60,7 @@ def __init__(
         url: str,
         api_key: str,
         api_secret: str,
-        failover: Optional[FailoverConfig] = None,
+        failover: Optional[FailoverOptions] = None,
     ):
         super().__init__(session, url, api_key, api_secret, failover=failover)