feat(UIComponent): return Task from Initialize

jonisavo · May 8, 2023 · 77a7cb7 · 77a7cb7
1 parent e163110
commit 77a7cb7
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 58 deletions.
diff --git a/Assets/UIComponents.Benchmarks/BenchmarkUtils.cs b/Assets/UIComponents.Benchmarks/BenchmarkUtils.cs
@@ -20,8 +20,7 @@ public static void MeasureComponentInitWithColdCache<TComponent>() where TCompon
             Measure.Method(async () =>
                 {
                     var component = new TComponent();
-                    component.Initialize();
-                    await component.InitializationTask;
+                    await component.Initialize();
                 })
                 .SetUp(() =>
                 {
@@ -41,8 +40,7 @@ public static void MeasureComponentInitWithWarmCache<TComponent>() where TCompon
             Measure.Method(async () => 
                 {
                     var component = new TComponent();
-                    component.Initialize();
-                    await component.InitializationTask;
+                    await component.Initialize();
                 })
                 .SampleGroup(new SampleGroup("Warm Cache Time"))
                 .WarmupCount(10)

diff --git a/Assets/UIComponents.Tests/LayoutAttributeTests.cs b/Assets/UIComponents.Tests/LayoutAttributeTests.cs
@@ -2,6 +2,7 @@
 using NSubstitute;
 using NSubstitute.ReturnsExtensions;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UIComponents.Testing;
 using UIComponents.Tests.Utilities;
 using UnityEngine.TestTools;
@@ -44,8 +45,7 @@ public IEnumerator Given_Layout_Is_Loaded()
         {
             var testBed = new TestBed<UIComponentWithLayout>().WithSingleton(_mockResolver);
             var component = testBed.CreateComponent();
-            component.Initialize();
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
             _mockResolver.Received().LoadAsset<VisualTreeAsset>("Assets/MyAsset.uxml");
         }
 
@@ -54,8 +54,7 @@ public IEnumerator Superclass_Layout_Is_Loaded_If_It_Is_Not_Overridden()
         {
             var testBed = new TestBed<InheritedComponentWithoutAttribute>().WithSingleton(_mockResolver);
             var component = testBed.CreateComponent();
-            component.Initialize();
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
             _mockResolver.Received().LoadAsset<VisualTreeAsset>("Assets/MyAsset.uxml");
         }
 
@@ -64,18 +63,17 @@ public IEnumerator Superclass_Layout_Is_Not_Loaded_If_Overridden()
         {
             var testBed = new TestBed<InheritedComponentWithAttribute>().WithSingleton(_mockResolver);
             var component = testBed.CreateComponent();
-            component.Initialize();
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
             _mockResolver.Received().LoadAsset<VisualTreeAsset>("Assets/MyOtherAsset.uxml");
             _mockResolver.DidNotReceive().LoadAsset<VisualTreeAsset>("Assets/MyAsset.uxml");
         }
 
-        [Test]
-        public void Null_Layout_Is_Handled()
+        [UnityTest]
+        public IEnumerator Null_Layout_Is_Handled()
         {
             var testBed = new TestBed<UIComponentWithNullLayout>().WithSingleton(_mockResolver);
             var component = testBed.CreateComponent();
-            Assert.DoesNotThrow(() => component.Initialize());
+            yield return component.Initialize().AsEnumerator();
         }
     }
 }
diff --git a/Assets/UIComponents.Tests/QueryAttributeTests.cs b/Assets/UIComponents.Tests/QueryAttributeTests.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using NSubstitute;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UIComponents.Testing;
 using UnityEngine.TestTools;
 using UnityEngine.UIElements;
@@ -51,10 +52,8 @@ public IEnumerator Should_Populate_Fields()
             var testBed = new TestBed<ComponentWithQueryAttribute>()
                 .WithSingleton(_mockLogger);
             var component = testBed.CreateComponent();
-            component.Initialize();
+            yield return component.Initialize().AsEnumerator();
 
-            yield return component.WaitForInitializationEnumerator();
-
             Assert.That(component.HelloWorldLabel, Is.InstanceOf<Label>());
             Assert.That(component.HelloWorldLabel.text, Is.EqualTo("Hello world!"));
 
@@ -88,10 +87,8 @@ public IEnumerator Should_Populate_Inherited_Fields()
             var testBed = new TestBed<ChildComponentWithQueryAttribute>()
                 .WithSingleton(_mockLogger);
             var component = testBed.CreateComponent();
-            component.Initialize();
+            yield return component.Initialize().AsEnumerator();
 
-            yield return component.WaitForInitializationEnumerator();
-
             Assert.That(component.HelloWorldLabel, Is.InstanceOf<Label>());
             Assert.That(component.TestFoldout, Is.InstanceOf<Foldout>());
             Assert.That(component.FoldoutContent, Is.InstanceOf<Label>());
@@ -117,9 +114,7 @@ public IEnumerator Should_Not_Populate_Invalid_Fields()
             var testBed = new TestBed<ComponentWithInvalidQueryAttribute>()
                 .WithSingleton(_mockLogger);
             var component = testBed.CreateComponent();
-            component.Initialize();
-
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
 
             Assert.That(component.InvalidField, Is.Null);
             Assert.That(component.InvalidArray, Is.Null);
@@ -144,10 +139,8 @@ public IEnumerator Should_Log_Errors_If_Query_Yields_No_Results()
             var testBed = new TestBed<ComponentWithMissingFields>()
                 .WithSingleton(_mockLogger);
             var component = testBed.CreateComponent();
-            component.Initialize();
+            yield return component.Initialize().AsEnumerator();
 
-            yield return component.WaitForInitializationEnumerator();
-
             Assert.That(component.label, Is.Null);
             Assert.That(component.components.Length, Is.EqualTo(0));
             Assert.That(component.buttons.Count, Is.EqualTo(0));

diff --git a/Assets/UIComponents.Tests/QueryClassAttributeTests.cs b/Assets/UIComponents.Tests/QueryClassAttributeTests.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using NSubstitute;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UIComponents.Testing;
 using UnityEngine.TestTools;
 using UnityEngine.UIElements;
@@ -70,8 +71,7 @@ public IEnumerator UnitySetUp()
             var testBed = new TestBed<QueryClassTestComponent>()
                 .WithSingleton(_mockLogger);
             _queryClassTestComponent = testBed.CreateComponent();
-            _queryClassTestComponent.Initialize();
-            yield return _queryClassTestComponent.WaitForInitializationEnumerator();
+            yield return _queryClassTestComponent.Initialize().AsEnumerator();
         }
 
         [Test]

diff --git a/Assets/UIComponents.Tests/RootClassAttributeTests.cs b/Assets/UIComponents.Tests/RootClassAttributeTests.cs
@@ -1,5 +1,6 @@
 using System.Collections;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UnityEngine.TestTools;
 
 namespace UIComponents.Tests
@@ -14,9 +15,8 @@ private partial class ComponentWithRootClass : UIComponent {}
         public IEnumerator Adds_Class_To_Component()
         {
             var component = new ComponentWithRootClass();
-            component.Initialize();
-            yield return component.WaitForInitializationEnumerator();
-
+            yield return component.Initialize().AsEnumerator();
+
             Assert.That(component.ClassListContains("test-class"), Is.True);
         }
 
