appium-webdriveragent 9.4.1 → 9.5.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [9.5.1](https://github.com/appium/WebDriverAgent/compare/v9.5.0...v9.5.1) (2025-04-10)
+
+### Bug Fixes
+
+* Make sure we don't store element snapshot in the cache ([#1001](https://github.com/appium/WebDriverAgent/issues/1001)) ([cfe052b](https://github.com/appium/WebDriverAgent/commit/cfe052bb3adb3f3b24d0a34f386c60cf1516b308))
+
+## [9.5.0](https://github.com/appium/WebDriverAgent/compare/v9.4.1...v9.5.0) (2025-04-10)
+
+### Features
+
+* Add support for the autoClickAlertSelector setting ([#1002](https://github.com/appium/WebDriverAgent/issues/1002)) ([fd31b95](https://github.com/appium/WebDriverAgent/commit/fd31b9589199d0a7bc76919f6aa7c7c74c498b90))
+
 ## [9.4.1](https://github.com/appium/WebDriverAgent/compare/v9.4.0...v9.4.1) (2025-04-05)
 
 ### Miscellaneous Chores

package/WebDriverAgentLib/Categories/XCUIElement+FBClassChain.h

@@ -50,7 +50,8 @@ NS_ASSUME_NONNULL_BEGIN
  @return an array of descendants matching given class chain
  @throws FBUnknownAttributeException if any of predicates in the chain contains unknown attribute(s)
  */
-- (NSArray<XCUIElement *> *)fb_descendantsMatchingClassChain:(NSString *)classChainQuery shouldReturnAfterFirstMatch:(BOOL)shouldReturnAfterFirstMatch;
+- (NSArray<XCUIElement *> *)fb_descendantsMatchingClassChain:(NSString *)classChainQuery
+                                 shouldReturnAfterFirstMatch:(BOOL)shouldReturnAfterFirstMatch;
 
 @end
 

package/WebDriverAgentLib/Commands/FBElementCommands.m

@@ -269,6 +269,7 @@
     NSString *focusedUUID = [elementCache storeElement:(useNativeCachingStrategy
                                                         ? focusedElement
                                                         : [focusedElement fb_stableInstanceWithUid:focusedElement.fb_uid])];
+    focusedElement.lastSnapshot = nil;
     if (focusedUUID && [focusedUUID isEqualToString:(id)request.parameters[@"uuid"]]) {
       isFocused = YES;
     }

package/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -10,6 +10,7 @@
 #import "FBSessionCommands.h"
 
 #import "FBCapabilities.h"
+#import "FBClassChainQueryParser.h"
 #import "FBConfiguration.h"
 #import "FBExceptions.h"
 #import "FBLogger.h"
@@ -347,6 +348,7 @@
       FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS: @([FBConfiguration includeNonModalElements]),
       FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR: FBConfiguration.acceptAlertButtonSelector,
       FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR: FBConfiguration.dismissAlertButtonSelector,
+      FB_SETTING_AUTO_CLICK_ALERT_SELECTOR: FBConfiguration.autoClickAlertSelector,
       FB_SETTING_DEFAULT_ALERT_ACTION: request.session.defaultAlertAction ?: @"",
       FB_SETTING_MAX_TYPING_FREQUENCY: @([FBConfiguration maxTypingFrequency]),
       FB_SETTING_RESPECT_SYSTEM_ALERTS: @([FBConfiguration shouldRespectSystemAlerts]),
@@ -431,6 +433,13 @@
   if (nil != [settings objectForKey:FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR]) {
     [FBConfiguration setDismissAlertButtonSelector:(NSString *)[settings objectForKey:FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR]];
   }
+  if (nil != [settings objectForKey:FB_SETTING_AUTO_CLICK_ALERT_SELECTOR]) {
+    FBCommandStatus *status = [self.class configureAutoClickAlertWithSelector:settings[FB_SETTING_AUTO_CLICK_ALERT_SELECTOR]
+                                                                   forSession:request.session];
+    if (status.hasError) {
+      return FBResponseWithStatus(status);
+    }
+  }
   if (nil != [settings objectForKey:FB_SETTING_WAIT_FOR_IDLE_TIMEOUT]) {
     [FBConfiguration setWaitForIdleTimeout:[[settings objectForKey:FB_SETTING_WAIT_FOR_IDLE_TIMEOUT] doubleValue]];
   }
@@ -467,6 +476,26 @@
 
 #pragma mark - Helpers
 
++ (FBCommandStatus *)configureAutoClickAlertWithSelector:(NSString *)selector
+                                              forSession:(FBSession *)session
+{
+  if (0 == [selector length]) {
+    [FBConfiguration setAutoClickAlertSelector:selector];
+    [session disableAlertsMonitor];
+    return [FBCommandStatus ok];
+  }
+
+  NSError *error;
+  FBClassChain *parsedChain = [FBClassChainQueryParser parseQuery:selector error:&error];
+  if (nil == parsedChain) {
+    return [FBCommandStatus invalidSelectorErrorWithMessage:error.localizedDescription
+                                                  traceback:nil];
+  }
+  [FBConfiguration setAutoClickAlertSelector:selector];
+  [session enableAlertsMonitor];
+  return [FBCommandStatus ok];
+}
+
 + (NSString *)buildTimestamp
 {
   return [NSString stringWithFormat:@"%@ %@",

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>9.4.1</string>
+    <string>9.5.1</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>9.4.1</string>
+    <string>9.5.1</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>

package/WebDriverAgentLib/Routing/FBCommandStatus.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, nullable, readonly) NSString* message;
 @property (nonatomic, nullable, readonly) NSString* traceback;
 @property (nonatomic, readonly) HTTPStatusCode statusCode;
-
+@property (nonatomic, readonly) BOOL hasError;
 
 + (instancetype)ok;
 

package/WebDriverAgentLib/Routing/FBCommandStatus.m

@@ -109,6 +109,11 @@ static NSString *const FB_NO_SUCH_DRIVER_MSG = @"A session is either terminated
   return self;
 }
 
+- (BOOL)hasError
+{
+  return self.statusCode != kHTTPStatusCodeOK;
+}
+
 + (instancetype)ok
 {
   return [[FBCommandStatus alloc] initWithValue:nil];

package/WebDriverAgentLib/Routing/FBResponsePayload.m

@@ -55,7 +55,9 @@ XCUIElement *maybeStable(XCUIElement *element)
 id<FBResponsePayload> FBResponseWithCachedElement(XCUIElement *element, FBElementCache *elementCache, BOOL compact)
 {
   [elementCache storeElement:maybeStable(element)];
-  return FBResponseWithStatus([FBCommandStatus okWithValue:FBDictionaryResponseWithElement(element, compact)]);
+  NSDictionary *response = FBDictionaryResponseWithElement(element, compact);
+  element.lastSnapshot = nil;
+  return FBResponseWithStatus([FBCommandStatus okWithValue:response]);
 }
 
 id<FBResponsePayload> FBResponseWithCachedElements(NSArray<XCUIElement *> *elements, FBElementCache *elementCache, BOOL compact)
@@ -64,6 +66,7 @@ id<FBResponsePayload> FBResponseWithCachedElements(NSArray<XCUIElement *> *eleme
   for (XCUIElement *element in elements) {
     [elementCache storeElement:maybeStable(element)];
     [elementsResponse addObject:FBDictionaryResponseWithElement(element, compact)];
+    element.lastSnapshot = nil;
   }
   return FBResponseWithStatus([FBCommandStatus okWithValue:elementsResponse]);
 }

package/WebDriverAgentLib/Routing/FBSession.h

@@ -121,6 +121,22 @@ extern NSString* const FB_SAFARI_BUNDLE_ID;
  */
 - (NSUInteger)applicationStateWithBundleId:(NSString *)bundleIdentifier;
 
+/**
+ Allows to enable automated session alerts monitoring.
+ Repeated calls are ignored if alerts monitoring has been already enabled.
+
+ @returns YES if the actual alerts monitoring state has been changed
+ */
+- (BOOL)enableAlertsMonitor;
+
+/**
+ Allows to disable automated alerts monitoring
+ Repeated calls are ignored if alerts monitoring has been already disabled.
+
+ @returns YES if the actual alerts monitoring state has been changed
+ */
+- (BOOL)disableAlertsMonitor;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Routing/FBSession.m

@@ -25,6 +25,7 @@
 #import "FBXCTestDaemonsProxy.h"
 #import "XCUIApplication+FBQuiescence.h"
 #import "XCUIElement.h"
+#import "XCUIElement+FBClassChain.h"
 
 /*!
  The intial value for the default application property.
@@ -53,6 +54,22 @@ NSString *const FB_SAFARI_BUNDLE_ID = @"com.apple.mobilesafari";
 
 - (void)didDetectAlert:(FBAlert *)alert
 {
+  NSString *autoClickAlertSelector = FBConfiguration.autoClickAlertSelector;
+  if ([autoClickAlertSelector length] > 0) {
+    @try {
+      NSArray<XCUIElement*> *matches = [alert.alertElement fb_descendantsMatchingClassChain:autoClickAlertSelector
+                                                                shouldReturnAfterFirstMatch:YES];
+      if (matches.count > 0) {
+          [[matches objectAtIndex:0] tap];
+      }
+    } @catch (NSException *e) {
+      [FBLogger logFmt:@"Could not click at the alert element '%@'. Original error: %@",
+       autoClickAlertSelector, e.description];
+    }
+    // This setting has priority over other settings if enabled
+    return;
+  }
+
   if (nil == self.defaultAlertAction || 0 == self.defaultAlertAction.length) {
     return;
   }
@@ -125,23 +142,41 @@ static FBSession *_activeSession = nil;
                  defaultAlertAction:(NSString *)defaultAlertAction
 {
   FBSession *session = [self.class initWithApplication:application];
-  session.alertsMonitor = [[FBAlertsMonitor alloc] init];
-  session.alertsMonitor.delegate = (id<FBAlertsMonitorDelegate>)session;
   session.defaultAlertAction = [defaultAlertAction lowercaseString];
-  [session.alertsMonitor enable];
+  [session enableAlertsMonitor];
   return session;
 }
 
+- (BOOL)enableAlertsMonitor
+{
+  if (nil != self.alertsMonitor) {
+    return NO;
+  }
+
+  self.alertsMonitor = [[FBAlertsMonitor alloc] init];
+  self.alertsMonitor.delegate = (id<FBAlertsMonitorDelegate>)self;
+  [self.alertsMonitor enable];
+  return YES;
+}
+
+- (BOOL)disableAlertsMonitor
+{
+  if (nil == self.alertsMonitor) {
+    return NO;
+  }
+
+  [self.alertsMonitor disable];
+  self.alertsMonitor = nil;
+  return YES;
+}
+
 - (void)kill
 {
   if (nil == _activeSession) {
     return;
   }
 
-  if (nil != self.alertsMonitor) {
-    [self.alertsMonitor disable];
-    self.alertsMonitor = nil;
-  }
+  [self disableAlertsMonitor];
 
   FBScreenRecordingPromise *activeScreenRecording = FBScreenRecordingContainer.sharedInstance.screenRecordingPromise;
   if (nil != activeScreenRecording) {

package/WebDriverAgentLib/Utilities/FBConfiguration.h

@@ -283,6 +283,12 @@ typedef NS_ENUM(NSInteger, FBConfigurationKeyboardPreference) {
 + (void)setDismissAlertButtonSelector:(NSString *)classChainSelector;
 + (NSString *)dismissAlertButtonSelector;
 
+/**
+ Sets class chain selector to apply for an automated alert click
+ */
++ (void)setAutoClickAlertSelector:(NSString *)classChainSelector;
++ (NSString *)autoClickAlertSelector;
+
 /**
  * Whether to use HIDEvent for text clear.
  * By default this is enabled and HIDEvent is used for text clear.

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -51,6 +51,7 @@ static BOOL FBShouldBoundElementsByIndex;
 static BOOL FBIncludeNonModalElements;
 static NSString *FBAcceptAlertButtonSelector;
 static NSString *FBDismissAlertButtonSelector;
+static NSString *FBAutoClickAlertSelector;
 static NSTimeInterval FBWaitForIdleTimeout;
 static NSTimeInterval FBAnimationCoolOffTimeout;
 static BOOL FBShouldUseCompactResponses;
@@ -429,6 +430,16 @@ static UIInterfaceOrientation FBScreenshotOrientation;
   return FBDismissAlertButtonSelector;
 }
 
++ (void)setAutoClickAlertSelector:(NSString *)classChainSelector
+{
+  FBAutoClickAlertSelector = classChainSelector;
+}
+
++ (NSString *)autoClickAlertSelector
+{
+  return FBAutoClickAlertSelector;
+}
+
 + (void)setUseClearTextShortcut:(BOOL)enabled
 {
   FBUseClearTextShortcut = enabled;
@@ -509,6 +520,7 @@ static UIInterfaceOrientation FBScreenshotOrientation;
   FBIncludeNonModalElements = NO;
   FBAcceptAlertButtonSelector = @"";
   FBDismissAlertButtonSelector = @"";
+  FBAutoClickAlertSelector = @"";
   FBWaitForIdleTimeout = 10.;
   FBAnimationCoolOffTimeout = 2.;
   // 50 should be enough for the majority of the cases. The performance is acceptable for values up to 100.

package/WebDriverAgentLib/Utilities/FBSettings.h

@@ -39,6 +39,7 @@ extern NSString* const FB_SETTING_MAX_TYPING_FREQUENCY;
 extern NSString* const FB_SETTING_RESPECT_SYSTEM_ALERTS;
 extern NSString* const FB_SETTING_USE_CLEAR_TEXT_SHORTCUT;
 extern NSString* const FB_SETTING_LIMIT_XPATH_CONTEXT_SCOPE;
+extern NSString* const FB_SETTING_AUTO_CLICK_ALERT_SELECTOR;
 
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBSettings.m

@@ -35,3 +35,4 @@ NSString* const FB_SETTING_MAX_TYPING_FREQUENCY = @"maxTypingFrequency";
 NSString* const FB_SETTING_RESPECT_SYSTEM_ALERTS = @"respectSystemAlerts";
 NSString* const FB_SETTING_USE_CLEAR_TEXT_SHORTCUT = @"useClearTextShortcut";
 NSString* const FB_SETTING_LIMIT_XPATH_CONTEXT_SCOPE = @"limitXPathContextScope";
+NSString* const FB_SETTING_AUTO_CLICK_ALERT_SELECTOR = @"autoClickAlertSelector";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "9.4.1",
+  "version": "9.5.1",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",