Skip to content

Commit d4ffd4f

Browse files
fix B0003 example and update logs (#11162)
# Objective - Example in error B0003 is not failing anymore after #9822 ## Solution - Update the example code so that is always fail - Also update logs and instructions on how to debug as it's easier now --------- Co-authored-by: Alice Cecile <[email protected]>
1 parent a657478 commit d4ffd4f

File tree

1 file changed

+24
-70
lines changed

1 file changed

+24
-70
lines changed

errors/B0003.md

Lines changed: 24 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -11,98 +11,52 @@ fn main() {
1111
App::new()
1212
.add_plugins(DefaultPlugins)
1313
.add_systems(Startup, setup)
14-
.add_systems(Update, despawning)
15-
.add_systems(Update, use_entity.after(despawning))
14+
.add_systems(Update, (use_0_and_despawn_1, use_1_and_despawn_0))
1615
.run();
1716
}
1817
1918
#[derive(Resource)]
20-
struct MyEntity(Entity);
19+
struct MyEntities(Entity, Entity);
2120
2221
#[derive(Component)]
2322
struct Hello;
2423
2524
fn setup(mut commands: Commands) {
26-
let entity = commands.spawn_empty().id();
27-
commands.insert_resource(MyEntity(entity));
25+
let entity1 = commands.spawn_empty().id();
26+
let entity2 = commands.spawn_empty().id();
27+
commands.insert_resource(MyEntities(entity1, entity2));
2828
}
2929
30-
fn despawning(mut commands: Commands, entity: Option<Res<MyEntity>>) {
31-
if let Some(my_entity) = entity {
32-
commands.entity(my_entity.0).despawn();
33-
commands.remove_resource::<MyEntity>();
34-
}
30+
fn use_0_and_despawn_1(mut commands: Commands, my_entities: Res<MyEntities>) {
31+
commands.entity(my_entities.0).insert(Hello);
32+
commands.entity(my_entities.1).despawn();
3533
}
3634
37-
fn use_entity(mut commands: Commands, entity: Option<Res<MyEntity>>) {
38-
if let Some(my_entity) = entity {
39-
commands.entity(my_entity.0).insert(Hello);
40-
}
35+
fn use_1_and_despawn_0(mut commands: Commands, my_entities: Res<MyEntities>) {
36+
commands.entity(my_entities.1).insert(Hello);
37+
commands.entity(my_entities.0).despawn();
4138
}
4239
```
4340

44-
This will panic, as system `use_entity` is executed after system `despawning`. Without the system ordering specified here, the ordering would be random and this code would panic half the time.
41+
This will panic, as the system that is executed first will despawn the entity used by the second.
4542

46-
The default panic message is telling you the entity id (`1v0`) and the command that failed (adding a component `Hello`):
43+
The default panic message is telling you which entity doesn't exist (`2v0` in the example log just below), the command that failed (adding a component `Hello`) and the system from which it originated (`use_1_and_despawn_0`):
4744

4845
```text
49-
thread 'main' panicked at 'error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 1v0 because it doesn't exist in this World.', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:934:13
46+
thread 'main' panicked at /bevy/crates/bevy_ecs/src/system/commands/mod.rs:1097:13:
47+
error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 2v0 because it doesn't exist in this World.
48+
Encountered a panic when applying buffers for system `use_entity_after_despawn::use_1_and_despawn_0`!
49+
Encountered a panic in system `bevy_app::main_schedule::Main::run_main`!
5050
```
5151

52-
But you don't know which system tried to add a component, and which system despawned the entity.
53-
54-
To get the system that created the command that panics, you can enable the `trace` feature of Bevy. This will add a panic handler that will print more information:
55-
56-
```text
57-
0: bevy_ecs::system::commands::system_commands
58-
with name="use_entity_after_despawn::use_entity"
59-
at crates/bevy_ecs/src/system/commands/mod.rs:117
60-
1: bevy_ecs::world::schedule
61-
with name=Update
62-
at crates/bevy_ecs/src/world/mod.rs:1755
63-
2: bevy_ecs::schedule::executor::single_threaded::system
64-
with name="bevy_app::main_schedule::Main::run_main"
65-
at crates/bevy_ecs/src/schedule/executor/single_threaded.rs:98
66-
3: bevy_ecs::world::schedule
67-
with name=Main
68-
at crates/bevy_ecs/src/world/mod.rs:1755
69-
4: bevy_app::app::main app
70-
at crates/bevy_app/src/app.rs:249
71-
5: bevy_app::app::update
72-
at crates/bevy_app/src/app.rs:246
73-
6: bevy_winit::winit event_handler
74-
at crates/bevy_winit/src/lib.rs:338
75-
7: bevy_app::app::bevy_app
76-
at crates/bevy_app/src/app.rs:290
77-
thread 'main' panicked at 'error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 1v0 because it doesn't exist in this World.', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:934:13
78-
```
79-
80-
From the first two lines, you now know that it panics while executing a command from the system `use_entity`.
81-
82-
To get the system that created the despawn command, you can enable DEBUG logs for crate `bevy_ecs`, for example by setting the environment variable `RUST_LOG=bevy_ecs=debug`. This will log:
52+
To get the system that created the despawn command, you can enable DEBUG logs for crate `bevy_ecs`, for example by setting the environment variable `RUST_LOG=bevy_ecs=debug` or by configuring the `LogPlugin`. This will log:
8353

8454
```text
85-
DEBUG schedule{name=Main}:system{name="bevy_app::main_schedule::Main::run_main"}:schedule{name=Update}:system_commands{name="use_entity_after_despawn::despawning"}: bevy_ecs::world::entity_ref: Despawning entity 1v0
86-
thread 'main' panicked at 'error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 1v0 because it doesn't exist in this World.', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:934:13
55+
DEBUG system_commands{name="use_entity_after_despawn::use_0_and_despawn_1"}: bevy_ecs::world::entity_ref: Despawning entity 2v0
56+
thread 'main' panicked at /bevy/crates/bevy_ecs/src/system/commands/mod.rs:1097:13:
57+
error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 2v0 because it doesn't exist in this World.
58+
Encountered a panic when applying buffers for system `use_entity_after_despawn::use_1_and_despawn_0`!
59+
Encountered a panic in system `bevy_app::main_schedule::Main::run_main`!
8760
```
8861

89-
From the first line, you know the entity `1v0` was despawned when executing a command from system `despawning`. In a real case, you could have many log lines, you will need to search for the exact entity from the panic message.
90-
91-
Combining those two, you should get enough information to understand why this panic is happening and how to fix it:
92-
93-
```text
94-
DEBUG schedule{name=Main}:system{name="bevy_app::main_schedule::Main::run_main"}:schedule{name=Update}:system_commands{name="use_entity_after_despawn::despawning"}: bevy_ecs::world::entity_ref: Despawning entity 1v0
95-
0: bevy_ecs::system::commands::system_commands
96-
with name="use_entity_after_despawn::use_entity"
97-
at crates/bevy_ecs/src/system/commands/mod.rs:117
98-
1: bevy_ecs::world::schedule
99-
with name=Update
100-
at crates/bevy_ecs/src/world/mod.rs:1755
101-
2: bevy_ecs::schedule::executor::single_threaded::system
102-
with name="bevy_app::main_schedule::Main::run_main"
103-
at crates/bevy_ecs/src/schedule/executor/single_threaded.rs:98
104-
3: bevy_ecs::world::schedule
105-
with name=Main
106-
at crates/bevy_ecs/src/world/mod.rs:1755
107-
thread 'main' panicked at 'error[B0003]: Could not insert a bundle (of type `use_entity_after_despawn::Hello`) for entity 1v0 because it doesn't exist in this World.', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:934:13
108-
```
62+
From the first line, you know the entity `2v0` was despawned when executing a command from system `use_0_and_despawn_1`. In a real case, you could have many log lines, you will need to search for the exact entity from the panic message.

0 commit comments

Comments
 (0)