fix: AS-86 Update constants http timeout (#26)

* Update constants.py

* Refactor: Introduce DEFAULT_HTTP_TIMEOUT constant and update client timeout handling

- Added DEFAULT_HTTP_TIMEOUT constant in constants.py for consistent timeout management.
- Updated AiolaClient and related classes to utilize the new timeout constant.
- Adjusted HTTP client instantiation in auth client to use DEFAULT_HTTP_TIMEOUT.
- Updated .gitignore to include .vscode directory.

These changes enhance code maintainability and ensure consistent timeout behavior across the SDK.

* Refactor: Update transcribe_file to use environment variable for API key

- Replaced hardcoded API key in transcribe_file.py with a call to os.getenv('AIOLA_API_KEY') for improved security and flexibility.
- Removed the timeout parameter from AiolaClient instantiation to align with recent changes in client timeout handling.

These updates enhance code maintainability and security by adhering to best practices for sensitive information management.

Author: yoavsraya

.gitignore

@@ -175,3 +175,4 @@ streamed_audio.wav
 example_output/
 .coveragerc
 .DS_Store
+.vscode

aiola/client.py

@@ -3,7 +3,7 @@
 from .clients.auth.client import AsyncAuthClient, AuthClient
 from .clients.stt.client import AsyncSttClient, SttClient
 from .clients.tts.client import AsyncTtsClient, TtsClient
-from .constants import DEFAULT_AUTH_BASE_URL, DEFAULT_BASE_URL, DEFAULT_WORKFLOW_ID
+from .constants import DEFAULT_AUTH_BASE_URL, DEFAULT_BASE_URL, DEFAULT_HTTP_TIMEOUT, DEFAULT_WORKFLOW_ID
 from .errors import AiolaError, AiolaValidationError
 from .types import AiolaClientOptions, GrantTokenResponse, SessionCloseResponse
 
@@ -19,6 +19,7 @@ def __init__(
         base_url: str | None = None,
         auth_base_url: str | None = None,
         workflow_id: str = DEFAULT_WORKFLOW_ID,
+        timeout: int = DEFAULT_HTTP_TIMEOUT,
     ):
         # Initialize lazy-loaded clients
         self._stt: SttClient | None = None
@@ -32,6 +33,7 @@ def __init__(
                 api_key=api_key,
                 access_token=access_token,
                 workflow_id=workflow_id,
+                timeout=timeout,
             )
         except (ValueError, TypeError) as exc:
             raise AiolaValidationError(str(exc)) from exc

aiola/clients/auth/client.py

@@ -7,7 +7,7 @@
 
 import httpx
 
-from ...constants import DEFAULT_HEADERS, HTTP_TIMEOUT
+from ...constants import DEFAULT_HEADERS, DEFAULT_HTTP_TIMEOUT
 from ...errors import AiolaError
 from ...types import AiolaClientOptions, GrantTokenResponse, SessionCloseResponse
 
@@ -85,7 +85,7 @@ def grant_token(api_key: str, auth_base_url: str, workflow_id: str) -> GrantToke
                 "Authorization": f"Bearer {api_key}",
             }
             # Generate temporary token
