Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix WheelTimer implementation that can expired timeout early #17850

Merged
merged 9 commits into from
Nov 5, 2024
Merged

Fix WheelTimer implementation that can expired timeout early #17850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dd1d0f6
Fix WheelTimer implementation can raise events early
udovichenkoAlexander Oct 18, 2024
f7770d3
add changelog
udovichenkoAlexander Oct 18, 2024
511f88e
Update changelog.d/17850.bugfix
udovichenkoAlexander Nov 1, 2024
2796a5a
Refactor wheel timer tests from object to strings
udovichenkoAlexander Nov 1, 2024
e7c670d
lint fixes
udovichenkoAlexander Nov 2, 2024
4ee2711
Merge branch 'develop' into wheel_fix
udovichenkoAlexander Nov 2, 2024
9bad32b
Merge branch 'develop' into wheel_fix
MadLittleMods Nov 4, 2024
f9e4ff5
Merge branch 'element-hq:develop' into wheel_fix
udovichenkoAlexander Nov 5, 2024
9b90ddb
lint fixes
udovichenkoAlexander Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/17850.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix bug when some presence and typing timeouts can expire early.
udovichenkoAlexander marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 2 additions & 4 deletions synapse/util/wheel_timer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ def __init__(self, bucket_size: int = 5000) -> None:
"""
self.bucket_size: int = bucket_size
self.entries: List[_Entry[T]] = []
self.current_tick: int = 0

def insert(self, now: int, obj: T, then: int) -> None:
"""Inserts object into timer.
Expand Down Expand Up @@ -78,11 +77,10 @@ def insert(self, now: int, obj: T, then: int) -> None:
self.entries[max(min_key, then_key) - min_key].elements.add(obj)
return

next_key = now_key + 1
if self.entries:
last_key = self.entries[-1].end_key
last_key = self.entries[-1].end_key + 1
else:
last_key = next_key
last_key = now_key + 1

# Handle the case when `then` is in the past and `entries` is empty.
then_key = max(last_key, then_key)
Expand Down
50 changes: 26 additions & 24 deletions tests/util/test_wheel_timer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,53 +28,55 @@ class WheelTimerTestCase(unittest.TestCase):
def test_single_insert_fetch(self) -> None:
wheel: WheelTimer[object] = WheelTimer(bucket_size=5)

obj = object()
wheel.insert(100, obj, 150)
wheel.insert(100, "1", 150)

self.assertListEqual(wheel.fetch(101), [])
self.assertListEqual(wheel.fetch(110), [])
self.assertListEqual(wheel.fetch(120), [])
self.assertListEqual(wheel.fetch(130), [])
self.assertListEqual(wheel.fetch(149), [])
self.assertListEqual(wheel.fetch(156), [obj])
self.assertListEqual(wheel.fetch(156), ["1"])
self.assertListEqual(wheel.fetch(170), [])

def test_multi_insert(self) -> None:
wheel: WheelTimer[object] = WheelTimer(bucket_size=5)

obj1 = object()
obj2 = object()
obj3 = object()
wheel.insert(100, obj1, 150)
wheel.insert(105, obj2, 130)
wheel.insert(106, obj3, 160)
wheel.insert(100, "1", 150)
wheel.insert(105, "2", 130)
wheel.insert(106, "3", 160)

self.assertListEqual(wheel.fetch(110), [])
self.assertListEqual(wheel.fetch(135), [obj2])
self.assertListEqual(wheel.fetch(135), ["2"])
self.assertListEqual(wheel.fetch(149), [])
self.assertListEqual(wheel.fetch(158), [obj1])
self.assertListEqual(wheel.fetch(158), ["1"])
self.assertListEqual(wheel.fetch(160), [])
self.assertListEqual(wheel.fetch(200), [obj3])
self.assertListEqual(wheel.fetch(200), ["3"])
self.assertListEqual(wheel.fetch(210), [])

def test_insert_past(self) -> None:
wheel: WheelTimer[object] = WheelTimer(bucket_size=5)

obj = object()
wheel.insert(100, obj, 50)
self.assertListEqual(wheel.fetch(120), [obj])
wheel.insert(100, "1", 50)
self.assertListEqual(wheel.fetch(120), ["1"])

def test_insert_past_multi(self) -> None:
wheel: WheelTimer[object] = WheelTimer(bucket_size=5)

obj1 = object()
obj2 = object()
obj3 = object()
wheel.insert(100, obj1, 150)
wheel.insert(100, obj2, 140)
wheel.insert(100, obj3, 50)
self.assertListEqual(wheel.fetch(110), [obj3])
wheel.insert(100, "1", 150)
wheel.insert(100, "2", 140)
wheel.insert(100, "3", 50)
self.assertListEqual(wheel.fetch(110), ["3"])
self.assertListEqual(wheel.fetch(120), [])
self.assertListEqual(wheel.fetch(147), [obj2])
self.assertListEqual(wheel.fetch(200), [obj1])
self.assertListEqual(wheel.fetch(147), ["2"])
self.assertListEqual(wheel.fetch(200), ["1"])
self.assertListEqual(wheel.fetch(240), [])

def test_multi_insert_then_past(self) -> None:
wheel: WheelTimer[object] = WheelTimer(bucket_size=5)

wheel.insert(100, "1", 150)
wheel.insert(100, "2", 160)
wheel.insert(100, "3", 155)

self.assertListEqual(wheel.fetch(110), [])
self.assertListEqual(wheel.fetch(158), ["1"])
Loading