appium-webdriveragent 16.13.4 → 16.13.5

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [16.13.5](https://github.com/appium/WebDriverAgent/compare/v16.13.4...v16.13.5) (2026-09-30)
+
+### Performance Improvements
+
+* stream page-source XML with exception-safe resource cleanup ([#1276](https://github.com/appium/WebDriverAgent/issues/1276)) ([4e8639b](https://github.com/appium/WebDriverAgent/commit/4e8639bf73f962591e3e7b3be211f289a19ebf84))
+
 ## [16.13.4](https://github.com/appium/WebDriverAgent/compare/v16.13.3...v16.13.4) (2026-09-30)
 
 ### Performance Improvements

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -175,154 +175,175 @@ static NSString *const topNodeIndexPath = @"top";
 + (nullable NSString *)xmlStringWithRootElement:(id<FBElement>)root
                                         options:(nullable FBXMLGenerationOptions *)options
 {
-  xmlDocPtr doc;
-  xmlTextWriterPtr writer = xmlNewTextWriterDoc(&doc, 0);
-  int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
-  if (rc < 0) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
-  } else {
-    BOOL hasScope = nil != options.scope && [options.scope length] > 0;
-    if (hasScope) {
-      rc = xmlTextWriterStartElement(writer,
-                                     (xmlChar *)[[self safeXmlStringWithString:options.scope] UTF8String]);
-      if (rc < 0) {
-        [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartElement for the tag value '%@'. Error code: %d", options.scope, rc];
-      }
+  xmlBufferPtr buffer = NULL;
+  xmlTextWriterPtr writer = NULL;
+  @try {
+    buffer = xmlBufferCreate();
+    if (NULL == buffer) {
+      [FBLogger log:@"Failed to invoke libxml2>xmlBufferCreate"];
+      return nil;
     }
-
-    if (rc >= 0) {
-      [self waitUntilStableWithElement:root];
-      // If 'includeHittableInPageSource' setting is enabled, then use native snapshots
-      // to calculate a more accurate value for the 'hittable' attribute.
-      rc = [self xmlRepresentationWithRootElement:[self snapshotWithRoot:root
-                                                        useNative:FBConfiguration.sharedInstance.includeHittableInPageSource]
-                                           writer:writer
-                                     elementStore:nil
-                                            query:nil
-                              excludingAttributes:options.excludedAttributes];
+    writer = xmlNewTextWriterMemory(buffer, 0);
+    if (NULL == writer) {
+      [FBLogger log:@"Failed to invoke libxml2>xmlNewTextWriterMemory"];
+      return nil;
     }
+    xmlTextWriterSetIndent(writer, 1);
+    xmlTextWriterSetIndentString(writer, BAD_CAST "  ");
+    int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
+    if (rc < 0) {
+      [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
+    } else {
+      BOOL hasScope = nil != options.scope && [options.scope length] > 0;
+      if (hasScope) {
+        rc = xmlTextWriterStartElement(writer,
+                                       (xmlChar *)[[self safeXmlStringWithString:options.scope] UTF8String]);
+        if (rc < 0) {
+          [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartElement for the tag value '%@'. Error code: %d", options.scope, rc];
+        }
+      }
 
-    if (rc >= 0 && hasScope) {
-      rc = xmlTextWriterEndElement(writer);
-      if (rc < 0) {
-        [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterEndElement. Error code: %d", rc];
+      if (rc >= 0) {
+        [self waitUntilStableWithElement:root];
+        // If 'includeHittableInPageSource' setting is enabled, then use native snapshots
+        // to calculate a more accurate value for the 'hittable' attribute.
+        rc = [self xmlRepresentationWithRootElement:[self snapshotWithRoot:root
+                                                          useNative:FBConfiguration.sharedInstance.includeHittableInPageSource]
+                                             writer:writer
+                                       elementStore:nil
+                                              query:nil
+                                excludingAttributes:options.excludedAttributes];
       }
-    }
 
-    if (rc >= 0) {
-      rc = xmlTextWriterEndDocument(writer);
-      if (rc < 0) {
-        [FBLogger logFmt:@"Failed to invoke libxml2>xmlXPathNewContext. Error code: %d", rc];
+      if (rc >= 0 && hasScope) {
+        rc = xmlTextWriterEndElement(writer);
+        if (rc < 0) {
+          [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterEndElement. Error code: %d", rc];
+        }
+      }
+
+      if (rc >= 0) {
+        rc = xmlTextWriterEndDocument(writer);
+        if (rc < 0) {
+          [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterEndDocument. Error code: %d", rc];
+        }
       }
     }
+    if (rc < 0) {
+      return nil;
+    }
+    return [[NSString alloc] initWithBytes:xmlBufferContent(buffer)
+                                  length:(NSUInteger)xmlBufferLength(buffer)
+                                encoding:NSUTF8StringEncoding];
+  } @finally {
+    if (NULL != writer) {
+      xmlFreeTextWriter(writer);
+    }
+    if (NULL != buffer) {
+      xmlBufferFree(buffer);
+    }
   }
-  if (rc < 0) {
-    xmlFreeTextWriter(writer);
-    xmlFreeDoc(doc);
-    return nil;
-  }
-  int buffersize;
-  xmlChar *xmlbuff;
-  xmlDocDumpFormatMemory(doc, &xmlbuff, &buffersize, 1);
-  xmlFreeTextWriter(writer);
-  xmlFreeDoc(doc);
-  NSString *result = [NSString stringWithCString:(const char *)xmlbuff encoding:NSUTF8StringEncoding];
-  xmlFree(xmlbuff);
-  return result;
 }
 
 + (NSArray<id<FBXCElementSnapshot>> *)matchesWithRootElement:(id<FBElement>)root
                                                     forQuery:(NSString *)xpathQuery
 {
-  xmlDocPtr doc;
-
-  xmlTextWriterPtr writer = xmlNewTextWriterDoc(&doc, 0);
-  if (NULL == writer) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlNewTextWriterDoc for XPath query \"%@\"", xpathQuery];
-    return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
-  }
-  NSMutableDictionary *elementStore = [NSMutableDictionary dictionary];
-  int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
-  id<FBXCElementSnapshot> lookupScopeSnapshot = nil;
-  id<FBXCElementSnapshot> contextRootSnapshot = nil;
-  BOOL useNativeSnapshot = nil == xpathQuery
-    ? NO
-    : [[self.class elementAttributesWithXPathQuery:xpathQuery] containsObject:FBHittableAttribute.class];
-  if (rc < 0) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
-  } else {
-    [self waitUntilStableWithElement:root];
-    if (FBConfiguration.sharedInstance.limitXpathContextScope) {
-      lookupScopeSnapshot = [self snapshotWithRoot:root useNative:useNativeSnapshot];
+  xmlDocPtr doc = NULL;
+  xmlTextWriterPtr writer = NULL;
+  xmlXPathObjectPtr contextNodeQueryResult = NULL;
+  xmlXPathObjectPtr queryResult = NULL;
+  @try {
+    writer = xmlNewTextWriterDoc(&doc, 0);
+    if (NULL == writer) {
+      [FBLogger logFmt:@"Failed to invoke libxml2>xmlNewTextWriterDoc for XPath query \"%@\"", xpathQuery];
+      return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
+    }
+    NSMutableDictionary *elementStore = [NSMutableDictionary dictionary];
+    int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
+    id<FBXCElementSnapshot> lookupScopeSnapshot = nil;
+    id<FBXCElementSnapshot> contextRootSnapshot = nil;
+    BOOL useNativeSnapshot = nil == xpathQuery
+      ? NO
+      : [[self.class elementAttributesWithXPathQuery:xpathQuery] containsObject:FBHittableAttribute.class];
+    if (rc < 0) {
+      [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
     } else {
-      if ([root isKindOfClass:XCUIElement.class]) {
-        lookupScopeSnapshot = [self snapshotWithRoot:[(XCUIElement *)root application]
-                                           useNative:useNativeSnapshot];
-        // root.lastSnapshot may be stale leftover from an unrelated earlier command.
-        contextRootSnapshot = [root isKindOfClass:XCUIApplication.class]
-          ? nil
-          : ([(XCUIElement *)root fb_cachedSnapshot] ?: [self snapshotWithRoot:(XCUIElement *)root
-                                                                     useNative:useNativeSnapshot]);
+      [self waitUntilStableWithElement:root];
+      if (FBConfiguration.sharedInstance.limitXpathContextScope) {
+        lookupScopeSnapshot = [self snapshotWithRoot:root useNative:useNativeSnapshot];
       } else {
-        lookupScopeSnapshot = (id<FBXCElementSnapshot>)root;
-        contextRootSnapshot = nil == lookupScopeSnapshot.parent ? nil : (id<FBXCElementSnapshot>)root;
-        while (nil != lookupScopeSnapshot.parent) {
-          lookupScopeSnapshot = lookupScopeSnapshot.parent;
+        if ([root isKindOfClass:XCUIElement.class]) {
+          lookupScopeSnapshot = [self snapshotWithRoot:[(XCUIElement *)root application]
+                                             useNative:useNativeSnapshot];
+          // root.lastSnapshot may be stale leftover from an unrelated earlier command.
+          contextRootSnapshot = [root isKindOfClass:XCUIApplication.class]
+            ? nil
+            : ([(XCUIElement *)root fb_cachedSnapshot] ?: [self snapshotWithRoot:(XCUIElement *)root
+                                                                       useNative:useNativeSnapshot]);
+        } else {
+          lookupScopeSnapshot = (id<FBXCElementSnapshot>)root;
+          contextRootSnapshot = nil == lookupScopeSnapshot.parent ? nil : (id<FBXCElementSnapshot>)root;
+          while (nil != lookupScopeSnapshot.parent) {
+            lookupScopeSnapshot = lookupScopeSnapshot.parent;
+          }
         }
       }
-    }
 
-    rc = [self xmlRepresentationWithRootElement:lookupScopeSnapshot
-                                         writer:writer
-                                   elementStore:elementStore
-                                          query:xpathQuery
-                            excludingAttributes:nil];
-    if (rc >= 0) {
-      rc = xmlTextWriterEndDocument(writer);
-      if (rc < 0) {
-        [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterEndDocument. Error code: %d", rc];
+      rc = [self xmlRepresentationWithRootElement:lookupScopeSnapshot
+                                           writer:writer
+                                     elementStore:elementStore
+                                            query:xpathQuery
+                              excludingAttributes:nil];
+      if (rc >= 0) {
+        rc = xmlTextWriterEndDocument(writer);
+        if (rc < 0) {
+          [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterEndDocument. Error code: %d", rc];
+        }
       }
     }
-  }
-  if (rc < 0) {
-    xmlFreeTextWriter(writer);
-    xmlFreeDoc(doc);
-    return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
-  }
+    if (rc < 0) {
+      return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
+    }
 
-  xmlXPathObjectPtr contextNodeQueryResult = [self matchNodeInDocument:doc
-                                                          elementStore:elementStore.copy
-                                                           forSnapshot:contextRootSnapshot];
-  xmlNodePtr contextNode = NULL;
-  if (NULL != contextNodeQueryResult) {
-    xmlNodeSetPtr nodeSet = contextNodeQueryResult->nodesetval;
-    if (!xmlXPathNodeSetIsEmpty(nodeSet)) {
-      contextNode = nodeSet->nodeTab[0];
+    contextNodeQueryResult = [self matchNodeInDocument:doc
+                                                            elementStore:elementStore.copy
+                                                             forSnapshot:contextRootSnapshot];
+    xmlNodePtr contextNode = NULL;
+    if (NULL != contextNodeQueryResult) {
+      xmlNodeSetPtr nodeSet = contextNodeQueryResult->nodesetval;
+      if (!xmlXPathNodeSetIsEmpty(nodeSet)) {
+        contextNode = nodeSet->nodeTab[0];
+      }
+    }
+    NSString *evaluationError = nil;
+    queryResult = [self evaluate:xpathQuery
+                                          document:doc
+                                       contextNode:contextNode
+                                      errorMessage:&evaluationError];
+    if (NULL == queryResult) {
+      return [self throwException:FBInvalidXPathException forQuery:xpathQuery detail:evaluationError];
     }
-  }
-  NSString *evaluationError = nil;
-  xmlXPathObjectPtr queryResult = [self evaluate:xpathQuery
-                                        document:doc
-                                     contextNode:contextNode
-                                    errorMessage:&evaluationError];
-  if (NULL != contextNodeQueryResult) {
-    xmlXPathFreeObject(contextNodeQueryResult);
-  }
-  if (NULL == queryResult) {
-    xmlFreeTextWriter(writer);
-    xmlFreeDoc(doc);
-    return [self throwException:FBInvalidXPathException forQuery:xpathQuery detail:evaluationError];
-  }
 
-  NSArray *matchingSnapshots = [self collectMatchingSnapshots:queryResult->nodesetval
-                                                 elementStore:elementStore];
-  xmlXPathFreeObject(queryResult);
-  xmlFreeTextWriter(writer);
-  xmlFreeDoc(doc);
-  if (nil == matchingSnapshots) {
-    return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
+    NSArray *matchingSnapshots = [self collectMatchingSnapshots:queryResult->nodesetval
+                                                   elementStore:elementStore];
+    if (nil == matchingSnapshots) {
+      return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
+    }
+    return matchingSnapshots;
+  } @finally {
+    if (NULL != queryResult) {
+      xmlXPathFreeObject(queryResult);
+    }
+    if (NULL != contextNodeQueryResult) {
+      xmlXPathFreeObject(contextNodeQueryResult);
+    }
+    if (NULL != writer) {
+      xmlFreeTextWriter(writer);
+    }
+    if (NULL != doc) {
+      xmlFreeDoc(doc);
+    }
   }
-  return matchingSnapshots;
 }
 
 + (NSArray *)collectMatchingSnapshots:(xmlNodeSetPtr)nodeSet

package/WebDriverAgentTests/UnitTests/FBXPathTests.m

@@ -16,6 +16,33 @@
 #import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "XCTestPrivateSymbols.h"
 
+// libxml's node callbacks are thread-local; restore any existing callbacks after each probe.
+static __thread NSUInteger FBReviewCreatedDocs;
+static __thread NSUInteger FBReviewFreedDocs;
+static __thread xmlRegisterNodeFunc FBReviewPreviousRegister;
+static __thread xmlDeregisterNodeFunc FBReviewPreviousDeregister;
+
+static void FBReviewRegisterNode(xmlNodePtr node)
+{
+  if (node->type == XML_DOCUMENT_NODE) { FBReviewCreatedDocs++; }
+  if (NULL != FBReviewPreviousRegister) { FBReviewPreviousRegister(node); }
+}
+
+static void FBReviewDeregisterNode(xmlNodePtr node)
+{
+  if (node->type == XML_DOCUMENT_NODE) { FBReviewFreedDocs++; }
+  if (NULL != FBReviewPreviousDeregister) { FBReviewPreviousDeregister(node); }
+}
+
+@interface FBThrowingLabelSnapshot : XCElementSnapshotDouble
+@end
+@implementation FBThrowingLabelSnapshot
+- (NSString *)label
+{
+  @throw [NSException exceptionWithName:@"SnapshotAttributeFailure" reason:@"test" userInfo:nil];
+}
+@end
+
 @interface FBTraversalSnapshot : XCElementSnapshotDouble
 @property (nonatomic, copy) NSArray *childSnapshots;
 @property (nonatomic, weak) FBTraversalSnapshot *parentSnapshot;
@@ -57,6 +84,44 @@
   }
 }
 
+- (void)testDirectXmlWriterPreservesEscapingAndFormatting
+{
+  XCElementSnapshotDouble *snapshot = [XCElementSnapshotDouble new];
+  snapshot.label = @"line one\nline two\t& < > \" йоло";
+  snapshot.value = @"value";
+  NSString *expected = [[self xmlStringWithElement:(id)snapshot xpathQuery:nil excludingAttributes:nil]
+    stringByReplacingOccurrencesOfString:@" private_indexPath=\"top\"" withString:@""];
+  NSString *actual = [FBXPath xmlStringWithRootElement:(id)snapshot options:nil];
+  XCTAssertEqualObjects(actual, expected);
+}
+
+- (void)testXmlDocumentsAreFreedWhenSnapshotAttributesThrow
+{
+  for (NSNumber *isLookup in @[@NO, @YES]) {
+    FBReviewCreatedDocs = 0;
+    FBReviewFreedDocs = 0;
+    FBReviewPreviousRegister = xmlRegisterNodeDefault(FBReviewRegisterNode);
+    FBReviewPreviousDeregister = xmlDeregisterNodeDefault(FBReviewDeregisterNode);
+    @try {
+      id<FBElement> snapshot = (id)[FBThrowingLabelSnapshot new];
+      if (isLookup.boolValue) {
+        XCTAssertThrowsSpecificNamed([FBXPath matchesWithRootElement:snapshot forQuery:@"//*[@label]"],
+                                     NSException, @"SnapshotAttributeFailure");
+      } else {
+        XCTAssertThrowsSpecificNamed([FBXPath xmlStringWithRootElement:snapshot options:nil],
+                                     NSException, @"SnapshotAttributeFailure");
+      }
+      if (isLookup.boolValue) {
+        XCTAssertGreaterThan(FBReviewCreatedDocs, 0u);
+      }
+      XCTAssertEqual(FBReviewCreatedDocs, FBReviewFreedDocs);
+    } @finally {
+      xmlRegisterNodeDefault(FBReviewPreviousRegister);
+      xmlDeregisterNodeDefault(FBReviewPreviousDeregister);
+    }
+  }
+}
+
 - (NSString *)xmlStringWithElement:(id<FBXCElementSnapshot>)snapshot
                         xpathQuery:(nullable NSString *)query
                excludingAttributes:(nullable NSArray<NSString *> *)excludedAttributes

package/package.json

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