ADD error catching #109
ADD error catching #109
Conversation
| discard runCatchingTyped( | ||
| fun = testErrorProc, | ||
| fatal = false, | ||
| messagePrefix = "Intentional Error: " |
| @@ -33,9 +36,41 @@ proc getSecondsSinceEpoch* (this: ptr PlaydateSys): tuple[seconds: uint, millise | |||
| type PDCallbackFunction* = proc(): int {.raises: [].} | |||
| var updateCallback: PDCallbackFunction = nil | |||
|
|
|||
| proc runCatchingTyped*[T](fun: () -> T, fatal: bool = false, messagePrefix: string=""): T = | |||
There was a problem hiding this comment.
@Nycto
Is there some magic we can add to get rid of the separate typed and untyped variant using a template, macro, or auto typing?
There was a problem hiding this comment.
You should be able to implement a single version of this by using a template like this:
template runCatching*(fatal: bool = false, messagePrefix: string = "", body: typed): auto =
try:
body
except:
getCurrentException().logException(fatal, messagePrefix)
default(typeof(body))
| try: | ||
| message = &"{messagePrefix}: {getCurrentExceptionMsg()}\n{exception.getStackTrace()}" | ||
| # replace line number notation from (90) to :90, which is more common and can be picked up as source link | ||
| message = message.replace('(', ':') |
There was a problem hiding this comment.
Apply this replacement to the stacktrace only
There was a problem hiding this comment.
...Or perhaps remove it completely.
Vscode terminal can pick up line numbers in parentheses and IntelliJ can do it too when the "Awesome Console" plugin is installed
| if fatal: | ||
| playdate.system.error("FATAL:" & getCurrentExceptionMsg()) | ||
|
|
||
| proc runCatchingVoid*(fun: () -> void, fatal: bool = false, messagePrefix: string = "") = |
There was a problem hiding this comment.
"fun" might not be a very descriptive name for non-Kotlin devs
There was a problem hiding this comment.
body is the usual name used in Nim
|
@Nycto This one is a bit rough still, see my comments. I thought I'd first make a PR to see if you'd agree to this idea before polishing it. Note there is also a question for you in there regarding a possibility to have a single proc for both typed and untyped usage. |
| proc runCatchingTyped*[T](fun: () -> T, fatal: bool = false, messagePrefix: string=""): T = | ||
| try: | ||
| return fun() | ||
| except: |
There was a problem hiding this comment.
We should pull all of this exception logging code into its own proc, with a signature like this:
proc logException*(exception: ref Exception, fatal: bool = false, messagePrefix: string = "")
| let exception = getCurrentException() | ||
| var message: string = "" | ||
| try: | ||
| message = &"{messagePrefix}: {getCurrentExceptionMsg()}\n{exception.getStackTrace()}" |
There was a problem hiding this comment.
Use exception.msg instead of getCurrentExceptionMsg
| except: | ||
| let exception = getCurrentException() | ||
| var message: string = "" | ||
| try: |
There was a problem hiding this comment.
Why do we need this try/catch?
| if fatal: | ||
| playdate.system.error("FATAL:" & getCurrentExceptionMsg()) | ||
|
|
||
| proc runCatchingVoid*(fun: () -> void, fatal: bool = false, messagePrefix: string = "") = |
There was a problem hiding this comment.
body is the usual name used in Nim
| @@ -33,9 +36,41 @@ proc getSecondsSinceEpoch* (this: ptr PlaydateSys): tuple[seconds: uint, millise | |||
| type PDCallbackFunction* = proc(): int {.raises: [].} | |||
| var updateCallback: PDCallbackFunction = nil | |||
|
|
|||
| proc runCatchingTyped*[T](fun: () -> T, fatal: bool = false, messagePrefix: string=""): T = | |||
There was a problem hiding this comment.
You should be able to implement a single version of this by using a template like this:
template runCatching*(fatal: bool = false, messagePrefix: string = "", body: typed): auto =
try:
body
except:
getCurrentException().logException(fatal, messagePrefix)
default(typeof(body))
| try: | ||
| message = &"{messagePrefix}: {getCurrentExceptionMsg()}\n{exception.getStackTrace()}" | ||
| # replace line number notation from (90) to :90, which is more common and can be picked up as source link | ||
| message = message.replace('(', ':') |
What is it
A proc that will execute a provided lambda and catch any errors. The exception is printed to the console.
Optionally, the error is marked as fatal, causing the simulator to be paused and the error message to be printed in red.
This is manly intended to add default error catching to the main update loop, but it can also be used in game code if desired. Sample usage is added
Why
Challenges
handlercall in theinitSdkmacro too but that is executed very early in the boot sequence and I couldn't figure that outOut of scope
I plan a follow-up PR where the error is printed to the screen (device only, since simulator has the Console view). This provides a similar crash experience to the lua sdk and allows players to share a photo of the stacktrace with the dev, as is common practice for lua games.