feat(UIComponent): add InitializationTask property

jonisavo · Sep 3, 2022 · 5596a42 · 5596a42
1 parent 09274bd
commit 5596a42
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/Assets/UIComponents.Benchmarks/BenchmarkUtils.cs b/Assets/UIComponents.Benchmarks/BenchmarkUtils.cs
@@ -5,7 +5,7 @@ namespace UIComponents.Benchmarks
 {
     public static class BenchmarkUtils
     {
-        public const string Version = "0.21.0.0";
+        public const string Version = "0.22.0.0";
 
         private static SampleGroup[] GetProfilerMarkers()
         {
@@ -22,7 +22,7 @@ public static void MeasureComponentInitWithColdCache<TComponent>() where TCompon
             Measure.Method(async () =>
                 {
                     var component = new TComponent();
-                    await component.WaitForInitialization();
+                    await component.InitializationTask;
                 })
                 .SetUp(() =>
                 {
@@ -42,7 +42,7 @@ public static void MeasureComponentInitWithWarmCache<TComponent>() where TCompon
             Measure.Method(async () => 
                 {
                     var component = new TComponent();
-                    await component.WaitForInitialization();
+                    await component.InitializationTask;
                 })
                 .SampleGroup(new SampleGroup("Warm Cache Time"))
                 .MeasurementCount(50)

diff --git a/Assets/UIComponents/Core/UIComponent.cs b/Assets/UIComponents/Core/UIComponent.cs
@@ -56,6 +56,11 @@ public abstract class UIComponent : VisualElement
         /// </summary>
         public bool Initialized { get; private set; }
 
+        /// <summary>
+        /// A Task that completes when the UIComponent has been fully initialized.
+        /// </summary>
+        public Task<UIComponent> InitializationTask => _initCompletionSource.Task;
+
         /// <summary>
         /// The IUIComponentLogger used by this UIComponent.
         /// Defaults to <see cref="UIComponentDebugLogger"/>.
@@ -186,7 +191,7 @@ public Task<UIComponent> WaitForInitialization()
         /// <returns>An enumerator which yields when the component has initialized</returns>
         public IEnumerator WaitForInitializationEnumerator()
         {
-            yield return WaitForInitialization().AsEnumerator();
+            yield return _initCompletionSource.Task.AsEnumerator();
         }
 
         /// <summary>

diff --git a/Assets/UIComponents/Testing/TestBed.cs b/Assets/UIComponents/Testing/TestBed.cs
@@ -93,7 +93,7 @@ public async Task<TComponent> CreateComponentAsync<TComponent>(Func<TComponent>
         {
             var component = CreateComponent(factoryPredicate);
 
-            var initTask = component.WaitForInitialization();
+            var initTask = component.InitializationTask;
             var timeoutTask = Task.Delay(AsyncTimeout);
 
             var task = await Task.WhenAny(initTask, timeoutTask);