mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-15 11:23:52 +01:00
Merge pull request #346 from matrix-org/markjh/remove_lock_manager
Remove the LockManager class because it wasn't being used
This commit is contained in:
Mark Haines
commit
23cfd32e64
4 changed files with 0 additions and 189 deletions
|
|
@ -72,8 +72,6 @@ class FederationHandler(BaseHandler):
|
||||||
self.server_name = hs.hostname
|
self.server_name = hs.hostname
|
||||||
self.keyring = hs.get_keyring()
|
self.keyring = hs.get_keyring()
|
||||||
|
|
||||||
self.lock_manager = hs.get_room_lock_manager()
|
|
||||||
|
|
||||||
self.replication_layer.set_handler(self)
|
self.replication_layer.set_handler(self)
|
||||||
|
|
||||||
# When joining a room we need to queue any events for that room up
|
# When joining a room we need to queue any events for that room up
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,6 @@ from synapse.state import StateHandler
|
||||||
from synapse.storage import DataStore
|
from synapse.storage import DataStore
|
||||||
from synapse.util import Clock
|
from synapse.util import Clock
|
||||||
from synapse.util.distributor import Distributor
|
from synapse.util.distributor import Distributor
|
||||||
from synapse.util.lockutils import LockManager
|
|
||||||
from synapse.streams.events import EventSources
|
from synapse.streams.events import EventSources
|
||||||
from synapse.api.ratelimiting import Ratelimiter
|
from synapse.api.ratelimiting import Ratelimiter
|
||||||
from synapse.crypto.keyring import Keyring
|
from synapse.crypto.keyring import Keyring
|
||||||
|
|
@ -70,7 +69,6 @@ class BaseHomeServer(object):
|
||||||
'auth',
|
'auth',
|
||||||
'rest_servlet_factory',
|
'rest_servlet_factory',
|
||||||
'state_handler',
|
'state_handler',
|
||||||
'room_lock_manager',
|
|
||||||
'notifier',
|
'notifier',
|
||||||
'distributor',
|
'distributor',
|
||||||
'resource_for_client',
|
'resource_for_client',
|
||||||
|
|
@ -201,9 +199,6 @@ class HomeServer(BaseHomeServer):
|
||||||
def build_state_handler(self):
|
def build_state_handler(self):
|
||||||
return StateHandler(self)
|
return StateHandler(self)
|
||||||
|
|
||||||
def build_room_lock_manager(self):
|
|
||||||
return LockManager()
|
|
||||||
|
|
||||||
def build_distributor(self):
|
def build_distributor(self):
|
||||||
return Distributor()
|
return Distributor()
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,74 +0,0 @@
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
# Copyright 2014, 2015 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.
|
|
||||||
|
|
||||||
|
|
||||||
from twisted.internet import defer
|
|
||||||
|
|
||||||
import logging
|
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class Lock(object):
|
|
||||||
|
|
||||||
def __init__(self, deferred, key):
|
|
||||||
self._deferred = deferred
|
|
||||||
self.released = False
|
|
||||||
self.key = key
|
|
||||||
|
|
||||||
def release(self):
|
|
||||||
self.released = True
|
|
||||||
self._deferred.callback(None)
|
|
||||||
|
|
||||||
def __del__(self):
|
|
||||||
if not self.released:
|
|
||||||
logger.critical("Lock was destructed but never released!")
|
|
||||||
self.release()
|
|
||||||
|
|
||||||
def __enter__(self):
|
|
||||||
return self
|
|
||||||
|
|
||||||
def __exit__(self, type, value, traceback):
|
|
||||||
logger.debug("Releasing lock for key=%r", self.key)
|
|
||||||
self.release()
|
|
||||||
|
|
||||||
|
|
||||||
class LockManager(object):
|
|
||||||
""" Utility class that allows us to lock based on a `key` """
|
|
||||||
|
|
||||||
def __init__(self):
|
|
||||||
self._lock_deferreds = {}
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def lock(self, key):
|
|
||||||
""" Allows us to block until it is our turn.
|
|
||||||
Args:
|
|
||||||
key (str)
|
|
||||||
Returns:
|
|
||||||
Lock
|
|
||||||
"""
|
|
||||||
new_deferred = defer.Deferred()
|
|
||||||
old_deferred = self._lock_deferreds.get(key)
|
|
||||||
self._lock_deferreds[key] = new_deferred
|
|
||||||
|
|
||||||
if old_deferred:
|
|
||||||
logger.debug("Queueing on lock for key=%r", key)
|
|
||||||
yield old_deferred
|
|
||||||
logger.debug("Obtained lock for key=%r", key)
|
|
||||||
else:
|
|
||||||
logger.debug("Entering uncontended lock for key=%r", key)
|
|
||||||
|
|
||||||
defer.returnValue(Lock(new_deferred, key))
|
|
||||||
|
|
@ -1,108 +0,0 @@
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
# Copyright 2014 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.
|
|
||||||
|
|
||||||
|
|
||||||
from twisted.internet import defer
|
|
||||||
from tests import unittest
|
|
||||||
|
|
||||||
from synapse.util.lockutils import LockManager
|
|
||||||
|
|
||||||
|
|
||||||
class LockManagerTestCase(unittest.TestCase):
|
|
||||||
|
|
||||||
def setUp(self):
|
|
||||||
self.lock_manager = LockManager()
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def test_one_lock(self):
|
|
||||||
key = "test"
|
|
||||||
deferred_lock1 = self.lock_manager.lock(key)
|
|
||||||
|
|
||||||
self.assertTrue(deferred_lock1.called)
|
|
||||||
|
|
||||||
lock1 = yield deferred_lock1
|
|
||||||
|
|
||||||
self.assertFalse(lock1.released)
|
|
||||||
|
|
||||||
lock1.release()
|
|
||||||
|
|
||||||
self.assertTrue(lock1.released)
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def test_concurrent_locks(self):
|
|
||||||
key = "test"
|
|
||||||
deferred_lock1 = self.lock_manager.lock(key)
|
|
||||||
deferred_lock2 = self.lock_manager.lock(key)
|
|
||||||
|
|
||||||
self.assertTrue(deferred_lock1.called)
|
|
||||||
self.assertFalse(deferred_lock2.called)
|
|
||||||
|
|
||||||
lock1 = yield deferred_lock1
|
|
||||||
|
|
||||||
self.assertFalse(lock1.released)
|
|
||||||
self.assertFalse(deferred_lock2.called)
|
|
||||||
|
|
||||||
lock1.release()
|
|
||||||
|
|
||||||
self.assertTrue(lock1.released)
|
|
||||||
self.assertTrue(deferred_lock2.called)
|
|
||||||
|
|
||||||
lock2 = yield deferred_lock2
|
|
||||||
|
|
||||||
lock2.release()
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def test_sequential_locks(self):
|
|
||||||
key = "test"
|
|
||||||
deferred_lock1 = self.lock_manager.lock(key)
|
|
||||||
|
|
||||||
self.assertTrue(deferred_lock1.called)
|
|
||||||
|
|
||||||
lock1 = yield deferred_lock1
|
|
||||||
|
|
||||||
self.assertFalse(lock1.released)
|
|
||||||
|
|
||||||
lock1.release()
|
|
||||||
|
|
||||||
self.assertTrue(lock1.released)
|
|
||||||
|
|
||||||
deferred_lock2 = self.lock_manager.lock(key)
|
|
||||||
|
|
||||||
self.assertTrue(deferred_lock2.called)
|
|
||||||
|
|
||||||
lock2 = yield deferred_lock2
|
|
||||||
|
|
||||||
self.assertFalse(lock2.released)
|
|
||||||
|
|
||||||
lock2.release()
|
|
||||||
|
|
||||||
self.assertTrue(lock2.released)
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def test_with_statement(self):
|
|
||||||
key = "test"
|
|
||||||
with (yield self.lock_manager.lock(key)) as lock:
|
|
||||||
self.assertFalse(lock.released)
|
|
||||||
|
|
||||||
self.assertTrue(lock.released)
|
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
|
||||||
def test_two_with_statement(self):
|
|
||||||
key = "test"
|
|
||||||
with (yield self.lock_manager.lock(key)):
|
|
||||||
pass
|
|
||||||
|
|
||||||
with (yield self.lock_manager.lock(key)):
|
|
||||||
pass
|
|
||||||
Loading…
Reference in a new issue