[XC] add IRootObjectProvider #28310

StephaneDelcroix · 2025-03-11T14:21:52Z

Description of Change

[XC] add IRootObjectProvider

this was never meant to be public, but it is. and people are using it

Issues Fixed

fixes MarkupExtension: IRootObjectProvider not available in release mode #16881

Copilot

Pull Request Overview

This PR introduces the IRootObjectProvider into several components to address its unintended public exposure and to properly handle XAML type resolution and IL generation.

Integrates IRootObjectProvider into XAML service provider classes.
Updates array type resolution logic in XamlCache.cs.
Adjusts test cases and IL generation in NodeILExtensions.cs to verify and support the new provider.

Reviewed Changes

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

File	Description
src/Controls/src/Build.Tasks/XamlCache.cs	Enhanced GetOrAddTypeReference to handle array types.
src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml.cs	Modified test output and attributes to validate changes for IRootObjectProvider.
src/Controls/src/Xaml/XamlServiceProvider.cs	Extended SimpleValueTargetProvider to implement IRootObjectProvider.
src/Controls/src/Build.Tasks/NodeILExtensions.cs	Updated IL generation to load and register the root object and IRootObjectProvider.

Comments suppressed due to low confidence (4)

src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml.cs:25

Ensure that the dynamic string content for IRootObjectProvider remains consistent and expected, especially if type names might vary across different contexts.

services.Add($"IRootObjectProvider({((IRootObjectProvider)serviceProvider.GetService(typeof(IRootObjectProvider))).RootObject.GetType().Name})")

src/Controls/tests/Xaml.UnitTests/ServiceProviderTests.xaml.cs:71

Verify that the revised test attribute setup ([Test] with [Values]) adequately covers the intended test cases, as the change from [TestCase(true)] might affect test variations.

[Test] public void TestServiceProviders([Values]bool useCompiledXaml)

src/Controls/src/Build.Tasks/NodeILExtensions.cs:649

Ensure that context.Root reliably returns a VariableDefinition or FieldReference; otherwise, the IL generation will fall back to loading null, which might lead to unintended behavior.

if (context.Root is VariableDefinition rootVariable)

src/Controls/src/Build.Tasks/NodeILExtensions.cs:684

Confirm that duplicating the serviceProvider on the stack does not inadvertently affect the instruction order or subsequent IL operations, potentially leading to runtime issues.

yield return Create(Dup); //Keep the serviceProvider on the stack

Copilot · 2025-03-11T14:23:38Z

src/Controls/src/Xaml/XamlServiceProvider.cs

@@ -135,10 +135,11 @@ public ValueTargetProvider(object targetObject, object targetProperty)
 	}
 #nullable restore

-	public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider
+	public class SimpleValueTargetProvider : IProvideParentValues, IProvideValueTarget, IReferenceProvider, IRootObjectProvider


Adding IRootObjectProvider to a public class constitutes a breaking change in the public API; please ensure that this change is well-documented and validated in downstream usage.

this was never meant to be public, but it was. and people are using it - fixes #16881

StephaneDelcroix · 2025-03-13T07:57:36Z

src/Controls/src/Build.Tasks/XamlCache.cs

@@ -38,8 +39,13 @@ public TypeDefinition Resolve(TypeReference typeReference) =>
 	public FieldReference GetOrAddFieldReference((ModuleDefinition module, string fieldRefKey) key, Func<(ModuleDefinition module, string fieldRefKey), FieldReference> valueFactory) =>
 		GetOrAdd(_fieldReferenceCache, key, valueFactory);

-	public TypeReference GetOrAddTypeReference(ModuleDefinition module, (string assemblyName, string clrNamespace, string typeName) type) =>
-		GetOrAdd(_typeReferenceCache, (module, type.ToString()), x => x.module.ImportReference(x.module.GetTypeDefinition(this, type)));
+	public TypeReference GetOrAddTypeReference(ModuleDefinition module, (string assemblyName, string clrNamespace, string typeName) type) => GetOrAdd(_typeReferenceCache, (module, type.ToString()), x =>


this allows specifying [] in the string tuple for type, so we can pick a methodreference with the right parameters if some of them are arrays

StephaneDelcroix · 2025-03-13T07:58:41Z

src/Controls/src/Xaml/XamlServiceProvider.cs

@@ -147,7 +148,13 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert
 		{
 		}

+		[Obsolete("Use the other ctor")]


we need to keep this around, like the other one, to make code compiled with a previous version of XamlC to keep working

StephaneDelcroix · 2025-03-13T08:00:26Z

src/Controls/src/Build.Tasks/NodeILExtensions.cs

+					}
+					else
+						yield return Create(Ldnull);
+


the runtime cost of passing an extra parameter that doesn't need to be evaluated is negligible

jsuarezruiz · 2025-03-28T13:04:43Z

src/Controls/src/Xaml/PublicAPI/net-android/PublicAPI.Unshipped.txt

@@ -8,3 +8,5 @@ Microsoft.Maui.Controls.Embedding.EmbeddingExtensions
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider
 Microsoft.Maui.Controls.Xaml.Internals.ValueTargetProvider.ValueTargetProvider(object! targetObject, object! targetProperty) -> void
 Microsoft.Maui.Controls.Xaml.ResourceDictionaryHelpers
+~Microsoft.Maui.Controls.Xaml.Internals.SimpleValueTargetProvider.RootObject.get -> object


Is not modifying the publicAPI shipped files, so, is fine to include it in a SR?

jsuarezruiz · 2025-03-28T13:07:18Z

src/Controls/src/Build.Tasks/XamlCache.cs

-		GetOrAdd(_typeReferenceCache, (module, type.ToString()), x => x.module.ImportReference(x.module.GetTypeDefinition(this, type)));
+	public TypeReference GetOrAddTypeReference(ModuleDefinition module, (string assemblyName, string clrNamespace, string typeName) type) => GetOrAdd(_typeReferenceCache, (module, type.ToString()), x =>
+	{
+		if (type.typeName.EndsWith("[]"))


While type.typeName.EndsWith("[]") works, EndsWith internally traverses the string. Not sure if we have types with less than 2 characters but, consider checking its length first:

if (type.typeName.Length >= 2 && type.typeName.EndsWith("[]"))

this happens at compile time, max once per type (as we cache the results), so I won't even bother profiling the potential gain with the 26^2 (a bit more) existing names of length 2 :)

jsuarezruiz · 2025-03-28T13:10:58Z

src/Controls/src/Xaml/XamlServiceProvider.cs

@@ -147,7 +148,13 @@ public SimpleValueTargetProvider(object[] objectAndParents, object targetPropert
 		{
 		}

+		[Obsolete("Use the other ctor")]


Just try to add more details about the suggested alternative:
[Obsolete("This constructor is deprecated. Use the SimpleValueTargetProvider constructor with INameScope[] scopes and object rootObject instead.")]

this is only used by generated code, so the obsolete message should never show up

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes #16881 * ignore case

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes dotnet#16881 * ignore case

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes #16881 * ignore case

@albyrock87

### Description of Change ## .NET MAUI Release Notes - Inflight/Candidate ## What's Changed ### MAUI Product Fixes * Fix CarouselView layout SR6 regressions by @albyrock87 in #29035 * Revert "[Android] picker - focus/unfocus events (#28122)" by @PureWeen in https://github.com/dotnet/maui/pull/1fb5164929 * [Windows] Fixed the flyout content width not being set correctly after updating to WinUI SDK 1.7 by @Tamilarasan-Paranthaman in #28996 * [Android] picker - focus/unfocus events by @kubaflo in #28122 * [XC] add IRootObjectProvider by @StephaneDelcroix in #28310 * [iOS] Fix for the File.ContentType from MediaPicker not being in valid MIME format by @SyedAbdulAzeemSF4852 in #28842 * [Android] Fixed the Incorrect Text Color Applied to Selected Tab in TabbedPage by @Ahamed-Ali in #28844 * [iOS] Fix FlyoutPage does not respond to changes in the FlyoutLayoutBehavior property by @devanathan-vaithiyanathan in #28884 * [Android] Fixed ScalingCanvas.SetBlur not working by @NirmalKumarYuvaraj in #28911 * [iOS] - Resolved Proper Rendering of Dynamic Header/Footer Updates in CV2 by @prakashKannanSf3972 in #28641 * [iOS] Fixed the TargetInvocationException Occurs When Selecting Header/Footer After Changing ItemsLayout in CV2 by @Ahamed-Ali in #28890 * [Windows] - Fix Visual State Issue with Picker TextColor After Navigation by @prakashKannanSf3972 in #28746 ### Dependency Updates * [Windows] Upgrade to Windows App SDK 1.7 by @MartyIX in #28499 ### Testing * [Testing] Feature Matrix UITest Cases for CollectionView EmptyView Feature by @NafeelaNazhir in #28679 * Fixed Test case failure in PR 29037 - [2025/04/21] Candidate by @HarishKumarSF4517 in #29049 **Full Changelog**: main...inflight/candidate For more information about inflight process check https://github.com/dotnet/maui/wiki/Inflight-Branch-Process

Copilot AI review requested due to automatic review settings March 11, 2025 14:21

StephaneDelcroix requested a review from a team as a code owner March 11, 2025 14:21

StephaneDelcroix requested review from rmarinho and jsuarezruiz March 11, 2025 14:21

Copilot AI reviewed Mar 11, 2025

View reviewed changes

[XC] add IRootObjectProvider

379525a

this was never meant to be public, but it was. and people are using it - fixes #16881

StephaneDelcroix force-pushed the fix_16881 branch from 406d683 to 379525a Compare March 11, 2025 15:59

SirJohnK mentioned this pull request Mar 21, 2025

MarkupExtension: IRootObjectProvider not available in release mode #16881

Closed

StephaneDelcroix commented Mar 21, 2025

View reviewed changes

jfversluis added the area-xaml XAML, CSS, Triggers, Behaviors label Mar 25, 2025

jsuarezruiz reviewed Mar 28, 2025

View reviewed changes

ignore case

3f6610a

jfversluis approved these changes Apr 10, 2025

View reviewed changes

jfversluis added this to the .NET 9 SR7 milestone Apr 10, 2025

PureWeen changed the base branch from main to inflight/current April 11, 2025 15:44

PureWeen merged commit 0fdb9ff into inflight/current Apr 11, 2025
126 of 128 checks passed

PureWeen deleted the fix_16881 branch April 11, 2025 15:44

PureWeen pushed a commit that referenced this pull request Apr 16, 2025

[XC] add IRootObjectProvider (#28310)

57f7f4d

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes #16881 * ignore case

sheiksyedm pushed a commit to sheiksyedm/maui that referenced this pull request Apr 17, 2025

[XC] add IRootObjectProvider (dotnet#28310)

4b4f53e

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes dotnet#16881 * ignore case

github-actions bot pushed a commit that referenced this pull request Apr 18, 2025

[XC] add IRootObjectProvider (#28310)

dd0929e

* [XC] add IRootObjectProvider this was never meant to be public, but it was. and people are using it - fixes #16881 * ignore case

PureWeen mentioned this pull request Apr 22, 2025

[2025/04/21] Candidate - In Flight Branch #29037

Merged

github-actions bot locked and limited conversation to collaborators May 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[XC] add IRootObjectProvider #28310

[XC] add IRootObjectProvider #28310

Uh oh!

StephaneDelcroix commented Mar 11, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 11, 2025

Uh oh!

StephaneDelcroix Mar 13, 2025

Uh oh!

StephaneDelcroix Mar 13, 2025

Uh oh!

StephaneDelcroix Mar 13, 2025

Uh oh!

jsuarezruiz Mar 28, 2025

Uh oh!

jsuarezruiz Mar 28, 2025

Uh oh!

StephaneDelcroix Mar 28, 2025 •

edited

Loading

Uh oh!

jsuarezruiz Mar 28, 2025

Uh oh!

StephaneDelcroix Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

[XC] add IRootObjectProvider #28310

[XC] add IRootObjectProvider #28310

Uh oh!

Conversation

StephaneDelcroix commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Issues Fixed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

StephaneDelcroix Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

StephaneDelcroix Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

StephaneDelcroix Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

StephaneDelcroix Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

StephaneDelcroix Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

StephaneDelcroix commented Mar 11, 2025 •

edited

Loading

StephaneDelcroix Mar 28, 2025 •

edited

Loading