Skip to content

Add default timeout to all API requests #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
janfryauf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add default timeout to all API requests #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions ThermiaOnlineAPI/api/ThermiaAPI.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@
# Fix for multiple operation modes with the same value
REG_OPERATIONMODE_SKIP_VALUES = ["REG_VALUE_OPERATION_MODE_SERVICE"]

# Default (connect, read) timeout in seconds for every request
DEFAULT_REQUEST_TIMEOUT = (10, 30)


class ThermiaSession(requests.Session):
"""Session that applies a default timeout to every request."""

def request(self, *args, **kwargs):
kwargs.setdefault("timeout", DEFAULT_REQUEST_TIMEOUT)
return super().request(*args, **kwargs)


class ThermiaAPI:
def __init__(self, email, password):
Expand All @@ -65,9 +76,9 @@ def __init__(self, email, password):
"Access-Control-Allow-Origin": "*",
}

self.__session = requests.Session()
self.__session = ThermiaSession()
retry = Retry(
total=20, backoff_factor=0.1, status_forcelist=[500, 502, 503, 504]
total=5, backoff_factor=0.1, status_forcelist=[500, 502, 503, 504]
)
adapter = HTTPAdapter(max_retries=retry)
self.__session.mount("https://", adapter)
Expand Down
6 changes: 6 additions & 0 deletions ThermiaOnlineAPI/tests/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
AZURE_AUTH_CONFIRM_URL,
AZURE_AUTH_GET_TOKEN_URL,
AZURE_SELF_ASSERTED_URL,
DEFAULT_REQUEST_TIMEOUT,
)
from ..const import THERMIA_CONFIG_URL
from ..model.HeatPump import ThermiaHeatPump
Expand Down Expand Up @@ -130,4 +131,9 @@ def setup_thermia_and_perform_basic_tests(
heat_pump.operational_status_pid == expected_operational_status_pid_value
), f"Operational status PID - expected: {expected_operational_status_pid_value}, got: {heat_pump.operational_status_pid}"

request_timeouts = [request.timeout for request in requests_mock.request_history]
assert all(
timeout == DEFAULT_REQUEST_TIMEOUT for timeout in request_timeouts
), f"Request timeouts - expected: {DEFAULT_REQUEST_TIMEOUT}, got: {request_timeouts}"

return heat_pump