fix: Load and Unload framework elements from resources [Skia,Wasm,And…

…roid only]
unoplatform · Mar 4, 2024 · 1a95989 · 1a95989
1 parent a1a6402
commit 1a95989
Show file tree

Hide file tree

Showing 4 changed files with 182 additions and 6 deletions.
diff --git a/src/Uno.UI.RuntimeTests/Tests/Windows_UI_Xaml/Given_ResourceDictionary.cs b/src/Uno.UI.RuntimeTests/Tests/Windows_UI_Xaml/Given_ResourceDictionary.cs
@@ -5,6 +5,9 @@
 using Microsoft.UI.Xaml.Markup;
 using Microsoft.UI.Xaml.Media;
 using Uno.UI.RuntimeTests.Helpers;
+using Microsoft.UI.Xaml.Controls;
+using Private.Infrastructure;
+
 
 
 #if HAS_UNO
@@ -17,6 +20,117 @@ namespace Uno.UI.RuntimeTests.Tests.Windows_UI_Xaml
 	[RunsOnUIThread]
 	public class Given_ResourceDictionary
 	{
+		[TestMethod]
+		public async Task When_FrameworkElement_In_Resources_Should_Receive_Loaded_Unloaded()
+		{
+			var textBlock = new TextBlock();
+			var resourceTextBlock = new TextBlock();
+			var resourceGrid = new Grid()
+			{
+				Children =
+				{
+					resourceTextBlock,
+				},
+			};
+			var grid = new Grid()
+			{
+				Children =
+				{
+					textBlock,
+				},
+				Width = 100,
+				Height = 100,
+			};
+
+			grid.Resources.Add("MyResourceGridKey", resourceGrid);
+
+			string result = "";
+
+			resourceTextBlock.Loaded += (_, _) => result += "ResourceTextBlockLoaded,";
+			resourceGrid.Loaded += (_, _) => result += "ResourceGridLoaded,";
+			textBlock.Loaded += (_, _) => result += "TextBlockLoaded,";
+
+			resourceTextBlock.Unloaded += (_, _) => result += "ResourceTextBlockUnloaded,";
+			resourceGrid.Unloaded += (_, _) => result += "ResourceGridUnloaded,";
+			textBlock.Unloaded += (_, _) => result += "TextBlockUnloaded,";
+
+			await UITestHelper.Load(grid);
+
+#if WINAPPSDK
+			Assert.AreEqual("ResourceTextBlockLoaded,ResourceGridLoaded,TextBlockLoaded,", result);
+#else
+			Assert.AreEqual("ResourceGridLoaded,ResourceTextBlockLoaded,TextBlockLoaded,", result);
+#endif
+
+			await UITestHelper.Load(new Border() { Width = 1, Height = 1 });
+
+#if WINAPPSDK
+			Assert.AreEqual("ResourceTextBlockLoaded,ResourceGridLoaded,TextBlockLoaded,ResourceGridUnloaded,ResourceTextBlockUnloaded,TextBlockUnloaded,", result);
+#else
+			Assert.AreEqual("ResourceGridLoaded,ResourceTextBlockLoaded,TextBlockLoaded,ResourceTextBlockUnloaded,ResourceGridUnloaded,TextBlockUnloaded,", result);
+#endif
+		}
+
+		[TestMethod]
+		public async Task When_FrameworkElement_In_Resources_Then_Removed_Should_Not_Receive_Loaded_Unloaded()
+		{
+			var textBlock = new TextBlock();
+			var resourceTextBlock = new TextBlock();
+			var resourceGrid = new Grid()
+			{
+				Children =
+				{
+					resourceTextBlock,
+				},
+			};
+			var grid = new Grid()
+			{
+				Children =
+				{
+					textBlock,
+				},
+				Width = 100,
+				Height = 100,
+			};
+
+			grid.Resources.Add("MyResourceGridKey", resourceGrid);
+
+			string result = "";
+
+			resourceTextBlock.Loaded += (_, _) => result += "ResourceTextBlockLoaded,";
+			resourceGrid.Loaded += (_, _) => result += "ResourceGridLoaded,";
+			textBlock.Loaded += (_, _) => result += "TextBlockLoaded,";
+
+			resourceTextBlock.Unloaded += (_, _) => result += "ResourceTextBlockUnloaded,";
+			resourceGrid.Unloaded += (_, _) => result += "ResourceGridUnloaded,";
+			textBlock.Unloaded += (_, _) => result += "TextBlockUnloaded,";
+
+			await UITestHelper.Load(grid);
+
+#if WINAPPSDK
+			Assert.AreEqual("ResourceTextBlockLoaded,ResourceGridLoaded,TextBlockLoaded,", result);
+#else
+			Assert.AreEqual("ResourceGridLoaded,ResourceTextBlockLoaded,TextBlockLoaded,", result);
+#endif
+
+			grid.Resources.Remove("MyResourceGridKey");
+			await TestServices.WindowHelper.WaitForIdle();
+
+#if WINAPPSDK
+			Assert.AreEqual("ResourceTextBlockLoaded,ResourceGridLoaded,TextBlockLoaded,ResourceGridUnloaded,ResourceTextBlockUnloaded,", result);
+#else
+			Assert.AreEqual("ResourceGridLoaded,ResourceTextBlockLoaded,TextBlockLoaded,ResourceTextBlockUnloaded,ResourceGridUnloaded,", result);
+#endif
+
+			await UITestHelper.Load(new Border() { Width = 1, Height = 1 });
+
+#if WINAPPSDK
+			Assert.AreEqual("ResourceTextBlockLoaded,ResourceGridLoaded,TextBlockLoaded,ResourceGridUnloaded,ResourceTextBlockUnloaded,TextBlockUnloaded,", result);
+#else
+			Assert.AreEqual("ResourceGridLoaded,ResourceTextBlockLoaded,TextBlockLoaded,ResourceTextBlockUnloaded,ResourceGridUnloaded,TextBlockUnloaded,", result);
+#endif
+		}
+
 		[TestMethod]
 		public void When_Key_Overwritten()
 		{

diff --git a/src/Uno.UI/UI/Xaml/FrameworkElement.Android.cs b/src/Uno.UI/UI/Xaml/FrameworkElement.Android.cs
@@ -34,10 +34,13 @@ protected FrameworkElement()
 		partial void Initialize();
 
 		protected override void OnNativeLoaded()
+			=> OnNativeLoaded(isFromResources: false);
+
+		private void OnNativeLoaded(bool isFromResources)
 		{
 			try
 			{
-				PerformOnLoaded();
+				PerformOnLoaded(isFromResources);
 
 				base.OnNativeLoaded();
 			}
@@ -48,10 +51,25 @@ protected override void OnNativeLoaded()
 			}
 		}
 
-		private void PerformOnLoaded()
+		private void PerformOnLoaded(bool isFromResources = false)
 		{
-			((IDependencyObjectStoreProvider)this).Store.Parent = base.Parent;
-			OnLoading();
+			if (!isFromResources)
+			{
+				((IDependencyObjectStoreProvider)this).Store.Parent = base.Parent;
+				OnLoading();
+			}
+
+			if (this.Resources is not null)
+			{
+				foreach (var resource in Resources.Values)
+				{
+					if (resource is FrameworkElement resourceAsFrameworkElement)
+					{
+						resourceAsFrameworkElement.PerformOnLoaded(isFromResources: true);
+					}
+				}
+			}
+
 			OnLoaded();
 
 			if (FeatureConfiguration.FrameworkElement.AndroidUseManagedLoadedUnloaded)
@@ -67,7 +85,7 @@ private void PerformOnLoaded()
 						// Calling this method is acceptable as it is an abstract method that
 						// will never do interop with the java class. It is required to invoke
 						// Loaded/Unloaded actions.
-						e.OnNativeLoaded();
+						e.OnNativeLoaded(isFromResources);
 					}
 				}
 			}

