Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix threadsafety in ThreadedMemoryReactorClock #8497

Merged
merged 5 commits into from
Oct 9, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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/8497.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a threadsafety bug in unit tests.
23 changes: 19 additions & 4 deletions tests/server.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import json
import logging
from collections import deque
from io import SEEK_END, BytesIO
from typing import Any, Callable, Deque, List

import attr
from zope.interface import implementer
Expand Down Expand Up @@ -251,6 +253,7 @@ def __init__(self):
self._tcp_callbacks = {}
self._udp = []
lookups = self.lookups = {}
self._thread_callbacks = deque() # type: Deque[Callable[[], None]]()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you using a deque simply for the performance benefits of popleft?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using it because I don't think a list is threadsafe.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing some research it looks to be threadsafe in CPython, however using a deque is likely a safer bet.


@implementer(IResolverSimple)
class FakeResolver:
Expand All @@ -272,10 +275,10 @@ def callFromThread(self, callback, *args, **kwargs):
"""
Make the callback fire in the next reactor iteration.
"""
d = Deferred()
d.addCallback(lambda x: callback(*args, **kwargs))
self.callLater(0, d.callback, True)
return d
cb = lambda: callback(*args, **kwargs)
# it's not safe to call callLater() here, so we append the callback to a
# separate queue.
self._thread_callbacks.append(cb)

def getThreadPool(self):
return self.threadpool
Expand Down Expand Up @@ -303,6 +306,18 @@ def connectTCP(self, host, port, factory, timeout=30, bindAddress=None):

return conn

def advance(self, amount):
# run any "callFromThread" callbacks before anything registered with
# "callLater"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by "before anything registered with "callLater"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, super().advance() runs callbacks that were registered with callLater. Perhaps I'll reword.

while True:
try:
callback = self._thread_callbacks.popleft()
except IndexError:
break
callback()

super().advance(amount)


class ThreadPool:
"""
Expand Down