List components for QueryEntityError::QueryDoesNotMatch#15435
Merged
alice-i-cecile merged 4 commits intobevyengine:mainfrom Sep 26, 2024
Merged
List components for QueryEntityError::QueryDoesNotMatch#15435alice-i-cecile merged 4 commits intobevyengine:mainfrom
alice-i-cecile merged 4 commits intobevyengine:mainfrom
Conversation
atornity
approved these changes
Sep 26, 2024
Contributor
atornity
left a comment
There was a problem hiding this comment.
LGTM, seems super useful
BenjaminBrienen
approved these changes
Sep 26, 2024
Contributor
BenjaminBrienen
left a comment
There was a problem hiding this comment.
My questions have been answered. Great idea, thanks!
Member
|
Thank you to everyone involved with the authoring or reviewing of this PR! This work is relatively important and needs release notes! Head over to bevyengine/bevy-website#1697 if you'd like to help out. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Make it easier to debug why an entity doesn't match a query.
Solution
List the entities components in
QueryEntityError::QueryDoesNotMatch's message, e.g.The query does not match the entity 0v1, which has components foo::Bar, foo::Baz.This covers most cases as expected components are typically known and filtering for change detection is rare when assessing a query by entity id.
Testing
Added a test confirming the new message matches the entity's components.
Migration Guide
QueryEntityErrornow has a lifetime. Convert it to a custom error if you need to store it.