mirror of
https://github.com/status-im/nim-chronos.git
synced 2025-01-20 16:29:12 +00:00
4abd7a5645
* exception tracking This PR adds minimal exception tracking to chronos, moving the goalpost one step further. In particular, it becomes invalid to raise exceptions from `callSoon` callbacks: this is critical for writing correct error handling because there's no reasonable way that a user of chronos can possibly _reason_ about exceptions coming out of there: the event loop will be in an indeterminite state when the loop is executing an _random_ callback. As expected, there are several issues in the error handling of chronos: in particular, it will end up in an inconsistent internal state whenever the selector loop operations fail, because the internal state update functions are not written in an exception-safe way. This PR turns this into a Defect, which probably is not the optimal way of handling things - expect more work to be done here. Some API have no way of reporting back errors to callers - for example, when something fails in the accept loop, there's not much it can do, and no way to report it back to the user of the API - this has been fixed with the new accept flow - the old one should be deprecated. Finally, there is information loss in the API: in composite operations like `poll` and `waitFor` there's no way to differentiate internal errors from user-level errors originating from callbacks. * store `CatchableError` in future * annotate proc's with correct raises information * `selectors2` to avoid non-CatchableError IOSelectorsException * `$` should never raise * remove unnecessary gcsafe annotations * fix exceptions leaking out of timer waits * fix some imports * functions must signal raising the union of all exceptions across all platforms to enable cross-platform code * switch to unittest2 * add `selectors2` which supercedes the std library version and fixes several exception handling issues in there * fixes * docs, platform-independent eh specifiers for some functions * add feature flag for strict exception mode also bump version to 3.0.0 - _most_ existing code should be compatible with this version of exception handling but some things might need fixing - callbacks, existing raises specifications etc. * fix AsyncCheck for non-void T
115 lines
3.2 KiB
Nim
115 lines
3.2 KiB
Nim
# Chronos Test Suite
|
|
# (c) Copyright 2018-Present
|
|
# Status Research & Development GmbH
|
|
#
|
|
# Licensed under either of
|
|
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
|
# MIT license (LICENSE-MIT)
|
|
import unittest2
|
|
import ../chronos
|
|
|
|
when defined(nimHasUsed): {.used.}
|
|
|
|
suite "Asynchronous issues test suite":
|
|
const HELLO_PORT = 45679
|
|
const TEST_MSG = "testmsg"
|
|
const MSG_LEN = TEST_MSG.len()
|
|
const TestsCount = 500
|
|
|
|
type
|
|
CustomData = ref object
|
|
test: string
|
|
|
|
proc udp4DataAvailable(transp: DatagramTransport,
|
|
remote: TransportAddress): Future[void] {.async, gcsafe.} =
|
|
var udata = getUserData[CustomData](transp)
|
|
var expect = TEST_MSG
|
|
var data: seq[byte]
|
|
var datalen: int
|
|
transp.peekMessage(data, datalen)
|
|
if udata.test == "CHECK" and datalen == MSG_LEN and
|
|
equalMem(addr data[0], addr expect[0], datalen):
|
|
udata.test = "OK"
|
|
transp.close()
|
|
|
|
proc issue6(): Future[bool] {.async.} =
|
|
var myself = initTAddress("127.0.0.1:" & $HELLO_PORT)
|
|
var data = CustomData()
|
|
data.test = "CHECK"
|
|
var dsock4 = newDatagramTransport(udp4DataAvailable, udata = data,
|
|
local = myself)
|
|
await dsock4.sendTo(myself, TEST_MSG, MSG_LEN)
|
|
await dsock4.join()
|
|
if data.test == "OK":
|
|
result = true
|
|
|
|
proc testWait(): Future[bool] {.async.} =
|
|
for i in 0 ..< TestsCount:
|
|
try:
|
|
await wait(sleepAsync(4.milliseconds), 4.milliseconds)
|
|
except AsyncTimeoutError:
|
|
discard
|
|
result = true
|
|
|
|
proc testWithTimeout(): Future[bool] {.async.} =
|
|
for i in 0 ..< TestsCount:
|
|
discard await withTimeout(sleepAsync(4.milliseconds), 4.milliseconds)
|
|
result = true
|
|
|
|
proc testMultipleAwait(): Future[bool] {.async.} =
|
|
var promise = newFuture[void]()
|
|
var checkstr = ""
|
|
|
|
proc believers(name: string) {.async.} =
|
|
await promise
|
|
checkstr = checkstr & name
|
|
|
|
asyncCheck believers("Foo")
|
|
asyncCheck believers("Bar")
|
|
asyncCheck believers("Baz")
|
|
|
|
await sleepAsync(100.milliseconds)
|
|
promise.complete()
|
|
await sleepAsync(100.milliseconds)
|
|
result = (checkstr == "FooBarBaz")
|
|
|
|
proc testDefer(): Future[bool] {.async.} =
|
|
proc someConnect() {.async.} =
|
|
await sleepAsync(100.milliseconds)
|
|
|
|
proc someClose() {.async.} =
|
|
await sleepAsync(100.milliseconds)
|
|
|
|
proc testFooFails(): Future[bool] {.async.} =
|
|
await someConnect()
|
|
defer:
|
|
await someClose()
|
|
result = true
|
|
|
|
proc testFooSucceed(): Future[bool] {.async.} =
|
|
try:
|
|
await someConnect()
|
|
finally:
|
|
await someClose()
|
|
result = true
|
|
|
|
let r1 = await testFooFails()
|
|
let r2 = await testFooSucceed()
|
|
|
|
result = r1 and r2
|
|
|
|
test "Issue #6":
|
|
check waitFor(issue6()) == true
|
|
|
|
test "Callback-race double completion [wait()] test":
|
|
check waitFor(testWait()) == true
|
|
|
|
test "Callback-race double completion [withTimeout()] test":
|
|
check waitFor(testWithTimeout()) == true
|
|
|
|
test "Multiple await on single future test [Nim's issue #13889]":
|
|
check waitFor(testMultipleAwait()) == true
|
|
|
|
test "Defer for asynchronous procedures test [Nim's issue #13899]":
|
|
check waitFor(testDefer()) == true
|