mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-05-04 10:54:53 -04:00
Add config settings for background update parameters (#11980)
This commit is contained in:
Shay
GitHub
parent
e6a106fd5e
commit
ef3619e61d
9 changed files with 430 additions and 34 deletions
|
|
@ -14,12 +14,15 @@
|
|||
|
||||
from unittest.mock import Mock
|
||||
|
||||
import yaml
|
||||
|
||||
from twisted.internet.defer import Deferred, ensureDeferred
|
||||
|
||||
from synapse.storage.background_updates import BackgroundUpdater
|
||||
|
||||
from tests import unittest
|
||||
from tests.test_utils import make_awaitable, simple_async_mock
|
||||
from tests.unittest import override_config
|
||||
|
||||
|
||||
class BackgroundUpdateTestCase(unittest.HomeserverTestCase):
|
||||
|
|
@ -34,6 +37,19 @@ class BackgroundUpdateTestCase(unittest.HomeserverTestCase):
|
|||
self.updates.register_background_update_handler(
|
||||
"test_update", self.update_handler
|
||||
)
|
||||
self.store = self.hs.get_datastores().main
|
||||
|
||||
async def update(self, progress, count):
|
||||
duration_ms = 10
|
||||
await self.clock.sleep((count * duration_ms) / 1000)
|
||||
progress = {"my_key": progress["my_key"] + 1}
|
||||
await self.store.db_pool.runInteraction(
|
||||
"update_progress",
|
||||
self.updates._background_update_progress_txn,
|
||||
"test_update",
|
||||
progress,
|
||||
)
|
||||
return count
|
||||
|
||||
def test_do_background_update(self):
|
||||
# the time we claim it takes to update one item when running the update
|
||||
|
|
@ -42,27 +58,14 @@ class BackgroundUpdateTestCase(unittest.HomeserverTestCase):
|
|||
# the target runtime for each bg update
|
||||
target_background_update_duration_ms = 100
|
||||
|
||||
store = self.hs.get_datastores().main
|
||||
self.get_success(
|
||||
store.db_pool.simple_insert(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
# first step: make a bit of progress
|
||||
async def update(progress, count):
|
||||
await self.clock.sleep((count * duration_ms) / 1000)
|
||||
progress = {"my_key": progress["my_key"] + 1}
|
||||
await store.db_pool.runInteraction(
|
||||
"update_progress",
|
||||
self.updates._background_update_progress_txn,
|
||||
"test_update",
|
||||
progress,
|
||||
)
|
||||
return count
|
||||
|
||||
self.update_handler.side_effect = update
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
res = self.get_success(
|
||||
self.updates.do_next_background_update(False),
|
||||
|
|
@ -72,7 +75,7 @@ class BackgroundUpdateTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
# on the first call, we should get run with the default background update size
|
||||
self.update_handler.assert_called_once_with(
|
||||
{"my_key": 1}, self.updates.DEFAULT_BACKGROUND_BATCH_SIZE
|
||||
{"my_key": 1}, self.updates.default_background_batch_size
|
||||
)
|
||||
|
||||
# second step: complete the update
|
||||
|
|
@ -99,6 +102,224 @@ class BackgroundUpdateTestCase(unittest.HomeserverTestCase):
|
|||
self.assertTrue(result)
|
||||
self.assertFalse(self.update_handler.called)
|
||||
|
||||
@override_config(
|
||||
yaml.safe_load(
|
||||
"""
|
||||
background_updates:
|
||||
default_batch_size: 20
|
||||
"""
|
||||
)
|
||||
)
|
||||
def test_background_update_default_batch_set_by_config(self):
|
||||
"""
|
||||
Test that the background update is run with the default_batch_size set by the config
|
||||
"""
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
res = self.get_success(
|
||||
self.updates.do_next_background_update(False),
|
||||
by=0.01,
|
||||
)
|
||||
self.assertFalse(res)
|
||||
|
||||
# on the first call, we should get run with the default background update size specified in the config
|
||||
self.update_handler.assert_called_once_with({"my_key": 1}, 20)
|
||||
|
||||
def test_background_update_default_sleep_behavior(self):
|
||||
"""
|
||||
Test default background update behavior, which is to sleep
|
||||
"""
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
self.updates.start_doing_background_updates(),
|
||||
|
||||
# 2: advance the reactor less than the default sleep duration (1000ms)
|
||||
self.reactor.pump([0.5])
|
||||
# check that an update has not been run
|
||||
self.update_handler.assert_not_called()
|
||||
|
||||
# advance reactor past default sleep duration
|
||||
self.reactor.pump([1])
|
||||
# check that update has been run
|
||||
self.update_handler.assert_called()
|
||||
|
||||
@override_config(
|
||||
yaml.safe_load(
|
||||
"""
|
||||
background_updates:
|
||||
sleep_duration_ms: 500
|
||||
"""
|
||||
)
|
||||
)
|
||||
def test_background_update_sleep_set_in_config(self):
|
||||
"""
|
||||
Test that changing the sleep time in the config changes how long it sleeps
|
||||
"""
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
self.updates.start_doing_background_updates(),
|
||||
|
||||
# 2: advance the reactor less than the configured sleep duration (500ms)
|
||||
self.reactor.pump([0.45])
|
||||
# check that an update has not been run
|
||||
self.update_handler.assert_not_called()
|
||||
|
||||
# advance reactor past config sleep duration but less than default duration
|
||||
self.reactor.pump([0.75])
|
||||
# check that update has been run
|
||||
self.update_handler.assert_called()
|
||||
|
||||
@override_config(
|
||||
yaml.safe_load(
|
||||
"""
|
||||
background_updates:
|
||||
sleep_enabled: false
|
||||
"""
|
||||
)
|
||||
)
|
||||
def test_disabling_background_update_sleep(self):
|
||||
"""
|
||||
Test that disabling sleep in the config results in bg update not sleeping
|
||||
"""
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
self.updates.start_doing_background_updates(),
|
||||
|
||||
# 2: advance the reactor very little
|
||||
self.reactor.pump([0.025])
|
||||
# check that an update has run
|
||||
self.update_handler.assert_called()
|
||||
|
||||
@override_config(
|
||||
yaml.safe_load(
|
||||
"""
|
||||
background_updates:
|
||||
background_update_duration_ms: 500
|
||||
"""
|
||||
)
|
||||
)
|
||||
def test_background_update_duration_set_in_config(self):
|
||||
"""
|
||||
Test that the desired duration set in the config is used in determining batch size
|
||||
"""
|
||||
# Duration of one background update item
|
||||
duration_ms = 10
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
self.update_handler.side_effect = self.update
|
||||
self.update_handler.reset_mock()
|
||||
res = self.get_success(
|
||||
self.updates.do_next_background_update(False),
|
||||
by=0.02,
|
||||
)
|
||||
self.assertFalse(res)
|
||||
|
||||
# the first update was run with the default batch size, this should be run with 500ms as the
|
||||
# desired duration
|
||||
async def update(progress, count):
|
||||
self.assertEqual(progress, {"my_key": 2})
|
||||
self.assertAlmostEqual(
|
||||
count,
|
||||
500 / duration_ms,
|
||||
places=0,
|
||||
)
|
||||
await self.updates._end_background_update("test_update")
|
||||
return count
|
||||
|
||||
self.update_handler.side_effect = update
|
||||
self.get_success(self.updates.do_next_background_update(False))
|
||||
|
||||
@override_config(
|
||||
yaml.safe_load(
|
||||
"""
|
||||
background_updates:
|
||||
min_batch_size: 5
|
||||
"""
|
||||
)
|
||||
)
|
||||
def test_background_update_min_batch_set_in_config(self):
|
||||
"""
|
||||
Test that the minimum batch size set in the config is used
|
||||
"""
|
||||
# a very long-running individual update
|
||||
duration_ms = 50
|
||||
|
||||
self.get_success(
|
||||
self.store.db_pool.simple_insert(
|
||||
"background_updates",
|
||||
values={"update_name": "test_update", "progress_json": '{"my_key": 1}'},
|
||||
)
|
||||
)
|
||||
|
||||
# Run the update with the long-running update item
|
||||
async def update(progress, count):
|
||||
await self.clock.sleep((count * duration_ms) / 1000)
|
||||
progress = {"my_key": progress["my_key"] + 1}
|
||||
await self.store.db_pool.runInteraction(
|
||||
"update_progress",
|
||||
self.updates._background_update_progress_txn,
|
||||
"test_update",
|
||||
progress,
|
||||
)
|
||||
return count
|
||||
|
||||
self.update_handler.side_effect = update
|
||||
self.update_handler.reset_mock()
|
||||
res = self.get_success(
|
||||
self.updates.do_next_background_update(False),
|
||||
by=1,
|
||||
)
|
||||
self.assertFalse(res)
|
||||
|
||||
# the first update was run with the default batch size, this should be run with minimum batch size
|
||||
# as the first items took a very long time
|
||||
async def update(progress, count):
|
||||
self.assertEqual(progress, {"my_key": 2})
|
||||
self.assertEqual(count, 5)
|
||||
await self.updates._end_background_update("test_update")
|
||||
return count
|
||||
|
||||
self.update_handler.side_effect = update
|
||||
self.get_success(self.updates.do_next_background_update(False))
|
||||
|
||||
|
||||
class BackgroundUpdateControllerTestCase(unittest.HomeserverTestCase):
|
||||
def prepare(self, reactor, clock, homeserver):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue