set spawn_despawn on the correct entity when despawning (#21364)

# Objective

Fixes #21293
Fixes #17314 to ensure that this is tested correctly.

## Solution
when despawning an entity, previously the swapped in (archetype) or
moved in entity (table) (which both require extra bookkeeping to update
archetype or table rows) were marked as `spawned_or_despawned` by the
location and tick that the to-be-removed entity was meant to be marked,
while the to-be-removed entity wasn't marked.
As pointed out by @akimakinai in
[#19047](#19047), I've re-added
the correct `mark_spawn_despawn` call to `despawn_with_caller`.

## Testing

I've added a test `spawned_after_swap_remove` that ensures that
despawning an entity by swapping doesn't effect other entities
`spawned_or_despawned` location, and that it does effect the despawned
entity's index's `spawned_or_despawned` location.

Co-Authored By: [email protected]

---------

Co-authored-by: WaterWhisperer <[email protected]>

Author: 2 people

crates/bevy_ecs/src/world/entity_ref.rs

@@ -2665,9 +2665,6 @@ impl<'w> EntityWorldMut<'w> {
                             table_row: swapped_location.table_row,
                         }),
                     );
-                    world
-                        .entities
-                        .mark_spawn_despawn(swapped_entity.index(), caller, change_tick);
                 }
             }
             table_row = remove_result.table_row;
@@ -2697,14 +2694,18 @@ impl<'w> EntityWorldMut<'w> {
                         table_row,
                     }),
                 );
-                world
-                    .entities
-                    .mark_spawn_despawn(moved_entity.index(), caller, change_tick);
             }
             world.archetypes[moved_location.archetype_id]
                 .set_entity_table_row(moved_location.archetype_row, table_row);
         }
         world.flush();
+
+        // SAFETY: `self.entity` is a valid entity index
+        unsafe {
+            world
+                .entities
+                .mark_spawn_despawn(self.entity.index(), caller, change_tick);
+        }
     }
 
     /// Ensures any commands triggered by the actions of Self are applied, equivalent to [`World::flush`]
@@ -6585,4 +6586,28 @@ mod tests {
             }
         );
     }
+
+    #[test]
+    fn spawned_after_swap_remove() {
+        #[derive(Component)]
+        struct Marker;
+
+        let mut world = World::new();
+        let id1 = world.spawn(Marker).id();
+        let _id2 = world.spawn(Marker).id();
+        let id3 = world.spawn(Marker).id();
+
+        #[cfg(feature = "track_location")]
+        let e1_spawned = world.entity(id1).spawned_by();
+
+        let spawn = world.entity(id3).spawned_by();
+        world.entity_mut(id1).despawn();
+        #[cfg(feature = "track_location")]
+        let e1_despawned = world.entities().entity_get_spawned_or_despawned_by(id1);
+        #[cfg(feature = "track_location")]
+        assert_ne!(e1_spawned.map(Some), e1_despawned);
+
+        let spawn_after = world.entity(id3).spawned_by();
+        assert_eq!(spawn, spawn_after);
+    }
 }

tools/ci/src/commands/test.rs

@@ -20,7 +20,7 @@ impl Prepare for TestCommand {
             PreparedCommand::new::<Self>(
                 cmd!(
                     sh,
-                    "cargo test --workspace --lib --bins --tests {no_fail_fast...} {jobs_ref...} -- {test_threads_ref...}"
+                    "cargo test --workspace --lib --bins --tests --features bevy_ecs/track_location {no_fail_fast...} {jobs_ref...} -- {test_threads_ref...}"
                 ),
                 "Please fix failing tests in output above.",
             ),