Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions zulip/tests/test_session_retries.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
from unittest.mock import patch

from requests.adapters import HTTPAdapter

from zulip import Client


class TestSessionRetries:
def test_session_has_retry_adapter(self) -> None:
with patch.object(
Client,
"get_server_settings",
return_value={"zulip_version": "test-version", "zulip_feature_level": 1},
):
client = Client(
email="test@example.com",
api_key="test-api-key",
site="https://zulip.example.com",
client="test-client",
)
client.ensure_session()
session = client.session
assert session is not None
for scheme in ("http://", "https://"):
adapter = session.get_adapter(scheme)
assert isinstance(adapter, HTTPAdapter)
retries = adapter.max_retries
assert retries.total == 3
assert retries.connect == 3
assert retries.read == 3
assert retries.status == 0
# POST and other methods must also be retried, because
# requests over a stale pooled connection never reach
# the server.
assert retries.allowed_methods is None
19 changes: 19 additions & 0 deletions zulip/zulip/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import distro
import requests
from typing_extensions import Literal, override
from urllib3.util.retry import Retry

__version__ = "0.9.1"

Expand Down Expand Up @@ -552,6 +553,24 @@ def ensure_session(self) -> None:
session.verify = self.tls_verification
session.cert = client_cert
session.headers.update({"User-agent": self.get_user_agent()})
# Networks often silently drop idle TCP connections, so the next
# request over a pooled keep-alive connection can fail with a
# connection error even though the server is healthy. Retry this
# class of error transparently instead of failing the request.
# All methods, including POST, are retried since the request is
# never delivered over the stale connection.
retries = Retry(
total=3,
connect=3,
read=3,
status=0,
backoff_factor=0.5,
allowed_methods=None,
raise_on_status=False,
)
adapter = requests.adapters.HTTPAdapter(max_retries=retries)
session.mount("http://", adapter)
session.mount("https://", adapter)
self.session = session

def get_user_agent(self) -> str:
Expand Down
Loading