fix($animate): avoid memory leak with $animate.enabled(element, enabled)
#16649
Conversation
…led)` When disabling/enabling animations on a specific element (via `$animate.enabled(element, enabled)`), the element is added in a map to track its state. Previously, the element was never removed from the map, causing AngularJS to hold on to the element even after it is removed from the DOM, thus preventing it from being garbage collected. This commit fixes it by removing the element from the map on `$destroy`. Fixes angular#16637.
|
It crossed my mind that this migth be a breaking change, because previously removing and re-inserting an element let it retain its "animations enabled" status. But generally a lot of things will break if you remove an element (via The proper method if you want to temporarily remove an element from the DOM is An alternative would be to attach the "animations enabled" status on the element itself (directly, not via I lean towards not considering this a breaking change, though 😅 WDYT? |
|
I don't think it's a breaking change. It was an interesting side-effect but if somebody relied on this behavior I don't think it's many people. |
|
There was a bug (when using jQuery) 😁 Pushed a fixup commit. |
…led)` When disabling/enabling animations on a specific element (via `$animate.enabled(element, enabled)`), the element is added in a map to track its state. Previously, the element was never removed from the map, causing AngularJS to hold on to the element even after it is removed from the DOM, thus preventing it from being garbage collected. This commit fixes it by removing the element from the map on `$destroy`. Fixes #16637. Closes #16649
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Bug fix (memory leak).
What is the current behavior? (You can also link to an open issue here)
When disabling/enabling animations on a specific element (via
$animate.enabled(element, enabled)), the element is added in a map to track its state.Currently, the element is never removed from the map, causing AngularJS to hold on to the element even after it is removed from the DOM, thus preventing it from being garbage collected.
See #16637.
What is the new behavior (if this is a feature change)?
The element is removed from the map on
$destroy, making it eligible for garbage collection (if there are no references to it).Does this PR introduce a breaking change?
Maybe... (bar probably not really)
Please check if the PR fulfills these requirements
Other information:
Fixes #16637.