KEMBAR78
Fixed the RealParent Warning shown issue by Ahamed-Ali · Pull Request #30156 · dotnet/maui · GitHub
Skip to content

Conversation

@Ahamed-Ali
Copy link
Contributor

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 from this PR and let us know in a comment if this change resolves your issue. Thank you!

Root Cause of the issue

  • When navigating from a first page (with a button) to a second page containing controls like Image, Label, or Border, a warning occurs if properties such as StrokeShape, Image.Source, or Label.FormattedText are bound to values from a ViewModel that was implemented as a static (singleton) instance.

For example, if a StrokeShape is created and stored statically, it is instantiated only once during the first navigation. On subsequent navigations, the same instance is reused. Since elements like StrokeShape maintain a reference to their previous parent, reusing the same instance causes conflicts and triggers warnings due to improper parent-child relationships.

Description of Change

  • Accesses RealParent in a safe way to prevent warnings from occurring when the parent has already been removed or collected.

Issues Fixed

Fixes #23050

Tested the behaviour in the following platforms

  • Android
  • Windows
  • iOS
  • Mac

Screenshot

Before Issue Fix After Issue Fix
WithWarnings.mov
NoWarnings.mov

@dotnet-policy-service
Copy link
Contributor

Hey there @@Ahamed-Ali! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@dotnet-policy-service dotnet-policy-service bot added community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration labels Jun 24, 2025
@Ahamed-Ali Ahamed-Ali marked this pull request as ready for review June 24, 2025 07:52
@Copilot Copilot AI review requested due to automatic review settings June 24, 2025 07:52
@Ahamed-Ali Ahamed-Ali requested a review from a team as a code owner June 24, 2025 07:52
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes warnings caused by reusing element instances across navigation by safely accessing RealParent and avoiding invalid parent references.

  • Introduces GetRealParent method with optional warning suppression
  • Encapsulates and preserves the public RealParent API via the new method
  • Updates SetParent to use the non-logging parent lookup
Comments suppressed due to low confidence (1)

src/Controls/src/Core/Element/Element.cs:335

  • Add unit tests to cover GetRealParent behavior in both warning and non-warning modes, ensuring that old parents are handled correctly and no warnings are emitted when suppressed.
		WeakReference<Element> _realParent;

if (_parentOverride == null)
{
OnParentChangingCore(Parent, value);
OnParentChangingCore(ParentOverride ?? GetRealParent(false), value);
Copy link

Copilot AI Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of calling GetRealParent(false) again, reuse the realParent local variable for the previous parent to avoid redundant method calls and ensure consistent state.

Suggested change
OnParentChangingCore(ParentOverride ?? GetRealParent(false), value);
OnParentChangingCore(ParentOverride ?? realParent, value);

Copilot uses AI. Check for mistakes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optimized the fix based on suggestion


return null;
}
if (_realParent.TryGetTarget(out var parent))
Copy link
Contributor

@MartyIX MartyIX Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it the safest to store

var realParent = _realParent;
if (realParent is null) { return null;}
if (...) 
...

?

I believe that if (_realParent.TryGetTarget(out var parent)) can still lead to NRE because _realParent can become null at any moment.

@PureWeen PureWeen added this to the .NET 9 SR9 milestone Jun 24, 2025
@PureWeen PureWeen added the p/0 Work that we can't release without label Jun 24, 2025
@github-project-automation github-project-automation bot moved this from Todo to Changes Requested in MAUI SDK Ongoing Jun 27, 2025
Copilot AI added a commit that referenced this pull request Jun 28, 2025
Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
Copilot AI added a commit that referenced this pull request Jun 28, 2025
…ase on PR #30156 with improvements

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
Copilot AI added a commit that referenced this pull request Jun 28, 2025
…0156 with enhancements

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
Copy link
Member

@PureWeen PureWeen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you review the changes here as well #30291 and see if the test is relevant.
Just pull over whatever changes seem correct into this PR

