fix: Materialize list in Component.removeWhere (#2458)

This is needed since it'll get a ConcurrentModificationException in some cases otherwise, like in the test added for example.
flame-engine · Apr 2, 2023 · 13cce4a · 13cce4a
1 parent d1ac01f
commit 13cce4a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/packages/flame/lib/src/components/core/component.dart b/packages/flame/lib/src/components/core/component.dart
@@ -614,11 +614,7 @@ class Component {
 
   /// Removes all the children for which the [test] function returns true.
   void removeWhere(bool Function(Component component) test) {
-    for (final component in children) {
-      if (test(component)) {
-        remove(component);
-      }
-    }
+    removeAll([...children.where(test)]);
   }
 
   void _removeChild(Component child) {

diff --git a/packages/flame/test/components/component_test.dart b/packages/flame/test/components/component_test.dart
@@ -691,6 +691,19 @@ void main() {
           );
         },
       );
+
+      testWithFlameGame(
+        'removeWhere works before all components are mounted',
+        (game) async {
+          game.add(_RemoveWhereComponent());
+          expect(
+            () async {
+              await game.ready();
+            },
+            returnsNormally,
+          );
+        },
+      );
     });
 
     group('Moving components', () {
@@ -1302,3 +1315,11 @@ class _OnChildrenChangedComponent extends PositionComponent {
     lastChangeType = type;
   }
 }
+
+class _RemoveWhereComponent extends Component {
+  @override
+  Future<void> onLoad() async {
+    add(Component());
+    removeWhere((_) => true);
+  }
+}