Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Add Retry-After to M_LIMIT_EXCEEDED error responses #16136

Merged
merged 15 commits into from
Aug 24, 2023
Merged

Add Retry-After to M_LIMIT_EXCEEDED error responses #16136

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5efeae8
Add Retry-After header
Half-Shot Aug 19, 2023
9d26b2f
changelog
Half-Shot Aug 19, 2023
7656743
Tidy tidy
Half-Shot Aug 19, 2023
ab6f26f
Retry-After may be ceil'd
Half-Shot Aug 20, 2023
a16504a
Fixes
Half-Shot Aug 21, 2023
0ccce88
Add tests for exceeded rounding.
Half-Shot Aug 21, 2023
6d82dd3
Merge branch 'develop' into hs/retry-after-headers
Half-Shot Aug 21, 2023
b26a203
Fixup types
Half-Shot Aug 21, 2023
f04efbf
Allowed headers on errors to be conditional based on config setting.
Half-Shot Aug 22, 2023
793daa7
Update tests
Half-Shot Aug 22, 2023
8774a1f
Merge branch 'develop' into hs/retry-after-headers
Half-Shot Aug 22, 2023
fc6ab19
Merge branch 'develop' into hs/retry-after-headers
Half-Shot Aug 23, 2023
efa247c
Revert "Allowed headers on errors to be conditional based on config s…
clokep Aug 24, 2023
16a1e09
Revert "Update tests"
clokep Aug 24, 2023
4302d2d
Use a class-property to control headers.
clokep Aug 24, 2023
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
1 change: 1 addition & 0 deletions changelog.d/16136.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Return a `Retry-After` with `M_LIMIT_EXCEEDED` error responses.
8 changes: 7 additions & 1 deletion synapse/api/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"""Contains exceptions and error codes."""

import logging
import math
import typing
from enum import Enum
from http import HTTPStatus
Expand Down Expand Up @@ -510,7 +511,12 @@ def __init__(
retry_after_ms: Optional[int] = None,
errcode: str = Codes.LIMIT_EXCEEDED,
):
super().__init__(code, msg, errcode)
headers = (
None
if retry_after_ms is None
else {"Retry-After": str(math.ceil(retry_after_ms / 1000))}
)
super().__init__(code, msg, errcode, None, headers)
self.retry_after_ms = retry_after_ms

def error_dict(self, config: Optional["HomeServerConfig"]) -> "JsonDict":
Expand Down
9 changes: 9 additions & 0 deletions tests/rest/client/test_login.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,15 @@ def test_POST_ratelimiting_per_address(self) -> None:
if i == 5:
self.assertEqual(channel.code, 429, msg=channel.result)
retry_after_ms = int(channel.json_body["retry_after_ms"])
retry_header = channel.headers.getRawHeaders("Retry-After")
else:
self.assertEqual(channel.code, 200, msg=channel.result)

# Since we're ratelimiting at 1 request/min, retry_after_ms should be lower
# than 1min.
self.assertTrue(retry_after_ms < 6000)
assert retry_header
self.assertTrue(int(retry_header[0]) <= 6)

self.reactor.advance(retry_after_ms / 1000.0 + 1.0)

Expand Down Expand Up @@ -234,12 +237,15 @@ def test_POST_ratelimiting_per_account(self) -> None:
if i == 5:
self.assertEqual(channel.code, 429, msg=channel.result)
retry_after_ms = int(channel.json_body["retry_after_ms"])
retry_header = channel.headers.getRawHeaders("Retry-After")
else:
self.assertEqual(channel.code, 200, msg=channel.result)

# Since we're ratelimiting at 1 request/min, retry_after_ms should be lower
# than 1min.
self.assertTrue(retry_after_ms < 6000)
assert retry_header
self.assertTrue(int(retry_header[0]) <= 6)

self.reactor.advance(retry_after_ms / 1000.0)

Expand Down Expand Up @@ -279,12 +285,15 @@ def test_POST_ratelimiting_per_account_failed_attempts(self) -> None:
if i == 5:
self.assertEqual(channel.code, 429, msg=channel.result)
retry_after_ms = int(channel.json_body["retry_after_ms"])
retry_header = channel.headers.getRawHeaders("Retry-After")
else:
self.assertEqual(channel.code, 403, msg=channel.result)

# Since we're ratelimiting at 1 request/min, retry_after_ms should be lower
# than 1min.
self.assertTrue(retry_after_ms < 6000)
assert retry_header
self.assertTrue(int(retry_header[0]) <= 6)

self.reactor.advance(retry_after_ms / 1000.0 + 1.0)

Expand Down