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

Jump to bottom

AsyncEventQueue (AsyncEventBus replacement). #275

Merged
merged 23 commits into from
Jun 15, 2022
Merged

AsyncEventQueue (AsyncEventBus replacement). #275

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
d675f6c
AsyncEventQueue (AsyncEventBus replacement) initial commit.
cheatfate May 24, 2022
bda5d38
Add closeWait() and remove assertion test.
cheatfate May 24, 2022
978df76
Fix "possible" memory leak.
cheatfate Jun 2, 2022
4e6ec9e
Add limits to AsyncEventQueue[T].
cheatfate Jun 2, 2022
f594b3d
Adopt AsyncEventQueue to garbage collect events on emit() too.
cheatfate Jun 7, 2022
c834a0e
Remove AsyncEventBus test suite.
cheatfate Jun 8, 2022
5799173
Remove unneeded [T] usage.
cheatfate Jun 8, 2022
d50f1af
Optimize memory usage in 1m test.
cheatfate Jun 8, 2022
80c4d11
Lower number of events in test from 1m to 100k.
cheatfate Jun 8, 2022
da2106a
Deprecate AsyncEventBus.
cheatfate Jun 8, 2022
f17ab03
Fix mistype.
cheatfate Jun 8, 2022
f5a7c47
One more attempt to fix crash.
cheatfate Jun 9, 2022
c543bcc
Add some echo debugging.
cheatfate Jun 9, 2022
ace652d
More echo debugging.
cheatfate Jun 9, 2022
597a3b2
More closer debug echoes.
cheatfate Jun 9, 2022
fe85ba9
Attempt to workaround crash place.
cheatfate Jun 9, 2022
ddc41a9
More debugging echoes in exception handlers.
cheatfate Jun 9, 2022
abe488c
Convert suspected test into async procedure.
cheatfate Jun 9, 2022
4e38a77
Make multiple consumers test async.
cheatfate Jun 9, 2022
22d4c4d
Remove GC debugging.
cheatfate Jun 9, 2022
4e2e7ac
Disable added tests.
cheatfate Jun 9, 2022
70338e5
Disable AsyncEventQueue tests to confirm that this is an issue.
cheatfate Jun 10, 2022
88d8477
Enable all the tests.
cheatfate Jun 15, 2022
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
Prev Previous commit
Next Next commit
Add closeWait() and remove assertion test.
  • Loading branch information
@cheatfate
cheatfate committed Jun 15, 2022
commit bda5d38f5591bfbea9216fce79a2a11de8911b2a
9 changes: 9 additions & 0 deletions chronos/asyncsync.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -683,6 +683,15 @@ proc close*[T](ab: AsyncEventQueue[T]) =
ab.readers.setLen(0)
cheatfate marked this conversation as resolved.
Show resolved Hide resolved
ab.queue.clear()

proc closeWait*[T](ab: AsyncEventQueue[T]): Future[void] =
var retFuture = newFuture[void]("AsyncEventQueue.closeWait()")
proc continuation(udata: pointer) {.gcsafe.} =
if not(retFuture.finished()):
retFuture.complete()
Copy link
Member

Choose a reason for hiding this comment

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

shouldn't this be a cancel?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Why? to raise CancelledError from closeWait() procedure?
The idea here is to ensure that all event consumers will receive notification about that AsyncEventQueue is get closed, and because all this callbacks get schedule inside ab.close() call, it means that continuation procedure will be scheduled after all the consumer notification callbacks will be already processed.

ab.close()
callSoon(continuation)
retFuture

proc waitEvents*[T](ab: AsyncEventQueue[T],
key: EventQueueKey,
eventsCount = -1): Future[seq[T]] {.async.} =
Expand Down
40 changes: 9 additions & 31 deletions tests/testsync.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,34 +560,8 @@ suite "Asynchronous sync primitives test suite":
test2()
eventQueue.close()

test "AsyncEventQueue() concurrency assert test":
let eventQueue = newAsyncEventQueue[int]()
let key1 = eventQueue.register()
let key2 = eventQueue.register()

proc test() =
let dataFut = eventQueue.waitEvents(key1)
expect AssertionError:
let failFut {.used.} = eventQueue.waitEvents(key1)
eventQueue.emit(100)
expect AssertionError:
let failFut {.used.} = eventQueue.waitEvents(key1)
let goodFut = eventQueue.waitEvents(key2)
check:
dataFut.finished() == false
goodFut.finished() == true
goodFut.read() == @[100]
poll()
check:
dataFut.finished() == true
dataFut.read() == @[100]

test()
eventQueue.close()

test "AsyncEventQueue() concurrency test":
let eventQueue = newAsyncEventQueue[int]()

let key0 = eventQueue.register()
let key1 = eventQueue.register()
eventQueue.emit(100)
Expand Down Expand Up @@ -635,7 +609,8 @@ suite "Asynchronous sync primitives test suite":
dataFut0.finished() == true
dataFut0.read() == @[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000,
2000]
eventQueue.close()

waitFor eventQueue.closeWait()

test "AsyncEventQueue() specific number test":
let eventQueue = newAsyncEventQueue[int]()
Expand All @@ -651,10 +626,12 @@ suite "Asynchronous sync primitives test suite":
check:
dataFut1.finished() == true
dataFut1.read() == @[100]

let dataFut2 = eventQueue.waitEvents(key, 2)
check:
dataFut2.finished() == true
dataFut2.read() == @[200, 300]

let dataFut3 = eventQueue.waitEvents(key, 5)
check dataFut3.finished() == false
eventQueue.emit(500)
Expand All @@ -666,6 +643,7 @@ suite "Asynchronous sync primitives test suite":
check:
dataFut3.finished() == true
dataFut3.read() == @[400, 500, 600, 700, 800]

let dataFut4 = eventQueue.waitEvents(key, -1)
check dataFut4.finished() == false
eventQueue.emit(900)
Expand All @@ -682,7 +660,7 @@ suite "Asynchronous sync primitives test suite":
dataFut4.finished() == true
dataFut4.read() == @[900, 1000, 1100, 1200, 1300, 1400, 1500, 1600]

eventQueue.close()
waitFor eventQueue.closeWait()

test "AsyncEventQueue() register()/unregister() test":
var emptySeq: seq[int]
Expand Down Expand Up @@ -729,7 +707,7 @@ suite "Asynchronous sync primitives test suite":
dataFut3.finished() == true
dataFut3.read() == @[100, 200, 300]

eventQueue.close()
waitFor eventQueue.closeWait()

test "AsyncEventQueue() garbage collection test":
let eventQueue = newAsyncEventQueue[int]()
Expand Down Expand Up @@ -771,7 +749,7 @@ suite "Asynchronous sync primitives test suite":
dataFut2.read() == @[400, 500, 600, 700, 800, 900, 1000, 1100, 1200]
len(eventQueue) == 0

eventQueue.close()
waitFor eventQueue.closeWait()

test "AsyncEventQueue() 1,000,000 of events to 10 clients test":
let eventQueue = newAsyncEventQueue[int]()
Expand Down Expand Up @@ -808,7 +786,7 @@ suite "Asynchronous sync primitives test suite":
await sleepAsync(0.milliseconds)
eventQueue.emit(i)

eventQueue.close()
await eventQueue.closeWait()
await allFutures(futs)
for fut in futs:
check:
Expand Down