-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Merged by Bors] - Add entity ID to expect() message #2943
Closed
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
Add the entity ID and generation to the expect() message of two world accessors, to make it easier to debug use-after-free issues. Coupled with e.g. bevy-inspector-egui which also displays the entity ID, this makes it much easier to identify what entity is being misused.
DJMcNab
suggested changes
Oct 9, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
Good idea, but please remove the unneeded allocations
DJMcNab
added
A-ECS
Entities, components, systems, and events
C-Feature
A new feature, making something new possible
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
and removed
S-Needs-Triage
This issue needs to be labelled
labels
Oct 9, 2021
alice-i-cecile
added
S-Needs-Review
A-ECS
Entities, components, systems, and events
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
and removed
C-Feature
A new feature, making something new possible
A-ECS
Entities, components, systems, and events
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
labels
Oct 9, 2021
LGTM once the allocation issue is fixed :) |
djeedai
commented
Oct 9, 2021
mockersf
approved these changes
Oct 9, 2021
alice-i-cecile
approved these changes
Oct 9, 2021
alice-i-cecile
added
the
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
label
Oct 9, 2021
DJMcNab
reviewed
Oct 10, 2021
alice-i-cecile
approved these changes
Oct 10, 2021
payload
approved these changes
Oct 10, 2021
DJMcNab
approved these changes
Oct 10, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Oct 10, 2021
Add the entity ID and generation to the expect() message of two world accessors, to make it easier to debug use-after-free issues. Coupled with e.g. bevy-inspector-egui which also displays the entity ID, this makes it much easier to identify what entity is being misused. # Objective Make it easier to identity an entity being accessed after being deleted. ## Solution Augment the error message of some `expect()` call with the entity ID and generation. Combined with some external tool like `bevy-inspector-egui`, which also displays the entity ID, this increases the chances to be able to identify the entity, and therefore find the error that led to a use-after-despawn.
bors
bot
changed the title
Add entity ID to expect() message
[Merged by Bors] - Add entity ID to expect() message
Oct 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-ECS
Entities, components, systems, and events
C-Usability
A targeted quality-of-life change that makes Bevy easier to use
S-Ready-For-Final-Review
This PR has been approved by the community. It's ready for a maintainer to consider merging it
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.
Add the entity ID and generation to the expect() message of two
world accessors, to make it easier to debug use-after-free issues.
Coupled with e.g. bevy-inspector-egui which also displays the entity ID,
this makes it much easier to identify what entity is being misused.
Objective
Make it easier to identity an entity being accessed after being deleted.
Solution
Augment the error message of some
expect()
call with the entity ID andgeneration. Combined with some external tool like
bevy-inspector-egui
, whichalso displays the entity ID, this increases the chances to be able to identify
the entity, and therefore find the error that led to a use-after-despawn.