Merge pull request #3038 from unoplatform/dev/mara/fix-dialog-nav

fix: close dialog and escape orphaned region on root navigation

Author: rajamatt

src/Uno.Extensions.Navigation.UI/Navigator.cs

@@ -399,6 +399,15 @@ await navAncestor.Navigator.CanNavigate(depRequest.Route))
 		// Required for Test: Given_PageNavigationRegistered.When_PageNavigationRegisteredRoot
 		if (request.Route.IsRoot())
 		{
+			// If we're inside a ClosableNavigator (dialog/flyout) whose region is not parented
+			// in the main region tree, delegate through CloseAndNavigateAsync so the request
+			// escapes to the navigator that opened the dialog.
+			if (Region.Parent is null && this is ClosableNavigator closable)
+			{
+				if (Logger.IsEnabled(LogLevel.Trace)) Logger.LogTraceMessage($"Closing closable navigator and redirecting root request via source");
+				return closable.CloseAndNavigateAsync(request);
+			}
+
 			if (Region.Parent?.Parent is null)
 			{
 				// If parent's Parent is null, then parent is the root

src/Uno.Extensions.Navigation.UI/Navigators/ClosableNavigator.cs

@@ -52,4 +52,10 @@ protected ClosableNavigator(ILogger logger, IDispatcher dispatcher, IRegion regi
 	/// </summary>
 	/// <returns>Task that can be awaited</returns>
 	protected abstract Task CloseNavigator();
+
+	/// <summary>
+	/// Closes the navigator without any subsequent navigation.
+	/// Used internally when navigating away from a page that has open dialogs/flyouts.
+	/// </summary>
+	internal Task ForceCloseAsync() => CloseNavigator();
 }

src/Uno.Extensions.Navigation.UI/Navigators/ContentControlNavigator.cs

@@ -60,6 +60,10 @@ protected override async Task<bool> RegionCanNavigate(Route route, RouteInfo? ro
 
 		try
 		{
+			// Close any active dialogs/flyouts before clearing children,
+			// otherwise they persist as overlays even after navigation
+			Region.CloseActiveClosableNavigators();
+
 			// Clear all child navigation regions
 			Region.Children.Clear();
 

src/Uno.Extensions.Navigation.UI/Navigators/ContentDialogNavigator.cs

@@ -86,5 +86,19 @@ services is null ||
 	}
 
 
+	protected override Task CloseNavigator()
+	{
+		var dialog = _activeDialog;
+		_activeDialog = null;
+
+		// Cancel the ShowTask before calling Hide() so the ContinueWith
+		// continuation sees a canceled task and skips the back-navigation.
+		var result = base.CloseNavigator();
+
+		dialog?.Hide();
+
+		return result;
+	}
+
 	protected override Task CheckLoadedAsync() => _activeDialog is not null ? _activeDialog.EnsureLoaded() : Task.CompletedTask;
 }

src/Uno.Extensions.Navigation.UI/Navigators/FrameNavigator.cs

@@ -104,6 +104,10 @@ viewType is null ||
 			childRoute = CaptureActiveChildRoute();
 		}
 
+		// Close any active dialogs/flyouts before clearing children,
+		// otherwise they persist as overlays even after navigation
+		Region.CloseActiveClosableNavigators();
+
 		// Detach all nested regions as we're moving away from the current view
 		Region.Children.Clear();
 

src/Uno.Extensions.Navigation.UI/Regions/RegionExtensions.cs

@@ -77,4 +77,25 @@ public static IEnumerable<IRegion> FindChildren(this IRegion region, Func<IRegio
 			}
 		}
 	}
+
+	/// <summary>
+	/// Closes any active closable navigators (ContentDialogs, MessageDialogs, Flyouts)
+	/// in the region's child hierarchy. This should be called before clearing children
+	/// when navigating away, to ensure overlays don't persist on screen.
+	/// </summary>
+	internal static void CloseActiveClosableNavigators(this IRegion region)
+	{
+		// Materialize to array first since closing may modify the children collection
+		var closableRegions = region.FindChildren(
+			r => r.Services?.GetService<INavigator>() is ClosableNavigator { CanGoBack: true }
+		).ToArray();
+
+		foreach (var childRegion in closableRegions)
+		{
+			if (childRegion.Services?.GetService<INavigator>() is ClosableNavigator closable)
+			{
+				_ = closable.ForceCloseAsync();
+			}
+		}
+	}
 }