@@ -28,9 +28,8 @@ private partial class ChildComponentWithRootClass : ComponentWithRootClass {}
         public IEnumerator Adds_Class_To_Component_And_Child_Component()
         {
             var component = new ChildComponentWithRootClass();
-            component.Initialize();
-            yield return component.WaitForInitializationEnumerator();
-
+            yield return component.Initialize().AsEnumerator();
+
             Assert.That(component.ClassListContains("test-class"), Is.True);
             Assert.That(component.ClassListContains("other-test-class"), Is.True);
             Assert.That(component.ClassListContains("final-test-class"), Is.True);

diff --git a/Assets/UIComponents.Tests/StylesheetAttributeTests.cs b/Assets/UIComponents.Tests/StylesheetAttributeTests.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 using NSubstitute;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UIComponents.Testing;
 using UIComponents.Tests.Utilities;
 using UnityEngine;
@@ -43,10 +44,8 @@ public IEnumerator Given_Stylesheets_Are_Loaded()
                 .WithSingleton(_mockLogger)
                 .WithTransient(_mockResolver);
             var component = testBed.CreateComponent();
-            component.Initialize();
-
-            yield return component.WaitForInitializationEnumerator();
-
+            yield return component.Initialize().AsEnumerator();
+
             _mockResolver.Received().LoadAsset<StyleSheet>("Assets/StylesheetOne.uss");
             _mockResolver.Received().LoadAsset<StyleSheet>("Assets/StylesheetTwo.uss");
             Assert.That(component.styleSheets.count, Is.EqualTo(2));
@@ -59,9 +58,7 @@ public IEnumerator Inherited_Stylesheets_Are_Loaded()
                 .WithSingleton(_mockLogger)
                 .WithTransient(_mockResolver);
             var component = testBed.CreateComponent();
-            component.Initialize();
-
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
 
             _mockResolver.Received().LoadAsset<StyleSheet>("Assets/StylesheetOne.uss");
             _mockResolver.Received().LoadAsset<StyleSheet>("Assets/StylesheetTwo.uss");
@@ -80,9 +77,7 @@ public IEnumerator Invalid_Stylesheets_Output_Error_Message()
                 .WithTransient(_mockResolver);
 
             var component = testBed.CreateComponent();
-            component.Initialize();
-
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
 
             _mockResolver.Received().LoadAsset<StyleSheet>("Assets/StylesheetOne.uss");
             _mockLogger.Received().LogError("Could not find stylesheet Assets/StylesheetOne.uss", component);

diff --git a/Assets/UIComponents.Tests/UIComponentEffectAttributeTests.cs b/Assets/UIComponents.Tests/UIComponentEffectAttributeTests.cs
@@ -2,6 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UnityEngine.TestTools;
 
 namespace UIComponents.Tests
@@ -38,9 +39,7 @@ private partial class UIComponentWithEffects : UIComponent
         public IEnumerator Effects_Are_Sorted_By_Priority()
         {
             var component = new UIComponentWithEffects();
-            component.Initialize();
-
-            yield return component.WaitForInitializationEnumerator();
+            yield return component.Initialize().AsEnumerator();
 
             Assert.That(component.AppliedEffects.Count, Is.EqualTo(4));
             Assert.That(component.AppliedEffects[0], Is.EqualTo(999));

diff --git a/Assets/UIComponents.Tests/UIComponentNoAttributesTests.cs b/Assets/UIComponents.Tests/UIComponentNoAttributesTests.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 using NSubstitute;
 using NUnit.Framework;
+using UIComponents.Internal;
 using UIComponents.Testing;
 using UnityEngine.TestTools;
 using UnityEngine.UIElements;
@@ -27,8 +28,7 @@ public IEnumerator UnitySetUp()
             var testBed = new TestBed<UIComponentNoAttributes>()
                 .WithSingleton(_mockResolver);
             _component = testBed.CreateComponent();
-            _component.Initialize();
-            yield return _component.WaitForInitializationEnumerator();
+            yield return _component.Initialize().AsEnumerator();
         }
 
         [TearDown]

diff --git a/Assets/UIComponents.Tests/UIComponentTests.cs b/Assets/UIComponents.Tests/UIComponentTests.cs
@@ -6,6 +6,7 @@
 using UnityEngine;
 using UnityEngine.TestTools;
 using UnityEngine.UIElements;
+#pragma warning disable CS4014
 
 namespace UIComponents.Tests
 {

diff --git a/Assets/UIComponents/Core/Internal/TaskExtensions.cs b/Assets/UIComponents/Core/Internal/TaskExtensions.cs
@@ -11,14 +11,10 @@ internal static class TaskExtensions
         public static IEnumerator AsEnumerator(this Task task)
         {
             while (!task.IsCompleted)
-            {
                 yield return null;
-            }
 
             if (task.IsFaulted)
-            {
                 ExceptionDispatchInfo.Capture(task.Exception!).Throw();
-            }
 
             yield return null;
         }

diff --git a/Assets/UIComponents/Core/UIComponent.cs b/Assets/UIComponents/Core/UIComponent.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using UIComponents.DependencyInjection;
 using UIComponents.Internal;
@@ -80,13 +81,24 @@ protected UIComponent()
             UIC_UnregisterEventCallbacks();
         }
 
+        [ExcludeFromCodeCoverage] // Pragmas are shown as uncovered lines
         private void OnFirstAttachToPanel(AttachToPanelEvent evt)
         {
+#pragma warning disable CS4014
             Initialize();
+#pragma warning restore CS4014
             UnregisterCallback<AttachToPanelEvent>(OnFirstAttachToPanel);
         }
 
-        public async void Initialize()
+        /// <summary>
+        /// Starts the initialization of the UIComponent. Does nothing if the UIComponent has already been initialized
+        /// or if initialization is already ongoing.
+        /// </summary>
+        /// <remarks>
+        /// This method is called automatically when the UIComponent is first attached to a panel.
+        /// It can also be called manually to force initialization.
+        /// </remarks>
+        public async Task Initialize()
         {
             if (Initialized || _initializationOngoing)
                 return;

diff --git a/Assets/UIComponents/Testing/TestBed.cs b/Assets/UIComponents/Testing/TestBed.cs
@@ -71,19 +71,16 @@ public TComponent CreateComponent(Func<TComponent> factoryPredicate)
         public async Task<TComponent> CreateComponentAsync(Func<TComponent> factoryPredicate)
         {
             var component = CreateComponent(factoryPredicate);
-            component.Initialize();
 
-            var initTask = component.InitializationTask;
+            var initTask = component.Initialize();
             var timeoutTask = Task.Delay(AsyncTimeout);
 
             var task = await Task.WhenAny(initTask, timeoutTask);
 
             if (task == timeoutTask)
                 throw new TestBedTimeoutException(component.GetType().Name, (int)AsyncTimeout.TotalMilliseconds);
 
-            var initializedComponent = await initTask;
-
-            return initializedComponent as TComponent;
+            return component;
         }