synapse/tests/util/test_expiring_cache.py
Eric Eastwood 5adb08f3c9
Remove MockClock() (#18992)
Spawning from adding some logcontext debug logs in
https://github.com/element-hq/synapse/pull/18966 and since we're not
logging at the `set_current_context(...)` level (see reasoning there),
this removes some usage of `set_current_context(...)`.

Specifically, `MockClock.call_later(...)` doesn't handle logcontexts
correctly. It uses the calling logcontext as the callback context
(wrong, as the logcontext could finish before the callback finishes) and
it didn't reset back to the sentinel context before handing back to the
reactor. It was like this since it was [introduced 10+ years
ago](38da9884e7).
Instead of fixing the implementation which would just be a copy of our
normal `Clock`, we can just remove `MockClock`
2025-09-30 11:27:29 -05:00

111 lines
3.3 KiB
Python

#
# This file is licensed under the Affero General Public License (AGPL) version 3.
#
# Copyright 2017 OpenMarket Ltd
# Copyright (C) 2023 New Vector, Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# See the GNU Affero General Public License for more details:
# <https://www.gnu.org/licenses/agpl-3.0.html>.
#
# Originally licensed under the Apache License, Version 2.0:
# <http://www.apache.org/licenses/LICENSE-2.0>.
#
# [This file includes modifications made by New Vector Limited]
#
#
from typing import List
from synapse.util.caches.expiringcache import ExpiringCache
from tests.server import get_clock
from .. import unittest
class ExpiringCacheTestCase(unittest.HomeserverTestCase):
def test_get_set(self) -> None:
reactor, clock = get_clock()
cache: ExpiringCache[str, str] = ExpiringCache(
cache_name="test",
server_name="testserver",
clock=clock,
max_len=1,
)
cache["key"] = "value"
self.assertEqual(cache.get("key"), "value")
self.assertEqual(cache["key"], "value")
def test_eviction(self) -> None:
reactor, clock = get_clock()
cache: ExpiringCache[str, str] = ExpiringCache(
cache_name="test",
server_name="testserver",
clock=clock,
max_len=2,
)
cache["key"] = "value"
cache["key2"] = "value2"
self.assertEqual(cache.get("key"), "value")
self.assertEqual(cache.get("key2"), "value2")
cache["key3"] = "value3"
self.assertEqual(cache.get("key"), None)
self.assertEqual(cache.get("key2"), "value2")
self.assertEqual(cache.get("key3"), "value3")
def test_iterable_eviction(self) -> None:
reactor, clock = get_clock()
cache: ExpiringCache[str, List[int]] = ExpiringCache(
cache_name="test",
server_name="testserver",
clock=clock,
max_len=5,
iterable=True,
)
cache["key"] = [1]
cache["key2"] = [2, 3]
cache["key3"] = [4, 5]
self.assertEqual(cache.get("key"), [1])
self.assertEqual(cache.get("key2"), [2, 3])
self.assertEqual(cache.get("key3"), [4, 5])
cache["key4"] = [6, 7]
self.assertEqual(cache.get("key"), None)
self.assertEqual(cache.get("key2"), None)
self.assertEqual(cache.get("key3"), [4, 5])
self.assertEqual(cache.get("key4"), [6, 7])
def test_time_eviction(self) -> None:
reactor, clock = get_clock()
cache: ExpiringCache[str, int] = ExpiringCache(
cache_name="test",
server_name="testserver",
clock=clock,
expiry_ms=1000,
)
cache["key"] = 1
reactor.advance(0.5)
cache["key2"] = 2
self.assertEqual(cache.get("key"), 1)
self.assertEqual(cache.get("key2"), 2)
reactor.advance(0.9)
self.assertEqual(cache.get("key"), None)
self.assertEqual(cache.get("key2"), 2)
reactor.advance(1)
self.assertEqual(cache.get("key"), None)
self.assertEqual(cache.get("key2"), None)