Copilot made a good point about nulling out the weakref as well since that's going to lead to repetative logging messages when retrieving the parent

@Ahamed-Ali
Copy link
Contributor Author

Can you review the changes here as well #30291 and see if the test is relevant. Just pull over whatever changes seem correct into this PR

Copilot made a good point about nulling out the weakref as well since that's going to lead to repetative logging messages when retrieving the parent

I have included the valid changes from the Copilot PR into this PR, specifically addressing the clearing of the weak reference when the target object has been collected.

Additionally, I have included the tests from the Copilot PR. While the test passes both with and without the fix—since the warning issue, based on investigation, occurs in a static element during random multiple navigations—the test is still valid for verifying the RealParent. Therefore, I have included it. @PureWeen

@PureWeen PureWeen changed the base branch from main to inflight/current July 2, 2025 16:15
@PureWeen PureWeen merged commit 249a31d into dotnet:inflight/current Jul 2, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from Changes Requested to Done in MAUI SDK Ongoing Jul 2, 2025
github-actions bot pushed a commit that referenced this pull request Jul 2, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
github-actions bot pushed a commit that referenced this pull request Jul 8, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
github-actions bot pushed a commit that referenced this pull request Jul 9, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
PureWeen pushed a commit that referenced this pull request Jul 10, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
PureWeen pushed a commit that referenced this pull request Jul 15, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
PureWeen pushed a commit that referenced this pull request Jul 17, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
github-actions bot pushed a commit that referenced this pull request Jul 25, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
github-actions bot pushed a commit that referenced this pull request Jul 31, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
rmarinho pushed a commit that referenced this pull request Aug 1, 2025
* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Remove .NET 8 specific code for templates (#30342)

* [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* fix added

* fix updated

* [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069)

* fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens.

* fix-22045- Set the contentview frame value when the FlyoutView layout change.

* fix-22045- Changes committed.

* Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874)

* otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime
  (even if it is not strictly required)

* Fixed the RealParent Warning shown issue (#30156)

* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly

* [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940)

* Re-evaluate indexpaths in PerformBatchUpdates

* Add UI test

* update test

* bring back null check

* add a check to see if ItemsSource is disposed

* [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926)

* Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment.

* Included test case for Vertical StackLayout

* Updated label content

* [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028)

* [Windows] Fixed CanvasDrawingSession Exception

* Update in description label

* Updated Suggested Changes

* [Testing] Feature matrix UITest Cases for ScrollView Control (#30188)

* Added Feature Matrix for ScrollView

* Updated changes

* Changes updated

* Modified the test cases

* Modified UI

* Added snapshots

* Added images

* Modified Test Case

* Added images

* Resaved images

* [Testing] Feature Matrix UITest Cases for TimePicker Control  (#30271)

* modified UI and test cases

* updated test cases

* added new test cases

* updated test cases

* added android and iOS snapshots

* updated format

* updated flow direction code

* added mac and windows snapshots

* updated iOS snapshots

* [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307)

* Disconnect context flyout handler

* Update MenuFlyoutHandler.iOS.cs

* Fix for TapGestureRecognizer ButtonMask always return 0 (#30372)

* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase

* fix extention typo (#30461)

* fix some incorrect casting using `as` (#30459)

if the type is known then a direct cast should be used instead of an as.
since, in the case where the assumption is wrong, then it is better to
get a cast exception instead of a null ref exception.

basically if code uses `as` and does not check for null when that
variable is used, then it is likely problematic code.

* [Testing] Feature Matrix UITest Cases for SearchBar Control  (#30398)

* added test cases

* added snapshots

* comment added

* snapshot added

* changed method name

* [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159)

* added test cases

* added new test cases

* removed test cases

* updated test cases

* updated test cases

* changes in test case

* added new event

* updated test cases

* added culture test cases

* added snapshots

* added the failing condition

* modified test case

* added new test case code

* added mac and windows snapshots

* [create-pull-request] automated change (#30591)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
# Conflicts:
#	src/Compatibility/Core/src/Tizen/Forms.cs

* [Testing] Add UITest for Issue30147 on iOS (#30506)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* test case added

* test sample modified

* test sample updated

* affected platform changed

* sample changes added

* [Android] Fix for Search Handler visual and functional bug in subtabs (#30467)

* fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones.

* fix-21119-Testcase and test snapshot added.

* fix-21119-Updated code changes. Also added Mac and Windows snapshots.

* [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353)

* Fixed the masked text issue of same value pasted into the textbox field

* Added the test for verifying the masked text

* [create-pull-request] automated change (#30700)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False  (#30755)

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False

* Updated PlatformTouchGraphicsView

* Updated test sample

* Fix duplicate app icon resizing (#30920)

Possibly helps with #30900

* Addressed the feedbacks

* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Addressed the feedbacks

---------

Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com>
Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com>
Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com>
Co-authored-by: Janus Weil <janus@gcc.gnu.org>
Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com>
Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com>
Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com>
Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com>
Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com>
Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com>
Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com>
Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com>
Co-authored-by: Simon Cropp <simon.cropp@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Shane Neuville <shneuvil@microsoft.com>
Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
PureWeen added a commit that referenced this pull request Aug 1, 2025
* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Remove .NET 8 specific code for templates (#30342)

* [Catalyst] Fix Scrollbar does not align with FlowDirection change in ScrollView (#30241)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* fix added

* fix updated

* [Android] Fix for OnSizeAllocated is not reported for Android AppShell Flyout content. (#30069)

* fix-22045 - Made changes on Android ShellFlyout sizing by adding OnDrawerOpened event and updating Content so OnSizeAllocated is called with correct values when drawer opens.

* fix-22045- Set the contentview frame value when the FlyoutView layout change.

* fix-22045- Changes committed.

* Permissions (BT & WiFi): don't add AccessFineLocation to required permissions if NeverForLocation flag is present (#20874)

* otherwise the permission-status will be 'denied' if AccessFineLocation is in the manifest, but denied at runtime
  (even if it is not strictly required)

* Fixed the RealParent Warning shown issue (#30156)

* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly

* [iOS/MacCatalyst] Fix: Setting SelectedItem Programmatically and Then Immediately Setting ItemsSource to Null Causes a Crash (#29940)

* Re-evaluate indexpaths in PerformBatchUpdates

* Add UI test

* update test

* bring back null check

* add a check to see if ItemsSource is disposed

* [Windows] Fixed StackLayout crashes on Windows with HeightRequest as 0 (#29926)

* Fixed StackLayout crashes on Windows with HeightRequest 0, padding, and opposing alignment.

* Included test case for Vertical StackLayout

* Updated label content

* [Windows] Fixed CanvasDrawingSession Exception on Clipping Image (#30028)

* [Windows] Fixed CanvasDrawingSession Exception

* Update in description label

* Updated Suggested Changes

* [Testing] Feature matrix UITest Cases for ScrollView Control (#30188)

* Added Feature Matrix for ScrollView

* Updated changes

* Changes updated

* Modified the test cases

* Modified UI

* Added snapshots

* Added images

* Modified Test Case

* Added images

* Resaved images

* [Testing] Feature Matrix UITest Cases for TimePicker Control  (#30271)

* modified UI and test cases

* updated test cases

* added new test cases

* updated test cases

* added android and iOS snapshots

* updated format

* updated flow direction code

* added mac and windows snapshots

* updated iOS snapshots

* [Catalyst] Adding and Removing ContextMenus currently does not work - fix (#30307)

* Disconnect context flyout handler

* Update MenuFlyoutHandler.iOS.cs

* Fix for TapGestureRecognizer ButtonMask always return 0 (#30372)

* Fix for TapGesture ButtonMask

* Added TestCase

* Update Testcase

* Modified Testcase

* fix extention typo (#30461)

* fix some incorrect casting using `as` (#30459)

if the type is known then a direct cast should be used instead of an as.
since, in the case where the assumption is wrong, then it is better to
get a cast exception instead of a null ref exception.

basically if code uses `as` and does not check for null when that
variable is used, then it is likely problematic code.

* [Testing] Feature Matrix UITest Cases for SearchBar Control  (#30398)

* added test cases

* added snapshots

* comment added

* snapshot added

* changed method name

* [Testing] Feature Matrix UITest Cases for DatePicker Control (#30159)

* added test cases

* added new test cases

* removed test cases

* updated test cases

* updated test cases

* changes in test case

* added new event

* updated test cases

* added culture test cases

* added snapshots

* added the failing condition

* modified test case

* added new test case code

* added mac and windows snapshots

* [create-pull-request] automated change (#30591)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
# Conflicts:
#	src/Compatibility/Core/src/Tizen/Forms.cs

* [Testing] Add UITest for Issue30147 on iOS (#30506)

* fix added

* Revert "fix added"

This reverts commit 138797f.

* test case added

* test sample modified

* test sample updated

* affected platform changed

* sample changes added

* [Android] Fix for Search Handler visual and functional bug in subtabs (#30467)

* fix-21119-Made changes to ShellToolbarTracker.cs to prevent search handler stacking on Android Shell tab navigation by removing existing menu items before adding new ones.

* fix-21119-Testcase and test snapshot added.

* fix-21119-Updated code changes. Also added Mac and Windows snapshots.

* [Windows] Fixed the Pasted Password Becomes Visible When IsPassword Is Enabled (#30353)

* Fixed the masked text issue of same value pasted into the textbox field

* Added the test for verifying the masked text

* [create-pull-request] automated change (#30700)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False  (#30755)

* Fixed GraphicsView event handlers are triggered even when IsEnabled is set to False

* Updated PlatformTouchGraphicsView

* Updated test sample

* Fix duplicate app icon resizing (#30920)

Possibly helps with #30900

* Addressed the feedbacks

* Added sample for GraphicsView

* Added the feature matrix code

* Added the test cases for the GraphicsView

* Updated the GraphicsViewFeaturetests

* Updated the GraphicsViewViewModel

* Addressed the feedbacks

* Added the snapshots for Mac and Windows

* Addressed the feedbacks

---------

Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com>
Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com>
Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com>
Co-authored-by: Janus Weil <janus@gcc.gnu.org>
Co-authored-by: Ahamed-Ali <102580874+Ahamed-Ali@users.noreply.github.com>
Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com>
Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com>
Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com>
Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com>
Co-authored-by: TamilarasanSF4853 <tamilarasan.velu@syncfusion.com>
Co-authored-by: Jakub Florkowski <42434498+kubaflo@users.noreply.github.com>
Co-authored-by: HarishwaranVijayakumar <harishwaran.vijayakumar@syncfusion.com>
Co-authored-by: Simon Cropp <simon.cropp@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Shane Neuville <shneuvil@microsoft.com>
Co-authored-by: Jeremy Powell <47993233+jeremy-visionaid@users.noreply.github.com>
PureWeen pushed a commit that referenced this pull request Aug 1, 2025
* Safe Get of RealParent to avoid warnings

* Optimized the fix

* Make it as default private

* Optimized the fix

* Modified the fix and added test

* Modified the fix based on concern and added test

* unwanted spacing

* Replaced the Parent property directly
@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2025
@PureWeen PureWeen added the area-architecture Issues with code structure, SDK structure, implementation details label Sep 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-architecture Issues with code structure, SDK structure, implementation details community ✨ Community Contribution p/0 Work that we can't release without partner/syncfusion Issues / PR's with Syncfusion collaboration

Projects

Status: Done

4 participants