Improve error reporting in the asset library and in related types #87628
Conversation
This also makes errors related to asset image loading verbose-only, because, frankly, users can't do much about those errors. Spamming them with error messages about some assets on the frontend being broken is pointless.
| if (is_print_verbose_enabled()) { | ||
| WARN_PRINT(vformat("Asset Library: Error getting image from '%s' for asset # %d.", image_queue[p_queue_id].image_url, image_queue[p_queue_id].asset_id)); | ||
| } |
There was a problem hiding this comment.
Makes me think we want to add a dedicated macro for this, a WARN_PRINT_VERBOSE or something
There was a problem hiding this comment.
So far this is very situational, and normally we want all errors and warnings to be always printed. But yes, I was thinking about this as well.
Edit: Also I was thinking about defining a local method instead, which would print a generic message once, if verbose mode is disabled. Not sure if there is a need for this though.
There was a problem hiding this comment.
We have a WARN_PRINT_ONCE so a macro for WARN_PRINT_VERBOSE could be adapted to that too, but good to discuss in the future
There was a problem hiding this comment.
👍
The reason why I mentioned a dedicated local method is because I want WARN_PRINT_ONCE to be called once for all warnings from all other methods. Since WARN_PRINT_ONCE works based on a scope, I need to create a funnel for all messages.
|
Thanks! |
Right now opening asset library, both in the project manager and in the editor, may result in a barrage of error messages. All of them are related to various problems with assets listed on the frontend. But that's not really relevant to end users. And for people who may find some relevance in these messages, they remain obscure and and confusing; require debugging the engine to actually understand.
So this PR tries to improve related error messages, adds early checks to avoid invalid calls to internal APIs, and hides some of the messages behind the
--verboseflag.This is what the output can look like:
The latter for example currently manifests as
Some of the touched up error messages are outside of the scope for the asset library specifically, but the improvements should still be welcome. Namely, we seem to have this beauty across the codebase: "It's not a reference to a valid ... object." And despite the claim of the commit message that added it, it's not actually an obvious error, especially if repeated 8 times verbatim.
PS. Changes to
EditorAssetLibrary::_image_updateinclude whitespace and nesting removal. They aren't as scary as they look, use the whitespace off mode when reviewing 🙃