Skip to content
Draft
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
20 changes: 17 additions & 3 deletions sentry_sdk/transport.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,15 @@ def is_healthy(self: "Self") -> bool:
return True



def _keep_longer_rate_limit(disabled_until, category, until):
# type: (Dict[Optional[EventDataCategory], datetime], Optional[EventDataCategory], datetime) -> None
"""Store until unless a later deadline is already recorded for category."""
previous = disabled_until.get(category)
if previous is None or until > previous:
disabled_until[category] = until


def _parse_rate_limits(
header: str, now: "Optional[datetime]" = None
) -> "Iterable[Tuple[Optional[EventDataCategory], datetime]]":
Expand Down Expand Up @@ -341,7 +350,10 @@ def _update_rate_limits(
header = self._get_header_value(response, "x-sentry-rate-limits")
if header:
logger.warning("Rate-limited via x-sentry-rate-limits")
self._disabled_until.update(_parse_rate_limits(header))
# A later, shorter limit must not replace one that is still active.
# https://develop.sentry.dev/sdk/foundations/transport/rate-limiting/
for category, until in _parse_rate_limits(header):
_keep_longer_rate_limit(self._disabled_until, category, until)

# old sentries only communicate global rate limit hits via the
# retry-after header on 429. This header can also be emitted on new
Expand All @@ -354,8 +366,10 @@ def _update_rate_limits(
if retry_after_value is not None
else None
) or 60
self._disabled_until[None] = datetime.now(timezone.utc) + timedelta(
seconds=retry_after
_keep_longer_rate_limit(
self._disabled_until,
None,
datetime.now(timezone.utc) + timedelta(seconds=retry_after),
)

def _handle_request_error(
Expand Down
45 changes: 45 additions & 0 deletions tests/test_transport.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
AsyncHttpTransport,
HttpTransport,
_parse_rate_limits,
_keep_longer_rate_limit,
)

server = None
Expand Down Expand Up @@ -473,6 +474,50 @@ def test_parse_rate_limits(input, expected):
assert dict(_parse_rate_limits(input, now=NOW)) == expected


def test_shorter_rate_limit_keeps_the_longer_deadline():
disabled = {}
longer = NOW + timedelta(seconds=3600)
shorter = NOW + timedelta(seconds=0)
_keep_longer_rate_limit(disabled, "error", longer)
_keep_longer_rate_limit(disabled, "error", shorter)
assert disabled["error"] == longer
# An expired deadline still yields to a newer one.
_keep_longer_rate_limit(disabled, "error", NOW - timedelta(seconds=5))
assert disabled["error"] == longer
renewed = NOW + timedelta(seconds=10)
disabled["error"] = NOW - timedelta(seconds=5)
_keep_longer_rate_limit(disabled, "error", renewed)
assert disabled["error"] == renewed


class _HeaderResponse:
def __init__(self, status, headers):
self.status = status
self.headers = headers


def test_rate_limit_header_does_not_shorten_active_limit(capturing_server, make_client):
client = make_client(send_client_reports=False)
capturing_server.respond_with(
code=200,
headers={"X-Sentry-Rate-Limits": "3600:error:organization, 0:error:project"},
)
client.capture_event({"type": "event"})
client.flush()
until = client.transport._disabled_until["error"]
assert until > datetime.now(timezone.utc) + timedelta(seconds=3000)

client.transport._update_rate_limits(
_HeaderResponse(200, {"x-sentry-rate-limits": "1:error"})
)
assert client.transport._disabled_until["error"] == until

client.transport._disabled_until[None] = datetime.now(timezone.utc) + timedelta(seconds=3600)
kept = client.transport._disabled_until[None]
client.transport._update_rate_limits(_HeaderResponse(429, {"retry-after": "1"}))
assert client.transport._disabled_until[None] == kept


def test_envelope_too_large_response(capturing_server, make_client):
client = make_client()

Expand Down