pull Schedules::ignored_scheduling_ambiguities into a separate resource

Author: ItsDoot

crates/bevy_ecs/src/schedule/ambiguity.rs

@@ -0,0 +1,48 @@
+use core::{
+    fmt::Write as _,
+    ops::{Deref, DerefMut},
+};
+
+use alloc::{
+    collections::BTreeSet,
+    string::{String, ToString},
+};
+
+use crate::{
+    component::{ComponentId, Components},
+    resource::Resource,
+};
+
+/// List of [`ComponentId`]s to ignore when reporting system order ambiguity conflicts.
+#[derive(Resource, Default)]
+pub struct IgnoredAmbiguities(pub BTreeSet<ComponentId>);
+
+impl IgnoredAmbiguities {
+    /// Returns a string listing all ignored ambiguity component names.
+    ///
+    /// May panic or retrieve incorrect names if [`Components`] is not from the
+    /// same world.
+    pub fn to_string(&self, components: &Components) -> String {
+        let mut message =
+            "System order ambiguities caused by conflicts on the following types are ignored:\n"
+                .to_string();
+        for id in self.iter() {
+            writeln!(message, "{}", components.get_name(*id).unwrap()).unwrap();
+        }
+        message
+    }
+}
+
+impl Deref for IgnoredAmbiguities {
+    type Target = BTreeSet<ComponentId>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for IgnoredAmbiguities {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}

crates/bevy_ecs/src/schedule/mod.rs

@@ -1,5 +1,6 @@
 //! Contains APIs for ordering systems and executing them on a [`World`](crate::world::World)
 
+mod ambiguity;
 mod auto_insert_apply_deferred;
 mod condition;
 mod config;
@@ -12,7 +13,9 @@ mod set;
 mod stepping;
 
 pub use self::graph::GraphInfo;
-pub use self::{condition::*, config::*, error::*, executor::*, node::*, schedule::*, set::*};
+pub use self::{
+    ambiguity::*, condition::*, config::*, error::*, executor::*, node::*, schedule::*, set::*,
+};
 pub use pass::ScheduleBuildPass;
 
 /// An implementation of a graph data structure.
@@ -801,9 +804,6 @@ mod tests {
     }
 
     mod system_ambiguity {
-        #[cfg(feature = "trace")]
-        use alloc::collections::BTreeSet;
-
         use super::*;
         use crate::prelude::*;
 
@@ -1145,9 +1145,7 @@ mod tests {
             ));
 
             schedule.graph_mut().initialize(&mut world);
-            let _ = schedule
-                .graph_mut()
-                .build_schedule(&mut world, &BTreeSet::new());
+            let _ = schedule.graph_mut().build_schedule(&mut world);
 
             let ambiguities: Vec<_> = schedule
                 .graph()
@@ -1204,9 +1202,7 @@ mod tests {
 
             let mut world = World::new();
             schedule.graph_mut().initialize(&mut world);
-            let _ = schedule
-                .graph_mut()
-                .build_schedule(&mut world, &BTreeSet::new());
+            let _ = schedule.graph_mut().build_schedule(&mut world);
 
             let ambiguities: Vec<_> = schedule
                 .graph()

crates/bevy_ecs/src/schedule/schedule.rs

@@ -14,24 +14,17 @@ use bevy_platform::collections::{HashMap, HashSet};
 use bevy_utils::{default, TypeIdMap};
 use core::{
     any::{Any, TypeId},
-    fmt::{Debug, Write},
+    fmt::Debug,
 };
 use fixedbitset::FixedBitSet;
-use log::{info, warn};
+use log::warn;
 use pass::ScheduleBuildPassObj;
 use thiserror::Error;
 #[cfg(feature = "trace")]
 use tracing::info_span;
 
 use crate::{change_detection::CheckChangeTicks, system::System};
-use crate::{
-    component::{ComponentId, Components},
-    prelude::Component,
-    resource::Resource,
-    schedule::*,
-    system::ScheduleSystem,
-    world::World,
-};
+use crate::{resource::Resource, schedule::*, system::ScheduleSystem, world::World};
 
 pub use stepping::Stepping;
 use Direction::{Incoming, Outgoing};
@@ -40,8 +33,6 @@ use Direction::{Incoming, Outgoing};
 #[derive(Default, Resource)]
 pub struct Schedules {
     inner: HashMap<InternedScheduleLabel, Schedule>,
-    /// List of [`ComponentId`]s to ignore when reporting system order ambiguity conflicts
-    pub ignored_scheduling_ambiguities: BTreeSet<ComponentId>,
 }
 
 impl Schedules {
@@ -135,38 +126,6 @@ impl Schedules {
         }
     }
 
-    /// Ignore system order ambiguities caused by conflicts on [`Component`]s of type `T`.
-    pub fn allow_ambiguous_component<T: Component>(&mut self, world: &mut World) {
-        self.ignored_scheduling_ambiguities
-            .insert(world.register_component::<T>());
-    }
-
-    /// Ignore system order ambiguities caused by conflicts on [`Resource`]s of type `T`.
-    pub fn allow_ambiguous_resource<T: Resource>(&mut self, world: &mut World) {
-        self.ignored_scheduling_ambiguities
-            .insert(world.components_registrator().register_resource::<T>());
-    }
-
-    /// Iterate through the [`ComponentId`]'s that will be ignored.
-    pub fn iter_ignored_ambiguities(&self) -> impl Iterator<Item = &ComponentId> + '_ {
-        self.ignored_scheduling_ambiguities.iter()
-    }
-
-    /// Prints the names of the components and resources with [`info`]
-    ///
-    /// May panic or retrieve incorrect names if [`Components`] is not from the same
-    /// world
-    pub fn print_ignored_ambiguities(&self, components: &Components) {
-        let mut message =
-            "System order ambiguities caused by conflicts on the following types are ignored:\n"
-                .to_string();
-        for id in self.iter_ignored_ambiguities() {
-            writeln!(message, "{}", components.get_name(*id).unwrap()).unwrap();
-        }
-
-        info!("{message}");
-    }
-
     /// Adds one or more systems to the [`Schedule`] matching the provided [`ScheduleLabel`].
     pub fn add_systems<M>(
         &mut self,
@@ -562,16 +521,9 @@ impl Schedule {
     pub fn initialize(&mut self, world: &mut World) -> Result<(), ScheduleBuildError> {
         if self.graph.changed {
             self.graph.initialize(world);
-            let ignored_ambiguities = world
-                .get_resource_or_init::<Schedules>()
-                .ignored_scheduling_ambiguities
-                .clone();
-            self.warnings = self.graph.update_schedule(
-                world,
-                &mut self.executable,
-                &ignored_ambiguities,
-                self.label,
-            )?;
+            self.warnings = self
+                .graph
+                .update_schedule(world, &mut self.executable, self.label)?;
             self.graph.changed = false;
             self.executor_initialized = false;
         }
@@ -1105,7 +1057,6 @@ impl ScheduleGraph {
     pub fn build_schedule(
         &mut self,
         world: &mut World,
-        ignored_ambiguities: &BTreeSet<ComponentId>,
     ) -> Result<(SystemSchedule, Vec<ScheduleBuildWarning>), ScheduleBuildError> {
         let mut warnings = Vec::new();
 
@@ -1189,7 +1140,10 @@ impl ScheduleGraph {
             &flat_dependency_analysis,
             &flat_ambiguous_with,
             &self.ambiguous_with_all,
-            ignored_ambiguities,
+            world
+                .get_resource::<IgnoredAmbiguities>()
+                .map(|ia| &ia.0)
+                .unwrap_or(&BTreeSet::new()),
         );
         // If there are any ambiguities, log warnings or return errors as configured.
         if self.settings.ambiguity_detection != LogLevel::Ignore
@@ -1309,7 +1263,6 @@ impl ScheduleGraph {
         &mut self,
         world: &mut World,
         schedule: &mut SystemSchedule,
-        ignored_ambiguities: &BTreeSet<ComponentId>,
         schedule_label: InternedScheduleLabel,
     ) -> Result<Vec<ScheduleBuildWarning>, ScheduleBuildError> {
         if !self.systems.is_initialized() || !self.system_sets.is_initialized() {
@@ -1342,7 +1295,7 @@ impl ScheduleGraph {
             }
         }
 
-        let (new_schedule, warnings) = self.build_schedule(world, ignored_ambiguities)?;
+        let (new_schedule, warnings) = self.build_schedule(world)?;
         *schedule = new_schedule;
 
         for warning in &warnings {

crates/bevy_ecs/src/world/mod.rs

@@ -53,7 +53,7 @@ use crate::{
     query::{DebugCheckedUnwrap, QueryData, QueryFilter, QueryState},
     relationship::RelationshipHookMode,
     resource::Resource,
-    schedule::{Schedule, ScheduleLabel, Schedules},
+    schedule::{IgnoredAmbiguities, Schedule, ScheduleLabel, Schedules},
     storage::{ResourceData, Storages},
     system::Commands,
     world::{
@@ -3675,16 +3675,14 @@ impl World {
 
     /// Ignore system order ambiguities caused by conflicts on [`Component`]s of type `T`.
     pub fn allow_ambiguous_component<T: Component>(&mut self) {
-        let mut schedules = self.remove_resource::<Schedules>().unwrap_or_default();
-        schedules.allow_ambiguous_component::<T>(self);
-        self.insert_resource(schedules);
+        let id = self.register_component::<T>();
+        self.get_resource_or_init::<IgnoredAmbiguities>().insert(id);
     }
 
     /// Ignore system order ambiguities caused by conflicts on [`Resource`]s of type `T`.
     pub fn allow_ambiguous_resource<T: Resource>(&mut self) {
-        let mut schedules = self.remove_resource::<Schedules>().unwrap_or_default();
-        schedules.allow_ambiguous_resource::<T>(self);
-        self.insert_resource(schedules);
+        let id = self.components_registrator().register_resource::<T>();
+        self.get_resource_or_init::<IgnoredAmbiguities>().insert(id);
     }
 }
 

release-content/migration-guides/schedule_cleanup.md

@@ -22,3 +22,8 @@ pull_requests: [21608, 21817]
 - `ScheduleBuildPass::collapse_set` now takes `&HashSet<SystemKey>` instead of a slice, to reduce redundant allocations.
 - `simple_cycles_in_component` has been changed from a free function into a method on `DiGraph`.
 - `DiGraph::try_into`/`UnGraph::try_into` was renamed to `DiGraph::try_convert`/`UnGraph::try_convert` to prevent overlap with the `TryInto` trait, and now makes use of `TryInto` instead of `TryFrom` for conversions.
+- Removed `Schedules::ignored_scheduling_ambiguities`: access the same info via the new `IgnoredAmbiguities` resource instead.
+- Removed `Schedules::allow_ambiguous_component` and `Schedules::allow_ambiguous_resource`: use the equivalent functions on `World` instead.
+- Removed `Schedules::iter_ignored_ambiguities`: use `IgnoredAmbiguities::iter` via Deref instead.
+- Removed `Schedules::print_ignored_ambiguities`: print the string returned by `IgnoredAmbiguities::to_string` yourself.
+- Removed the `ignored_ambiguities` parameter from `Schedule::build_schedule`, it is now fetched internally from the new `IgnoredAmbiguities` resource.