[Android] Fix Flickering issue when calling Navigation.PopAsync #24887

devanathan-vaithiyanathan · 2024-09-24T07:30:47Z

Root Cause

The flickering during navigation occurred because, when performing PopAsync, the removed page’s handlers were set to null. This caused flickering as the navigation was processed.

Description of Change

The fix involves avoiding the removal of page handlers during PopAsync, which eliminates the flickering issue during navigation.

Issues Fixed

Fixes #13810

Validated the behaviour in the following platforms

Android
Windows
iOS
Mac

Output Screenshot

Before

366413807-f0592d6d-6b89-48b0-bab8-eed46d20336c.mp4

After

366413828-b47e24f4-68f0-44a0-b1bf-ed8dd24d1dcf.mp4

rmarinho · 2024-09-24T11:08:31Z

/azp run

azure-pipelines · 2024-09-24T11:08:50Z

Azure Pipelines successfully started running 3 pipeline(s).

rmarinho

Seems is making the Windows Device tests fail , I run few times and got same results. Maybe this is causing some side effects on Windows. But maybe also rebase just to make sure branch is updated with latest .

PureWeen · 2024-09-25T01:48:09Z

/rebase

PureWeen · 2024-09-25T01:48:54Z

/azp run

azure-pipelines · 2024-09-25T01:49:13Z

Azure Pipelines successfully started running 3 pipeline(s).

…han/maui into fix-13810

azure-pipelines · 2024-09-30T07:33:23Z

Azure Pipelines successfully started running 3 pipeline(s).

PureWeen

It looks like the device tests on windows are crashing.

On CI you can check the logs here to see where it's crashing

jsuarezruiz · 2024-10-04T09:38:40Z

It looks like the device tests on windows are crashing.

On CI you can check the logs here to see where it's crashing

This is the failing test NavigatedFiresAfterSwitchingFlyoutItems.

at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IContentPresenterMethods.set_Content(IObjectReference _obj, Object value)
   at Microsoft.UI.Xaml.Controls.ContentPresenter.set_Content(Object value)
   at Microsoft.Maui.Platform.StackNavigationManager.OnNavigated(Object sender, NavigationEventArgs e)
   at WinRT._EventSource_global__Microsoft_UI_Xaml_Navigation_NavigatedEventHandler.EventState.<GetEventInvoke>b__1_0(Object sender, NavigationEventArgs e)
   at ABI.Microsoft.UI.Xaml.Navigation.NavigatedEventHandler.Do_Abi_Invoke(IntPtr thisPtr, IntPtr sender, IntPtr e)
--- End of stack trace from previous location ---
   at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IFrameMethods.GoBack(IObjectReference _obj, NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.UI.Xaml.Controls.Frame.GoBack(NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.Maui.Platform.StackNavigationManager.NavigateTo(NavigationRequest args)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.RequestNavigation(ShellSectionHandler handler, IStackNavigation view, Object arg3)
   at Microsoft.Maui.CommandMapper`2.<>c__DisplayClass6_0.<Add>b__0(IElementHandler h, IElement v, Object o)
   at Microsoft.Maui.CommandMapper.InvokeCore(String key, IElementHandler viewHandler, IElement virtualView, Object args)
   at Microsoft.Maui.CommandMapper.Invoke(IElementHandler viewHandler, IElement virtualView, String property, Object args)
   at Microsoft.Maui.Handlers.ElementHandler.Invoke(String command, Object args)
   at Microsoft.Maui.Controls.ShellSection.Microsoft.Maui.IStackNavigation.RequestNavigation(NavigationRequest eventArgs)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.SyncNavigationStack(Boolean animated, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.OnNavigationRequested(Object sender, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.ShellSection.InvokeNavigationRequest(NavigationRequestedEventArgs args)
   at Microsoft.Maui.Controls.ShellSection.OnPopAsync(Boolean animated)
   at Microsoft.Maui.Controls.ShellSection.GoToAsync(ShellNavigationRequest request, ShellRouteParameters queryData, IServiceProvider services, Nullable`1 animate, Boolean isRelativePopping)
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Controls.ShellNavigationManager.GoToAsync(ShellNavigationParameters shellNavigationParameters, ShellNavigationRequest navigationRequest)
   at Microsoft.Maui.DeviceTests.ShellTests.<>c__DisplayClass32_0.<<NavigatedFiresAfterSwitchingFlyoutItems>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_1`1.<<CreateHandlerAndAddToWindow>b__1>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_0`1.<<CreateHandlerAndAddToWindow>

devanathan-vaithiyanathan · 2024-10-11T08:40:06Z

It looks like the device tests on windows are crashing.
On CI you can check the logs here to see where it's crashing

This is the failing test NavigatedFiresAfterSwitchingFlyoutItems.

at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IContentPresenterMethods.set_Content(IObjectReference _obj, Object value)
   at Microsoft.UI.Xaml.Controls.ContentPresenter.set_Content(Object value)
   at Microsoft.Maui.Platform.StackNavigationManager.OnNavigated(Object sender, NavigationEventArgs e)
   at WinRT._EventSource_global__Microsoft_UI_Xaml_Navigation_NavigatedEventHandler.EventState.<GetEventInvoke>b__1_0(Object sender, NavigationEventArgs e)
   at ABI.Microsoft.UI.Xaml.Navigation.NavigatedEventHandler.Do_Abi_Invoke(IntPtr thisPtr, IntPtr sender, IntPtr e)
--- End of stack trace from previous location ---
   at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IFrameMethods.GoBack(IObjectReference _obj, NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.UI.Xaml.Controls.Frame.GoBack(NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.Maui.Platform.StackNavigationManager.NavigateTo(NavigationRequest args)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.RequestNavigation(ShellSectionHandler handler, IStackNavigation view, Object arg3)
   at Microsoft.Maui.CommandMapper`2.<>c__DisplayClass6_0.<Add>b__0(IElementHandler h, IElement v, Object o)
   at Microsoft.Maui.CommandMapper.InvokeCore(String key, IElementHandler viewHandler, IElement virtualView, Object args)
   at Microsoft.Maui.CommandMapper.Invoke(IElementHandler viewHandler, IElement virtualView, String property, Object args)
   at Microsoft.Maui.Handlers.ElementHandler.Invoke(String command, Object args)
   at Microsoft.Maui.Controls.ShellSection.Microsoft.Maui.IStackNavigation.RequestNavigation(NavigationRequest eventArgs)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.SyncNavigationStack(Boolean animated, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.OnNavigationRequested(Object sender, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.ShellSection.InvokeNavigationRequest(NavigationRequestedEventArgs args)
   at Microsoft.Maui.Controls.ShellSection.OnPopAsync(Boolean animated)
   at Microsoft.Maui.Controls.ShellSection.GoToAsync(ShellNavigationRequest request, ShellRouteParameters queryData, IServiceProvider services, Nullable`1 animate, Boolean isRelativePopping)
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Controls.ShellNavigationManager.GoToAsync(ShellNavigationParameters shellNavigationParameters, ShellNavigationRequest navigationRequest)
   at Microsoft.Maui.DeviceTests.ShellTests.<>c__DisplayClass32_0.<<NavigatedFiresAfterSwitchingFlyoutItems>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_1`1.<<CreateHandlerAndAddToWindow>b__1>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_0`1.<<CreateHandlerAndAddToWindow>

We'll run the DeviceTests using NET9 and provide an update.

ygl-rg · 2024-10-17T09:02:59Z

will this ptach be merged into dotnet 8 maui?

jfversluis · 2024-10-18T09:01:33Z

@ygl-rg I think at this point with .NET 9 being close to being released this will be .NET 9 only

devanathan-vaithiyanathan · 2024-10-23T09:26:39Z

It looks like the device tests on windows are crashing.
On CI you can check the logs here to see where it's crashing

This is the failing test NavigatedFiresAfterSwitchingFlyoutItems.

at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IContentPresenterMethods.set_Content(IObjectReference _obj, Object value)
   at Microsoft.UI.Xaml.Controls.ContentPresenter.set_Content(Object value)
   at Microsoft.Maui.Platform.StackNavigationManager.OnNavigated(Object sender, NavigationEventArgs e)
   at WinRT._EventSource_global__Microsoft_UI_Xaml_Navigation_NavigatedEventHandler.EventState.<GetEventInvoke>b__1_0(Object sender, NavigationEventArgs e)
   at ABI.Microsoft.UI.Xaml.Navigation.NavigatedEventHandler.Do_Abi_Invoke(IntPtr thisPtr, IntPtr sender, IntPtr e)
--- End of stack trace from previous location ---
   at WinRT.ExceptionHelpers.<ThrowExceptionForHR>g__Throw|39_0(Int32 hr)
   at ABI.Microsoft.UI.Xaml.Controls.IFrameMethods.GoBack(IObjectReference _obj, NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.UI.Xaml.Controls.Frame.GoBack(NavigationTransitionInfo transitionInfoOverride)
   at Microsoft.Maui.Platform.StackNavigationManager.NavigateTo(NavigationRequest args)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.RequestNavigation(ShellSectionHandler handler, IStackNavigation view, Object arg3)
   at Microsoft.Maui.CommandMapper`2.<>c__DisplayClass6_0.<Add>b__0(IElementHandler h, IElement v, Object o)
   at Microsoft.Maui.CommandMapper.InvokeCore(String key, IElementHandler viewHandler, IElement virtualView, Object args)
   at Microsoft.Maui.CommandMapper.Invoke(IElementHandler viewHandler, IElement virtualView, String property, Object args)
   at Microsoft.Maui.Handlers.ElementHandler.Invoke(String command, Object args)
   at Microsoft.Maui.Controls.ShellSection.Microsoft.Maui.IStackNavigation.RequestNavigation(NavigationRequest eventArgs)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.SyncNavigationStack(Boolean animated, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.Handlers.ShellSectionHandler.OnNavigationRequested(Object sender, NavigationRequestedEventArgs e)
   at Microsoft.Maui.Controls.ShellSection.InvokeNavigationRequest(NavigationRequestedEventArgs args)
   at Microsoft.Maui.Controls.ShellSection.OnPopAsync(Boolean animated)
   at Microsoft.Maui.Controls.ShellSection.GoToAsync(ShellNavigationRequest request, ShellRouteParameters queryData, IServiceProvider services, Nullable`1 animate, Boolean isRelativePopping)
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Controls.ShellNavigationManager.GoToAsync(ShellNavigationParameters shellNavigationParameters, ShellNavigationRequest navigationRequest)
   at Microsoft.Maui.DeviceTests.ShellTests.<>c__DisplayClass32_0.<<NavigatedFiresAfterSwitchingFlyoutItems>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_1`1.<<CreateHandlerAndAddToWindow>b__1>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass30_0`1.<<SetupWindowForTests>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass3_0.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.Dispatching.DispatcherExtensions.<>c__DisplayClass2_0`1.<<DispatchAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.Maui.DeviceTests.ControlsHandlerTestBase.<>c__DisplayClass16_0`1.<<CreateHandlerAndAddToWindow>

We'll run the DeviceTests using NET9 and provide an update.

I ran the device tests using the latest MAUI source with our fix and confirmed that the mentioned test passed successfully. Let me know if you have any concerns.

devanathan-vaithiyanathan · 2024-10-25T12:05:06Z

/rebase

jsuarezruiz · 2024-10-25T15:41:34Z

/azp run

azure-pipelines · 2024-10-25T15:41:56Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz

There is a device test failing related with pop navigating.

jsuarezruiz

Could review the failing test?

devanathan-vaithiyanathan · 2024-10-29T13:40:56Z

Could review the failing test?

I reviewed the failing test case by running it on our machine, and it seems to be running fine.

PureWeen

Can you move the PoppingFlyoutPageDoesntCrash test to Appium from the Device Tests?

Vignesh-SF3580 · 2024-11-05T11:38:28Z

Can you move the PoppingFlyoutPageDoesntCrash test to Appium from the Device Tests?

I have moved the specified test case to Appium. Could you please review it and let me know if you have any concerns?

jsuarezruiz · 2024-11-05T12:05:46Z

/azp run

azure-pipelines · 2024-11-05T12:06:08Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2024-11-06T10:27:49Z

/azp run

azure-pipelines · 2024-11-06T10:28:10Z

Azure Pipelines successfully started running 3 pipeline(s).

changes added

16c0e0d

devanathan-vaithiyanathan changed the title ~~changes added~~ [Android] Fix Flickering issue when calling Navigation.PopAsync Sep 24, 2024

dotnet-policy-service bot added the community ✨ Community Contribution label Sep 24, 2024

devanathan-vaithiyanathan marked this pull request as ready for review September 24, 2024 07:50

devanathan-vaithiyanathan requested a review from a team as a code owner September 24, 2024 07:50

devanathan-vaithiyanathan requested review from mattleibow and rmarinho September 24, 2024 07:50

rmarinho approved these changes Sep 24, 2024

View reviewed changes

rmarinho self-requested a review September 24, 2024 18:04

rmarinho requested changes Sep 24, 2024

View reviewed changes

changes added

22d7398

github-actions bot force-pushed the fix-13810 branch from 16c0e0d to 22d7398 Compare September 25, 2024 01:48

Merge branch 'fix-13810' of https://github.com/devanathan-vaithiyanat…

4e1c926

…han/maui into fix-13810

PureWeen requested changes Oct 3, 2024

View reviewed changes

devanathan-vaithiyanathan changed the base branch from net9.0 to main October 22, 2024 09:30

jsuarezruiz reviewed Oct 29, 2024

View reviewed changes

jsuarezruiz requested changes Oct 29, 2024

View reviewed changes

PureWeen added this to the .NET 9 Servicing milestone Oct 31, 2024

PureWeen requested changes Nov 4, 2024

View reviewed changes

UI Testcases added

4632a2d

Attached screenshots

226352e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Android] Fix Flickering issue when calling Navigation.PopAsync #24887

[Android] Fix Flickering issue when calling Navigation.PopAsync #24887

devanathan-vaithiyanathan commented Sep 24, 2024 •

edited

Loading

rmarinho commented Sep 24, 2024

azure-pipelines bot commented Sep 24, 2024

rmarinho left a comment •

edited

Loading

PureWeen commented Sep 25, 2024

PureWeen commented Sep 25, 2024 •

edited by jfversluis

Loading

azure-pipelines bot commented Sep 25, 2024

azure-pipelines bot commented Sep 30, 2024

PureWeen left a comment

jsuarezruiz commented Oct 4, 2024

devanathan-vaithiyanathan commented Oct 11, 2024

ygl-rg commented Oct 17, 2024

jfversluis commented Oct 18, 2024

devanathan-vaithiyanathan commented Oct 23, 2024

devanathan-vaithiyanathan commented Oct 25, 2024

jsuarezruiz commented Oct 25, 2024

azure-pipelines bot commented Oct 25, 2024

jsuarezruiz left a comment

jsuarezruiz left a comment

devanathan-vaithiyanathan commented Oct 29, 2024

PureWeen left a comment

Vignesh-SF3580 commented Nov 5, 2024

jsuarezruiz commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

jsuarezruiz commented Nov 6, 2024

azure-pipelines bot commented Nov 6, 2024

[Android] Fix Flickering issue when calling Navigation.PopAsync #24887

Are you sure you want to change the base?

[Android] Fix Flickering issue when calling Navigation.PopAsync #24887

Conversation

devanathan-vaithiyanathan commented Sep 24, 2024 • edited Loading

Root Cause

Description of Change

Issues Fixed

Validated the behaviour in the following platforms

Output Screenshot

rmarinho commented Sep 24, 2024

azure-pipelines bot commented Sep 24, 2024

rmarinho left a comment • edited Loading

Choose a reason for hiding this comment

PureWeen commented Sep 25, 2024

PureWeen commented Sep 25, 2024 • edited by jfversluis Loading

azure-pipelines bot commented Sep 25, 2024

azure-pipelines bot commented Sep 30, 2024

PureWeen left a comment

Choose a reason for hiding this comment

jsuarezruiz commented Oct 4, 2024

devanathan-vaithiyanathan commented Oct 11, 2024

ygl-rg commented Oct 17, 2024

jfversluis commented Oct 18, 2024

devanathan-vaithiyanathan commented Oct 23, 2024

devanathan-vaithiyanathan commented Oct 25, 2024

jsuarezruiz commented Oct 25, 2024

azure-pipelines bot commented Oct 25, 2024

jsuarezruiz left a comment

Choose a reason for hiding this comment

jsuarezruiz left a comment

Choose a reason for hiding this comment

devanathan-vaithiyanathan commented Oct 29, 2024

PureWeen left a comment

Choose a reason for hiding this comment

Vignesh-SF3580 commented Nov 5, 2024

jsuarezruiz commented Nov 5, 2024

azure-pipelines bot commented Nov 5, 2024

jsuarezruiz commented Nov 6, 2024

azure-pipelines bot commented Nov 6, 2024

devanathan-vaithiyanathan commented Sep 24, 2024 •

edited

Loading

rmarinho left a comment •

edited

Loading

PureWeen commented Sep 25, 2024 •

edited by jfversluis

Loading