fix: unbind all retainers when instance is destroyed #135
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes
scatterplot.destroy()
to properly remove all event listeners bound during instance creation.Description
wheelHandler
bound tocanvas
when destroyinglassoManager.destroy
when destroyingDestroyed scatterplot instances are currently retained in memory in full (including the allocated
KDBush
indexes and the webGL context), which leads to memory leaks in applications that create and destroy scatterplots frequently. This happens because there are some event handlers still bound to (detached) DOM elements, so the garbage collection skips the whole thing. The behavior can be observed as follows:Adjust the example to call destroy after a timeout.
Open the
Memory
tab in chrome devtools and open the example. After the canvas is removed, perform a manual garbage collection and take a heap snapshot. You will see that the instance and a canvas element is still held in memory, with the retainers pointing to certain event handlers:Open a new tab and repeat with the fixes applied. When looking at the snapshot now, the instance and canvas are no longer present:
Fixes #___
Checklist
CHANGELOG.md
updatedREADME.md
added or updated