Improvements to execution order ambiguity reporting#4299

Closed

alice-i-cecile wants to merge 113 commits intobevyengine:mainfrom alice-i-cecile:improvements-to-ambiguity-reporting

+1,175-727

Commits on Apr 21, 2022

Number the reported ambiguities, to make them easier to discuss in a team

afonsolage
authored and
alice-i-cecile
committed
Fixed formatting

afonsolage
authored and
alice-i-cecile
committed
Explain which components/resources the systems are conflicting on.

afonsolage
authored and
alice-i-cecile
committed
Fixed wrong output_prefix

afonsolage
authored and
alice-i-cecile
committed
Report ambiguities where all pairwise combinations of systems conflict on the same data as a group.

afonsolage
authored and
alice-i-cecile
committed
Create a simple ambiguous method that causes a system to be ignored completely in the ambiguity checker.

afonsolage
authored and
alice-i-cecile
committed
Create a simple ambiguous_with system_label method to create two-element ambiguity sets without being forced to invent an ambiguity set label.

afonsolage
authored and
alice-i-cecile
committed
Provide an 'X unresolved ambiguities detected' message that runs by default

afonsolage
authored and
alice-i-cecile
committed
Fixed format issue

afonsolage
authored and
alice-i-cecile
committed
Fixed ecs_guide example

afonsolage
authored and
alice-i-cecile
committed
Provide an way to ignore/filter crates when using ambiguity checker.

afonsolage
authored and
alice-i-cecile
committed
By default, ambiguity checker should ignore internal bevy crates.

afonsolage
authored and
alice-i-cecile
committed
Added better message when warning about unresolved ambiguities

afonsolage
authored and
alice-i-cecile
committed
Updated ReportExecutionOrderAmbiguities docs

afonsolage
authored and
alice-i-cecile
committed
Added ambiguity_checker example

afonsolage
authored and
alice-i-cecile
committed
Fixed typo on ReportExecutionOrderAmbiguities docs

afonsolage
authored and
alice-i-cecile
committed
Added example on README.md

afonsolage
authored and
alice-i-cecile
committed
Ignoring ReportExecutionOrderAmbiguities doc test since there is no bevy_app dependancy on bevy_ecs crate

afonsolage
authored and
alice-i-cecile
committed
Changed ambiguity_checker to use custom component instead of primitive components, since they will be removed in the future.

afonsolage
authored and
alice-i-cecile
committed
Moved ecs_guide to be the first example on ECS section

afonsolage
authored and
alice-i-cecile
committed
Added better example description on README.md

afonsolage
authored and
alice-i-cecile
committed
Apply suggestions from code review

authored and
alice-i-cecile
committed
Added doc hidden method include_bevy witch includes bevy internal crates

afonsolage
authored and
alice-i-cecile
committed
Added missing docs on ReportExecutionOrderAmbiguities.ignore

afonsolage
authored and
alice-i-cecile
committed
Renamed ambigous method to silence_ambiguity_checks

afonsolage
authored and
alice-i-cecile
committed
Supress the hint message if the ReportExecutionOrderAmbiguities is already verbose

afonsolage
authored and
alice-i-cecile
committed
Typo suggestion fix

authored and
alice-i-cecile
committed
Fixed formating

afonsolage
authored and
alice-i-cecile
committed
Explicitly added bevy internal crates names, in order to avoid conflusion with third party crates with bevy_ prefix names

afonsolage
authored and
alice-i-cecile
committed
Ambiguity checker ignores conflicts only between crates inside the crate ignored list

afonsolage
authored and
alice-i-cecile
committed
Fixed ambiguity tests error due to new ambiguity check behavior

afonsolage
authored and
alice-i-cecile
committed
Apply suggestions from code review

afonsolage
and
alice-i-cecile
committed
Fixed formatting

afonsolage
authored and
alice-i-cecile
committed
Removed bevy_egui from BEVY_CRATES

afonsolage
authored and
alice-i-cecile
committed
Fixed BEVY_CRATES array size

afonsolage
authored and
alice-i-cecile
committed
Added instructions to add new crates to BEVY_CRATES array

afonsolage
authored and
alice-i-cecile
committed
Fixed typo on ReportExecutionOrderAmbiguities ignore function

afonsolage
authored and
alice-i-cecile
committed
Removed BEVY_CRATES const array

afonsolage
authored and
alice-i-cecile
committed
Added ignore crate on plugins of bevy_audio, bevy_render, bevy_sprites, bevy_text, bevy_ui, bevy_transform, bevy_winit

afonsolage
authored and
alice-i-cecile
committed
Updated ambiguity_checker example

afonsolage
authored and
alice-i-cecile
committed
Updated ReportExecutionOrderAmbiguities docs

afonsolage
authored and
alice-i-cecile
committed
Removed the information of BEVY_CRATES from CONTRIBUTING.md, since it doesn't exists anymore

