Turn Visual and Binding diags on EnableDiagnostics

StephaneDelcroix · StephaneDelcroix · commit b2393753db45 · 2025-07-04T12:08:08.000+02:00
more diagnostics to be plugged on this later - fixes #29809
diff --git a/src/Controls/src/Build.Tasks/nuget/buildTransitive/netstandard2.0/Microsoft.Maui.Controls.targets b/src/Controls/src/Build.Tasks/nuget/buildTransitive/netstandard2.0/Microsoft.Maui.Controls.targets
@@ -269,7 +269,10 @@
                                       Condition="'$(MauiHybridWebViewSupported)' != ''"
                                       Value="$(MauiHybridWebViewSupported)"
                                       Trim="true" />
+      <RuntimeHostConfigurationOption Include="Microsoft.Maui.RuntimeFeature.EnableDiagnostics"
+                                      Condition="'$(EnableDiagnostics)' != ''"
+                                      Value="$(EnableDiagnostics)"
+                                      Trim="true" />
     </ItemGroup>
   </Target>
-
 </Project>
diff --git a/src/Controls/src/Core/Xaml/Diagnostics/BindingDiagnostics.cs b/src/Controls/src/Core/Xaml/Diagnostics/BindingDiagnostics.cs
@@ -15,12 +15,16 @@ public class BindingDiagnostics
 
 		internal static void SendBindingFailure(BindingBase binding, string errorCode, string message, params object[] messageArgs)
 		{
+			if (RuntimeFeature.EnableDiagnostics == false)
+				return;
 			Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);
 			BindingFailed?.Invoke(null, new BindingBaseErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, errorCode, message, messageArgs));
 		}
 
 		internal static void SendBindingFailure(BindingBase binding, object source, BindableObject bo, BindableProperty bp, string errorCode, string message, params object[] messageArgs)
 		{
+			if (RuntimeFeature.EnableDiagnostics == false)
+				return;
 			Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);
 			BindingFailed?.Invoke(null, new BindingErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, source, bo, bp, errorCode, message, messageArgs));
 		}