-            with httpx.Client(timeout=HTTP_TIMEOUT) as client:
+            with httpx.Client(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 token_response = client.post(
                     token_endpoint,
                     headers=headers,
@@ -152,7 +152,7 @@ async def async_grant_token(api_key: str, auth_base_url: str, workflow_id: str)
             session_endpoint = f"{auth_base_url}/voip-auth/session"
 
             # Generate temporary token
-            async with httpx.AsyncClient(timeout=HTTP_TIMEOUT) as client:
+            async with httpx.AsyncClient(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 token_response = await client.post(
                     token_endpoint, headers={**DEFAULT_HEADERS, "Authorization": f"Bearer {api_key}"}
                 )
@@ -214,7 +214,7 @@ async def async_close_session(access_token: str, auth_base_url: str) -> SessionC
             auth_base_url = auth_base_url.rstrip("/")
             session_endpoint = f"{auth_base_url}/voip-auth/session"
 
-            async with httpx.AsyncClient(timeout=HTTP_TIMEOUT) as client:
+            async with httpx.AsyncClient(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = await client.delete(
                     session_endpoint,
                     headers={
@@ -283,7 +283,7 @@ def get_access_token(self, access_token: str, api_key: str, workflow_id: str) ->
     def _api_key_to_token(self, api_key: str) -> str:
         """Generate a temporary JWT token from API key."""
         try:
-            with httpx.Client(timeout=HTTP_TIMEOUT) as client:
+            with httpx.Client(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = client.post(
                     f"{self._options.auth_base_url}/voip-auth/apiKey2Token",
                     headers={**DEFAULT_HEADERS, "Authorization": f"Bearer {api_key}"},
@@ -316,7 +316,7 @@ def _create_session(self, token: str, workflow_id: str) -> dict[str, str]:
             body = {"workflow_id": workflow_id}
             headers = {**DEFAULT_HEADERS, "Content-Type": "application/json", "Authorization": f"Bearer {token}"}
 
-            with httpx.Client(timeout=HTTP_TIMEOUT) as client:
+            with httpx.Client(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = client.post(
                     f"{self._options.auth_base_url}/voip-auth/session",
                     headers=headers,
@@ -375,7 +375,7 @@ def close_session(access_token: str, auth_base_url: str) -> SessionCloseResponse
             auth_base_url = auth_base_url.rstrip("/")
             session_endpoint = f"{auth_base_url}/voip-auth/session"
 
-            with httpx.Client(timeout=HTTP_TIMEOUT) as client:
+            with httpx.Client(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = client.delete(
                     session_endpoint,
                     headers={
@@ -516,7 +516,7 @@ async def get_access_token(self, access_token: str, api_key: str, workflow_id: s
     async def _api_key_to_token(self, api_key: str) -> str:
         """Generate a temporary JWT token from API key."""
         try:
-            async with httpx.AsyncClient(timeout=HTTP_TIMEOUT) as client:
+            async with httpx.AsyncClient(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = await client.post(
                     f"{self._options.auth_base_url}/voip-auth/apiKey2Token",
                     headers={**DEFAULT_HEADERS, "Authorization": f"Bearer {api_key}"},
@@ -548,7 +548,7 @@ async def _create_session(self, token: str, workflow_id: str) -> dict[str, str]:
         try:
             body = {"workflow_id": workflow_id}
 
-            async with httpx.AsyncClient(timeout=HTTP_TIMEOUT) as client:
+            async with httpx.AsyncClient(timeout=DEFAULT_HTTP_TIMEOUT) as client:
                 response = await client.post(
                     f"{self._options.auth_base_url}/voip-auth/session",
                     headers={**DEFAULT_HEADERS, "Content-Type": "application/json", "Authorization": f"Bearer {token}"},

aiola/constants.py

@@ -5,6 +5,6 @@
     "User-Agent": "@aiola/aiola-python",
 }
 
-HTTP_TIMEOUT = 60
+DEFAULT_HTTP_TIMEOUT = 150
 
 DEFAULT_WORKFLOW_ID = "2c78fcf1-9265-408f-b8c3-d9d7e7ebc1bc"

aiola/http_client.py

@@ -5,7 +5,7 @@
 
 import httpx
 
-from .constants import DEFAULT_BASE_URL, DEFAULT_HEADERS, HTTP_TIMEOUT
+from .constants import DEFAULT_BASE_URL, DEFAULT_HEADERS
 from .errors import AiolaError
 
 if TYPE_CHECKING:
@@ -34,8 +34,9 @@ def create_authenticated_client(options: AiolaClientOptions, auth: AuthClient) -
 
         # Create client with base URL and headers
         full_base_url = (options.base_url or DEFAULT_BASE_URL).rstrip("/")
+        timeout = options.timeout
 
-        return httpx.Client(base_url=full_base_url, headers=headers, timeout=HTTP_TIMEOUT)
+        return httpx.Client(base_url=full_base_url, headers=headers, timeout=timeout)
     except Exception as exc:
         raise AiolaError("Failed to create authenticated HTTP client") from exc
 
@@ -53,7 +54,8 @@ async def create_async_authenticated_client(options: AiolaClientOptions, auth: A
 
         # Create client with base URL and headers
         full_base_url = (options.base_url or DEFAULT_BASE_URL).rstrip("/")
+        timeout = options.timeout
 
-        return httpx.AsyncClient(base_url=full_base_url, headers=headers, timeout=HTTP_TIMEOUT)
+        return httpx.AsyncClient(base_url=full_base_url, headers=headers, timeout=timeout)
     except Exception as exc:
         raise AiolaError("Failed to create authenticated async HTTP client") from exc

aiola/types.py

@@ -5,7 +5,7 @@
 from dataclasses import dataclass
 from typing import IO, TypedDict, Union
 
-from .constants import DEFAULT_AUTH_BASE_URL, DEFAULT_BASE_URL, DEFAULT_WORKFLOW_ID
+from .constants import DEFAULT_AUTH_BASE_URL, DEFAULT_BASE_URL, DEFAULT_HTTP_TIMEOUT, DEFAULT_WORKFLOW_ID
 
 
 @dataclass
@@ -17,6 +17,7 @@ class AiolaClientOptions:
     api_key: str | None = None
     access_token: str | None = None
     workflow_id: str = DEFAULT_WORKFLOW_ID
+    timeout: float | None = DEFAULT_HTTP_TIMEOUT
 
     def __post_init__(self) -> None:
         """Validate options after initialization."""
@@ -38,6 +39,9 @@ def __post_init__(self) -> None:
         if not isinstance(self.workflow_id, str):
             raise TypeError("Workflow ID must be a string")
 
+        if self.timeout is not None and not isinstance(self.timeout, (int | float)):
+            raise TypeError("Timeout must be a number")
+
 
 class LiveEvents(str, enum.Enum):
     Transcript = "transcript"