diff options
| author | Erik Johnston <erik@matrix.org> | 2021-07-20 14:24:25 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-20 14:24:25 +0100 |
| commit | 54389d5697622f1beffaeda96d9c6da7ef7d93a9 (patch) | |
| tree | 8e557666edbca114d09fbd002a1d8510644792d3 | |
| parent | Combine some changelog lines in the documentation section (diff) | |
| download | synapse-54389d5697622f1beffaeda96d9c6da7ef7d93a9.tar.xz | |
Fix dropping locks on shut down (#10433)
| -rw-r--r-- | changelog.d/10433.bugfix | 1 | ||||
| -rw-r--r-- | synapse/storage/databases/main/lock.py | 6 | ||||
| -rw-r--r-- | tests/storage/databases/main/test_lock.py | 13 |
3 files changed, 19 insertions, 1 deletions
diff --git a/changelog.d/10433.bugfix b/changelog.d/10433.bugfix new file mode 100644 index 0000000000..ad85a83f96 --- /dev/null +++ b/changelog.d/10433.bugfix @@ -0,0 +1 @@ +Fix error while dropping locks on shutdown. Introduced in v1.38.0. diff --git a/synapse/storage/databases/main/lock.py b/synapse/storage/databases/main/lock.py index 774861074c..3d1dff660b 100644 --- a/synapse/storage/databases/main/lock.py +++ b/synapse/storage/databases/main/lock.py @@ -78,7 +78,11 @@ class LockStore(SQLBaseStore): """Called when the server is shutting down""" logger.info("Dropping held locks due to shutdown") - for (lock_name, lock_key), token in self._live_tokens.items(): + # We need to take a copy of the tokens dict as dropping the locks will + # cause the dictionary to change. + tokens = dict(self._live_tokens) + + for (lock_name, lock_key), token in tokens.items(): await self._drop_lock(lock_name, lock_key, token) logger.info("Dropped locks due to shutdown") diff --git a/tests/storage/databases/main/test_lock.py b/tests/storage/databases/main/test_lock.py index 9ca70e7367..d326a1d6a6 100644 --- a/tests/storage/databases/main/test_lock.py +++ b/tests/storage/databases/main/test_lock.py @@ -98,3 +98,16 @@ class LockTestCase(unittest.HomeserverTestCase): lock2 = self.get_success(self.store.try_acquire_lock("name", "key")) self.assertIsNotNone(lock2) + + def test_shutdown(self): + """Test that shutting down Synapse releases the locks""" + # Acquire two locks + lock = self.get_success(self.store.try_acquire_lock("name", "key1")) + self.assertIsNotNone(lock) + lock2 = self.get_success(self.store.try_acquire_lock("name", "key2")) + self.assertIsNotNone(lock2) + + # Now call the shutdown code + self.get_success(self.store._on_shutdown()) + + self.assertEqual(self.store._live_tokens, {}) |