[iOS] Fixed NavigationStack not updating when OnAppearing is invoked #28666

Vignesh-SF3580 · 2025-03-27T10:36:01Z

Issue Detail

The NavigationStack was not updated when OnAppearing was invoked.

Root Cause

The OnAppearing event was triggered before the popped page was removed from the stack in the RemoveAsyncInner method. This method is triggered on iOS when popping pages.

Description of Change

Triggering the OnAppearing event after updating the stack resolves the issue.

Tested the behavior in the following platforms

Android
Windows
iOS
Mac

Issues Fixed

Fixes #28414

Screenshots

Before Issue Fix	After Issue Fix
28414Before.mov	28414After.mov

jsuarezruiz · 2025-03-27T10:48:15Z

/azp run

azure-pipelines · 2025-03-27T10:48:37Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull Request Overview

This PR fixes an issue where the NavigationStack was not correctly updated on iOS when the OnAppearing event was triggered. The changes include:

Reordering the FireAppearing call in NavigationPage.Legacy.cs to occur after the page is removed from the stack.
Adding corresponding tests in both TestCases.Shared.Tests and TestCases.HostApp to verify the updated navigation behavior.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue28414.cs	Adds a test verifying the NavigationStack count after a page pop.
src/Controls/tests/TestCases.HostApp/Issues/Issue28414.cs	Sets up pages and navigation steps to validate the OnAppearing behavior.
src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs	Adjusts the logic for firing the OnAppearing event after removing a page.

src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs

bhavanesh2001

Seems MemortyTests which use PopAsync() have failed and some other related UITests are also failed

System.ArgumentOutOfRangeException : Index was out of range. Must be non-negative and less than the size of the collection. (Parameter 'index')

More info...

Vignesh-SF3580 · 2025-04-02T10:34:06Z

Seems MemortyTests which use PopAsync() have failed and some other related UITests are also failed
```cs System.ArgumentOutOfRangeException : Index was out of range. Must be non-negative and less than the size of the collection. (Parameter 'index') ```
More info...

@bhavanesh2001 I have updated the code changes to resolve the test case failures.

jsuarezruiz · 2025-04-10T07:28:27Z

/azp run

azure-pipelines · 2025-04-10T07:28:49Z

Azure Pipelines successfully started running 3 pipeline(s).

MitchBomcanhao · 2025-04-11T07:43:25Z

build seems a bit stuck?

MitchBomcanhao · 2025-04-16T13:15:26Z

this needs re-running as the pipeline agents got disconnected

MitchBomcanhao · 2025-04-21T08:21:41Z

nobody? @jsuarezruiz

MitchBomcanhao · 2025-04-22T07:45:23Z

@rmarinho ?

bhavanesh2001 · 2025-04-22T08:52:26Z

@MitchBomcanhao I think the pipelines will be run if someone reviewing this feels it’s necessary. It's possible the team is currently busy with other PRs.

MitchBomcanhao · 2025-04-22T09:34:29Z

they tried to run it once and it hasn't worked. they've been ignoring it since... the build agent failed, the build needs to be triggered again. it isn't much effort for someone to stop this and trigger it again. nobody is that busy. this PR possibly fixes an important issue for us and to see it be ignored is quite disconcerting.

src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs

azure-pipelines · 2025-07-01T06:31:59Z

Azure Pipelines successfully started running 1 pipeline(s).

MitchBomcanhao · 2025-07-11T09:25:34Z

bump

MitchBomcanhao · 2025-07-17T11:13:17Z

nobody?

MitchBomcanhao · 2025-07-25T11:35:37Z

bump

MitchBomcanhao · 2025-08-12T12:23:18Z

hello?

PureWeen · 2025-08-15T23:21:57Z

/rebase

…hen the OnAppearing method is called

Changes Made

PureWeen

Can you change this to use a unit test vs a UITest? Since this is all xplat code we should be able to reproduce inside a test

…28666) * Fixed - 28414 : iOS] Popping a page includes in the NavigationStack when the OnAppearing method is called * updated NavigationPage.Legacy.cs * Updated NavigationPage.Legacy.cs

> [!NOTE] > Are you waiting for the changes in this PR to be merged? > It would be very helpful if you could [test the resulting artifacts](https://github.com/dotnet/maui/wiki/Testing-PR-Builds) from this PR and let us know in a comment if this change resolves your issue. Thank you! ### Issue Details In the failed test `AppDoesntCrashWhenSettingNewTitleViewOnExistingPage`, the TitleView was updated in the OnAppearing method. When popping the page using PopAsync, the OnAppearing event is triggered twice with my fix, whereas previously it was triggered only once: once from [FireAppearing](https://github.com/dotnet/maui/blob/b2c3452f68298f407ca18f8fe9e0f8841e7c9cad/src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs#L67) and once from [CurrentPageChanged](https://github.com/dotnet/maui/blob/b2c3452f68298f407ca18f8fe9e0f8841e7c9cad/src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs#L70). This additional trigger causes the title to mismatch the expected value, resulting in the test failure. ### Root Cause The fix moves FireAppearing to after RemoveFromInnerChildren(page), but at that point InternalChildren.Last() has already changed. Currently, StackDepth - 2 is calculated based on the original stack depth. Once the popped page is removed from stack, accessing InternalChildren[StackDepth - 2] is not valid. ### Description of Change Remove the page first, then use InternalChildren.Last(); directly to get the correct page that should appear. Regressed PR: #28666 Fixes AppDoesntCrashWhenSettingNewTitleViewOnExistingPage test failure in PR: #31327 ### Screenshots <img width="540" height="300" alt="image" src="https://github.com/user-attachments/assets/9dfaed05-0b66-489b-9b81-9a285088cc96" /> <img width="540" height="300" alt="image" src="https://github.com/user-attachments/assets/81626605-6567-4a30-b183-d26513d5f60c" /> <img width="540" height="300" alt="image" src="https://github.com/user-attachments/assets/260ca192-4baa-45e2-9991-8abcdadb2961" />

…28666) * Fixed - 28414 : iOS] Popping a page includes in the NavigationStack when the OnAppearing method is called * updated NavigationPage.Legacy.cs * Updated NavigationPage.Legacy.cs

dotnet-policy-service bot added community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration labels Mar 27, 2025

jsuarezruiz added platform/ios area-navigation NavigationPage labels Mar 27, 2025

Vignesh-SF3580 marked this pull request as ready for review March 28, 2025 13:41

Copilot AI review requested due to automatic review settings March 28, 2025 13:41

Vignesh-SF3580 requested a review from a team as a code owner March 28, 2025 13:41

Vignesh-SF3580 requested review from mattleibow and rmarinho March 28, 2025 13:41

Copilot AI reviewed Mar 28, 2025

View reviewed changes

src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs Show resolved Hide resolved

bhavanesh2001 suggested changes Apr 1, 2025

View reviewed changes

rmarinho added this to the .NET 9 SR7 milestone Apr 11, 2025

rmarinho added this to MAUI SDK Ongoing Apr 11, 2025

github-project-automation bot moved this to Todo in MAUI SDK Ongoing Apr 11, 2025

rmarinho moved this from Todo to Ready To Review in MAUI SDK Ongoing Apr 11, 2025

jsuarezruiz previously requested changes Apr 23, 2025

View reviewed changes

src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs Show resolved Hide resolved

github-project-automation bot moved this from Ready To Review to Changes Requested in MAUI SDK Ongoing Apr 23, 2025

karthikraja-arumugam moved this from Changes Requested to Ready To Review in MAUI SDK Ongoing Apr 23, 2025

karthikraja-arumugam moved this from Ready To Review to Changes Requested in MAUI SDK Ongoing Apr 23, 2025

PureWeen modified the milestones: .NET 9 SR9, .NET 9 SR10 Jul 3, 2025

PureWeen modified the milestones: .NET 9 SR10, .NET 9 SR12 Aug 4, 2025

Vignesh-SF3580 and others added 3 commits August 15, 2025 23:22

Fixed - 28414 : iOS] Popping a page includes in the NavigationStack w…

63b6712

…hen the OnAppearing method is called

updated NavigationPage.Legacy.cs

f4d6f24

Updated NavigationPage.Legacy.cs

d78db48

github-actions bot force-pushed the fix-28414 branch from 6fd89dd to d78db48 Compare August 15, 2025 23:22

PureWeen requested a review from jsuarezruiz August 20, 2025 18:58

PureWeen changed the base branch from main to inflight/current August 20, 2025 18:59

PureWeen approved these changes Aug 20, 2025

View reviewed changes

github-project-automation bot moved this from Changes Requested to Approved in MAUI SDK Ongoing Aug 20, 2025

PureWeen merged commit 39efbe3 into dotnet:inflight/current Aug 20, 2025
1 check passed

github-project-automation bot moved this from Approved to Done in MAUI SDK Ongoing Aug 20, 2025

PureWeen modified the milestones: .NET 9 SR12, .NET 9 SR11 Aug 20, 2025

Vignesh-SF3580 mentioned this pull request Aug 28, 2025

Fixed Test case failure in PR 31327 #31378

Merged

github-actions bot locked and limited conversation to collaborators Sep 20, 2025

[iOS] Fixed NavigationStack not updating when OnAppearing is invoked #28666

[iOS] Fixed NavigationStack not updating when OnAppearing is invoked #28666

Uh oh!

Conversation

Vignesh-SF3580 commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Detail

Root Cause

Description of Change

Tested the behavior in the following platforms

Issues Fixed

Screenshots

Uh oh!

jsuarezruiz commented Mar 27, 2025

Uh oh!

azure-pipelines bot commented Mar 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

bhavanesh2001 left a comment

Choose a reason for hiding this comment

Uh oh!

Vignesh-SF3580 commented Apr 2, 2025

Uh oh!

jsuarezruiz commented Apr 10, 2025

Uh oh!

azure-pipelines bot commented Apr 10, 2025

Uh oh!

MitchBomcanhao commented Apr 11, 2025

Uh oh!

MitchBomcanhao commented Apr 16, 2025

Uh oh!

MitchBomcanhao commented Apr 21, 2025

Uh oh!

MitchBomcanhao commented Apr 22, 2025

Uh oh!

bhavanesh2001 commented Apr 22, 2025

Uh oh!

MitchBomcanhao commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

azure-pipelines bot commented Jul 1, 2025

Uh oh!

MitchBomcanhao commented Jul 11, 2025

Uh oh!

MitchBomcanhao commented Jul 17, 2025

Uh oh!

MitchBomcanhao commented Jul 25, 2025

Uh oh!

MitchBomcanhao commented Aug 12, 2025

Uh oh!

PureWeen commented Aug 15, 2025

Uh oh!

PureWeen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Vignesh-SF3580 commented Mar 27, 2025 •

edited

Loading

MitchBomcanhao commented Apr 22, 2025 •

edited

Loading