Merge pull request #6507 from Takoooooo/fix-logging-errors

Don't log $parent binding errors when control detached from logical tree
AvaloniaUI · Sep 10, 2021 · 2f1ff3d · 2f1ff3d
2 parents d36858a + a5d76cb
commit 2f1ff3d
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 5 deletions.
diff --git a/src/Avalonia.Visuals/Visual.cs b/src/Avalonia.Visuals/Visual.cs
@@ -489,11 +489,8 @@ protected virtual void OnVisualParentChanged(IVisual? oldParent, IVisual? newPar
 
         protected internal sealed override void LogBindingError(AvaloniaProperty property, Exception e)
         {
-            // Don't log a binding error unless the control is attached to a logical or visual tree.
-            // In theory this should only need to check for logical tree attachment, but in practise
-            // due to ContentControlMixin only taking effect when the template has finished being
-            // applied, some controls are attached to the visual tree before the logical tree.
-            if (((ILogical)this).IsAttachedToLogicalTree || ((IVisual)this).IsAttachedToVisualTree)
+            // Don't log a binding error unless the control is attached to a logical tree.
+            if (((ILogical)this).IsAttachedToLogicalTree)
             {
                 if (e is BindingChainException b &&
                     string.IsNullOrEmpty(b.ExpressionErrorPoint) &&

diff --git a/tests/Avalonia.Base.UnitTests/Avalonia.Base.UnitTests.csproj b/tests/Avalonia.Base.UnitTests/Avalonia.Base.UnitTests.csproj
@@ -14,6 +14,7 @@
   <Import Project="..\..\build\SharedVersion.props" />
   <ItemGroup>
     <ProjectReference Include="..\..\src\Avalonia.Base\Avalonia.Base.csproj" />
+    <ProjectReference Include="..\..\src\Markup\Avalonia.Markup.Xaml.Loader\Avalonia.Markup.Xaml.Loader.csproj" />
     <ProjectReference Include="..\Avalonia.UnitTests\Avalonia.UnitTests.csproj" />
   </ItemGroup>
   <ItemGroup>

diff --git a/tests/Avalonia.Base.UnitTests/Logging/LoggingTests.cs b/tests/Avalonia.Base.UnitTests/Logging/LoggingTests.cs
@@ -0,0 +1,73 @@
+using Avalonia.Controls;
+using Avalonia.Controls.Shapes;
+using Avalonia.Markup.Xaml;
+using Avalonia.UnitTests;
+using Xunit;
+
+namespace Avalonia.Base.UnitTests.Logging
+{
+    public class LoggingTests
+    {
+        [Fact]
+        public void Control_Should_Not_Log_Binding_Errors_When_Detached_From_Visual_Tree()
+        {
+            using (UnitTestApplication.Start(TestServices.StyledWindow))
+            {
+                var xaml = @"
+<Window xmlns='https://github.com/avaloniaui'
+        xmlns:x='http://schemas.microsoft.com/winfx/2006/xaml'
+        xmlns:local='clr-namespace:Avalonia.Base.UnitTests.Logging;assembly=Avalonia.UnitTests'>
+    <Panel Name='panel'>
+    <Rectangle Name='rect' Fill='{Binding $parent[Window].Background}'/>
+  </Panel>
+</Window>";
+
+                var window = (Window)AvaloniaRuntimeXamlLoader.Load(xaml);
+                var calledTimes = 0;
+                using var logSink = TestLogSink.Start((l, a, s, m, d) =>
+                {
+                    if (l >= Avalonia.Logging.LogEventLevel.Warning)
+                    {
+                        calledTimes++;
+                    }
+                });
+                var panel = window.FindControl<Panel>("panel");
+                var rect = window.FindControl<Rectangle>("rect");
+                window.ApplyTemplate();
+                window.Presenter.ApplyTemplate();
+                panel.Children.Remove(rect);
+                Assert.Equal(0, calledTimes);
+            }
+        }
+
+        [Fact]
+        public void Control_Should_Log_Binding_Errors_When_No_Ancestor_With_Such_Name()
+        {
+            using (UnitTestApplication.Start(TestServices.StyledWindow))
+            {
+                var xaml = @"
+<Window xmlns='https://github.com/avaloniaui'
+        xmlns:x='http://schemas.microsoft.com/winfx/2006/xaml'
+        xmlns:local='clr-namespace:Avalonia.Base.UnitTests.Logging;assembly=Avalonia.UnitTests'>
+    <Panel>
+    <Rectangle Fill='{Binding $parent[Grid].Background}'/>
+  </Panel>
+</Window>";
+                var calledTimes = 0;
+                using var logSink = TestLogSink.Start((l, a, s, m, d) =>
+                {
+                    if (l >= Avalonia.Logging.LogEventLevel.Warning && s is Rectangle)
+                    {
+                        calledTimes++;
+                    }
+                });
+                var window = (Window)AvaloniaRuntimeXamlLoader.Load(xaml);
+                window.ApplyTemplate();
+                window.Presenter.ApplyTemplate();
+                Assert.Equal(1, calledTimes);
+            }
+        }
+    }
+
+
+}