Fix/maestro flow races (#569)

Author: YogendraShelke

.github/workflows/NativePipeline.yml

@@ -751,7 +751,7 @@ jobs:
     # truncated — at 20 min several shards (accordion, background-image, bottom-sheet,
     # color-picker, safe-area-view) were cancelled mid-flow. If a shard still hits 30 the cause
     # is real app instability, not the cap.
-    timeout-minutes: 35
+    timeout-minutes: 30
     strategy:
       max-parallel: 4
       matrix:

maestro/helpers/helpers.sh

@@ -92,14 +92,48 @@ cleanup_xctest_processes() {
 }
 
 # Function to restart the iOS simulator
+#
+# This is the recovery path taken when the Maestro/XCTest driver wedges ("iOS driver not
+# ready in time"), so it has to ACTUALLY restart the device. It previously did not: the
+# shutdown result was discarded with `|| true`, and the following prepare_ios.sh reported
+#
+#     Monitoring boot status for iPhone 17 Pro (...).
+#     Device already booted, nothing to do.
+#
+# i.e. the device never went down and the shard only got an app reinstall on top of the
+# same wedged runtime. So we now verify the device reaches Shutdown and say so loudly if
+# it doesn't, rather than silently continuing with a half-reset simulator.
 restart_simulator() {
     echo "🔄 Restarting iOS Simulator..."
-    # Clean up XCTest processes first
+    # Kill the XCTest runner FIRST: while it holds the device, shutdown can fail.
     cleanup_xctest_processes
-    # Shut down whatever is booted; the device is auto-selected in prepare_ios.sh,
-    # so we don't depend on a hardcoded device name here.
-    xcrun simctl shutdown all || true
-    sleep 10
+
+    # Target the device prepare_ios.sh selected when we know it; `all` otherwise (first
+    # call in a shard, where SIMULATOR_DEVICE_ID isn't exported into this shell yet).
+    local target="${SIMULATOR_DEVICE_ID:-all}"
+    echo "Shutting down simulator ($target)..."
+    if ! xcrun simctl shutdown "$target" 2>&1; then
+        # Already-shutdown is a benign error, so don't fail here — the poll below is what
+        # decides whether the device is actually down.
+        echo "shutdown reported an error; verifying device state anyway"
+    fi
+
+    # `simctl shutdown <udid>` is synchronous (measured ~3s), but poll rather than trust
+    # it: this replaces a blind `sleep 10` that padded every retry whether or not it was
+    # needed. Bounded so a stuck device surfaces as a warning instead of hanging.
+    local deadline=$((SECONDS + 30))
+    while [ "$SECONDS" -lt "$deadline" ]; do
+        if [ -n "${SIMULATOR_DEVICE_ID:-}" ]; then
+            xcrun simctl list devices | grep -q "$SIMULATOR_DEVICE_ID.*Shutdown" && break
+        else
+            xcrun simctl list devices | grep -q "(Booted)" || break
+        fi
+        sleep 1
+    done
+    if [ "$SECONDS" -ge "$deadline" ]; then
+        echo "::warning::Simulator did not reach Shutdown within 30s; the driver may still be wedged after this restart"
+    fi
+
     bash ./maestro/helpers/prepare_ios.sh
 }
 

packages/pluggableWidgets/background-gradient-native/e2e/specs/maestro/BackgroundGradient.yaml

@@ -5,6 +5,11 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background gradient"
+    timeout: 10000
 - tapOn:
     text: "Background gradient"
 - extendedWaitUntil:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_clickable_container.yaml

@@ -4,6 +4,11 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_conditional_visibility.yaml

@@ -4,6 +4,11 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_dynamic_image.yaml

@@ -4,15 +4,20 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:
     text: "Dynamic image"
-# Because the image loading can take some time due to resources on emulator, we need to wait for the image to be visible
-- extendedWaitUntil: 
-     visible: randText  # Any random text that does not exist in the UI
-     optional: true  # This should be true so that the test won't fail
-     timeout: 30000 # 15 seconds
+# Wait for the screen to stop changing (image decode / sheet animation)
+# rather than sleeping a fixed time: this returns as soon as the UI
+# settles, and still caps at 30s.
+- waitForAnimationToEnd:
+    timeout: 30000
 - takeScreenshot:
     path: "maestro/images/actual/${PLATFORM}/bg_image_dynamic_image"
 - assertScreenshot:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_dynamic_svg.yaml

@@ -4,15 +4,20 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:
     text: "Dynamic SVG image"
-# Because the image loading can take some time due to resources on emulator, we need to wait for the image to be visible
-- extendedWaitUntil: 
-     visible: randText  # Any random text that does not exist in the UI
-     optional: true  # This should be true so that the test won't fail
-     timeout: 15000 # 15 seconds
+# Wait for the screen to stop changing (image decode / sheet animation)
+# rather than sleeping a fixed time: this returns as soon as the UI
+# settles, and still caps at 15s.
+- waitForAnimationToEnd:
+    timeout: 15000
 - takeScreenshot:
     path: "maestro/images/actual/${PLATFORM}/bg_image_dynamic_svg"
 - assertScreenshot:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_layout_grid.yaml

@@ -4,16 +4,21 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:
     text: "Layout grid"
 - assertVisible: "Layout grid"
-# Because the image loading can take some time due to resources on emulator, we need to wait for the image to be visible
-- extendedWaitUntil: 
-     visible: randText  # Any random text that does not exist in the UI
-     optional: true  # This should be true so that the test won't fail
-     timeout: 15000 # 15 seconds
+# Wait for the screen to stop changing (image decode / sheet animation)
+# rather than sleeping a fixed time: this returns as soon as the UI
+# settles, and still caps at 15s.
+- waitForAnimationToEnd:
+    timeout: 15000
 - takeScreenshot:
     path: "maestro/images/actual/${PLATFORM}/bg_image_layout_grid"
 - assertScreenshot:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_nested.yaml

@@ -4,16 +4,21 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:
     text: "Nested"
 - assertVisible: "Nested"
-# Because the image loading can take some time due to resources on emulator, we need to wait for the image to be visible
-- extendedWaitUntil: 
-     visible: randText  # Any random text that does not exist in the UI
-     optional: true  # This should be true so that the test won't fail
-     timeout: 15000 # 15 seconds
+# Wait for the screen to stop changing (image decode / sheet animation)
+# rather than sleeping a fixed time: this returns as soon as the UI
+# settles, and still caps at 15s.
+- waitForAnimationToEnd:
+    timeout: 15000
 - takeScreenshot:
     path: "maestro/images/actual/${PLATFORM}/bg_image_nested"
 - assertScreenshot:

packages/pluggableWidgets/background-image-native/e2e/specs/maestro/BgImage_static_images.yaml

@@ -4,17 +4,22 @@ appId: "${APP_ID}"
     file: "../../../../../../maestro/Precondition.yaml"
 - tapOn:
     text: "B"
+# Tapping the alphabet index re-renders the widget list; wait for the
+# entry before tapping it, otherwise the tap races that render.
+- extendedWaitUntil:
+    visible: "Background image"
+    timeout: 10000
 - tapOn:
     text: "Background image"
 - tapOn:
     text: "Static images"
 - assertVisible:
     text: "Static images"
-# Because the image loading can take some time due to resources on emulator, we need to wait for the image to be visible
-- extendedWaitUntil: 
-     visible: randText  # Any random text that does not exist in the UI
-     optional: true  # This should be true so that the test won't fail
-     timeout: 10000 # 10 seconds
+# Wait for the screen to stop changing (image decode / sheet animation)
+# rather than sleeping a fixed time: this returns as soon as the UI
+# settles, and still caps at 10s.
+- waitForAnimationToEnd:
+    timeout: 10000
 - takeScreenshot:
     path: "maestro/images/actual/${PLATFORM}/bg_image_static_images"
 - assertScreenshot: