feat: add useClearTextShortcut setting

WebDriverAgentLib/Categories/XCUIElement+FBTyping.m

@@ -166,7 +166,7 @@ - (BOOL)fb_clearTextWithSnapshot:(FBXCElementSnapshotWrapper *)snapshot
       [self fb_prepareForTextInputWithSnapshot:snapshot];
     }
 
-    if (retry == 0) {
+    if (retry == 0 && FBConfiguration.useHIDClear) {
       // 1st attempt is via the IOHIDEvent as the fastest operation
       // https://github.com/appium/appium/issues/19389
       [[XCUIDevice sharedDevice] fb_performIOHIDEventWithPage:0x07  // kHIDPage_KeyboardOrKeypad

WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -141,6 +141,10 @@ + (NSArray *)routes
     [FBConfiguration forceSimulatorSoftwareKeyboardPresence];
   }
 
+  if (capabilities[FB_CAP_USE_HID_CLEAR]) {
+    [FBConfiguration setUseHIDClear:[capabilities[FB_CAP_USE_HID_CLEAR] boolValue]];
+  }
+
   NSString *bundleID = capabilities[FB_CAP_BUNDLE_ID];
   NSString *initialUrl = capabilities[FB_CAP_INITIAL_URL];
   XCUIApplication *app = nil;
@@ -351,6 +355,7 @@ + (NSArray *)routes
       FB_SETTING_DEFAULT_ALERT_ACTION: request.session.defaultAlertAction ?: @"",
       FB_SETTING_MAX_TYPING_FREQUENCY: @([FBConfiguration maxTypingFrequency]),
       FB_SETTING_RESPECT_SYSTEM_ALERTS: @([FBConfiguration shouldRespectSystemAlerts]),
+      FB_SETTING_USE_HID_CLEAR: @([FBConfiguration useHIDClear]),
 #if !TARGET_OS_TV
       FB_SETTING_SCREENSHOT_ORIENTATION: [FBConfiguration humanReadableScreenshotOrientation],
 #endif
@@ -449,6 +454,9 @@ + (NSArray *)routes
   if (nil != [settings objectForKey:FB_SETTING_MAX_TYPING_FREQUENCY]) {
     [FBConfiguration setMaxTypingFrequency:[[settings objectForKey:FB_SETTING_MAX_TYPING_FREQUENCY] unsignedIntegerValue]];
   }
+  if (nil != [settings objectForKey:FB_SETTING_USE_HID_CLEAR]) {
+    [FBConfiguration setUseHIDClear:[[settings objectForKey:FB_SETTING_USE_HID_CLEAR] boolValue]];
+  }
 
 #if !TARGET_OS_TV
   if (nil != [settings objectForKey:FB_SETTING_SCREENSHOT_ORIENTATION]) {

WebDriverAgentLib/Utilities/FBCapabilities.h

@@ -44,3 +44,5 @@ extern NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY;
 extern NSString* const FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE;
 /** Sets the application state change timeout for the initial app startup */
 extern NSString* const FB_CAP_APP_LAUNCH_STATE_TIMEOUT_SEC;
+/** Whether to use HIDEvent for text clear */
+extern NSString* const FB_CAP_USE_HID_CLEAR;

WebDriverAgentLib/Utilities/FBCapabilities.m

@@ -24,3 +24,4 @@
 NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY = @"useNativeCachingStrategy";
 NSString* const FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE = @"forceSimulatorSoftwareKeyboardPresence";
 NSString* const FB_CAP_APP_LAUNCH_STATE_TIMEOUT_SEC = @"appLaunchStateTimeoutSec";
+NSString* const FB_CAP_USE_HID_CLEAR = @"useHIDClear";

WebDriverAgentLib/Utilities/FBConfiguration.h

@@ -283,6 +283,15 @@ typedef NS_ENUM(NSInteger, FBConfigurationKeyboardPreference) {
 + (void)setDismissAlertButtonSelector:(NSString *)classChainSelector;
 + (NSString *)dismissAlertButtonSelector;
 
+/**
+ * Whether to use HIDEvent for text clear.
+ * By default this is enabled and HIDEvent is used for text clear.
+ *
+ * @param enabled Either YES or NO
+ */
++ (void)setUseHIDClear:(BOOL)enabled;
++ (BOOL)useHIDClear;
+
 #if !TARGET_OS_TV
 /**
  Set the screenshot orientation for iOS

WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -56,6 +56,7 @@
 static NSTimeInterval FBAnimationCoolOffTimeout;
 static BOOL FBShouldUseCompactResponses;
 static NSString *FBElementResponseAttributes;
+static BOOL FBUseHIDClear;
 #if !TARGET_OS_TV
 static UIInterfaceOrientation FBScreenshotOrientation;
 #endif
@@ -438,6 +439,16 @@ + (NSString *)dismissAlertButtonSelector
   return FBDismissAlertButtonSelector;
 }
 
++ (void)setUseHIDClear:(BOOL)enabled
+{
+  FBUseHIDClear = enabled;
+}
+
++ (BOOL)useHIDClear
+{
+  return FBUseHIDClear;
+}
+
 #if !TARGET_OS_TV
 + (BOOL)setScreenshotOrientation:(NSString *)orientation error:(NSError **)error
 {
@@ -503,6 +514,7 @@ + (void)resetSessionSettings
   FBAnimationCoolOffTimeout = 2.;
   // 50 should be enough for the majority of the cases. The performance is acceptable for values up to 100.
   FBSetCustomParameterForElementSnapshot(FBSnapshotMaxDepthKey, @50);
+  FBUseHIDClear = YES;
 #if !TARGET_OS_TV
   FBScreenshotOrientation = UIInterfaceOrientationUnknown;
 #endif

WebDriverAgentLib/Utilities/FBSettings.h

@@ -40,6 +40,7 @@ extern NSString* const FB_SETTING_WAIT_FOR_IDLE_TIMEOUT;
 extern NSString* const FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT;
 extern NSString* const FB_SETTING_MAX_TYPING_FREQUENCY;
 extern NSString* const FB_SETTING_RESPECT_SYSTEM_ALERTS;
+extern NSString* const FB_SETTING_USE_HID_CLEAR;
 
 
 NS_ASSUME_NONNULL_END

WebDriverAgentLib/Utilities/FBSettings.m

@@ -35,3 +35,4 @@
 NSString* const FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT = @"animationCoolOffTimeout";
 NSString* const FB_SETTING_MAX_TYPING_FREQUENCY = @"maxTypingFrequency";
 NSString* const FB_SETTING_RESPECT_SYSTEM_ALERTS = @"respectSystemAlerts";
+NSString* const FB_SETTING_USE_HID_CLEAR = @"useHIDClear";

lib/types.ts

@@ -25,6 +25,7 @@ export interface WDASettings {
   waitForIdleTimeout?: number;
   animationCoolOffTimeout?: number;
   maxTypingFrequency?: number;
+  useHIDClear?: boolean;
 }
 
 // WebDriverAgentLib/Utilities/FBCapabilities.h
@@ -48,4 +49,5 @@ export interface WDACapabilities {
   forceSimulatorSoftwareKeyboardPresence?: boolean;
   defaultAlertAction?: 'accept' | 'dismiss';
   appLaunchStateTimeoutSec?: number;
+  useHIDClear?: boolean;
 }