diff --git a/src/Controls/tests/Xaml.UnitTests/BindingDiagnosticsTests.xaml.cs b/src/Controls/tests/Xaml.UnitTests/BindingDiagnosticsTests.xaml.cs
@@ -24,6 +24,21 @@ public BindingDiagnosticsTests(bool useCompiledXaml)
 #endif
 		public class Tests
 		{
+			bool enableDiagnosticsInitialState;
+			
+			[SetUp]
+			public void Setup()
+			{
+				enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+				RuntimeFeature.EnableDiagnostics = true;
+			}
+
+			[TearDown]
+			public void TearDown()
+			{
+				RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;			
+			}
+
 			[TestCase(false)]
 			//[TestCase(true)]
 			public void Test(bool useCompiledXaml)
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Gh10803.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Gh10803.xaml.cs
@@ -20,22 +20,22 @@ public Gh10803(bool useCompiledXaml)
 		[TestFixture]
 		class Tests
 		{
-			bool debuggerinitialstate;
+			bool enableDiagnosticsInitialState;
 			int failures = 0;
 
 			[SetUp]
 			public void Setup()
 			{
 				DispatcherProvider.SetCurrent(new DispatcherProviderStub());
 				VisualDiagnostics.VisualTreeChanged += VTChanged;
-				debuggerinitialstate = DebuggerHelper._mockDebuggerIsAttached;
-				DebuggerHelper._mockDebuggerIsAttached = true;
+				enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+				RuntimeFeature.EnableDiagnostics = true;
 			}
 
 			[TearDown]
 			public void TearDown()
 			{
-				DebuggerHelper._mockDebuggerIsAttached = debuggerinitialstate;
+				RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
 				DispatcherProvider.SetCurrent(null);
 				VisualDiagnostics.VisualTreeChanged -= VTChanged;
 				failures = 0;
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Gh11334.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Gh11334.xaml.cs
@@ -30,19 +30,19 @@ void Add(object sender, EventArgs e)
 		[TestFixture]
 		class Tests
 		{
-			bool _debuggerinitialstate;
+			bool enableDiagnosticsInitialState;
 
 			[SetUp]
 			public void Setup()
 			{
-				_debuggerinitialstate = DebuggerHelper._mockDebuggerIsAttached;
-				DebuggerHelper._mockDebuggerIsAttached = true;
+				enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+				RuntimeFeature.EnableDiagnostics = true;
 			}
 
 			[TearDown]
 			public void TearDown()
 			{
-				DebuggerHelper._mockDebuggerIsAttached = _debuggerinitialstate;
+				RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
 				VisualDiagnostics.VisualTreeChanged -= OnVTChanged;
 			}
 
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Gh11335.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Gh11335.xaml.cs
@@ -25,19 +25,19 @@ void Add(object sender, EventArgs e)
 		[TestFixture]
 		class Tests
 		{
-			bool _debuggerinitialstate;
+			bool enableDiagnosticsInitialState;
 
 			[SetUp]
 			public void Setup()
 			{
-				_debuggerinitialstate = DebuggerHelper._mockDebuggerIsAttached;
-				DebuggerHelper._mockDebuggerIsAttached = true;
+				enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+				RuntimeFeature.EnableDiagnostics = true;
 			}
 
 			[TearDown]
 			public void TearDown()
 			{
-				DebuggerHelper._mockDebuggerIsAttached = _debuggerinitialstate;
+				RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
 				VisualDiagnostics.VisualTreeChanged -= OnVTChanged;
 			}
 
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Maui17222.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Maui17222.xaml.cs
@@ -25,8 +25,22 @@ public Maui17222(bool useCompiledXaml)
 	class Test
 	{
 #if DEBUG
-		[SetUp] public void Setup() => AppInfo.SetCurrent(new MockAppInfo());
-		[TearDown] public void TearDown() => AppInfo.SetCurrent(null);
+		bool enableDiagnosticsInitialState;
+		
+		[SetUp]
+		public void Setup()
+		{
+			AppInfo.SetCurrent(new MockAppInfo());
+			enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+			RuntimeFeature.EnableDiagnostics = true;
+		}
+
+		[TearDown]
+		public void TearDown()
+		{
+			RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;			
+			AppInfo.SetCurrent(null);
+		}
 
 		[Test]
 		public void GetsourceInfo([Values(false)] bool useCompiledXaml)
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Maui2418.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Maui2418.xaml.cs
@@ -15,6 +15,21 @@ public Maui2418(bool useCompiledXaml)
 		[TestFixture]
 		class Tests
 		{
+			bool enableDiagnosticsInitialState;
+			
+			[SetUp]
+			public void Setup()
+			{
+				enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+				RuntimeFeature.EnableDiagnostics = true;
+			}
+
+			[TearDown]
+			public void TearDown()
+			{
+				RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;			
+			}
+
 			[Test]
 			public void SourceInfoIsRelative([Values(false)] bool useCompiledXaml)
 			{
diff --git a/src/Controls/tests/Xaml.UnitTests/Issues/Maui25608_2.xaml.cs b/src/Controls/tests/Xaml.UnitTests/Issues/Maui25608_2.xaml.cs
@@ -24,12 +24,16 @@ public Maui25608_2(bool useCompiledXaml)
 	class Test
 	{
 		EventHandler<BindingBaseErrorEventArgs> _bindingFailureHandler;
+		bool enableDiagnosticsInitialState;
+			
 
 		[SetUp]
 		public void Setup()
 		{
 			Application.SetCurrentApplication(new MockApplication());
 			DispatcherProvider.SetCurrent(new DispatcherProviderStub());
+			enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
+			RuntimeFeature.EnableDiagnostics = true;
 		}
 
 		[TearDown]
@@ -39,6 +43,7 @@ public void TearDown()
 			{
 				BindingDiagnostics.BindingFailed -= _bindingFailureHandler;
 			}
+			RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;			
 
 			AppInfo.SetCurrent(null);
 		}
diff --git a/src/Core/src/RuntimeFeature.cs b/src/Core/src/RuntimeFeature.cs
@@ -14,20 +14,21 @@ namespace Microsoft.Maui
 	/// </remarks>
 	internal static class RuntimeFeature
 	{
-		private const bool IsIVisualAssemblyScanningEnabledByDefault = false;
-		private const bool IsShellSearchResultsRendererDisplayMemberNameSupportedByDefault = true;
-		private const bool IsQueryPropertyAttributeSupportedByDefault = true;
-		private const bool IsImplicitCastOperatorsUsageViaReflectionSupportedByDefault = true;
-		private const bool AreBindingInterceptorsSupportedByDefault = true;
-		private const bool IsXamlCBindingWithSourceCompilationEnabledByDefault = false;
-		private const bool IsHybridWebViewSupportedByDefault = true;
+		const bool IsIVisualAssemblyScanningEnabledByDefault = false;
+		const bool IsShellSearchResultsRendererDisplayMemberNameSupportedByDefault = true;
+		const bool IsQueryPropertyAttributeSupportedByDefault = true;
+		const bool IsImplicitCastOperatorsUsageViaReflectionSupportedByDefault = true;
+		const bool AreBindingInterceptorsSupportedByDefault = true;
+		const bool IsXamlCBindingWithSourceCompilationEnabledByDefault = false;
+		const bool IsHybridWebViewSupportedByDefault = true;
+		const bool EnableDiagnosticsByDefault = false;
 
 #pragma warning disable IL4000 // Return value does not match FeatureGuardAttribute 'System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute'. 
 #if NET9_0_OR_GREATER
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsIVisualAssemblyScanningEnabled")]
 		[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
 #endif
-		internal static bool IsIVisualAssemblyScanningEnabled =>
+		public static bool IsIVisualAssemblyScanningEnabled =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsIVisualAssemblyScanningEnabled", out bool isEnabled)
 				? isEnabled
 				: IsIVisualAssemblyScanningEnabledByDefault;
@@ -36,7 +37,7 @@ internal static class RuntimeFeature
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsShellSearchResultsRendererDisplayMemberNameSupported")]
 		[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
 #endif
-		internal static bool IsShellSearchResultsRendererDisplayMemberNameSupported
+		public static bool IsShellSearchResultsRendererDisplayMemberNameSupported
 			=> AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsShellSearchResultsRendererDisplayMemberNameSupported", out bool isSupported)
 				? isSupported
 				: IsShellSearchResultsRendererDisplayMemberNameSupportedByDefault;
@@ -45,7 +46,7 @@ internal static bool IsShellSearchResultsRendererDisplayMemberNameSupported
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsQueryPropertyAttributeSupported")]
 		[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
 #endif
-		internal static bool IsQueryPropertyAttributeSupported =>
+		public static bool IsQueryPropertyAttributeSupported =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsQueryPropertyAttributeSupported", out bool isSupported)
 				? isSupported
 				: IsQueryPropertyAttributeSupportedByDefault;
@@ -54,23 +55,23 @@ internal static bool IsShellSearchResultsRendererDisplayMemberNameSupported
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsImplicitCastOperatorsUsageViaReflectionSupported")]
 		[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
 #endif
-		internal static bool IsImplicitCastOperatorsUsageViaReflectionSupported =>
+		public static bool IsImplicitCastOperatorsUsageViaReflectionSupported =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsImplicitCastOperatorsUsageViaReflectionSupported", out bool isSupported)
 				? isSupported
 				: IsImplicitCastOperatorsUsageViaReflectionSupportedByDefault;
 
 #if NET9_0_OR_GREATER
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.Microsoft.Maui.RuntimeFeature.AreBindingInterceptorsSupported")]
 #endif
-		internal static bool AreBindingInterceptorsSupported =>
+		public static bool AreBindingInterceptorsSupported =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.AreBindingInterceptorsSupported", out bool areSupported)
 				? areSupported
 				: AreBindingInterceptorsSupportedByDefault;
 
 #if NET9_0_OR_GREATER
 		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsXamlCBindingWithSourceCompilationEnabled")]
 #endif
-		internal static bool IsXamlCBindingWithSourceCompilationEnabled =>
+		public static bool IsXamlCBindingWithSourceCompilationEnabled =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsXamlCBindingWithSourceCompilationEnabled", out bool areSupported)
 				? areSupported
 				: IsXamlCBindingWithSourceCompilationEnabledByDefault;
@@ -80,10 +81,29 @@ internal static bool IsShellSearchResultsRendererDisplayMemberNameSupported
 		[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
 		[FeatureGuard(typeof(RequiresDynamicCodeAttribute))]
 #endif
-		internal static bool IsHybridWebViewSupported =>
+		public static bool IsHybridWebViewSupported =>
 			AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsHybridWebViewSupported", out bool isSupported)
 				? isSupported
 				: IsHybridWebViewSupportedByDefault;
+
+#if NET9_0_OR_GREATER
+		[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.EnableDiagnostics")]
+#endif
+		public static bool EnableDiagnostics
+		{
+			get
+			{
+				return AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.EnableDiagnostics", out bool isEnabled)
+				? isEnabled
+				: EnableDiagnosticsByDefault;
+			}
+			internal set
+			{
+				// This property is internal settable to allow tests to enable diagnostics.
+				// It should not be set in production code.
+				AppContext.SetSwitch("Microsoft.Maui.RuntimeFeature.EnableDiagnostics", value);
+			}
+		}
 #pragma warning restore IL4000
 	}
 }
diff --git a/src/Core/src/VisualDiagnostics/DebuggerHelper.cs b/src/Core/src/VisualDiagnostics/DebuggerHelper.cs
diff --git a/src/Core/src/VisualDiagnostics/VisualDiagnostics.cs b/src/Core/src/VisualDiagnostics/VisualDiagnostics.cs
@@ -18,7 +18,7 @@ public static class VisualDiagnostics
 		static ConditionalWeakTable<object, SourceInfo> sourceInfos = new ConditionalWeakTable<object, SourceInfo>();
 		static Lazy<bool> isVisualDiagnosticsEnvVarSet = new Lazy<bool>(() => Environment.GetEnvironmentVariable("ENABLE_XAML_DIAGNOSTICS_SOURCE_INFO") is { } value && value == "1");
 
-		static internal bool IsEnabled => DebuggerHelper.DebuggerIsAttached || isVisualDiagnosticsEnvVarSet.Value;
+		static internal bool IsEnabled => RuntimeFeature.EnableDiagnostics || isVisualDiagnosticsEnvVarSet.Value;
 
 		/// <summary>
 		/// Registers source file information (URI, line number, and position) for the specified target object when XAML diagnostics are enabled.

Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,16 @@ public class BindingDiagnostics`
`15`	`15`
`16`	`16`	`internal static void SendBindingFailure(BindingBase binding, string errorCode, string message, params object[] messageArgs)`
`17`	`17`	`{`
	`18`	`+ if (RuntimeFeature.EnableDiagnostics == false)`
	`19`	`+ return;`
`18`	`20`	`Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);`
`19`	`21`	`BindingFailed?.Invoke(null, new BindingBaseErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, errorCode, message, messageArgs));`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`internal static void SendBindingFailure(BindingBase binding, object source, BindableObject bo, BindableProperty bp, string errorCode, string message, params object[] messageArgs)`
`23`	`25`	`{`
	`26`	`+ if (RuntimeFeature.EnableDiagnostics == false)`
	`27`	`+ return;`
`24`	`28`	`Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);`
`25`	`29`	`BindingFailed?.Invoke(null, new BindingErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, source, bo, bp, errorCode, message, messageArgs));`
`26`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,19 +30,19 @@ void Add(object sender, EventArgs e)`
`30`	`30`	`[TestFixture]`
`31`	`31`	`class Tests`
`32`	`32`	`{`
`33`		`- bool _debuggerinitialstate;`
	`33`	`+ bool enableDiagnosticsInitialState;`
`34`	`34`
`35`	`35`	`[SetUp]`
`36`	`36`	`public void Setup()`
`37`	`37`	`{`
`38`		`- _debuggerinitialstate = DebuggerHelper._mockDebuggerIsAttached;`
`39`		`- DebuggerHelper._mockDebuggerIsAttached = true;`
	`38`	`+ enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;`
	`39`	`+ RuntimeFeature.EnableDiagnostics = true;`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`[TearDown]`
`43`	`43`	`public void TearDown()`
`44`	`44`	`{`
`45`		`- DebuggerHelper._mockDebuggerIsAttached = _debuggerinitialstate;`
	`45`	`+ RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;`
`46`	`46`	`VisualDiagnostics.VisualTreeChanged -= OnVTChanged;`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -25,19 +25,19 @@ void Add(object sender, EventArgs e)`
`25`	`25`	`[TestFixture]`
`26`	`26`	`class Tests`
`27`	`27`	`{`
`28`		`- bool _debuggerinitialstate;`
	`28`	`+ bool enableDiagnosticsInitialState;`
`29`	`29`
`30`	`30`	`[SetUp]`
`31`	`31`	`public void Setup()`
`32`	`32`	`{`
`33`		`- _debuggerinitialstate = DebuggerHelper._mockDebuggerIsAttached;`
`34`		`- DebuggerHelper._mockDebuggerIsAttached = true;`
	`33`	`+ enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;`
	`34`	`+ RuntimeFeature.EnableDiagnostics = true;`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`[TearDown]`
`38`	`38`	`public void TearDown()`
`39`	`39`	`{`
`40`		`- DebuggerHelper._mockDebuggerIsAttached = _debuggerinitialstate;`
	`40`	`+ RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;`
`41`	`41`	`VisualDiagnostics.VisualTreeChanged -= OnVTChanged;`
`42`	`42`	`}`
`43`	`43`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,16 @@ public Maui25608_2(bool useCompiledXaml)`
`24`	`24`	`class Test`
`25`	`25`	`{`
`26`	`26`	`EventHandler<BindingBaseErrorEventArgs> _bindingFailureHandler;`
	`27`	`+ bool enableDiagnosticsInitialState;`
	`28`	`+`
`27`	`29`
`28`	`30`	`[SetUp]`
`29`	`31`	`public void Setup()`
`30`	`32`	`{`
`31`	`33`	`Application.SetCurrentApplication(new MockApplication());`
`32`	`34`	`DispatcherProvider.SetCurrent(new DispatcherProviderStub());`
	`35`	`+ enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;`
	`36`	`+ RuntimeFeature.EnableDiagnostics = true;`
`33`	`37`	`}`
`34`	`38`
`35`	`39`	`[TearDown]`
`@@ -39,6 +43,7 @@ public void TearDown()`
`39`	`43`	`{`
`40`	`44`	`BindingDiagnostics.BindingFailed -= _bindingFailureHandler;`
`41`	`45`	`}`
	`46`	`+ RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;`
`42`	`47`
`43`	`48`	`AppInfo.SetCurrent(null);`
`44`	`49`	`}`