afonsolage
authored and
alice-i-cecile
committed
Fix up rebase
alice-i-cecile
committed
Add default for AmbiguityDetection enum
alice-i-cecile
committed
Simplify and clarify execution order reporting
alice-i-cecile
committed
CI nits
alice-i-cecile
committed
MyAnotherResource -> MyOtherResource
alice-i-cecile
committed
Improve wording of warning

alice-i-cecile
and
maniwani
committed
Split ambiguity detection logic off into its own file
alice-i-cecile
committed
Rename silence_ambiguity_checks to ignore_all_ambiguities
alice-i-cecile
committed
Yeet ambiguity sets
alice-i-cecile
committed
Note value of defaults
alice-i-cecile
committed
Docs for AmbiguityReportLevel
alice-i-cecile
committed
Fix rebase
alice-i-cecile
committed
Allow the use of implicit system labels with ambiguous_with
alice-i-cecile
committed
Export ReportExecutionOrderAmbiguities in prelude
alice-i-cecile
committed
Simplify architecture
alice-i-cecile
committed
No need to add the resource in CorePlugin
alice-i-cecile
committed
No need for LogPlugin
alice-i-cecile
committed
More reporting levels
alice-i-cecile
committed
Refactor to expose method to get ambiguities on SystemStage
alice-i-cecile
committed
Refactored (usize, usize, Vec<ComponentId>) into SystemOrderAmbiguity
alice-i-cecile
committed
Explicitly pass in a reporting level
alice-i-cecile
committed
Basic tests for ambiguity reporting levels
alice-i-cecile
committed
Initialize schedules for tests
alice-i-cecile
committed
Expose n_ambiguities method on SystemStage
alice-i-cecile
committed
Expose SystemStage::initialize
alice-i-cecile
committed
More tests
alice-i-cecile
committed
Fix logic for ignoring ambiguities
alice-i-cecile
committed
Remove error-prone Ord and PartialOrd traits
alice-i-cecile
committed
Remove report_internal test
alice-i-cecile
committed
Split error message by singular and plural for grammar purposes
alice-i-cecile
committed
Add internal_ambiguities dev example
alice-i-cecile
committed
Add bevy_hierarchy to the internal blacklist
alice-i-cecile
committed
Use stage.initialize in tests
alice-i-cecile
committed
Yeet giant test
alice-i-cecile
committed
Comprehensive test suite
alice-i-cecile
committed
Hide rough edges from the public API
alice-i-cecile
committed
Naming consistency
alice-i-cecile
committed
Refactor to make SystemOrderAmbiguity safe for public consumption
alice-i-cecile
committed
Tests for exclusive systems
alice-i-cecile
committed
Make ambiguity reporting prettier
alice-i-cecile
committed
Make warning for exclusive system conflicts clearer
alice-i-cecile
committed
Make levels of ReportExecutionOrderAmbiguities consistent with clippy
alice-i-cecile
committed
Rename ReportExecutionOrderAmbiguities to ExecutionOrderAmbiguities
alice-i-cecile
committed
Thanks clippy
alice-i-cecile
committed
Fix broken tests
alice-i-cecile
committed
Fix type name formatting when a local type is used as second type param
alice-i-cecile
committed
Fix doc links
alice-i-cecile
committed
Simplify string parsing
alice-i-cecile
committed
Fix overlooked refactoring errors
alice-i-cecile
committed
Use tracing macros, rather than println!()
alice-i-cecile
committed
Fix with/without query slicing test
alice-i-cecile
committed
Ignore known failing test
alice-i-cecile
committed
Remove spurious println()

alice-i-cecile
and
hymm
committed
Cleaner handling of plural case.

alice-i-cecile
and
hymm
committed
Formatting

alice-i-cecile
and
hymm
committed
Fix internal_ambiguities example warning level

alice-i-cecile
and
hymm
committed
Minor fixes
alice-i-cecile
committed
Improve docs
alice-i-cecile
committed
Move type name shortening to bevy_utils
alice-i-cecile
committed
Reuse get_short_name function
alice-i-cecile
committed
Handle more edge cases in get_short_name
alice-i-cecile
committed
Re-enable commented out test
alice-i-cecile
committed
Use ignore syntax
alice-i-cecile
committed
Move derives below docs

alice-i-cecile
and
MinerSebas
committed
Remove TODO

alice-i-cecile
and
maniwani
committed
Wording suggestions

alice-i-cecile
and
maniwani
committed
More wording suggestions

alice-i-cecile
and
maniwani
committed
Deterministic, not lockstep

alice-i-cecile
and
maniwani
committed
Fix outdated error message

alice-i-cecile
and
rparrett
committed

Commits on Apr 22, 2022

Fix rebase
alice-i-cecile
committed
Ignore newly introduced internal ambiguities T_T
alice-i-cecile
committed