fix(material): use same reference for adding and removing event listener#3588
Merged
aitboudad merged 1 commit intoFeb 13, 2023
Merged
Conversation
✅ Deploy Preview for formly-dev ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Member
|
Thank you @Arooba-git! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please check if the PR fulfills these requirements
npm run buildproduced a successful build. (Unit testing can be done by runningnpm test;)npm run lintto do this.npm run buildwill fail if there are files not linted.)Hello 👋
As part of our project, we are using Facebook's new Memlab tool to detect memory leaks in SPA applications and their libraries. While running the tool and analyzing the code of ngx-formly, we saw that your project does a very good job of ensuring that all async operations are cancelled when components destroy. However, as per Memlab execution results, we found some unremoved listeners, causing the memory to leak (screenshots below).
[before]

Hence we added the fix by adding & removing the listeners with proper references, and you can see the heap size and count of leaks reducing noticeably:
Basically
.bind()creates a new function reference each time [1-5]; which means the reference passed to the add and remove events were different, and hence the listeners were not actually being removed.We executed the test suite after the fixes and it successfully passed 56 of 56 total (in watch + non-watch mode)
You can analyze this and other potential leak sources, if you like, by running Memlab with a scenario file covering maximum count of use cases.
Following is a sample of the scenario file we used (it needs to be a .js file but attaching here in .txt form):
ngx-formly-scenario.txt
Note that some other reported leaks (in Memlab) originated from Angular's internal objects, and hence were ignored.
References:
https://kostasbariotis.com/removeeventlistener-and-this/
https://stackoverflow.com/questions/11565471/removing-event-listener-which-was-added-with-bind
https://stackoverflow.com/questions/28665784/how-to-remove-event-listener-of-a-object-with-bindthis
https://stackoverflow.com/questions/54921027/remove-event-listener-that-has-been-added-using-bindthis
https://stackoverflow.com/questions/46455624/javascript-addeventlistener-removeeventlistener-and-bind