Moving error formatting from wgpu-rs to wgpu-core #1082
Labels
area: validation
Issues related to validation, diagnostics, and error handling
help required
We need community help to make this happen.
type: enhancement
New feature or request
Comments
kvark
added
area: validation
bors bot
added a commit
that referenced
this issue
Aug 3, 2021
1728: Move error formatting functionality r=kvark a=scoopr **Connections** This is an attempt to implement #1082 **Description** This is a fairly straightforward move of the error formatting that were in wgpu-rs in to wgpu-code. The enriching of some of the errors with the additional `ContextError` were still left with the wgpu-rs code, as I realised the current error messages refer to the API names as they appear in rust code and might not make sense for all the consumers of wgpu-core. It could be left as is and other consumers might enrich in their own ways, or the messages could be reformatted to be more conversational **Testing** Limited testing with the examples Co-authored-by: Mikko Lehtonen <[email protected]>
|
Done in #1728 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As discussed in #1068 it may be that some of the error formatting that is now in wgpu-rs should in fact be moved to wgpu-core.
As I don't have time to do help with it right now, I wanted to write down the steps I was thinking about it so that I don't forget. Also maybe it helps if anyone else is willing to help with this one.
The
format_errorin wgpu-rserror.rsis the one that should end up either in directly toGlobal, or as a separate helper that takesGlobalas argument (It is basically doing that throughContextnow). Trivial in itself, but it depend onfmt_pretty_anyfmt_pretty_anyis what is doing the downcasting of errors, and mostly could just be moved to wgpu-core as-is, but it also downcasts theContextErrorthat is more specific to wgpu-rs.The
ContextErroris used to decorate the api calls in wgpu-rs for which api call the error came from. This was initially done because it had convenient access to the descriptor label, even when nothing was created on errors, as the errorIds were created on wgpu-rs error side, but since this was changed in #1034, it does not need to be in wgpu-rs side anymore.So working backwards,
• Move/add
ContextErrorto wgpu-core• Decorate the api call sites in wgpu-core
• Remove the
ContextErrordecoration in wgpu-rshandle_error• Now all of error.rs could be moved in wgpu-core (and slight tweak to
handle_errorto call theformat_errorin its new place)Alternatively, if just having some working
format_erroris deemed more important and waffing about theContextErroris boring busywork to be done later,• Move
PrettyErrortrait and its impls (except for the ContextError)• Add some hook (callback?) to
format_error/fmt_pretty_anythat allows wgpu-rs to inject its error to be downcasted• Move
format_errorto core. That should leave only theContextErrorrelated stuff in error.rsThat was quite a lot of text, what is ultimately fairly simple set of changes.
The text was updated successfully, but these errors were encountered: