Merge pull request #9463 from robertos/progress-bug

Ensure async operations on progress indicators don't wait on animations if the object is hidden

Author: MaxWang-MS

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/ProgressIndicatorObjectDisplay.cs

@@ -100,7 +100,7 @@ public async Task OpenAsync()
 
             float startTime = Time.unscaledTime;
             float openScale = 0f;
-            while (openScale < 1)
+            while (openScale < 1 && isActiveAndEnabled)
             {
                 openScale = openCurve.Evaluate(Time.unscaledTime - startTime);
                 scaleTargetObject.transform.localScale = Vector3.one * currentScale * openScale;
@@ -133,7 +133,7 @@ public async Task CloseAsync()
 
             float startTime = Time.unscaledTime;
             float closeScale = 1f;
-            while (closeScale > 0)
+            while (closeScale > 0 && isActiveAndEnabled)
             {
                 closeScale = closeCurve.Evaluate(Time.unscaledTime - startTime);
                 scaleTargetObject.transform.localScale = Vector3.one * currentScale * closeScale;

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/ProgressIndicatorOrbsRotator.cs

@@ -85,7 +85,7 @@ public async Task CloseAsync()
 
             StopOrbs();
 
-            while (!hasAnimationFinished)
+            while (!hasAnimationFinished && isActiveAndEnabled)
             {
                 await Task.Yield();
             }

Assets/MRTK/Tests/PlayModeTests/LoadingIndicatorTests.cs

@@ -93,7 +93,38 @@ public IEnumerator TestOpenCloseRotatingOrbsPrefab()
             yield return null;
         }
 
-        private async Task TestOpenCloseProgressIndicatorAsync(GameObject progressIndicatorObject, IProgressIndicator progressIndicator, float timeOpen = 2f)
+        /// <summary>
+        /// Tests that prefab finishes closing after being disabled at runtime.
+        /// </summary>
+        [UnityTest]
+        public IEnumerator TestHideBeforeClosingRotatingOrbsPrefab()
+        {
+            GameObject progressIndicatorObject;
+            IProgressIndicator progressIndicator;
+            InstantiatePrefab(progressIndicatorRotatingOrbsPrefabPath, out progressIndicatorObject, out progressIndicator);
+            Task testTask = TestOpenCloseProgressIndicatorAsync(progressIndicatorObject, progressIndicator, 3f, hideAfterOpening: true);
+
+            // Wait a maximum time before considering the progress bar as stuck
+            float timeStarted = Time.time;
+            const float timeout = 5.0f; 
+            while (!testTask.IsCompleted)
+            {
+                if (Time.time < timeStarted + timeout)
+                {
+                    yield return null;
+                }
+                else
+                {
+                    Assert.Fail("The progress bar is stuck closing.");
+                }
+            }
+
+            // clean up
+            GameObject.Destroy(progressIndicatorObject);
+            yield return null;
+        }
+
+        private async Task TestOpenCloseProgressIndicatorAsync(GameObject progressIndicatorObject, IProgressIndicator progressIndicator, float timeOpen = 2f, bool hideAfterOpening = false)
         {
             // Deactivate the progress indicator
             progressIndicatorObject.SetActive(false);
@@ -111,6 +142,12 @@ private async Task TestOpenCloseProgressIndicatorAsync(GameObject progressIndica
             // Make sure it's actually open
             Assert.True(progressIndicator.State == ProgressIndicatorState.Open, "Progress indicator was not open after open async call: " + progressIndicator.State);
 
+            // Hide the gameObject if requested
+            if (hideAfterOpening)
+            {
+                progressIndicatorObject.SetActive(false);
+            }
+
             // Make sure we can set its progress and message while open
             // Also make sure we can set progress to a value greater than 1 without blowing anything up
             float timeStarted = Time.time;