Closing a modal navigation page with physical Escape key corrupts the navigation stack

[filipnavara]

Description

iOS modal pages with NavigationPage can be closed by the physical Escape key (tested in iOS Simulator). Once that is done, no other modal page is presented since the navigation stack ends up in inconsistent state.

Video:
https://github.com/dotnet/maui/assets/1764393/ed05543c-b263-4180-a6a6-80b111ec0be8

Steps to Reproduce

1. Push a new NavigationPage to the modal stack
2. Close the page by pressing the physical Escape key
3. Try to push a new NavigationPage to the modal stack, observe it fails

Link to public reproduction project repository

https://github.com/filipnavara/maui-dark-mode-ios-bug

Version with bug

8.0.61 SR6.1

Is this a regression from previous behavior?

Not sure, did not test other versions

Last version that worked well

Unknown/Other

Affected platforms

iOS

Affected platform versions

iOS 17.5

Did you find any workaround?

No response

Relevant log output

No response

[github-actions]

Hi I'm an AI powered bot that finds similar issues based off the issue title.

Please view the issues below to see if they solve your problem, and if the issue describes your problem please consider closing this one and thumbs upping the other issue to help us prioritize it. Thank you!

Open similar issues:

• iOS | Navigating to a modal page under a different tab broken (#11430), similarity score: 0.74
• [Bug] ModalStack is broken (PushModalAsync, PopModalAsync [Android]) (#11270), similarity score: 0.74

Closed similar issues:

• [Bug] ModalStack is broken (PushModalAsync, PopModalAsync [Android]) (Remove Page [All Platform]) (#10543), similarity score: 0.75
• [regression/8.0.3] [iOS] PushModalAsync navigation doesn't navigate (#19225), similarity score: 0.74
• iOS PopModalAsync causes memory leaks (#21453), similarity score: 0.74

Note: You can give me feedback by thumbs upping or thumbs downing this comment.

[filipnavara]

Nasty workaround:

We already had an overridden navigation renderer with some additional functionality (class ExtendedNavigationPageRenderer : Microsoft.Maui.Controls.Handlers.Compatibility.NavigationRenderer).

I added AddKeyCommand(UIKeyCommand.Create(UIKeyCommand.Escape, 0, new Selector("closeModalPopup"))); to the constructor to intercept the Escape key.

It uses a pre-existing CloseModalPopup method with selector that we already had in there:

		[Export("closeModalPopup")]
		public async void CloseModalPopup()
		{
			if (closeButton != null)
			{
				closeButton = null;
				ParentViewController.PresentationController.WeakDelegate = null;
				await Element.Navigation.PopModalAsync();
			}
		}

[RoiChen001]

I can repro this issue at iOS platform on the latest 17.11.0 Preview 2.1 (8.0.61).