2019-09-17 12:41:54 +02:00
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
2023-08-03 20:36:55 +02:00
|
|
|
from synapse.util.retryutils import NotRetryingDestination, get_retry_limiter
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
from tests.unittest import HomeserverTestCase
|
|
|
|
|
|
|
|
|
|
|
|
class RetryLimiterTestCase(HomeserverTestCase):
|
2022-12-02 18:58:56 +01:00
|
|
|
def test_new_destination(self) -> None:
|
2019-09-17 12:41:54 +02:00
|
|
|
"""A happy-path case with a new destination and a successful operation"""
|
2022-02-23 12:04:02 +01:00
|
|
|
store = self.hs.get_datastores().main
|
2020-08-06 14:39:35 +02:00
|
|
|
limiter = self.get_success(get_retry_limiter("test_dest", self.clock, store))
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
# advance the clock a bit before making the request
|
|
|
|
self.pump(1)
|
|
|
|
|
|
|
|
with limiter:
|
|
|
|
pass
|
|
|
|
|
2020-08-06 14:39:35 +02:00
|
|
|
new_timings = self.get_success(store.get_destination_retry_timings("test_dest"))
|
2019-09-17 12:41:54 +02:00
|
|
|
self.assertIsNone(new_timings)
|
|
|
|
|
2022-12-02 18:58:56 +01:00
|
|
|
def test_limiter(self) -> None:
|
2019-09-17 12:41:54 +02:00
|
|
|
"""General test case which walks through the process of a failing request"""
|
2022-02-23 12:04:02 +01:00
|
|
|
store = self.hs.get_datastores().main
|
2019-09-17 12:41:54 +02:00
|
|
|
|
2020-08-06 14:39:35 +02:00
|
|
|
limiter = self.get_success(get_retry_limiter("test_dest", self.clock, store))
|
2019-09-17 12:41:54 +02:00
|
|
|
|
2023-08-03 20:36:55 +02:00
|
|
|
min_retry_interval_ms = (
|
|
|
|
self.hs.config.federation.destination_min_retry_interval_ms
|
|
|
|
)
|
|
|
|
retry_multiplier = self.hs.config.federation.destination_retry_multiplier
|
|
|
|
|
2019-09-17 12:41:54 +02:00
|
|
|
self.pump(1)
|
|
|
|
try:
|
|
|
|
with limiter:
|
|
|
|
self.pump(1)
|
|
|
|
failure_ts = self.clock.time_msec()
|
|
|
|
raise AssertionError("argh")
|
|
|
|
except AssertionError:
|
|
|
|
pass
|
|
|
|
|
2021-05-21 18:57:08 +02:00
|
|
|
self.pump()
|
|
|
|
|
2020-08-06 14:39:35 +02:00
|
|
|
new_timings = self.get_success(store.get_destination_retry_timings("test_dest"))
|
2023-02-14 20:03:35 +01:00
|
|
|
assert new_timings is not None
|
2021-05-21 18:57:08 +02:00
|
|
|
self.assertEqual(new_timings.failure_ts, failure_ts)
|
|
|
|
self.assertEqual(new_timings.retry_last_ts, failure_ts)
|
2023-08-03 20:36:55 +02:00
|
|
|
self.assertEqual(new_timings.retry_interval, min_retry_interval_ms)
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
# now if we try again we should get a failure
|
2020-08-06 14:39:35 +02:00
|
|
|
self.get_failure(
|
|
|
|
get_retry_limiter("test_dest", self.clock, store), NotRetryingDestination
|
|
|
|
)
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
#
|
|
|
|
# advance the clock and try again
|
|
|
|
#
|
|
|
|
|
2023-08-03 20:36:55 +02:00
|
|
|
self.pump(min_retry_interval_ms)
|
2020-08-06 14:39:35 +02:00
|
|
|
limiter = self.get_success(get_retry_limiter("test_dest", self.clock, store))
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
self.pump(1)
|
|
|
|
try:
|
|
|
|
with limiter:
|
|
|
|
self.pump(1)
|
|
|
|
retry_ts = self.clock.time_msec()
|
|
|
|
raise AssertionError("argh")
|
|
|
|
except AssertionError:
|
|
|
|
pass
|
|
|
|
|
2021-05-21 18:57:08 +02:00
|
|
|
self.pump()
|
|
|
|
|
2020-08-06 14:39:35 +02:00
|
|
|
new_timings = self.get_success(store.get_destination_retry_timings("test_dest"))
|
2023-02-14 20:03:35 +01:00
|
|
|
assert new_timings is not None
|
2021-05-21 18:57:08 +02:00
|
|
|
self.assertEqual(new_timings.failure_ts, failure_ts)
|
|
|
|
self.assertEqual(new_timings.retry_last_ts, retry_ts)
|
2019-09-17 12:41:54 +02:00
|
|
|
self.assertGreaterEqual(
|
2023-08-03 20:36:55 +02:00
|
|
|
new_timings.retry_interval, min_retry_interval_ms * retry_multiplier * 0.5
|
2019-09-17 12:41:54 +02:00
|
|
|
)
|
|
|
|
self.assertLessEqual(
|
2023-08-03 20:36:55 +02:00
|
|
|
new_timings.retry_interval, min_retry_interval_ms * retry_multiplier * 2.0
|
2019-09-17 12:41:54 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
#
|
|
|
|
# one more go, with success
|
|
|
|
#
|
2023-08-03 20:36:55 +02:00
|
|
|
self.reactor.advance(min_retry_interval_ms * retry_multiplier * 2.0)
|
2020-08-06 14:39:35 +02:00
|
|
|
limiter = self.get_success(get_retry_limiter("test_dest", self.clock, store))
|
2019-09-17 12:41:54 +02:00
|
|
|
|
|
|
|
self.pump(1)
|
|
|
|
with limiter:
|
|
|
|
self.pump(1)
|
|
|
|
|
|
|
|
# wait for the update to land
|
|
|
|
self.pump()
|
|
|
|
|
2020-08-06 14:39:35 +02:00
|
|
|
new_timings = self.get_success(store.get_destination_retry_timings("test_dest"))
|
2019-09-17 12:41:54 +02:00
|
|
|
self.assertIsNone(new_timings)
|