mirror of https://github.com/watcha-fr/synapse
Add a caching layer to .well-known responses (#4516)
Richard van der Hoff
6 years ago
committed by
GitHub
parent
3f189c902e
commit
bc5f6e1797
@ -0,0 +1 @@ |
||||
Implement MSC1708 (.well-known routing for server-server federation) |
||||
@ -0,0 +1,161 @@ |
||||
# -*- coding: utf-8 -*- |
||||
# Copyright 2015, 2016 OpenMarket Ltd |
||||
# |
||||
# 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. |
||||
|
||||
import logging |
||||
import time |
||||
|
||||
import attr |
||||
from sortedcontainers import SortedList |
||||
|
||||
from synapse.util.caches import register_cache |
||||
|
||||
logger = logging.getLogger(__name__) |
||||
|
||||
SENTINEL = object() |
||||
|
||||
|
||||
class TTLCache(object): |
||||
"""A key/value cache implementation where each entry has its own TTL""" |
||||
|
||||
def __init__(self, cache_name, timer=time.time): |
||||
# map from key to _CacheEntry |
||||
self._data = {} |
||||
|
||||
# the _CacheEntries, sorted by expiry time |
||||
self._expiry_list = SortedList() |
||||
|
||||
self._timer = timer |
||||
|
||||
self._metrics = register_cache("ttl", cache_name, self) |
||||
|
||||
def set(self, key, value, ttl): |
||||
"""Add/update an entry in the cache |
||||
|
||||
Args: |
||||
key: key for this entry |
||||
value: value for this entry |
||||
ttl (float): TTL for this entry, in seconds |
||||
""" |
||||
expiry = self._timer() + ttl |
||||
|
||||
self.expire() |
||||
e = self._data.pop(key, SENTINEL) |
||||
if e != SENTINEL: |
||||
self._expiry_list.remove(e) |
||||
|
||||
entry = _CacheEntry(expiry_time=expiry, key=key, value=value) |
||||
self._data[key] = entry |
||||
self._expiry_list.add(entry) |
||||
|
||||
def get(self, key, default=SENTINEL): |
||||
"""Get a value from the cache |
||||
|
||||
Args: |
||||
key: key to look up |
||||
default: default value to return, if key is not found. If not set, and the |
||||
key is not found, a KeyError will be raised |
||||
|
||||
Returns: |
||||
value from the cache, or the default |
||||
""" |
||||
self.expire() |
||||
e = self._data.get(key, SENTINEL) |
||||
if e == SENTINEL: |
||||
self._metrics.inc_misses() |
||||
if default == SENTINEL: |
||||
raise KeyError(key) |
||||
return default |
||||
self._metrics.inc_hits() |
||||
return e.value |
||||
|
||||
def get_with_expiry(self, key): |
||||
"""Get a value, and its expiry time, from the cache |
||||
|
||||
Args: |
||||
key: key to look up |
||||
|
||||
Returns: |
||||
Tuple[Any, float]: the value from the cache, and the expiry time |
||||
|
||||
Raises: |
||||
KeyError if the entry is not found |
||||
""" |
||||
self.expire() |
||||
try: |
||||
e = self._data[key] |
||||
except KeyError: |
||||
self._metrics.inc_misses() |
||||
raise |
||||
self._metrics.inc_hits() |
||||
return e.value, e.expiry_time |
||||
|
||||
def pop(self, key, default=SENTINEL): |
||||
"""Remove a value from the cache |
||||
|
||||
If key is in the cache, remove it and return its value, else return default. |
||||
If default is not given and key is not in the cache, a KeyError is raised. |
||||
|
||||
Args: |
||||
key: key to look up |
||||
default: default value to return, if key is not found. If not set, and the |
||||
key is not found, a KeyError will be raised |
||||
|
||||
Returns: |
||||
value from the cache, or the default |
||||
""" |
||||
self.expire() |
||||
e = self._data.pop(key, SENTINEL) |
||||
if e == SENTINEL: |
||||
self._metrics.inc_misses() |
||||
if default == SENTINEL: |
||||
raise KeyError(key) |
||||
return default |
||||
self._expiry_list.remove(e) |
||||
self._metrics.inc_hits() |
||||
return e.value |
||||
|
||||
def __getitem__(self, key): |
||||
return self.get(key) |
||||
|
||||
def __delitem__(self, key): |
||||
self.pop(key) |
||||
|
||||
def __contains__(self, key): |
||||
return key in self._data |
||||
|
||||
def __len__(self): |
||||
self.expire() |
||||
return len(self._data) |
||||
|
||||
def expire(self): |
||||
"""Run the expiry on the cache. Any entries whose expiry times are due will |
||||
be removed |
||||
""" |
||||
now = self._timer() |
||||
while self._expiry_list: |
||||
first_entry = self._expiry_list[0] |
||||
if first_entry.expiry_time - now > 0.0: |
||||
break |
||||
del self._data[first_entry.key] |
||||
del self._expiry_list[0] |
||||
|
||||
|
||||
@attr.s(frozen=True, slots=True) |
||||
class _CacheEntry(object): |
||||
"""TTLCache entry""" |
||||
# expiry_time is the first attribute, so that entries are sorted by expiry. |
||||
expiry_time = attr.ib() |
||||
key = attr.ib() |
||||
value = attr.ib() |
||||
@ -0,0 +1,83 @@ |
||||
# -*- coding: utf-8 -*- |
||||
# Copyright 2019 New Vector Ltd |
||||
# |
||||
# 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. |
||||
|
||||
from mock import Mock |
||||
|
||||
from synapse.util.caches.ttlcache import TTLCache |
||||
|
||||
from tests import unittest |
||||
|
||||
|
||||
class CacheTestCase(unittest.TestCase): |
||||
def setUp(self): |
||||
self.mock_timer = Mock(side_effect=lambda: 100.0) |
||||
self.cache = TTLCache("test_cache", self.mock_timer) |
||||
|
||||
def test_get(self): |
||||
"""simple set/get tests""" |
||||
self.cache.set('one', '1', 10) |
||||
self.cache.set('two', '2', 20) |
||||
self.cache.set('three', '3', 30) |
||||
|
||||
self.assertEqual(len(self.cache), 3) |
||||
|
||||
self.assertTrue('one' in self.cache) |
||||
self.assertEqual(self.cache.get('one'), '1') |
||||
self.assertEqual(self.cache['one'], '1') |
||||
self.assertEqual(self.cache.get_with_expiry('one'), ('1', 110)) |
||||
self.assertEqual(self.cache._metrics.hits, 3) |
||||
self.assertEqual(self.cache._metrics.misses, 0) |
||||
|
||||
self.cache.set('two', '2.5', 20) |
||||
self.assertEqual(self.cache['two'], '2.5') |
||||
self.assertEqual(self.cache._metrics.hits, 4) |
||||
|
||||
# non-existent-item tests |
||||
self.assertEqual(self.cache.get('four', '4'), '4') |
||||
self.assertIs(self.cache.get('four', None), None) |
||||
|
||||
with self.assertRaises(KeyError): |
||||
self.cache['four'] |
||||
|
||||
with self.assertRaises(KeyError): |
||||
self.cache.get('four') |
||||
|
||||
with self.assertRaises(KeyError): |
||||
self.cache.get_with_expiry('four') |
||||
|
||||
self.assertEqual(self.cache._metrics.hits, 4) |
||||
self.assertEqual(self.cache._metrics.misses, 5) |
||||
|
||||
def test_expiry(self): |
||||
self.cache.set('one', '1', 10) |
||||
self.cache.set('two', '2', 20) |
||||
self.cache.set('three', '3', 30) |
||||
|
||||
self.assertEqual(len(self.cache), 3) |
||||
self.assertEqual(self.cache['one'], '1') |
||||
self.assertEqual(self.cache['two'], '2') |
||||
|
||||
# enough for the first entry to expire, but not the rest |
||||
self.mock_timer.side_effect = lambda: 110.0 |
||||
|
||||
self.assertEqual(len(self.cache), 2) |
||||
self.assertFalse('one' in self.cache) |
||||
self.assertEqual(self.cache['two'], '2') |
||||
self.assertEqual(self.cache['three'], '3') |
||||
|
||||
self.assertEqual(self.cache.get_with_expiry('two'), ('2', 120)) |
||||
|
||||
self.assertEqual(self.cache._metrics.hits, 5) |
||||
self.assertEqual(self.cache._metrics.misses, 0) |
||||
Loading…
Reference in new issue