story: Avoid retaining PopoverStory from popover child#2378
Merged
Conversation
huacnlee
changed the title
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
2 participants
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
While reading the story examples to learn how to use, I noticed a potential memory leak in the popover story.
FormandDropdownListDelegatewere holding a strongEntity<PopoverStory>reference back to their parent. Since these child entities are owned byPopoverStory, keeping a strong parent reference can create a retain cycle.This PR changes those parent references to
WeakEntity<PopoverStory>and safely ignores updates when the parent has already been dropped.Changes
Entity<PopoverStory>parent references withWeakEntity<PopoverStory>.cx.weak_entity()when passing the parent intoFormandDropdownListDelegate.WeakEntity::updateresults without assuming the parent still exists.Notes
Thanks for providing such a great component set. I found this while studying the story examples and wanted to fix a small lifecycle issue that could otherwise be easy to miss.