appium-webdriveragent 16.1.4 → 16.1.5

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [16.1.5](https://github.com/appium/WebDriverAgent/compare/v16.1.4...v16.1.5) (2026-08-05)
+
+### Bug Fixes
+
+* Update various consumers to properly use cached snapshots ([#1198](https://github.com/appium/WebDriverAgent/issues/1198)) ([bed67cc](https://github.com/appium/WebDriverAgent/commit/bed67ccf6a1375f1d1164d7a2ef18d10ac44f632))
+
 ## [16.1.4](https://github.com/appium/WebDriverAgent/compare/v16.1.3...v16.1.4) (2026-08-04)
 
 ### Bug Fixes

package/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.m

@@ -135,7 +135,7 @@ static NSString *const FB_LIMITED_ACCESS_PROMPT_BUNDLE_ID = @"com.apple.Contacts
 
     // In case of iPad we want to check if sheet isn't contained by popover.
     // In that case we ignore it.
-    id<FBXCElementSnapshot> sheetSnapshot = sheet.lastSnapshot ?: sheet.fb_cachedSnapshot ?: [sheet fb_customSnapshot];
+    id<FBXCElementSnapshot> sheetSnapshot = sheet.fb_cachedSnapshot ?: [sheet fb_customSnapshot];
     BOOL isInsidePopover = NO;
     id<FBXCElementSnapshot> ancestor = sheetSnapshot.parent;
     while (nil != ancestor) {
@@ -154,7 +154,7 @@ static NSString *const FB_LIMITED_ACCESS_PROMPT_BUNDLE_ID = @"com.apple.Contacts
   }
 
   for (XCUIElement *scrollView in scrollViews) {
-    id<FBXCElementSnapshot> scrollViewSnapshot = scrollView.lastSnapshot ?: scrollView.fb_cachedSnapshot ?: [scrollView fb_customSnapshot];
+    id<FBXCElementSnapshot> scrollViewSnapshot = scrollView.fb_cachedSnapshot ?: [scrollView fb_customSnapshot];
     id<FBXCElementSnapshot> app = [[FBXCElementSnapshotWrapper ensureWrapped:scrollViewSnapshot] fb_parentMatchingType:XCUIElementTypeApplication];
     if (nil == app || ![app.label isEqualToString:FB_SAFARI_APP_NAME]) {
       continue;

package/WebDriverAgentLib/Categories/XCUIElement+FBClassChain.m

@@ -137,7 +137,7 @@
   // Reuse an already-taken snapshot of `self` if one is available (e.g. the
   // caller just resolved/inspected this same element) instead of always
   // paying for a fresh one.
-  NSArray<id<FBXCElementSnapshot>> *currentRoots = @[self.lastSnapshot ?: [self fb_customSnapshot]];
+  NSArray<id<FBXCElementSnapshot>> *currentRoots = @[self.lastSnapshot ?: self.fb_cachedSnapshot ?: [self fb_customSnapshot]];
   FBClassChainItem *chainItem = lookupChain.firstObject;
   NSArray<id<FBXCElementSnapshot>> *candidates = [self.class fb_snapshotsMatchingItem:chainItem inRoots:currentRoots];
   [lookupChain removeObjectAtIndex:0];

package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.h

@@ -7,6 +7,7 @@
  */
 
 #import <XCTest/XCTest.h>
+#import <WebDriverAgentLib/FBXCElementSnapshot.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -50,6 +51,25 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error);
           frequency:(NSUInteger)frequency
               error:(NSError **)error;
 
+/**
+ Types a text into element, reusing a snapshot the caller already holds
+ instead of fetching a new one. Only pass a snapshot that is known to
+ reflect the element's current state (e.g. one taken moments earlier in
+ the same operation) - a stale snapshot here will not be detected as such.
+
+ @param text text that should be typed
+ @param shouldClear Whether to clear the input field before start typing
+ @param frequency Frequency of typing (letters per sec)
+ @param snapshot A recent snapshot of the receiver
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_typeText:(NSString *)text
+        shouldClear:(BOOL)shouldClear
+          frequency:(NSUInteger)frequency
+           snapshot:(id<FBXCElementSnapshot>)snapshot
+              error:(NSError **)error;
+
 /**
  Clears text on element.
  It will try to activate keyboard on element, if element has no keyboard focus.
@@ -59,6 +79,19 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error);
  */
 - (BOOL)fb_clearTextWithError:(NSError **)error;
 
+/**
+ Clears text on element, reusing a snapshot the caller already holds
+ instead of fetching a new one. Only pass a snapshot that is known to
+ reflect the element's current state (e.g. one taken moments earlier in
+ the same operation) - a stale snapshot here will not be detected as such.
+
+ @param snapshot A recent snapshot of the receiver
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_clearTextWithSnapshot:(id<FBXCElementSnapshot>)snapshot
+                            error:(NSError **)error;
+
 @end
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.m

@@ -109,7 +109,22 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
           frequency:(NSUInteger)frequency
               error:(NSError **)error
 {
+  // No snapshot was handed to us, so there is nothing to safely reuse -
+  // always fetch a fresh one.
   id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
+  return [self fb_typeText:text
+               shouldClear:shouldClear
+                 frequency:frequency
+                  snapshot:snapshot
+                     error:error];
+}
+
+- (BOOL)fb_typeText:(NSString *)text
+        shouldClear:(BOOL)shouldClear
+          frequency:(NSUInteger)frequency
+           snapshot:(id<FBXCElementSnapshot>)snapshot
+              error:(NSError **)error
+{
   FBXCElementSnapshotWrapper *wrapped = [FBXCElementSnapshotWrapper ensureWrapped:snapshot];
   [self fb_prepareForTextInputWithSnapshot:wrapped];
   if (shouldClear && ![self fb_clearTextWithSnapshot:wrapped shouldPrepareForInput:NO error:error]) {
@@ -120,7 +135,15 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
 
 - (BOOL)fb_clearTextWithError:(NSError **)error
 {
+  // No snapshot was handed to us, so there is nothing to safely reuse -
+  // always fetch a fresh one.
   id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
+  return [self fb_clearTextWithSnapshot:snapshot error:error];
+}
+
+- (BOOL)fb_clearTextWithSnapshot:(id<FBXCElementSnapshot>)snapshot
+                            error:(NSError **)error
+{
   return [self fb_clearTextWithSnapshot:[FBXCElementSnapshotWrapper ensureWrapped:snapshot]
                   shouldPrepareForInput:YES
                                   error:error];

package/WebDriverAgentLib/Commands/FBElementCommands.m

@@ -221,9 +221,14 @@
   }
   NSUInteger frequency = (NSUInteger)[request.arguments[@"frequency"] longLongValue] ?: [FBConfiguration maxTypingFrequency];
   NSError *error = nil;
+  // checkStaleness:YES above already took a fresh, verified-live snapshot of
+  // `element` and cached it as `lastSnapshot` - reuse it instead of paying
+  // for another round trip.
+  id<FBXCElementSnapshot> snapshot = element.lastSnapshot ?: element.fb_cachedSnapshot ?: [element fb_standardSnapshot];
   if (![element fb_typeText:textToType
                 shouldClear:NO
                   frequency:frequency
+                   snapshot:snapshot
                       error:&error]) {
     return FBResponseWithStatus([FBCommandStatus invalidElementStateErrorWithMessage:error.description traceback:nil]);
   }

package/WebDriverAgentLib/FBAlert.m

@@ -74,7 +74,7 @@
     XCUIElement *alertElement = self.alertElement;
     self.cachedAlertSnapshot = nil == alertElement
       ? nil
-      : (alertElement.lastSnapshot ?: alertElement.fb_cachedSnapshot ?: [alertElement fb_customSnapshot]);
+      : (alertElement.fb_cachedSnapshot ?: [alertElement fb_customSnapshot]);
     self.hasCachedAlertSnapshot = YES;
   }
   return self.cachedAlertSnapshot;
@@ -194,7 +194,15 @@
     [self fb_raiseSetTextFailedExceptionWithReason:@"Failed to resolve the input field element"];
   }
   NSError *error;
-  if (![dstField fb_typeText:text shouldClear:YES error:&error]) {
+  // dstField was just resolved via a live query in fb_elementForSnapshot:underElement:
+  // above, so its cached snapshot can be safely reconstructed in memory
+  // instead of paying for a fresh round trip.
+  id<FBXCElementSnapshot> snapshot = dstField.fb_cachedSnapshot ?: [dstField fb_standardSnapshot];
+  if (![dstField fb_typeText:text
+                  shouldClear:YES
+                    frequency:FBConfiguration.maxTypingFrequency
+                     snapshot:snapshot
+                        error:&error]) {
     [self fb_raiseSetTextFailedExceptionWithReason:error.description];
   }
 }

package/WebDriverAgentLib/Info.plist

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "16.1.4",
+  "version": "16.1.5",
   "description": "Package bundling WebDriverAgent",
   "keywords": [
     "Appium",