testing/TestHarness/TestHarness.UITest/Ext/Navigation/TabBar/Given_TabBar_ClearBackStack.cs

@@ -124,4 +124,34 @@ public async Task When_StandardBack_From_Deep_Page()
 		var isTabTwoVisible = App.Marked("TabTwoSection").IsVisible();
 		isTabTwoVisible.Should().Be(true, "TabTwo section should be visible since we went back from Details");
 	}
+
+	/// <summary>
+	/// Test 6: Open a ContentDialog from the deep page, then navigate to /Root/Home
+	/// from inside the dialog. The dialog should be dismissed and we should end up
+	/// at the tabbed root.
+	/// Reproduces: ContentDialog not closed during root navigation
+	/// </summary>
+	[Test]
+	public async Task When_ContentDialog_Open_And_Navigate_Root()
+	{
+		NavigateToDetails();
+
+		// Open the ContentDialog
+		App.WaitThenTap("NavTest6ShowDialogButton");
+
+		// Wait for the dialog to appear
+		App.WaitElement("DialogContentText");
+		App.WaitElement("DialogNavToRootButton");
+
+		// Navigate to /Root/Home from inside the dialog
+		App.WaitThenTap("DialogNavToRootButton");
+
+		// The dialog should be dismissed and we should be at the tabbed root
+		AssertBackAtTabbedRoot();
+
+		// Verify the dialog is actually dismissed (not just hidden behind the root page).
+		// Use WaitForNoElement to allow time for the dialog overlay to be removed.
+		App.WaitForNoElement("DialogContentText", "ContentDialog content should be dismissed after navigating to root");
+		App.WaitForNoElement("DialogNavToRootButton", "ContentDialog button should be dismissed after navigating to root");
+	}
 }

testing/TestHarness/TestHarness/Ext/Navigation/TabBar/TabBarClearBackStack/TabBarClearBackStackDetailPage.xaml

@@ -70,6 +70,12 @@
 						uen:Navigation.Request="-"
 						HorizontalAlignment="Stretch" />
 
+				<!-- ContentDialog test: dialog should be closed by root navigation -->
+				<Button Content="6) Show Dialog (navigate from inside)"
+						AutomationProperties.AutomationId="NavTest6ShowDialogButton"
+						Click="NavTest6_Click"
+						HorizontalAlignment="Stretch" />
+
 				<TextBlock x:Name="StatusText"
 						   AutomationProperties.AutomationId="DetailStatusText"
 						   TextWrapping="Wrap"

testing/TestHarness/TestHarness/Ext/Navigation/TabBar/TabBarClearBackStack/TabBarClearBackStackDetailPage.xaml.cs

@@ -78,4 +78,19 @@ private async void NavTest5_Click(object sender, RoutedEventArgs e)
 		}
 	}
 
+	private async void NavTest6_Click(object sender, RoutedEventArgs e)
+	{
+		try
+		{
+			// Approach 6: open a ContentDialog, then navigate to root from inside it.
+			// The dialog should be dismissed automatically when root navigation occurs.
+			var nav = this.Navigator()!;
+			await nav.NavigateViewAsync<TabBarClearBackStackTestDialog>(this, Qualifiers.Dialog);
+		}
+		catch (Exception ex)
+		{
+			StatusText.Text = $"Test 6 failed: {ex.Message}";
+		}
+	}
+
 }

testing/TestHarness/TestHarness/Ext/Navigation/TabBar/TabBarClearBackStack/TabBarClearBackStackHostInit.cs

@@ -24,7 +24,9 @@ protected override void RegisterRoutes(IViewRegistry views, IRouteRegistry route
 			new ViewMap<TabBarClearBackStackTabTwoPage, TabBarClearBackStackTabTwoModel>(),
 			// Details uses ResultDataViewMap with data
 			new ResultDataViewMap<TabBarClearBackStackDetailPage, TabBarClearBackStackDetailModel, string>(
-				Data: new DataMap<string>())
+				Data: new DataMap<string>()),
+			// ContentDialog for testing dialog dismissal during root navigation
+			new ViewMap<TabBarClearBackStackTestDialog>()
 		);
 
 		// Route structure: