[MA-2561] Bad requests for inputText and eraseText if keyboard is not…

… present (#2175)

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

@@ -25,9 +25,7 @@ sealed class MaestroException(override val message: String) : RuntimeException(m
 
     class UnableToClearState(message: String) : MaestroException(message)
 
-    class UnableToPullState(message: String) : MaestroException(message)
-
-    class UnableToPushState(message: String) : MaestroException(message)
+    class UnableToProcessCommand(message: String, val command: String): MaestroException(message)
 
     class AppCrash(message: String): MaestroException(message)
 

maestro-client/src/main/java/maestro/drivers/IOSDriver.kt

@@ -22,13 +22,15 @@ package maestro.drivers
 import com.github.michaelbull.result.expect
 import com.github.michaelbull.result.getOrThrow
 import com.github.michaelbull.result.onSuccess
+import com.github.michaelbull.result.runCatching
 import hierarchy.AXElement
 import ios.IOSDevice
 import ios.IOSDeviceErrors
 import maestro.*
 import maestro.UiElement.Companion.toUiElement
 import maestro.UiElement.Companion.toUiElementOrNull
 import maestro.utils.*
+import maestro.utils.network.XCUITestServerError
 import okio.Sink
 import okio.source
 import org.slf4j.LoggerFactory
@@ -415,7 +417,6 @@ class IOSDriver(
 
     override fun inputText(text: String) {
         metrics.measured("operation", mapOf("command" to "inputText")) {
-            // silently fail if no XCUIElement has focus
             runDeviceCall("inputText") { iosDevice.input(text = text) }
         }
     }
@@ -528,7 +529,11 @@ class IOSDriver(
         return try {
             call()
         } catch (socketTimeoutException: SocketTimeoutException) {
-            throw MaestroException.DriverTimeout("iOS driver timed out while doing $callName call")
+            LOGGER.error("Got socket timeout processing $callName command", socketTimeoutException)
+            throw socketTimeoutException
+        } catch (badRequest: XCUITestServerError.BadRequest) {
+            LOGGER.error("Bad request for $callName, reason: ${badRequest.errorResponse}")
+            throw MaestroException.UnableToProcessCommand(command = callName, message = badRequest.error.errorMessage)
         } catch (appCrashException: IOSDeviceErrors.AppCrash) {
             throw MaestroException.AppCrash(appCrashException.errorMessage)
         }

maestro-client/src/test/java/maestro/xctestdriver/XCTestDriverClientTest.kt

@@ -6,15 +6,14 @@ import maestro.ios.MockXCTestInstaller
 import maestro.utils.network.XCUITestServerError
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
-import okhttp3.mockwebserver.SocketPolicy
+import maestro.utils.network.Error
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.MethodSource
 import xcuitest.XCTestClient
 import xcuitest.XCTestDriverClient
 import xcuitest.api.DeviceInfo
-import xcuitest.api.Error
 import java.net.InetAddress
 
 class XCTestDriverClientTest {

maestro-ios-driver/src/main/kotlin/xcuitest/XCTestDriverClient.kt

@@ -3,6 +3,7 @@ package xcuitest
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import hierarchy.ViewHierarchy
 import maestro.utils.HttpClient
+import maestro.utils.network.Error
 import maestro.utils.network.XCUITestServerError
 import okhttp3.*
 import okhttp3.MediaType.Companion.toMediaType
@@ -253,7 +254,7 @@ class XCTestDriverClient(
                 logger.error("Request for $pathString failed with bad request ${code}, body: $responseBodyAsString")
                 throw XCUITestServerError.BadRequest(
                     "Request for $pathString failed with bad request ${code}, body: $responseBodyAsString",
-                    responseBodyAsString
+                    error
                 )
             }
             error.errorMessage.contains("Lost connection to the application.*".toRegex()) -> {

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Handlers/EraseTextHandler.swift

@@ -20,7 +20,9 @@ struct EraseTextHandler: HTTPHandler {
             let start = Date()
 
             let appId = RunningApp.getForegroundAppId(requestBody.appIds)
-            await waitUntilKeyboardIsPresented(appId: appId)
+            if let errorResponse = await waitUntilKeyboardIsPresented(appId: appId) {
+                return errorResponse
+            }
 
             let deleteText = String(repeating: XCUIKeyboardKey.delete.rawValue, count: requestBody.charactersToErase)
 
@@ -35,11 +37,16 @@ struct EraseTextHandler: HTTPHandler {
         }
     }
 
-    private func waitUntilKeyboardIsPresented(appId: String?) async {
-        try? await TimeoutHelper.repeatUntil(timeout: 1, delta: 0.2) {
+    private func waitUntilKeyboardIsPresented(appId: String?) async -> HTTPResponse? {
+        let isKeyboardPresented: Bool = (try? await TimeoutHelper.repeatUntil(timeout: 1, delta: 0.2) {
             guard let appId = appId else { return true }
-
             return XCUIApplication(bundleIdentifier: appId).keyboards.firstMatch.exists
+        }) ?? false
+
+        // Return an error response if the keyboard is not presented
+        if !isKeyboardPresented {
+            return AppError(type: .timeout, message: "Keyboard not presented within 1 second timeout for erase command").httpResponse
         }
+        return nil
     }
 }

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Handlers/InputTextRouteHandler.swift

@@ -18,7 +18,9 @@ struct InputTextRouteHandler : HTTPHandler {
             let start = Date()
 
             let appId = RunningApp.getForegroundAppId(requestBody.appIds)
-            await waitUntilKeyboardIsPresented(appId: appId)
+            if let errorResponse = await waitUntilKeyboardIsPresented(appId: appId) {
+                return errorResponse
+            }
 
             try await TextInputHelper.inputText(requestBody.text)
 
@@ -30,11 +32,16 @@ struct InputTextRouteHandler : HTTPHandler {
         }
     }
 
-    private func waitUntilKeyboardIsPresented(appId: String?) async {
-        try? await TimeoutHelper.repeatUntil(timeout: 1, delta: 0.2) {
+    private func waitUntilKeyboardIsPresented(appId: String?) async -> HTTPResponse? {
+        let isKeyboardPresented: Bool = (try? await TimeoutHelper.repeatUntil(timeout: 1, delta: 0.2) {
             guard let appId = appId else { return true }
-
             return XCUIApplication(bundleIdentifier: appId).keyboards.firstMatch.exists
+        }) ?? false
+
+        // Return an error response if the keyboard is not presented
+        if !isKeyboardPresented {
+            return AppError(type: .timeout, message: "Keyboard not presented within 1 second timeout for input command").httpResponse
         }
+        return nil
     }
 }

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Helpers/AppError.swift

@@ -5,6 +5,7 @@ import FlyingFox
 enum AppErrorType: String, Codable {
     case `internal`
     case precondition
+    case timeout
 }
 
 struct AppError: Error, Codable {
@@ -15,6 +16,7 @@ struct AppError: Error, Codable {
         switch type {
         case .internal: return .internalServerError
         case .precondition: return .badRequest
+        case .timeout: return .badRequest
         }
     }
 

maestro-ios-xctest-runner/maestro-driver-iosUITests/Routes/Helpers/TimeoutHelper.swift

@@ -22,4 +22,25 @@ struct TimeoutHelper {
             }
         }
     }
+
+    static func repeatUntil(timeout: TimeInterval, delta: TimeInterval, block: () -> Bool) async throws -> Bool  {
+        guard delta >= 0 else {
+            throw NSError(domain: "Invalid value", code: 1, userInfo: [NSLocalizedDescriptionKey: "Delta cannot be negative"])
+        }
+
+        let timeout = Date().addingTimeInterval(timeout)
+
+        while Date() < timeout {
+            do {
+                try await Task.sleep(nanoseconds: UInt64(1_000_000_000 * delta))
+            } catch {
+                throw NSError(domain: "Failed to sleep task", code: 2, userInfo: [NSLocalizedDescriptionKey: "Task could not be put to sleep"])
+            }
+
+            if (block()) {
+                return true
+            }
+        }
+        return false
+    }
 }

maestro-utils/build.gradle.kts

@@ -11,6 +11,7 @@ dependencies {
     api(libs.square.okio)
     implementation(libs.square.okhttp)
     implementation(libs.micrometer.core)
+    api(libs.jackson.module.kotlin)
     implementation(libs.micrometer.observation)
 
     testImplementation(libs.mockk)

maestro-ios-driver/src/main/kotlin/xcuitest/api/Error.kt → maestro-utils/src/main/kotlin/network/Error.kt

@@ -1,4 +1,4 @@
-package xcuitest.api
+package maestro.utils.network
 
 import com.fasterxml.jackson.annotation.JsonProperty
 

maestro-utils/src/main/kotlin/network/Errors.kt

@@ -12,5 +12,5 @@ sealed class XCUITestServerError: Throwable() {
     data class UnknownFailure(val errorResponse: String) : XCUITestServerError()
     data class NetworkError(val errorResponse: String): XCUITestServerError()
     data class AppCrash(val errorResponse: String): XCUITestServerError()
-    data class BadRequest(val errorResponse: String, val clientMessage: String): XCUITestServerError()
+    data class BadRequest(val errorResponse: String, val error: Error): XCUITestServerError()
 }

maestro-utils/src/test/kotlin/network/ErrorsTest.kt

@@ -70,9 +70,10 @@ class ErrorsTest {
     fun `XCUITestServerError BadRequest should have correct messages`() {
         val errorMessage = "Bad request"
         val clientMessage = "Client error"
+        val error = Error(errorMessage = clientMessage, errorCode = "bad-request-precondition")
 
         assertThrows<XCUITestServerError.BadRequest>(errorMessage) {
-            throw XCUITestServerError.BadRequest(errorMessage, clientMessage)
+            throw XCUITestServerError.BadRequest(errorMessage, error)
         }
     }
 }