feature: Add logging to wolfram-app-discovery success and error paths + related cleanups #48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Rename ErrorKind::UnexpectedLayout to UnexpectedAppLayout * Add new ErrorKind::UnexpectedEnvironmentValueLayout
This makes wolfram-app-discovery easier to debug, particular in CI/CD
environments where it can otherwise we somewhat tedious to get
useful debugging output.
There is a loose naming convention for the added logging statements:
1. "discovery error: ..." -- emitted by every Error::*() constructor function
2. "discovery failed: ..." -- emitted on error return paths from top-level discovery functions
3. "discovered in (app|env): ..." -- emitted on success return paths from top-level discovery functions
(1) is commonly but not always a fatal error. For example, when using discover_all(),
an error discovering one app does not cause the overall discovery of installed apps
to fail.
(2) is typically a fatal error -- a top-level discovery function was forced to
return an error because the highest-precedence discovery mechanism found an
app or resource that produced an error during validation, or all discovery
mechanisms were exhausted resulting in no discovery.
Note that logging output will NOT be generated unless a `log` crate logger
has been initialized by other code in the binary wolfram-app-discovery is
compiled into.
E.g. for build scripts using wolfram-app-discovery, a prerequisite for logging
output would be a call to e.g. `env_logger::init()` at the beginning of the
build script.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.