Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Task<Page> PopModalPlatformAsync(bool animated)
return Task.FromResult(modal);
}

var source = new TaskCompletionSource<Page>();
var source = new TaskCompletionSource<Page>(TaskCreationOptions.RunContinuationsAsynchronously);

if (animated && dialogFragment.View is not null)
{
Expand Down Expand Up @@ -168,8 +168,6 @@ async Task PushModalPlatformAsync(Page modal, bool animated)

async Task PresentModal(Page modal, bool animated)
{
TaskCompletionSource<bool> animationCompletionSource = new();

var parentView = GetModalParentView();

var dialogFragment = new ModalFragment(WindowMauiContext, modal)
Expand All @@ -185,19 +183,32 @@ async Task PresentModal(Page modal, bool animated)

if (animated)
{
dialogFragment!.AnimationEnded += OnAnimationEnded;
TaskCompletionSource<bool> animationCompletionSource = new(TaskCreationOptions.RunContinuationsAsynchronously);

dialogFragment.AnimationEnded += OnAnimationEnded;

void OnAnimationEnded(object? sender, EventArgs e)
{
dialogFragment.AnimationEnded -= OnAnimationEnded;
animationCompletionSource.SetResult(true);
}

await animationCompletionSource.Task;
}
else
{
animationCompletionSource.TrySetResult(true);
}
// Non-animated modals need to wait for presentation completion to prevent race conditions
TaskCompletionSource<bool> presentationCompletionSource = new();

void OnAnimationEnded(object? sender, EventArgs e)
{
dialogFragment!.AnimationEnded -= OnAnimationEnded;
animationCompletionSource.SetResult(true);
dialogFragment.PresentationCompleted += OnPresentationCompleted;

void OnPresentationCompleted(object? sender, EventArgs e)
{
dialogFragment.PresentationCompleted -= OnPresentationCompleted;
presentationCompletionSource.SetResult(true);
}

await presentationCompletionSource.Task;
}
}

Expand All @@ -208,9 +219,10 @@ internal class ModalFragment : DialogFragment
NavigationRootManager? _navigationRootManager;
static readonly ColorDrawable TransparentColorDrawable = new(AColor.Transparent);
bool _pendingAnimation = true;
bool _pendingNavigation = true;

public event EventHandler? AnimationEnded;

internal event EventHandler? AnimationEnded;
internal event EventHandler? PresentationCompleted;

public bool IsAnimated { get; internal set; }

Expand Down Expand Up @@ -356,13 +368,25 @@ public override void OnStart()
var dialog = Dialog;

if (dialog is null || dialog.Window is null || View is null)
{
// SAFETY: Fire event even on early return to prevent deadlock
FirePresentationCompleted();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say we don't need this here. I added those null check here to make the nullable analyser happy. If this results in true, something is very wrong.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pictos, I have added FirePresentationCompleted() in the null check condition to prevent potential deadlocks as per @PureWeen's suggestion. Please find the below comment for your reference.

Comment link: #32479 (review)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BagavathiPerumal I read it, but not sure if we just want to complete the Task or set an exception to the user, since the navigation will be in a invalid state.

cc: @PureWeen

return;
}

int width = ViewGroup.LayoutParams.MatchParent;
int height = ViewGroup.LayoutParams.MatchParent;
dialog.Window.SetLayout(width, height);
}

public override void OnResume()
{
base.OnResume();

// Signal that the modal is fully presented and ready
FirePresentationCompleted();
}

public override void OnDismiss(IDialogInterface dialog)
{
_modal.PropertyChanged -= OnModalPagePropertyChanged;
Expand All @@ -385,6 +409,9 @@ public override void OnDestroy()
{
base.OnDestroy();
FireAnimationEnded();

// SAFETY: If destroyed before OnStart completed, fire PresentationCompleted to prevent deadlock
FirePresentationCompleted();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it's a good idea to complete the TCS, I would say the best here is to Cancel it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pictos, I have added FirePresentationCompleted() in OnDestroy() to handle cases where the fragment is destroyed before OnStart() completes, preventing deadlocks based on @PureWeen ’s earlier suggestion, which I mentioned in my previous comment.

}

void FireAnimationEnded()
Expand All @@ -398,6 +425,15 @@ void FireAnimationEnded()
AnimationEnded?.Invoke(this, EventArgs.Empty);
}

void FirePresentationCompleted()
{
if (!_pendingNavigation)
return;

_pendingNavigation = false;
PresentationCompleted?.Invoke(this, EventArgs.Empty);
}


sealed class CustomComponentDialog : ComponentDialog
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions src/Controls/tests/TestCases.HostApp/Issues/Issue32310.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
namespace Maui.Controls.Sample.Issues;

[Issue(IssueTracker.Github, 32310, "App hangs if PopModalAsync is called after PushModalAsync with single await Task.Yield()", PlatformAffected.Android)]
public class Issue32310 : ContentPage
{
public Issue32310()
{
var navigateButton = new Button
{
Text = "Perform Modal Navigation",
AutomationId = "NavigateButton",
VerticalOptions = LayoutOptions.Center,
HorizontalOptions = LayoutOptions.Center
};

navigateButton.Clicked += (s, e) =>
{
Dispatcher.DispatchAsync(async () =>
{
await Navigation.PushModalAsync(new ContentPage() { Content = new Label() { Text = "Hello!" } }, false);

await Task.Yield();

await Navigation.PopModalAsync();
});
};

var layout = new VerticalStackLayout
{
Padding = new Thickness(30, 0),
Spacing = 25,
VerticalOptions = LayoutOptions.Center,
HorizontalOptions = LayoutOptions.Center,
Children =
{
navigateButton
}
};

Content = layout;
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
using NUnit.Framework;
using UITest.Appium;
using UITest.Core;

namespace Microsoft.Maui.TestCases.Tests.Issues;

public class Issue32310 : _IssuesUITest
{
public Issue32310(TestDevice device) : base(device)
{
}

public override string Issue => "App hangs if PopModalAsync is called after PushModalAsync with single await Task.Yield()";

[Test]
[Category(UITestCategories.Navigation)]
public void ModalNavigationShouldNotHang()
{
App.WaitForElement("NavigateButton");
App.Tap("NavigateButton");
App.WaitForElement("NavigateButton");
VerifyScreenshot();
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading