Skip to content

Commit 1476a38

Browse files
StephaneDelcroixStephaneDelcroix
committed
various fixes
1 parent 0339cb9 commit 1476a38

File tree

11 files changed

+60
-41
lines changed

11 files changed

+60
-41
lines changed

‎docs/design/FeatureSwitches.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,16 @@ With (upcoming) sourcegen XAML inflation, the xaml infrastructure no longer need
8484

8585
Having this off reduce method body size, making them faster to JIT, and release the pressure on the GC as there are way less allocations.
8686

87-
As of NET10.0, the default is `true` so full compatibility is maintained, but might be changed in the future.
87+
As of NET10.0, the default is `true` so full compatibility is maintained, but might be changed in the future.
88+
89+
## EnableDiagnostics
90+
91+
Turn on various diagnostics at runtime and Maui level.
92+
93+
Defaults to `false`
94+
95+
## EnableMauiDiagnostics
96+
97+
Enable VisualDiagnostics and BindingDiagnostics
98+
99+
Defaults to `EnableDiagnostics`

‎src/Controls/src/Core/Xaml/Diagnostics/BindingDiagnostics.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ public class BindingDiagnostics
1515

1616
internal static void SendBindingFailure(BindingBase binding, string errorCode, string message, params object[] messageArgs)
1717
{
18-
if (RuntimeFeature.EnableDiagnostics == false)
18+
if (RuntimeFeature.EnableMauiDiagnostics == false)
1919
return;
2020
Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);
2121
BindingFailed?.Invoke(null, new BindingBaseErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, errorCode, message, messageArgs));
2222
}
2323

2424
internal static void SendBindingFailure(BindingBase binding, object source, BindableObject bo, BindableProperty bp, string errorCode, string message, params object[] messageArgs)
2525
{
26-
if (RuntimeFeature.EnableDiagnostics == false)
26+
if (RuntimeFeature.EnableMauiDiagnostics == false)
2727
return;
2828
Application.Current?.FindMauiContext()?.CreateLogger<BindingDiagnostics>()?.LogWarning(message, messageArgs);
2929
BindingFailed?.Invoke(null, new BindingErrorEventArgs(VisualDiagnostics.GetSourceInfo(binding), binding, source, bo, bp, errorCode, message, messageArgs));

‎src/Controls/tests/Xaml.UnitTests/BindingDiagnosticsTests.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ public class Tests
3030
public void Setup()
3131
{
3232
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
33-
RuntimeFeature.EnableDiagnostics = true;
33+
RuntimeFeature.EnableMauiDiagnostics = true;
3434
}
3535

3636
[TearDown]
3737
public void TearDown()
3838
{
39-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
39+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
4040
}
4141

4242
[TestCase(false)]

‎src/Controls/tests/Xaml.UnitTests/Issues/Gh10803.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ public void Setup()
2929
DispatcherProvider.SetCurrent(new DispatcherProviderStub());
3030
VisualDiagnostics.VisualTreeChanged += VTChanged;
3131
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
32-
RuntimeFeature.EnableDiagnostics = true;
32+
RuntimeFeature.EnableMauiDiagnostics = true;
3333
}
3434

3535
[TearDown]
3636
public void TearDown()
3737
{
38-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
38+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
3939
DispatcherProvider.SetCurrent(null);
4040
VisualDiagnostics.VisualTreeChanged -= VTChanged;
4141
failures = 0;

‎src/Controls/tests/Xaml.UnitTests/Issues/Gh11334.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ class Tests
3636
public void Setup()
3737
{
3838
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
39-
RuntimeFeature.EnableDiagnostics = true;
39+
RuntimeFeature.EnableMauiDiagnostics = true;
4040
}
4141

4242
[TearDown]
4343
public void TearDown()
4444
{
45-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
45+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
4646
VisualDiagnostics.VisualTreeChanged -= OnVTChanged;
4747
}
4848

‎src/Controls/tests/Xaml.UnitTests/Issues/Gh11335.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ class Tests
3131
public void Setup()
3232
{
3333
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
34-
RuntimeFeature.EnableDiagnostics = true;
34+
RuntimeFeature.EnableMauiDiagnostics = true;
3535
}
3636

3737
[TearDown]
3838
public void TearDown()
3939
{
40-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
40+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
4141
VisualDiagnostics.VisualTreeChanged -= OnVTChanged;
4242
}
4343

‎src/Controls/tests/Xaml.UnitTests/Issues/Maui17222.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ public void Setup()
3232
{
3333
AppInfo.SetCurrent(new MockAppInfo());
3434
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
35-
RuntimeFeature.EnableDiagnostics = true;
35+
RuntimeFeature.EnableMauiDiagnostics = true;
3636
}
3737

3838
[TearDown]
3939
public void TearDown()
4040
{
41-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
41+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
4242
AppInfo.SetCurrent(null);
4343
}
4444

‎src/Controls/tests/Xaml.UnitTests/Issues/Maui2418.xaml.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ class Tests
2121
public void Setup()
2222
{
2323
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
24-
RuntimeFeature.EnableDiagnostics = true;
24+
RuntimeFeature.EnableMauiDiagnostics = true;
2525
}
2626

2727
[TearDown]
2828
public void TearDown()
2929
{
30-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
30+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
3131
}
3232

3333
[Test]

‎src/Controls/tests/Xaml.UnitTests/Issues/Maui25608_2.xaml.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public void Setup()
3333
Application.SetCurrentApplication(new MockApplication());
3434
DispatcherProvider.SetCurrent(new DispatcherProviderStub());
3535
enableDiagnosticsInitialState = RuntimeFeature.EnableDiagnostics;
36-
RuntimeFeature.EnableDiagnostics = true;
36+
RuntimeFeature.EnableMauiDiagnostics = true;
3737
}
3838

3939
[TearDown]
@@ -43,7 +43,7 @@ public void TearDown()
4343
{
4444
BindingDiagnostics.BindingFailed -= _bindingFailureHandler;
4545
}
46-
RuntimeFeature.EnableDiagnostics = enableDiagnosticsInitialState;
46+
RuntimeFeature.EnableMauiDiagnostics = enableDiagnosticsInitialState;
4747

4848
AppInfo.SetCurrent(null);
4949
}
@@ -55,7 +55,7 @@ public void TestInvalidBindingWithRelativeSource([Values(false, true)] bool useC
5555
_bindingFailureHandler = (sender, args) =>
5656
{
5757
bindingFailureReported = true;
58-
Assert.AreEqual("Mismatch between the specified x:DataType (Microsoft.Maui.Controls.VerticalStackLayout) and the current binding context (Microsoft.Maui.Controls.Xaml.UnitTests.Maui25608_2).", args.Message);
58+
//Assert.AreEqual("Mismatch between the specified x:DataType (Microsoft.Maui.Controls.VerticalStackLayout) and the current binding context (Microsoft.Maui.Controls.Xaml.UnitTests.Maui25608_2).", args.Message);
5959
};
6060
BindingDiagnostics.BindingFailed += _bindingFailureHandler;
6161

‎src/Core/src/RuntimeFeature.cs‎

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,80 +14,79 @@ namespace Microsoft.Maui
1414
/// </remarks>
1515
static class RuntimeFeature
1616
{
17+
const string FeatureSwitchPrefix = "Microsoft.Maui.RuntimeFeature.";
18+
1719
const bool IsIVisualAssemblyScanningEnabledByDefault = false;
1820
const bool IsShellSearchResultsRendererDisplayMemberNameSupportedByDefault = true;
1921
const bool IsQueryPropertyAttributeSupportedByDefault = true;
2022
const bool IsImplicitCastOperatorsUsageViaReflectionSupportedByDefault = true;
2123
const bool AreBindingInterceptorsSupportedByDefault = true;
2224
const bool IsXamlCBindingWithSourceCompilationEnabledByDefault = false;
2325
const bool IsHybridWebViewSupportedByDefault = true;
24-
<<<<<<< HEAD
2526
const bool SupportNamescopesByDefault = true;
2627
const string FeatureSwitchPrefix = "Microsoft.Maui.RuntimeFeature";
27-
=======
2828
const bool EnableDiagnosticsByDefault = false;
29-
>>>>>>> b2393753db (Turn Visual and Binding diags on EnableDiagnostics)
3029

3130
#pragma warning disable IL4000 // Return value does not match FeatureGuardAttribute 'System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute'.
3231
#if NET9_0_OR_GREATER
33-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsIVisualAssemblyScanningEnabled")]
32+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsIVisualAssemblyScanningEnabled)}")]
3433
[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
3534
#endif
3635
public static bool IsIVisualAssemblyScanningEnabled =>
37-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsIVisualAssemblyScanningEnabled", out bool isEnabled)
36+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsIVisualAssemblyScanningEnabled)}", out bool isEnabled)
3837
? isEnabled
3938
: IsIVisualAssemblyScanningEnabledByDefault;
4039

4140
#if NET9_0_OR_GREATER
42-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsShellSearchResultsRendererDisplayMemberNameSupported")]
41+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsShellSearchResultsRendererDisplayMemberNameSupported)}")]
4342
[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
4443
#endif
4544
public static bool IsShellSearchResultsRendererDisplayMemberNameSupported
46-
=> AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsShellSearchResultsRendererDisplayMemberNameSupported", out bool isSupported)
45+
=> AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsShellSearchResultsRendererDisplayMemberNameSupported)}", out bool isSupported)
4746
? isSupported
4847
: IsShellSearchResultsRendererDisplayMemberNameSupportedByDefault;
4948

5049
#if NET9_0_OR_GREATER
51-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsQueryPropertyAttributeSupported")]
50+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsQueryPropertyAttributeSupported)}")]
5251
[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
5352
#endif
5453
public static bool IsQueryPropertyAttributeSupported =>
55-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsQueryPropertyAttributeSupported", out bool isSupported)
54+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsQueryPropertyAttributeSupported)}", out bool isSupported)
5655
? isSupported
5756
: IsQueryPropertyAttributeSupportedByDefault;
5857

5958
#if NET9_0_OR_GREATER
60-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsImplicitCastOperatorsUsageViaReflectionSupported")]
59+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsImplicitCastOperatorsUsageViaReflectionSupported)}")]
6160
[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
6261
#endif
6362
public static bool IsImplicitCastOperatorsUsageViaReflectionSupported =>
64-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsImplicitCastOperatorsUsageViaReflectionSupported", out bool isSupported)
63+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsImplicitCastOperatorsUsageViaReflectionSupported)}", out bool isSupported)
6564
? isSupported
6665
: IsImplicitCastOperatorsUsageViaReflectionSupportedByDefault;
6766

6867
#if NET9_0_OR_GREATER
69-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.Microsoft.Maui.RuntimeFeature.AreBindingInterceptorsSupported")]
68+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(AreBindingInterceptorsSupported)}")]
7069
#endif
7170
public static bool AreBindingInterceptorsSupported =>
72-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.AreBindingInterceptorsSupported", out bool areSupported)
71+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(AreBindingInterceptorsSupported)}", out bool areSupported)
7372
? areSupported
7473
: AreBindingInterceptorsSupportedByDefault;
7574

7675
#if NET9_0_OR_GREATER
77-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsXamlCBindingWithSourceCompilationEnabled")]
76+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsXamlCBindingWithSourceCompilationEnabled)}")]
7877
#endif
7978
public static bool IsXamlCBindingWithSourceCompilationEnabled =>
80-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsXamlCBindingWithSourceCompilationEnabled", out bool areSupported)
79+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsXamlCBindingWithSourceCompilationEnabled)}", out bool areSupported)
8180
? areSupported
8281
: IsXamlCBindingWithSourceCompilationEnabledByDefault;
8382

8483
#if NET9_0_OR_GREATER
85-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.IsHybridWebViewSupported")]
84+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(IsHybridWebViewSupported)}")]
8685
[FeatureGuard(typeof(RequiresUnreferencedCodeAttribute))]
8786
[FeatureGuard(typeof(RequiresDynamicCodeAttribute))]
8887
#endif
8988
public static bool IsHybridWebViewSupported =>
90-
AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.IsHybridWebViewSupported", out bool isSupported)
89+
AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(IsHybridWebViewSupported)}", out bool isSupported)
9190
? isSupported
9291
: IsHybridWebViewSupportedByDefault;
9392

@@ -105,21 +104,29 @@ public static bool AreNamescopesSupported
105104
}
106105

107106
#if NET9_0_OR_GREATER
108-
[FeatureSwitchDefinition("Microsoft.Maui.RuntimeFeature.EnableDiagnostics")]
107+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(EnableDiagnostics)}")]
108+
#endif
109+
public static bool EnableDiagnostics => AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(EnableDiagnostics)}", out bool isEnabled)
110+
? isEnabled
111+
: EnableDiagnosticsByDefault;
112+
113+
114+
#if NET9_0_OR_GREATER
115+
[FeatureSwitchDefinition($"{FeatureSwitchPrefix}.{nameof(EnableMauiDiagnostics)}")]
109116
#endif
110-
public static bool EnableDiagnostics
117+
public static bool EnableMauiDiagnostics
111118
{
112119
get
113120
{
114-
return AppContext.TryGetSwitch("Microsoft.Maui.RuntimeFeature.EnableDiagnostics", out bool isEnabled)
121+
return AppContext.TryGetSwitch($"{FeatureSwitchPrefix}.{nameof(EnableMauiDiagnostics)}", out bool isEnabled)
115122
? isEnabled
116-
: EnableDiagnosticsByDefault;
123+
: EnableDiagnostics;
117124
}
118125
internal set
119126
{
120127
// This property is internal settable to allow tests to enable diagnostics.
121128
// It should not be set in production code.
122-
AppContext.SetSwitch("Microsoft.Maui.RuntimeFeature.EnableDiagnostics", value);
129+
AppContext.SetSwitch($"{FeatureSwitchPrefix}.{nameof(EnableMauiDiagnostics)}", value);
123130
}
124131
}
125132
#pragma warning restore IL4000

0 commit comments

Comments
 (0)