[MA 3325] Config to opt for including element behind a modal on iOS

maestro-cli/src/main/java/maestro/cli/command/RecordCommand.kt

@@ -31,6 +31,7 @@ import maestro.cli.runner.TestRunner
 import maestro.cli.runner.resultview.AnsiResultView
 import maestro.cli.session.MaestroSessionManager
 import maestro.cli.util.FileUtils.isWebFlow
+import maestro.orchestra.workspace.WorkspaceExecutionPlanner
 import okio.sink
 import picocli.CommandLine
 import picocli.CommandLine.Option
@@ -111,47 +112,56 @@ class RecordCommand : Callable<Int> {
             parent?.deviceId
         }
 
+        val plan = WorkspaceExecutionPlanner.plan(
+            input = setOf(flowFile.toPath()),
+            includeTags = emptyList(),
+            excludeTags = emptyList(),
+            config = configFile?.toPath()
+        )
+
         return MaestroSessionManager.newSession(
             host = parent?.host,
             port = parent?.port,
             driverHostPort = null,
             deviceId = deviceId,
-            platform = parent?.platform,
             teamId = appleTeamId,
-        ) { session ->
-            val maestro = session.maestro
-            val device = session.device
-
-            if (flowFile.isDirectory) {
-                throw CommandLine.ParameterException(
-                    commandSpec.commandLine(),
-                    "Only single Flows are supported by \"maestro record\". $flowFile is a directory.",
-                )
-            }
-
-            val resultView = AnsiResultView()
-            val screenRecording = kotlin.io.path.createTempFile(suffix = ".mp4").toFile()
-            val exitCode = screenRecording.sink().use { out ->
-                maestro.startScreenRecording(out).use {
-                    TestRunner.runSingle(maestro, device, flowFile, env, resultView, path)
+            platform = parent?.platform,
+            executionPlan = plan,
+            block = { session ->
+                val maestro = session.maestro
+                val device = session.device
+
+                if (flowFile.isDirectory) {
+                    throw CommandLine.ParameterException(
+                        commandSpec.commandLine(),
+                        "Only single Flows are supported by \"maestro record\". $flowFile is a directory.",
+                    )
                 }
-            }
 
-            val frames = resultView.getFrames()
+                val resultView = AnsiResultView()
+                val screenRecording = kotlin.io.path.createTempFile(suffix = ".mp4").toFile()
+                val exitCode = screenRecording.sink().use { out ->
+                    maestro.startScreenRecording(out).use {
+                        TestRunner.runSingle(maestro, device, flowFile, env, resultView, path)
+                    }
+                }
 
-            val localOutputFile = outputFile ?: path.resolve("maestro-recording.mp4").toFile()
-            val videoRenderer = if (local) LocalVideoRenderer(
-                frameRenderer = SkiaFrameRenderer(),
-                outputFile = localOutputFile,
-                outputFPS = 25,
-                outputWidthPx = 1920,
-                outputHeightPx = 1080,
-            ) else RemoteVideoRenderer()
-            videoRenderer.render(screenRecording, frames)
+                val frames = resultView.getFrames()
 
-            TestDebugReporter.deleteOldFiles()
+                val localOutputFile = outputFile ?: path.resolve("maestro-recording.mp4").toFile()
+                val videoRenderer = if (local) LocalVideoRenderer(
+                    frameRenderer = SkiaFrameRenderer(),
+                    outputFile = localOutputFile,
+                    outputFPS = 25,
+                    outputWidthPx = 1920,
+                    outputHeightPx = 1080,
+                ) else RemoteVideoRenderer()
+                videoRenderer.render(screenRecording, frames)
 
-            exitCode
-        }
+                TestDebugReporter.deleteOldFiles()
+
+                exitCode
+            },
+        )
     }
 }

maestro-cli/src/main/java/maestro/cli/command/TestCommand.kt

@@ -335,8 +335,9 @@ class TestCommand : Callable<Int> {
     ): Triple<Int?, Int?, TestExecutionSummary?> {
         val driverHostPort = selectPort(effectiveShards)
         val deviceId = deviceIds[shardIndex]
+        val executionPlan = chunkPlans[shardIndex]
 
-        logger.info("[shard ${shardIndex + 1}] Selected device $deviceId using port $driverHostPort")
+        logger.info("[shard ${shardIndex + 1}] Selected device $deviceId using port $driverHostPort with execution plan $executionPlan")
 
         return MaestroSessionManager.newSession(
             host = parent?.host,
@@ -347,6 +348,7 @@ class TestCommand : Callable<Int> {
             platform = parent?.platform,
             isHeadless = headless,
             reinstallDriver = reinstallDriver,
+            executionPlan = executionPlan
         ) { session ->
             val maestro = session.maestro
             val device = session.device
@@ -457,7 +459,7 @@ class TestCommand : Callable<Int> {
             .groupBy { it.index % effectiveShards }
             .map { (_, files) ->
                 val flowsToRun = files.map { it.value }
-                ExecutionPlan(flowsToRun, plan.sequence)
+                ExecutionPlan(flowsToRun, plan.sequence, plan.workspaceConfig)
             }
     }
 

maestro-cli/src/main/java/maestro/cli/session/MaestroSessionManager.kt

@@ -36,6 +36,8 @@ import maestro.utils.CliInsights
 import maestro.cli.util.ScreenReporter
 import maestro.drivers.AndroidDriver
 import maestro.drivers.IOSDriver
+import maestro.orchestra.WorkspaceConfig.PlatformConfiguration
+import maestro.orchestra.workspace.WorkspaceExecutionPlanner
 import org.slf4j.LoggerFactory
 import util.IOSDeviceType
 import util.XCRunnerCLIUtils
@@ -71,6 +73,7 @@ object MaestroSessionManager {
         isHeadless: Boolean = isStudio,
         reinstallDriver: Boolean = true,
         deviceIndex: Int? = null,
+        executionPlan: WorkspaceExecutionPlanner.ExecutionPlan? = null,
         block: (MaestroSession) -> T,
     ): T {
         val selectedDevice = selectDevice(
@@ -112,7 +115,7 @@ object MaestroSessionManager {
             isHeadless = isHeadless,
             driverHostPort = driverHostPort,
             reinstallDriver = reinstallDriver,
-            prebuiltIOSRunner = false
+            platformConfiguration = executionPlan?.workspaceConfig?.platform
         )
         Runtime.getRuntime().addShutdownHook(thread(start = false) {
             heartbeatFuture.cancel(true)
@@ -191,8 +194,8 @@ object MaestroSessionManager {
         isStudio: Boolean,
         isHeadless: Boolean,
         reinstallDriver: Boolean,
-        prebuiltIOSRunner: Boolean,
         driverHostPort: Int?,
+        platformConfiguration: PlatformConfiguration? = null,
     ): MaestroSession {
         return when {
             selectedDevice.device != null -> MaestroSession(
@@ -209,7 +212,7 @@ object MaestroSessionManager {
                         driverHostPort,
                         reinstallDriver,
                         deviceType = selectedDevice.device.deviceType,
-                        prebuiltRunner = prebuiltIOSRunner
+                        platformConfiguration = platformConfiguration
                     )
 
                     Platform.WEB -> pickWebDevice(isStudio, isHeadless)
@@ -233,7 +236,8 @@ object MaestroSessionManager {
                     openDriver = !connectToExistingSession,
                     driverHostPort = driverHostPort ?: defaultXcTestPort,
                     reinstallDriver = reinstallDriver,
-                    isStudio = isStudio
+                    isStudio = isStudio,
+                    platformConfiguration = platformConfiguration,
                 ),
                 device = null,
             )
@@ -298,7 +302,8 @@ object MaestroSessionManager {
         openDriver: Boolean,
         driverHostPort: Int,
         reinstallDriver: Boolean,
-        isStudio: Boolean
+        isStudio: Boolean,
+        platformConfiguration: PlatformConfiguration?,
     ): Maestro {
         val device = PickDeviceInteractor.pickDevice(deviceId, driverHostPort)
         return createIOS(
@@ -307,7 +312,7 @@ object MaestroSessionManager {
             driverHostPort,
             reinstallDriver,
             deviceType = device.deviceType,
-            prebuiltRunner = isStudio
+            platformConfiguration = platformConfiguration
         )
     }
 
@@ -337,7 +342,7 @@ object MaestroSessionManager {
         openDriver: Boolean,
         driverHostPort: Int?,
         reinstallDriver: Boolean,
-        prebuiltRunner: Boolean,
+        platformConfiguration: PlatformConfiguration?,
         deviceType: Device.DeviceType,
     ): Maestro {
 
@@ -356,14 +361,16 @@ object MaestroSessionManager {
                 IOSDriverConfig(
                     prebuiltRunner = false,
                     sourceDirectory = driverPath.pathString,
-                    context = Context.CLI
+                    context = Context.CLI,
+                    snapshotKeyHonorModalViews = platformConfiguration?.ios?.snapshotKeyHonorModalViews
                 )
             }
             Device.DeviceType.SIMULATOR -> {
                 IOSDriverConfig(
-                    prebuiltRunner = prebuiltRunner,
+                    prebuiltRunner = false,
                     sourceDirectory =  "driver-iPhoneSimulator",
-                    context = Context.CLI
+                    context = Context.CLI,
+                    snapshotKeyHonorModalViews = platformConfiguration?.ios?.snapshotKeyHonorModalViews
                 )
             }
             else -> throw UnsupportedOperationException("Unsupported device type $deviceType for iOS platform")

maestro-client/src/main/java/maestro/Driver.kt

@@ -21,7 +21,6 @@ package maestro
 
 import okio.Sink
 import java.io.File
-import java.util.UUID
 
 interface Driver {
 

maestro-ios-driver/src/main/kotlin/util/LocalIOSDeviceController.kt

@@ -27,8 +27,12 @@ object LocalIOSDeviceController {
         )
     }
 
-    fun launchRunner(deviceId: String, port: Int) {
+    fun launchRunner(deviceId: String, port: Int, snapshotKeyHonorModalViews: Boolean?) {
         val outputFile = File(XCRunnerCLIUtils.logDirectory, "xctest_runner_$date.log")
+        val params = mutableMapOf("SIMCTL_CHILD_PORT" to port.toString())
+        if (snapshotKeyHonorModalViews != null) {
+            params["SIMCTL_CHILD_snapshotKeyHonorModalViews"] = snapshotKeyHonorModalViews.toString()
+        }
         runCommand(
             listOf(
                 "xcrun",
@@ -41,7 +45,7 @@ object LocalIOSDeviceController {
                 deviceId,
                 "dev.mobile.maestro-driver-iosUITests.xctrunner"
             ),
-            params = mapOf("SIMCTL_CHILD_PORT" to port.toString()),
+            params = params,
             waitForCompletion = false,
             outputFile = outputFile
         )

maestro-ios-driver/src/main/kotlin/util/LocalSimulatorUtils.kt

@@ -328,8 +328,13 @@ object LocalSimulatorUtils {
     fun launchUITestRunner(
         deviceId: String,
         port: Int,
+        snapshotKeyHonorModalViews: Boolean?,
     ) {
         val outputFile = File(XCRunnerCLIUtils.logDirectory, "xctest_runner_$date.log")
+        val params = mutableMapOf("SIMCTL_CHILD_PORT" to port.toString())
+        if (snapshotKeyHonorModalViews != null) {
+            params["SIMCTL_CHILD_snapshotKeyHonorModalViews"] = snapshotKeyHonorModalViews.toString()
+        }
         runCommand(
             listOf(
                 "xcrun",
@@ -340,7 +345,7 @@ object LocalSimulatorUtils {
                 deviceId,
                 "dev.mobile.maestro-driver-iosUITests.xctrunner"
             ),
-            params = mapOf("SIMCTL_CHILD_PORT" to port.toString()),
+            params = params,
             outputFile = outputFile,
             waitForCompletion = false,
         )

maestro-ios-driver/src/main/kotlin/util/XCRunnerCLIUtils.kt

@@ -120,10 +120,14 @@ object XCRunnerCLIUtils {
         return runningApps(deviceId)[bundleId]
     }
 
-    fun runXcTestWithoutBuild(deviceId: String, xcTestRunFilePath: String, port: Int): Process {
+    fun runXcTestWithoutBuild(deviceId: String, xcTestRunFilePath: String, port: Int, snapshotKeyHonorModalViews: Boolean?): Process {
         val date = dateFormatter.format(LocalDateTime.now())
         val outputFile = File(logDirectory, "xctest_runner_$date.log")
         val logOutputDir = Files.createTempDirectory("maestro_xctestrunner_xcodebuild_output")
+        val params = mutableMapOf("TEST_RUNNER_PORT" to port.toString())
+        if (snapshotKeyHonorModalViews != null) {
+            params["TEST_RUNNER_snapshotKeyHonorModalViews"] = snapshotKeyHonorModalViews.toString()
+        }
         return CommandLineUtils.runCommand(
             listOf(
                 "xcodebuild",
@@ -137,7 +141,7 @@ object XCRunnerCLIUtils {
             ),
             waitForCompletion = false,
             outputFile = outputFile,
-            params = mapOf("TEST_RUNNER_PORT" to port.toString())
+            params = params,
         )
     }
 }

maestro-ios-driver/src/main/kotlin/xcuitest/api/ViewHierarchyRequest.kt

@@ -1,3 +1,6 @@
 package xcuitest.api
 
-data class ViewHierarchyRequest(val appIds: Set<String>, val excludeKeyboardElements: Boolean)
+data class ViewHierarchyRequest(
+    val appIds: Set<String>,
+    val excludeKeyboardElements: Boolean
+)

maestro-ios-driver/src/main/kotlin/xcuitest/installer/LocalXCTestInstaller.kt

@@ -199,11 +199,12 @@ class LocalXCTestInstaller(
             installPrebuiltRunner(deviceId, buildProducts.uiRunnerPath)
         } else {
             logger.info("Installing driver with xcodebuild")
-            logger.info("[Start] Running XcUITest with `xcodebuild test-without-building`")
+            logger.info("[Start] Running XcUITest with `xcodebuild test-without-building` with $defaultPort and config: $iOSDriverConfig")
             xcTestProcess = XCRunnerCLIUtils.runXcTestWithoutBuild(
                 deviceId = this.deviceId,
                 xcTestRunFilePath = buildProducts.xctestRunPath.absolutePath,
                 port = defaultPort,
+                snapshotKeyHonorModalViews = iOSDriverConfig.snapshotKeyHonorModalViews
             )
             logger.info("[Done] Running XcUITest with `xcodebuild test-without-building`")
         }
@@ -214,11 +215,19 @@ class LocalXCTestInstaller(
         when (deviceType) {
             IOSDeviceType.REAL -> {
                 LocalIOSDeviceController.install(deviceId, bundlePath.toPath())
-                LocalIOSDeviceController.launchRunner(deviceId, defaultPort)
+                LocalIOSDeviceController.launchRunner(
+                    deviceId = deviceId,
+                    port = defaultPort,
+                    snapshotKeyHonorModalViews = iOSDriverConfig.snapshotKeyHonorModalViews
+                )
             }
             IOSDeviceType.SIMULATOR -> {
                 LocalSimulatorUtils.install(deviceId, bundlePath.toPath())
-                LocalSimulatorUtils.launchUITestRunner(deviceId, defaultPort)
+                LocalSimulatorUtils.launchUITestRunner(
+                    deviceId = deviceId,
+                    port = defaultPort,
+                    snapshotKeyHonorModalViews = iOSDriverConfig.snapshotKeyHonorModalViews
+                )
             }
         }
     }
@@ -241,7 +250,8 @@ class LocalXCTestInstaller(
     data class IOSDriverConfig(
         val prebuiltRunner: Boolean,
         val sourceDirectory: String,
-        val context: Context
+        val context: Context,
+        val snapshotKeyHonorModalViews: Boolean?
     )
 
     companion object {

maestro-ios-xctest-runner/maestro-driver-iosUITests/Categories/XCAXClient_iOS+FBSnapshotReqParams.m

@@ -61,24 +61,25 @@
 
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wobjc-load-method"
 #pragma clang diagnostic ignored "-Wcast-function-type-strict"
 
 + (void)load {
     // snapshotKeyHonorModalViews to false to make modals and dialogs visible that are invisible otherwise
-    FBSetCustomParameterForElementSnapshot(@"snapshotKeyHonorModalViews", @0);
+    NSString *snapshotKeyHonorModalViewsKey = [[[NSProcessInfo processInfo] environment] objectForKey:@"snapshotKeyHonorModalViews"];
+    if ([snapshotKeyHonorModalViewsKey isEqualToString:@"false"]) {
+        NSLog(@"Disabling snapshotKeyHonorModalViews to make elements behind modals visible");
+        FBSetCustomParameterForElementSnapshot(@"snapshotKeyHonorModalViews", @0);
 
-    Method original_defaultParametersMethod =
-        class_getInstanceMethod(self.class, @selector(defaultParameters));
-    IMP swizzledDefaultParametersImp = (IMP)swizzledDefaultParameters;
-    original_defaultParameters = (id(*)(id, SEL))method_setImplementation(
-        original_defaultParametersMethod, swizzledDefaultParametersImp);
+        Method original_defaultParametersMethod =
+            class_getInstanceMethod(self.class, @selector(defaultParameters));
+        IMP swizzledDefaultParametersImp = (IMP)swizzledDefaultParameters;
+        original_defaultParameters = (id(*)(id, SEL))method_setImplementation(
+            original_defaultParametersMethod, swizzledDefaultParametersImp);
 
-    Method original_snapshotParametersMethod =
-        class_getInstanceMethod(NSClassFromString(@"XCTElementQuery"),
-                                NSSelectorFromString(@"snapshotParameters"));
-    IMP swizzledSnapshotParametersImp = (IMP)swizzledSnapshotParameters;
-    original_snapshotParameters = (id(*)(id, SEL))method_setImplementation(
-        original_snapshotParametersMethod, swizzledSnapshotParametersImp);
+        Method original_snapshotParametersMethod = class_getInstanceMethod(NSClassFromString(@"XCTElementQuery"), NSSelectorFromString(@"snapshotParameters"));
+        IMP swizzledSnapshotParametersImp = (IMP)swizzledSnapshotParameters;
+        original_snapshotParameters = (id(*)(id, SEL))method_setImplementation(original_snapshotParametersMethod, swizzledSnapshotParametersImp);
+    }
 }
 
 #pragma clang diagnostic pop