[ios/catalyst] fix memory leak in ToolbarItem
#22893
Merged
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
Fixes: dotnet#22814 `ToolbarItem` has a circular reference that causes it to live forever: * `ToolbarItem` -> `ToolbarItemExtensions.PrimaryToolbarItem` -> `ToolbarItem` And then if you have a `Page` such as: class LeakyShellPage : ContentPage { public LeakyShellPage() { var item = new ToolbarItem { Text = "Primary Item" }; item.Clicked += OnToolbarItemClicked; ToolbarItems.Add(item); } // Needs to be an instance method void OnToolbarItemClicked(object sender, EventArgs e) { } } Then the `ToolbarItem` (that leaks), would also cause the entire `Page` to leak as it has a strong reference to it. I could reproduce this problem by updating a tests in `ShellTests.cs` to add a `ToolbarItem`. To solve this problem, I changed the `_item` field in both `PrimaryToolbarItem` and `SecondaryToolbarItem` to be a `WeakReference`. While writing tests, I found there was a mismatched `#if` and `#endif`. I think part of `ShellTests.cs` were not running at all on `MACCATALYST` by accident. So, I hope they still pass?
jonathanpeppers
commented
Jun 6, 2024
| @@ -82,6 +82,7 @@ public async Task PageLayoutDoesNotExceedWindowBounds() | |||
| Assert.True(pageBounds.Height <= window.Height); | |||
| }); | |||
| } | |||
| #endif | |||
There was a problem hiding this comment.
I think this accidentally put #if !MACCATALYST across this entire file. 👀 Might have been a merge conflict?
jonathanpeppers
added
the
memory-leak 💦
jonathanpeppers
commented
Jun 7, 2024
|
|
||
| Clicked += (sender, e) => ((IMenuItemController)_item).Activate(); | ||
| Clicked += OnClicked; |
There was a problem hiding this comment.
I couldn't change this to:
Suggested change
| Clicked += OnClicked; | |
| Clicked += (sender, e) => ((IMenuItemController)item).Activate();; |
This created a closure on item that also leaked.
PureWeen
approved these changes
Jun 7, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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: #22814
ToolbarItemhas a circular reference that causes it to live forever:ToolbarItem->ToolbarItemExtensions.PrimaryToolbarItem->ToolbarItemAnd then if you have a
Pagesuch as:Then the
ToolbarItem(that leaks), would also cause the entirePageto leak as it has a strong reference to it. I could reproduce this problem by updating a tests inShellTests.csto add aToolbarItem.To solve this problem, I changed the
_itemfield in bothPrimaryToolbarItemandSecondaryToolbarItemto be aWeakReference.While writing tests, I found there was a mismatched
#ifand#endif.I think part of
ShellTests.cswere not running at all onMACCATALYSTby accident. So, I hope they still pass?