[ios/catalyst] fix memory leaks in *Cell
#22067
Merged
+145
−103
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
jonathanpeppers
added
platform/iOS 🍎
memory-leak 💦
|
Needs a rebase to get the updated snapshot for Issue18242Test and fix the build. |
jonathanpeppers
force-pushed
the
CellLeaks
branch
from
86e9d49
to
08d9594
Compare
jsuarezruiz
previously approved these changes
May 13, 2024
|
@jsuarezruiz do you know what's wrong with the one test lane? I wonder if it is caused by the changes here. |
|
/rebase |
PureWeen
force-pushed
the
CellLeaks
branch
2 times, most recently
from
a9ff7f9
to
0e57c49
Compare
Context: https://github.com/AdamEssenmacher/MemoryToolkit.Maui/tree/main/samples Retesting this sample with the `ListView` leak fixed, I noticed the sample reports 0 leaks! Unfortunately, it still displayed memory growing over time... Taking a `.gcdump` snapshot, I noticed a cycle: * `ViewCellRenderer.ViewTableCell` -> `ViewCell _viewCell` -> `ViewCellRenderer` -> `ViewTableCell` I was able to write a test that reproduces the leak, and I extended it for every type of `*Cell` like `TextCell`, `ImageCell`, `SwitchCell`, etc. The fixes are: * `ViewTableCell` now uses a `WeakReference<ViewCell> _viewCell` * `CellTableViewCell` now uses a `WeakReference<Cell> _cell` * `CellTableViewCell` now uses a `WeakEventManager` for `PropertyChanged`, as the `*Renderer` subscribes to this event. Note that I changed `PropertyChanged` to an event, which is an API change. (I can revisit this if needed)
One test was crashing (even on rerun), so maybe this will fix
PureWeen
previously requested changes
May 16, 2024
PureWeen
reviewed
May 16, 2024
| @@ -135,44 +133,9 @@ protected void UpdateBackground(UITableViewCell tableViewCell, Cell cell) | |||
| SetBackgroundColor(tableViewCell, cell, uiBgColor); | |||
| } | |||
|
|
|||
| [Obsolete("The ForceUpdateSizeRequested event is now managed by the command mapper, so it's not necessary to invoke this event manually.")] | |||
There was a problem hiding this comment.
This method was just a really complicated way of wiring up to _onForceUpdateSizeRequested and making sure to unwire from it.
We can just achieve this same thing through the commandmapper now
PureWeen
reviewed
May 16, 2024
| else | ||
| { | ||
| tvc.PropertyChanged -= HandlePropertyChanged; | ||
| CellPropertyChanged -= HandlePropertyChanged; |
There was a problem hiding this comment.
Because this event now is just local to this class this isn't going to cause a circular reference. I opted to keep this event path because this maintains the timing of when HandlePropertyChanged will start and stop firing
PureWeen
dismissed
their stale review
I reworked most of this PR so my review isn't relevant anymore
jsuarezruiz
approved these changes
May 17, 2024
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.
Fixes: #20195
Context: https://github.com/AdamEssenmacher/MemoryToolkit.Maui/tree/main/samples
Retesting this sample with the
ListViewleak fixed, I noticed the sample reports 0 leaks! Unfortunately, it still displayed memory growing over time...Taking a
.gcdumpsnapshot, I noticed a cycle:ViewCellRenderer.ViewTableCell->ViewCell _viewCell->ViewCellRenderer->ViewTableCellI was able to write a test that reproduces the leak, and I extended it for every type of
*CelllikeTextCell,ImageCell,SwitchCell, etc.The fixes are:
ViewTableCellnow uses aWeakReference<ViewCell> _viewCellCellTableViewCellnow uses aWeakReference<Cell> _cellCellTableViewCellnow uses aWeakEventManagerforPropertyChanged, as the*Renderersubscribes to this event.Note that I changed
PropertyChangedto an event, which is an API change. (I can revisit this if needed)