[BUG] Popup V2 - Android - ShowPopupAsync(INavigation) returns a Task that never completes

[mfeingol]

Is there an existing issue for this?

• I have searched the existing issues

Did you read the "Reporting a bug" section on Contributing file?

• I have read the "Reporting a bug" section on Contributing file: https://github.com/CommunityToolkit/Maui/blob/main/CONTRIBUTING.md#reporting-a-bug

Current Behavior

When I call ShowPopupAsync and then call CloseAsync() from inside my popup, the popup closes but ShowPopupAsync's task never completes so the result is never available.

Expected Behavior

I expect the task to complete when I close the popup.

Steps To Reproduce

1. Derive a popup from Popup<bool?>
2. Call OpenPopupAsync() on it, and close the popup from within using CloseAsync()
3. Note that await OpenPopupAsync() never returns

Link to public reproduction project repository

https://github.com/mfeingol/repros/tree/master/CommunityToolkit_2703_repro

Environment

- .NET MAUI CommunityToolkit: 12.0.0
- OS: Windows 11
- .NET MAUI: 9.0.71

Anything else?

No response

[Cristian-Azeta]

Example in Android ...

TestPage.xaml

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:tk="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
             x:Class="TEST.TestPage"
             Title="TEST">

	<Label Text="TEST" />

</ContentPage>

TestPage.xaml.cs

namespace TEST;

using CommunityToolkit.Maui;
using CommunityToolkit.Maui.Core;
using CommunityToolkit.Maui.Extensions;
using CommunityToolkit.Mvvm.Messaging;

public partial class TestPage : ContentPage
{
    #region Constructor

    public TestPage()
    {
        InitializeComponent();
    }

    #endregion

    #region Event

    protected override Boolean OnBackButtonPressed()
    {
        return true;
    }

    protected override async void OnAppearing()
    {
        base.OnAppearing();
        IsBusy = true;
        try
        {
		IPopupResult<Boolean> result = await this.ShowPopupAsync<Boolean>(new TestPopup(), new PopupOptions
		{
			CanBeDismissedByTappingOutsideOfPopup = false,
			PageOverlayColor = Colors.Orange.WithAlpha(0.4f),
		}, CancellationToken.None);
		if (result.Result is true) // <<<<<<<<<<<<<<<<<<<<<<<<<<< NEVER GO HERE
		{
			// Yes was tapped
		}
		else
		{
			// No was tapped
		}
        }
        catch (Exception ex)
        {
            Vibration.Default.Vibrate(1000);
            await DisplayAlert(Title, ex.Message, "Continue");
        }
        finally
        {
            IsBusy = false;
        }
    }

    #endregion
}

TestPopup.xaml

<?xml version="1.0" encoding="utf-8" ?>
<tk:Popup xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
          xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
          xmlns:tk="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
          x:TypeArguments="x:Boolean"
          x:Class="TEST.TestPopup"
          HorizontalOptions="Fill"
          VerticalOptions="Fill"
          BackgroundColor="Red">

	<Label Text="TEST" />
	<Button Text="Close" Clicked="OnCancelClicked" />

</tk:Popup>

TestPopup.xaml.cs

namespace TEST;

using CommunityToolkit.Maui.Views;

public partial class TestPopup : Popup<Boolean>
{
    #region Constructor

    public TestPopup()
    {
        InitializeComponent();
        WidthRequest = 0.8 * (DeviceDisplay.Current.MainDisplayInfo.Width / DeviceDisplay.Current.MainDisplayInfo.Density);
        HeightRequest = 0.8 * (DeviceDisplay.Current.MainDisplayInfo.Height / DeviceDisplay.Current.MainDisplayInfo.Density);
    }

    #endregion

    #region Event

    private async void OnCancelClicked(Object sender, EventArgs e)
    {
        try
        {
	    await CloseAsync(false, CancellationToken.None);
        }
        catch { }
    }

    #endregion
}

[e0548965]

Having the same issue, any workaround? Quite big issue for us after just completing the upgrade to v12.0.0

[AlanHoiland]

I'm seeing the same issue. Doesn't happen every time, maybe 50%.

[crwsolutions]

I'm seeing the same issue. But only when I use the system back button (< ) (On android, haven't tried iOs).

[e0548965]

Happens consistently for us every time

[mfeingol]

Same here - happens every time.

[bijington]

Perhaps one of you can provide a sample repository?

[TheCodeTraveler]

Thanks for bringing this to my attention! I see the problem I missed when implementing Popup v2 and will open a PR shortly.

In the meantime, here's a quick + easy workaround:

Workaround

Avoid using CloseAsync when a Popup is displayed using ShowPopupAsync.

If you are using CloseAsync, display the popup using ShowPopup:

this.ShowPopup(new Label().Text("This Popup Will Close Automatically in 2 Seconds"), new PopupOptions
{
	CanBeDismissedByTappingOutsideOfPopup = false
});

await Task.Delay(TimeSpan.FromSeconds(2));

await this.ClosePopupAsync();

[TheCodeTraveler]

Hi gang!

1. The bug with the Android Back Button is unrelated to this Issue as reported by @mfeingol
   • @crwsolutions Could you please open a new Issue for your bug using the Android Back Button
   • To avoid confusing the Android Back Button bug, with @mfeingol's bug, I will hide the comments on this Issue specific to the Android Back Button
   • I've opened a PR to resolve the bug with the Android Back Button: [Popup] Properly handle Android Back Button pressed #2716
2. I am unable to reproduce @mfeingol's issue.
   • The Unit Test below passes successfully
   • @mfeingol Please provide a sample reproduction app so that we can help you fix your issue

[Fact(Timeout = (int)TestDuration.Short)]
public async Task ShowPopupAsync_TaskShouldCompleteWhenPopupCloseAsyncIsCalled()
{
	// Arrange
	Task<IPopupResult> showPopupAsyncTask;
	var popup = new Popup();

	if (Application.Current?.Windows[0].Page is not Page page)
	{
		throw new InvalidOperationException("Page cannot be null");
	}

	// Act
	showPopupAsyncTask = page.ShowPopupAsync(popup, token: TestContext.Current.CancellationToken);

	// Assert
	Assert.Single(page.Navigation.ModalStack);
	Assert.IsType<PopupPage>(page.Navigation.ModalStack[0]);

	// Act
	await popup.CloseAsync(TestContext.Current.CancellationToken);
	await showPopupAsyncTask;

	// Assert
	Assert.Empty(page.Navigation.ModalStack);
}

[e0548965]

Thanks for looking into this @TheCodeTraveler , can you edit your test to actually return a DTO/value from the Popup? I've tried a lot different things but I just cannot get the task to return.

I think this is the same issue: https://developercommunity.visualstudio.com/t/Popup-v2-in-CommunityToolkitMaui-1200/10921966?viewtype=all&space=21&ftype=problem&sort=newest