fix(sortable): unsubscribe item capture when component is destroyed #6546
Conversation
This file contains 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
Unsubscribed subscription in sortable component was causing memory to leak. We need to ensure all subscriptions are released whenever a component is destroyed.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## development #6546 +/- ##
===============================================
- Coverage 76.60% 76.59% -0.01%
===============================================
Files 317 317
Lines 10748 10754 +6
Branches 2866 2866
===============================================
+ Hits 8233 8237 +4
- Misses 2514 2516 +2
Partials 1 1
... and 5 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
|
bump @valorkin |
|
@lexasq Does this PR need any update on my part? :) |
|
@Arooba-git thanks for your contribution, this PR definitely caught my eye to have a better look. No actions needed on your part, we appreciate your help to make this lib better! |
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 ngx-bootstrap, 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 a dangling subscription that was causing the memory to leak (screenshots below).
[before]
Hence we added the fix by unsubscribing the subscription and you can see the heap size and # of leaks reducing noticeably:
As per the contribution guidelines, we ran the unit test cases; NX successfully ran the target tests for 24 projects.
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):
ngx-test-scenario-memlab.txt
Note that some other reported leaks (in Memlab) originated from Storybook, hence were ignored.