Better error reporting for embedded_path macro #11340
Closed
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
A number of cases will panic, which is fine. The issue is there are two or three different errors that all report an unwrap on a None value, so they're hard to differentiate for the user.
This refactor does not change `embedded_path!`'s behavior. All cases
that caused a panic before, will still cause a panic. But this change
will provide the user diagnostic information that will hopefully help
them right whatever issue is causing the panic.
The original behavior was this:
```
#[test]
#[should_panic(expected = "called `Option::unwrap()` on a `None` value")]
fn test_embedded_path_original_behavior() {
embedded_path!("NOT-IN-PATH", "b"),
}
```
The changed behavior is this:
```
#[test]
#[should_panic(
expected = "Expected source path `NOT-IN-PATH` in file path `crates/bevy_asset/src/io/embedded/mod.rs`"
)]
fn test_embedded_path_original_behavior() {
embedded_path!("NOT-IN-PATH", "b")
}
```
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
matiqo15
added
A-Assets
|
As I was fixing the tests to work on Windows, I noticed the "/src/" hardcoding for embedded paths isn't going to work as is. That appears to be fixed by #10383, so perhaps this PR shouldn't be considered until that PR is closed. |
matiqo15
added
the
S-Blocked
| let crate_name = module_path!() | ||
| .split(':') | ||
| .next() | ||
| .expect("Could not find crate name"); |
There was a problem hiding this comment.
Can we report the original string here for better diagnosability?
There was a problem hiding this comment.
Certainly. Is this the kind of error message you're looking for?
panic!("Could not find crate name. Expected ':' in module path `{}`", module_path!());
alice-i-cecile
approved these changes
Jan 14, 2024
NthTensor
approved these changes
Jan 14, 2024
alice-i-cecile
added
S-Ready-For-Final-Review
|
In reviewing #10383, I'd suggest closing this PR and going with that one. It does what I wanted to do here and more. |
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.
Objective
Better error reporting for embedded_path macro.
A number of cases will cause a panic, which is fine. The issue is there are two or three different possible panics that all report an unwrap on a None value, so they're hard to differentiate for the user, and they were difficult for me to diagnose as a user.
Solution
This refactor does not change
embedded_path!'s functional behavior. All cases that caused a panic before, will still cause a panic. However, this change will provide the user diagnostic information that will hopefully help them right whatever issue is causing the panic.The original behavior that caught me up was this:
The changed behavior is this:
Changelog