|
| 1 | +//! A test to confirm that `bevy` doesn't regress its system ambiguities count when using [`DefaultPlugins`]. |
| 2 | +//! This is run in CI. |
| 3 | +
|
| 4 | +use bevy::{ |
| 5 | + ecs::schedule::{InternedScheduleLabel, LogLevel, ScheduleBuildSettings, ScheduleLabel}, |
| 6 | + prelude::*, |
| 7 | + utils::HashMap, |
| 8 | +}; |
| 9 | +use bevy_render::{pipelined_rendering::RenderExtractApp, Render, RenderApp}; |
| 10 | + |
| 11 | +/// FIXME: bevy should not have any ambiguities, but it takes time to clean these up, |
| 12 | +/// so we're just ignoring those for now. |
| 13 | +/// |
| 14 | +/// See [#7386](https://github.com/bevyengine/bevy/issues/7386) for relevant issue. |
| 15 | +pub fn get_ignored_ambiguous_system_schedules() -> Vec<Box<dyn ScheduleLabel>> { |
| 16 | + vec![ |
| 17 | + Box::new(First), |
| 18 | + Box::new(PreUpdate), |
| 19 | + Box::new(Update), |
| 20 | + Box::new(PostUpdate), |
| 21 | + Box::new(Last), |
| 22 | + Box::new(ExtractSchedule), |
| 23 | + Box::new(Render), |
| 24 | + ] |
| 25 | +} |
| 26 | + |
| 27 | +/// A test to confirm that `bevy` doesn't regress its system ambiguities count when using [`DefaultPlugins`]. |
| 28 | +/// This is run in CI. |
| 29 | +pub fn main() { |
| 30 | + let mut app = App::new(); |
| 31 | + app.add_plugins(DefaultPlugins); |
| 32 | + |
| 33 | + let sub_app = app.main_mut(); |
| 34 | + configure_ambiguity_detection(sub_app); |
| 35 | + let sub_app = app.sub_app_mut(RenderApp); |
| 36 | + configure_ambiguity_detection(sub_app); |
| 37 | + let sub_app = app.sub_app_mut(RenderExtractApp); |
| 38 | + configure_ambiguity_detection(sub_app); |
| 39 | + |
| 40 | + app.finish(); |
| 41 | + app.cleanup(); |
| 42 | + app.update(); |
| 43 | + |
| 44 | + let sub_app = app.main(); |
| 45 | + |
| 46 | + let ignored_schedules = get_ignored_ambiguous_system_schedules(); |
| 47 | + |
| 48 | + let ambiguities = count_ambiguities(sub_app); |
| 49 | + let mut unexpected_ambiguities = vec![]; |
| 50 | + for (&label, &count) in ambiguities.0.iter() { |
| 51 | + if ignored_schedules |
| 52 | + .iter() |
| 53 | + .any(|label_to_ignore| **label_to_ignore == *label) |
| 54 | + { |
| 55 | + continue; |
| 56 | + } |
| 57 | + if count != 0 { |
| 58 | + unexpected_ambiguities.push(label); |
| 59 | + } |
| 60 | + } |
| 61 | + assert_eq!( |
| 62 | + unexpected_ambiguities.len(), |
| 63 | + 0, |
| 64 | + "Main app has unexpected ambiguities among these schedules: {:?}.\n\ |
| 65 | + More Details:\n{:#?}", |
| 66 | + unexpected_ambiguities, |
| 67 | + ambiguities |
| 68 | + ); |
| 69 | + |
| 70 | + let total_ambiguities = ambiguities.total(); |
| 71 | + assert_eq!( |
| 72 | + total_ambiguities, 82, |
| 73 | + "Main app does not have an expected conflicting systems count, \ |
| 74 | + you might consider verifying if it's normal, or change the expected number.\n\ |
| 75 | + Details:\n{:#?}", |
| 76 | + ambiguities |
| 77 | + ); |
| 78 | + |
| 79 | + // RenderApp is not checked here, because it is not within the App at this point. |
| 80 | + let sub_app = app.sub_app(RenderExtractApp); |
| 81 | + |
| 82 | + let ambiguities = count_ambiguities(sub_app); |
| 83 | + let total_ambiguities = ambiguities.total(); |
| 84 | + assert_eq!( |
| 85 | + total_ambiguities, 0, |
| 86 | + "RenderExtractApp contains conflicting systems.", |
| 87 | + ); |
| 88 | +} |
| 89 | + |
| 90 | +/// Contains the number of conflicting systems per schedule. |
| 91 | +#[derive(Debug, Deref, DerefMut)] |
| 92 | +struct AmbiguitiesCount(pub HashMap<InternedScheduleLabel, usize>); |
| 93 | + |
| 94 | +impl AmbiguitiesCount { |
| 95 | + fn total(&self) -> usize { |
| 96 | + self.values().sum() |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +fn configure_ambiguity_detection(sub_app: &mut SubApp) { |
| 101 | + let ignored_ambiguous_systems = get_ignored_ambiguous_system_schedules(); |
| 102 | + let mut schedules = sub_app.world_mut().resource_mut::<Schedules>(); |
| 103 | + for (_, schedule) in schedules.iter_mut() { |
| 104 | + if ignored_ambiguous_systems |
| 105 | + .iter() |
| 106 | + .any(|label| **label == *schedule.label()) |
| 107 | + { |
| 108 | + // Note: you can remove this bypass to get full details about ambiguities. |
| 109 | + continue; |
| 110 | + } |
| 111 | + schedule.set_build_settings(ScheduleBuildSettings { |
| 112 | + ambiguity_detection: LogLevel::Warn, |
| 113 | + use_shortnames: false, |
| 114 | + ..default() |
| 115 | + }); |
| 116 | + } |
| 117 | +} |
| 118 | + |
| 119 | +/// Returns the number of conflicting systems per schedule. |
| 120 | +fn count_ambiguities(sub_app: &SubApp) -> AmbiguitiesCount { |
| 121 | + let schedules = sub_app.world().resource::<Schedules>(); |
| 122 | + let mut ambiguities = HashMap::new(); |
| 123 | + for (_, schedule) in schedules.iter() { |
| 124 | + let ambiguities_in_schedule = schedule.graph().conflicting_systems().len(); |
| 125 | + ambiguities.insert(schedule.label(), ambiguities_in_schedule); |
| 126 | + } |
| 127 | + AmbiguitiesCount(ambiguities) |
| 128 | +} |
0 commit comments