excaliburjs / Excalibur / 17404966126

89%

push

github

fix: Entity map memory leaks (#3511)

Excalibur makes use of `Map<Entity, TData>` for functionality (event dispatch) and performance, using the entity as a key to event subscriptions or other data. This stores the Entity by reference as a key, making both lookup and storage fairly efficient. Thanks to Excalibur's event system, it's easy for engine developers to maintain these lists in a safe manner (paired entity added and removed event handlers); here we are patching up a few that slipped through.

Fixes open memory leaks I was experiencing in my game (which churns Actors); it now maintains a stable ~80-100mb memory usage, vs climbing to ~2gb before my poor browser gives up. Previously, these maps would grow without bounds as Actors were created and removed.

I did a quick search for more, but wanted to focus on what I could verify.

Tests passed, but I wasn't able to find a place to add new tests to automate verification and left that unchecked for now - if you have a place to start I'd be happy to look!

Thanks for the great engine ⚔️ 

Closes #3510

## Changes:

- removes entities from internal `Map<Entity>` and `Map<object>` lists when on entity removal

5180 of 7245 branches covered (71.5%)

7 of 7 new or added lines in 3 files covered. (100.0%)

14029 of 16058 relevant lines covered (87.36%)

24482.74 hits per line