Clear timeouts on component unmount to prevent memory leaks#380
Merged
Conversation
Contributor
Author
|
bump @YIZHUANG |
YIZHUANG
approved these changes
Feb 20, 2023
YIZHUANG
left a comment
Owner
There was a problem hiding this comment.
Thanks for making a PR to help.
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.
Hello 👋
As part of our project, we are using Facebook's new Memlab tool to detect memory leaks in SPA applications.
While running the tool and analyzing the code of react-multi-carousel, we saw that your project does a very good job of ensuring that all async operations are cancelled when the component unmounts. However, as per Memlab execution results, we found some dangling timers that were causing the memory to leak (screenshots below).
[before]


Hence we added the fix by clearing the timeouts and you can see the heap size and # of leaks reducing noticeably:
We used static variables, instead of normal ones, so that in future, even if the code changes for e.g encapsulating these timers in a nested function, the ID vars should still retain their correct (class) context, as opposed to volatile 'this' context.
We ran the unit test cases, and the results were the same as before our patch, i.e these patches had no effect on any case result.
You can analyze this and other potential leak sources, if you like, by running Memlab with a scenario file covering the maximum # 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):
multi-carousel-memlab-scenario.txt
Note that some other reported leaks (in Memlab) originated from Storybook, hence were ignored.