Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Better Debug support for Bevy ECS #1130

Closed
alice-i-cecile opened this issue Dec 22, 2020 · 5 comments
Closed

Better Debug support for Bevy ECS #1130

alice-i-cecile opened this issue Dec 22, 2020 · 5 comments
Labels
A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change C-Feature A new feature, making something new possible C-Usability A targeted quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

Debugging and troubleshooting ECS problems in

Describe the solution would you like?

Derive Debug for query filters, World, App, AppBuilder etc.

Describe the alternative(s) you've considered?

Write custom wrappers every time to extract and then display the information that I care about each time that I'm debugging these parts of the core logic.

Additional context

Creating a sensible debug output for some of the larger objects (like App and World) seems challenging; a pattern for doing so in a more / less verbose fashion would be welcome.
@memoryruins memoryruins added A-ECS Entities, components, systems, and events C-Feature A new feature, making something new possible labels Dec 22, 2020
@alice-i-cecile alice-i-cecile added C-Usability A targeted quality-of-life change that makes Bevy easier to use C-Code-Quality A section of code that is hard to understand or change labels Feb 17, 2021
@alice-i-cecile alice-i-cecile mentioned this issue Feb 18, 2021
Closed
@alice-i-cecile
Copy link
Member Author

This is improved by #1525, with a Debug impl for World.

@alice-i-cecile alice-i-cecile mentioned this issue Apr 12, 2021
Closed
@alice-i-cecile alice-i-cecile mentioned this issue Apr 29, 2021
Closed
@alice-i-cecile alice-i-cecile added the D-Trivial Nice and easy! A great choice to get started with Bevy label Aug 26, 2021
@alice-i-cecile alice-i-cecile mentioned this issue Oct 22, 2021
Open
@alice-i-cecile alice-i-cecile mentioned this issue Feb 9, 2022
Open
@targrub
Copy link
Contributor

targrub commented Oct 8, 2022

@alice-i-cecile What remains to be coded to complete this issue for now?

@alice-i-cecile
Copy link
Member Author

I would like debug impls for:

  • World
  • App
  • Query
  • QueryState

Once that's done I think we can close this out in favor of more specific issues.

@targrub
Copy link
Contributor

targrub commented Oct 8, 2022

I'll take a look to see if I can do any of those.

@alice-i-cecile
Copy link
Member Author

WRT App, don't worry about doing anything fancy for the Schedule. We can and should wait until after the stageless rewrite settles.

@targrub targrub mentioned this issue Oct 9, 2022
Closed
bors bot pushed a commit that referenced this issue Oct 10, 2022
@targrub
Adding Debug implementations for App, Stage, Schedule, Query, QuerySt…
89b417c 
…ate, etc. (#6214)

# Objective

- Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
- Fixes #1130.

## Solution

- Implemented std::fmt::Debug for a number of structures.

---

## Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation.  Best guess was taken for this initial version for these structures.


Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>
@bors bors bot closed this as completed in 9a597b7 Oct 10, 2022
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 19, 2022
@targrub @james7132
Adding Debug implementations for App, Stage, Schedule, Query, QuerySt…
f4f4eca 
…ate, etc. (bevyengine#6214)

# Objective

- Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
- Fixes bevyengine#1130.

## Solution

- Implemented std::fmt::Debug for a number of structures.

---

## Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation.  Best guess was taken for this initial version for these structures.


Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 28, 2022
@targrub @james7132
Adding Debug implementations for App, Stage, Schedule, Query, QuerySt…
cc609f3 
…ate, etc. (bevyengine#6214)

# Objective

- Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
- Fixes bevyengine#1130.

## Solution

- Implemented std::fmt::Debug for a number of structures.

---

## Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation.  Best guess was taken for this initial version for these structures.


Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this issue Dec 17, 2022
@targrub @Pietrek14
Adding Debug implementations for App, Stage, Schedule, Query, QuerySt…
5604d2d 
…ate, etc. (bevyengine#6214)

# Objective

- Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
- Fixes bevyengine#1130.

## Solution

- Implemented std::fmt::Debug for a number of structures.

---

## Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation.  Best guess was taken for this initial version for these structures.


Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this issue Feb 1, 2023
@targrub @ItsDoot
Adding Debug implementations for App, Stage, Schedule, Query, QuerySt…
f3f2cfb 
…ate, etc. (bevyengine#6214)

# Objective

- Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
- Fixes bevyengine#1130.

## Solution

- Implemented std::fmt::Debug for a number of structures.

---

## Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation.  Best guess was taken for this initial version for these structures.


Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change C-Feature A new feature, making something new possible C-Usability A targeted quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
3 participants
@alice-i-cecile @memoryruins @targrub