Skip to content

[ios/catalyst] fix memory leak in modal pages #22089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 3 commits into from
May 10, 2024
+39 −11
Merged

[ios/catalyst] fix memory leak in modal pages #22089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec3d854
[ios/catalyst] fix memory leak in modal pages
jonathanpeppers Apr 26, 2024
39f6bcb
Update MemoryTests.cs
jonathanpeppers May 7, 2024
8308b64
Update ContainerViewController.cs
jonathanpeppers May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/Controls/tests/DeviceTests/Memory/MemoryTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,35 @@ void SetupBuilder()
});
}

[Fact("Page Does Not Leak")]
public async Task PageDoesNotLeak()
{
SetupBuilder();

WeakReference viewReference = null;
WeakReference handlerReference = null;
WeakReference platformViewReference = null;

var navPage = new NavigationPage(new ContentPage { Title = "Page 1" });

await CreateHandlerAndAddToWindow(new Window(navPage), async () =>
{
var page = new ContentPage { Content = new Label() };

await navPage.Navigation.PushModalAsync(page);

viewReference = new WeakReference(page);
handlerReference = new WeakReference(page.Handler);
platformViewReference = new WeakReference(page.Handler.PlatformView);

// Windows requires Loaded event to fire before unloading
await Task.Delay(500);
await navPage.Navigation.PopModalAsync();
});

await AssertionExtensions.WaitForGC(viewReference, handlerReference, platformViewReference);
}

[Theory("Handler Does Not Leak")]
[InlineData(typeof(ActivityIndicator))]
[InlineData(typeof(Border))]
Expand Down
21 changes: 10 additions & 11 deletions src/Core/src/Platform/iOS/ContainerViewController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ namespace Microsoft.Maui.Platform
{
public class ContainerViewController : UIViewController, IReloadHandler
{
[UnconditionalSuppressMessage("Memory", "MEM0002", Justification = "Proven safe in test: NavigationPageTests.DoesNotLeak")]
IElement? _view;
WeakReference<IElement>? _view;
[UnconditionalSuppressMessage("Memory", "MEM0002", Justification = "Proven safe in test: NavigationPageTests.DoesNotLeak")]
UIView? currentPlatformView;

Expand All @@ -21,7 +20,7 @@ public class ContainerViewController : UIViewController, IReloadHandler

public IElement? CurrentView
{
get => _view;
get => _view?.GetTargetOrDefault();
set => SetView(value);
}

Expand All @@ -33,15 +32,15 @@ public UIView? CurrentPlatformView

void SetView(IElement? view, bool forceRefresh = false)
{
if (view == _view && !forceRefresh)
if (CurrentView is IElement existingView && view == existingView && !forceRefresh)
return;

_view = view;
_view = view is null ? null : new(view);

if (view is ITitledElement page)
Title = page.Title;

if (_view is IHotReloadableView ihr)
if (view is IHotReloadableView ihr)
{
ihr.ReloadHandler = this;
MauiHotReloadHelper.AddActiveView(ihr);
Expand All @@ -50,8 +49,8 @@ void SetView(IElement? view, bool forceRefresh = false)
currentPlatformView?.RemoveFromSuperview();
currentPlatformView = null;

if (IsViewLoaded && _view != null)
LoadPlatformView(_view);
if (IsViewLoaded && view is not null)
LoadPlatformView(view);
}

internal UIView LoadFirstView(IElement view)
Expand All @@ -63,8 +62,8 @@ internal UIView LoadFirstView(IElement view)
public override void LoadView()
{
base.LoadView();
if (_view != null && Context != null)
LoadPlatformView(_view);
if (CurrentView is IElement view && Context != null)
LoadPlatformView(view);
}

void LoadPlatformView(IElement view)
Expand All @@ -83,7 +82,7 @@ protected virtual UIView CreatePlatformView(IElement view)
_ = Context ?? throw new ArgumentNullException(nameof(Context));
_ = _view ?? throw new ArgumentNullException(nameof(view));

return _view.ToPlatform(Context);
return view.ToPlatform(Context);
}

public override void ViewDidLayoutSubviews()
Expand Down