2019-07-06 08:16:31 +00:00
|
|
|
# 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)
|
exception tracking (#166)
* 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
2021-03-24 09:08:33 +00:00
|
|
|
import unittest2
|
2022-03-30 13:13:58 +00:00
|
|
|
import macros
|
2019-07-06 08:16:31 +00:00
|
|
|
import ../chronos
|
|
|
|
|
2019-10-24 13:01:57 +00:00
|
|
|
when defined(nimHasUsed): {.used.}
|
|
|
|
|
2019-07-06 08:16:31 +00:00
|
|
|
proc asyncRetValue(n: int): Future[int] {.async.} =
|
|
|
|
await sleepAsync(n.milliseconds)
|
|
|
|
result = n * 10
|
|
|
|
|
|
|
|
proc asyncRetVoid(n: int) {.async.} =
|
|
|
|
await sleepAsync(n.milliseconds)
|
|
|
|
|
|
|
|
proc asyncRetExceptionValue(n: int): Future[int] {.async.} =
|
|
|
|
await sleepAsync(n.milliseconds)
|
|
|
|
result = n * 10
|
|
|
|
if true:
|
|
|
|
raise newException(ValueError, "Test exception")
|
|
|
|
|
|
|
|
proc asyncRetExceptionVoid(n: int) {.async.} =
|
|
|
|
await sleepAsync(n.milliseconds)
|
|
|
|
if true:
|
|
|
|
raise newException(ValueError, "Test exception")
|
|
|
|
|
|
|
|
proc testAwait(): Future[bool] {.async.} =
|
|
|
|
var res: int
|
|
|
|
await asyncRetVoid(100)
|
|
|
|
res = await asyncRetValue(100)
|
|
|
|
if res != 1000:
|
|
|
|
return false
|
|
|
|
if (await asyncRetValue(100)) != 1000:
|
|
|
|
return false
|
|
|
|
try:
|
|
|
|
await asyncRetExceptionVoid(100)
|
|
|
|
return false
|
|
|
|
except ValueError:
|
|
|
|
discard
|
|
|
|
res = 0
|
|
|
|
try:
|
2019-10-29 21:19:41 +00:00
|
|
|
discard await asyncRetExceptionValue(100)
|
2019-07-06 08:16:31 +00:00
|
|
|
return false
|
|
|
|
except ValueError:
|
|
|
|
discard
|
|
|
|
if res != 0:
|
|
|
|
return false
|
|
|
|
return true
|
|
|
|
|
|
|
|
proc testAwaitne(): Future[bool] {.async.} =
|
|
|
|
var res1: Future[void]
|
|
|
|
var res2: Future[int]
|
|
|
|
|
|
|
|
res1 = awaitne asyncRetVoid(100)
|
|
|
|
res2 = awaitne asyncRetValue(100)
|
|
|
|
if res1.failed():
|
|
|
|
return false
|
|
|
|
if res2.read() != 1000:
|
|
|
|
return false
|
|
|
|
|
|
|
|
res1 = awaitne asyncRetExceptionVoid(100)
|
|
|
|
if not(res1.failed()):
|
|
|
|
return false
|
|
|
|
|
|
|
|
res2 = awaitne asyncRetExceptionValue(100)
|
|
|
|
try:
|
2019-10-29 21:19:41 +00:00
|
|
|
discard res2.read()
|
2019-07-06 08:16:31 +00:00
|
|
|
return false
|
|
|
|
except ValueError:
|
|
|
|
discard
|
|
|
|
|
|
|
|
return true
|
|
|
|
|
|
|
|
suite "Macro transformations test suite":
|
|
|
|
test "`await` command test":
|
|
|
|
check waitFor(testAwait()) == true
|
|
|
|
test "`awaitne` command test":
|
|
|
|
check waitFor(testAwaitne()) == true
|
2022-03-30 13:13:58 +00:00
|
|
|
|
|
|
|
|
|
|
|
test "template async macro transformation":
|
|
|
|
template templatedAsync(name, restype: untyped): untyped =
|
|
|
|
proc name(): Future[restype] {.async.} = return @[4]
|
|
|
|
|
|
|
|
templatedAsync(testTemplate, seq[int])
|
|
|
|
check waitFor(testTemplate()) == @[4]
|
|
|
|
|
|
|
|
macro macroAsync(name, restype, innerrestype: untyped): untyped =
|
|
|
|
quote do:
|
|
|
|
proc `name`(): Future[`restype`[`innerrestype`]] {.async.} = return
|
|
|
|
|
|
|
|
type OpenObject = object
|
|
|
|
macroAsync(testMacro, seq, OpenObject)
|
|
|
|
check waitFor(testMacro()).len == 0
|
2022-05-05 09:05:04 +00:00
|
|
|
|
|
|
|
macro macroAsync2(name, restype, inner1, inner2, inner3, inner4: untyped): untyped =
|
|
|
|
quote do:
|
|
|
|
proc `name`(): Future[`restype`[`inner1`[`inner2`[`inner3`, `inner4`]]]] {.async.} = return
|
|
|
|
|
|
|
|
macroAsync2(testMacro2, seq, Opt, Result, OpenObject, cstring)
|
|
|
|
check waitFor(testMacro2()).len == 0
|
2022-07-18 21:30:27 +00:00
|
|
|
|
|
|
|
suite "async transformation issues":
|
|
|
|
test "Nested defer/finally not called on return":
|
|
|
|
# issue #288
|
|
|
|
# fixed by https://github.com/nim-lang/Nim/pull/19933
|
|
|
|
var answer = 0
|
|
|
|
proc a {.async.} =
|
|
|
|
try:
|
|
|
|
try:
|
|
|
|
await sleepAsync(0)
|
|
|
|
return
|
|
|
|
finally:
|
|
|
|
answer = 32
|
|
|
|
finally:
|
|
|
|
answer.inc(10)
|
|
|
|
waitFor(a())
|
|
|
|
check answer == 42
|