fix: add unsubscribe mechanism to prevent callback memory leaks#777
Open
atharrva01 wants to merge 2 commits intoHSF:mainfrom
Open
fix: add unsubscribe mechanism to prevent callback memory leaks#777atharrva01 wants to merge 2 commits intoHSF:mainfrom
atharrva01 wants to merge 2 commits intoHSF:mainfrom
Conversation
Author
|
Hi @EdwardMoyse 👋, 👍 Would appreciate a review whenever you get time. Thanks! |
Collaborator
|
Sorry @atharrva01 but this has a conflict now - probably I should have been a bit more careful about the order I accepted PRs, so my apologies for this ... but could you have a look? |
Author
|
hi @EdwardMoyse , Conflict resolved and branch updated, thanks for the heads-up! |
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.
Summary
Fixes a memory leak caused by push-only subscriptions in Phoenix when navigating between experiments. Route-scoped Angular components subscribed to long-lived singleton services without an unsubscribe mechanism, causing callbacks to accumulate and destroyed components to remain in memory.
Issue Description
Core services (
EventDisplay,ActiveVariable) stored callbacks in internal arrays but did not provide a way to remove them. When Angular components were destroyed on navigation, their callbacks remained registered and retained component instances via closures.Over time this led to unbounded memory growth and increasing event dispatch cost.
Steps to Reproduce
Before fix: callback counts and retained component instances grow with each navigation.
Fix
Subscription APIs now return an unsubscribe function, and Angular components clean up subscriptions on destroy.
This makes subscriptions lifecycle-safe and allows destroyed components to be garbage-collected.
Impact
Backward Compatibility
Fully backward-compatible. Existing callers that ignore the returned unsubscribe function continue to work unchanged.