diff --git a/src/Uno.UI/UI/Xaml/ResourceDictionary.cs b/src/Uno.UI/UI/Xaml/ResourceDictionary.cs
@@ -133,11 +133,29 @@ public bool Insert(object key, object value)
 		public bool Remove(object key)
 		{
 			var keyToRemove = new ResourceKey(key);
+#if __SKIA__ || __WASM__ || __ANDROID__
+			if (_values.TryGetValue(keyToRemove, out var value))
+			{
+				_values.Remove(keyToRemove);
+				if (value is FrameworkElement fe)
+				{
+#if __SKIA__ || __WASM__
+					fe.OnElementUnloaded();
+#else
+					fe.PerformOnUnloaded();
+#endif
+				}
+
+				ResourceDictionaryValueChange?.Invoke(this, EventArgs.Empty);
+				return true;
+			}
+#else
 			if (_values.Remove(keyToRemove))
 			{
 				ResourceDictionaryValueChange?.Invoke(this, EventArgs.Empty);
 				return true;
 			}
+#endif
 
 			return false;
 		}

diff --git a/src/Uno.UI/UI/Xaml/UIElement.crossruntime.cs b/src/Uno.UI/UI/Xaml/UIElement.crossruntime.cs
@@ -121,6 +121,21 @@ private void OnElementLoaded()
 			OnFwEltLoaded();
 			UpdateHitTest();
 
+			// The way this works on WinUI is that when an element enters the visual tree, all values
+			// of properties that are marked with MetaDataPropertyInfoFlags::IsSparse and MetaDataPropertyInfoFlags::IsVisualTreeProperty
+			// are entered as well.
+			// The property we currently know it has an effect is Resources
+			if (this is FrameworkElement { Resources: { } resources })
+			{
+				foreach (var resource in resources.Values)
+				{
+					if (resource is FrameworkElement resourceAsUIElement)
+					{
+						resourceAsUIElement.OnElementLoaded();
+					}
+				}
+			}
+
 			// Get a materialized copy for Wasm to avoid the use of iterators
 			// where try/finally has a high cost.
 			var children = _children.Materialized;
@@ -130,7 +145,7 @@ private void OnElementLoaded()
 			}
 		}
 
-		private void OnElementUnloaded()
+		internal void OnElementUnloaded()
 		{
 			if (!IsLoaded)
 			{
@@ -140,6 +155,17 @@ private void OnElementUnloaded()
 			IsLoaded = false;
 			Depth = int.MinValue;
 
+			if (this is FrameworkElement { Resources: { } resources })
+			{
+				foreach (var resource in resources.Values)
+				{
+					if (resource is FrameworkElement resourceAsUIElement)
+					{
+						resourceAsUIElement.OnElementUnloaded();
+					}
+				}
+			}
+
 			// Get a materialized copy for Wasm to avoid the use of iterators
 			// where try/finally has a high cost.
 			var children = _children.Materialized;