appium-webdriveragent 3.15.0 → 3.17.0

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.h

@@ -11,6 +11,7 @@
 
 @class XCElementSnapshot;
 @class XCAccessibilityElement;
+@class FBXMLGenerationOptions;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -45,18 +46,20 @@ NS_ASSUME_NONNULL_BEGIN
 - (NSDictionary *)fb_accessibilityTree;
 
 /**
- Return application elements tree in form of xml string
+ Return application elements tree in a form of xml string
+ with default options.
+
+ @return nil if there was a failure while retriveing the page source.
  */
 - (nullable NSString *)fb_xmlRepresentation;
 
 /**
- Return application elements tree in form of xml string exluding the given attribute names.
+ Return application elements tree in a form of xml string
 
- @param excludedAttributes the list of XML attribute names to be excluded from the resulting document.
- Invalid attribute names are silently skipped
- @returns The XML representation of the current element as a string
+ @param options Optional values that affect the resulting XML generation process.
+ @return nil if there was a failure while retriveing the page source.
  */
-- (NSString *)fb_xmlRepresentationWithoutAttributes:(NSArray<NSString *> *)excludedAttributes;
+- (nullable NSString *)fb_xmlRepresentationWithOptions:(nullable FBXMLGenerationOptions *)options;
 
 /**
  Return application elements tree in form of internal XCTest debugDescription string

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m

@@ -20,6 +20,7 @@
 #import "FBXPath.h"
 #import "FBXCTestDaemonsProxy.h"
 #import "FBXCAXClientProxy.h"
+#import "FBXMLGenerationOptions.h"
 #import "XCAccessibilityElement.h"
 #import "XCElementSnapshot+FBHelpers.h"
 #import "XCUIDevice+FBHelpers.h"
@@ -180,15 +181,12 @@ static NSString* const FBUnknownBundleId = @"unknown";
 
 - (NSString *)fb_xmlRepresentation
 {
-  return [FBXPath xmlStringWithRootElement:self excludingAttributes:nil];
+  return [self fb_xmlRepresentationWithOptions:nil];
 }
 
-- (NSString *)fb_xmlRepresentationWithoutAttributes:(NSArray<NSString *> *)excludedAttributes
+- (NSString *)fb_xmlRepresentationWithOptions:(FBXMLGenerationOptions *)options
 {
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wnullable-to-nonnull-conversion"
-  return [FBXPath xmlStringWithRootElement:self excludingAttributes:excludedAttributes];
-#pragma clang diagnostic pop
+  return [FBXPath xmlStringWithRootElement:self options:options];
 }
 
 - (NSString *)fb_descriptionRepresentation

package/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.h

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <XCTest/XCTest.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIApplication (FBUIInterruptions)
+
+/**
+ * Disables automatic UI interruptions handling for all applications.
+ */
++ (void)fb_disableUIInterruptionsHandling;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.m

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "XCUIApplication+FBUIInterruptions.h"
+
+#import "FBReflectionUtils.h"
+#import "XCUIApplication.h"
+
+@implementation XCUIApplication (FBUIInterruptions)
+
+- (BOOL)fb_doesNotHandleUIInterruptions
+{
+  return YES;
+}
+
++ (void)fb_disableUIInterruptionsHandling
+{
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    FBReplaceMethod([self class],
+                    @selector(doesNotHandleUIInterruptions),
+                    @selector(fb_doesNotHandleUIInterruptions));
+  });
+}
+
+@end

package/WebDriverAgentLib/Commands/FBDebugCommands.m

@@ -12,6 +12,7 @@
 #import "FBApplication.h"
 #import "FBRouteRequest.h"
 #import "FBSession.h"
+#import "FBXMLGenerationOptions.h"
 #import "XCUIApplication+FBHelpers.h"
 #import "XCUIElement+FBUtilities.h"
 #import "FBXPath.h"
@@ -43,14 +44,16 @@ static NSString *const SOURCE_FORMAT_DESCRIPTION = @"description";
   // This method might be called without session
   FBApplication *application = request.session.activeApplication ?: FBApplication.fb_activeApplication;
   NSString *sourceType = request.parameters[@"format"] ?: SOURCE_FORMAT_XML;
+  NSString *sourceScope = request.parameters[@"scope"];
   id result;
   if ([sourceType caseInsensitiveCompare:SOURCE_FORMAT_XML] == NSOrderedSame) {
     NSArray<NSString *> *excludedAttributes = nil == request.parameters[@"excluded_attributes"]
       ? nil
       : [request.parameters[@"excluded_attributes"] componentsSeparatedByString:@","];
-    result = nil == excludedAttributes
-      ? application.fb_xmlRepresentation
-      : [application fb_xmlRepresentationWithoutAttributes:(NSArray<NSString *> *)excludedAttributes];
+    result = [application fb_xmlRepresentationWithOptions:
+        [[[FBXMLGenerationOptions new]
+          withExcludedAttributes:excludedAttributes]
+         withScope:sourceScope]];
   } else if ([sourceType caseInsensitiveCompare:SOURCE_FORMAT_JSON] == NSOrderedSame) {
     result = application.fb_tree;
   } else if ([sourceType caseInsensitiveCompare:SOURCE_FORMAT_DESCRIPTION] == NSOrderedSame) {

package/WebDriverAgentLib/Utilities/FBConfiguration.h

@@ -118,6 +118,11 @@ extern NSString *const FBSnapshotMaxDepthKey;
  */
 + (BOOL)verboseLoggingEnabled;
 
+/**
+ Disables automatic handling of XCTest UI interruptions.
+ */
++ (void)disableApplicationUIInterruptionsHandling;
+
 /**
  * Configure keyboards preference to make test running stable
  */

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -17,6 +17,7 @@
 #import "XCTestPrivateSymbols.h"
 #import "XCElementSnapshot.h"
 #import "XCTestConfiguration.h"
+#import "XCUIApplication+FBUIInterruptions.h"
 
 static NSUInteger const DefaultStartingPort = 8100;
 static NSUInteger const DefaultMjpegServerPort = 9100;
@@ -74,6 +75,11 @@ static UIInterfaceOrientation FBScreenshotOrientation = UIInterfaceOrientationUn
   [[NSUserDefaults standardUserDefaults] setBool:YES forKey:@"XCTDisableRemoteQueryEvaluation"];
 }
 
++ (void)disableApplicationUIInterruptionsHandling
+{
+  [XCUIApplication fb_disableUIInterruptionsHandling];
+}
+
 + (void)enableXcTestDebugLogs
 {
   ((XCTestConfiguration *)XCTestConfiguration.activeTestConfiguration).emitOSLogs = YES;

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -33,7 +33,7 @@ static const char *QUEUE_NAME = "JPEG Screenshots Provider Queue";
 @property (nonatomic, readonly) NSMutableArray<GCDAsyncSocket *> *listeningClients;
 @property (nonatomic, readonly) mach_timebase_info_data_t timebaseInfo;
 @property (nonatomic, readonly) FBImageIOScaler *imageScaler;
-@property (nonatomic, readonly) unsigned int mainScreenID;
+@property (nonatomic, readonly) long long mainScreenID;
 
 @end
 

package/WebDriverAgentLib/Utilities/FBReflectionUtils.h

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Swizzles the implemntation of originalSelector with the swizzledSelector for the given class.
+ * Both methods must belong to this class.
+ *
+ * @param cls The class where to swizzle
+ * @param originalSelector original method selector
+ * @paramswizzledSelector swizzled method selector
+ */
+void FBReplaceMethod(Class cls, SEL originalSelector, SEL swizzledSelector);
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBReflectionUtils.m

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "FBReflectionUtils.h"
+
+#import <objc/runtime.h>
+
+void FBReplaceMethod(Class class, SEL originalSelector, SEL swizzledSelector) {
+  Method originalMethod = class_getInstanceMethod(class, originalSelector);
+  Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
+
+  BOOL didAddMethod =
+  class_addMethod(class,
+                  originalSelector,
+                  method_getImplementation(swizzledMethod),
+                  method_getTypeEncoding(swizzledMethod));
+
+  if (didAddMethod) {
+    class_replaceMethod(class,
+                        swizzledSelector,
+                        method_getImplementation(originalMethod),
+                        method_getTypeEncoding(originalMethod));
+  } else {
+    method_exchangeImplementations(originalMethod, swizzledMethod);
+  }
+}

package/WebDriverAgentLib/Utilities/FBScreenshot.h

@@ -51,7 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param error If there is an error, upon return contains an NSError object that describes the problem.
  @return Device screenshot as PNG- or JPG-encoded data or nil in case of failure
  */
-+ (nullable NSData *)takeInOriginalResolutionWithScreenID:(unsigned int)screenID
++ (nullable NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                                        compressionQuality:(CGFloat)compressionQuality
                                                       uti:(NSString *)uti
                                                   timeout:(NSTimeInterval)timeout

package/WebDriverAgentLib/Utilities/FBScreenshot.m

@@ -123,7 +123,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   return screenshotData;
 }
 
-+ (NSData *)takeWithScreenID:(unsigned int)screenID
++ (NSData *)takeWithScreenID:(long long)screenID
                        scale:(CGFloat)scale
           compressionQuality:(CGFloat)compressionQuality
                         rect:(CGRect)rect
@@ -146,7 +146,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
                                                         error:error];
 }
 
-+ (NSData *)takeInOriginalResolutionWithScreenID:(unsigned int)screenID
++ (NSData *)takeInOriginalResolutionWithScreenID:(long long)screenID
                               compressionQuality:(CGFloat)compressionQuality
                                              uti:(NSString *)uti
                                          timeout:(NSTimeInterval)timeout
@@ -254,7 +254,7 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   return imageEncoding;
 }
 
-+ (nullable id)screenshotRequestWithScreenID:(unsigned int)screenID
++ (nullable id)screenshotRequestWithScreenID:(long long)screenID
                                         rect:(struct CGRect)rect
                                          uti:(NSString *)uti
                           compressionQuality:(CGFloat)compressionQuality

package/WebDriverAgentLib/Utilities/FBXCAXClientProxy.m

@@ -13,9 +13,10 @@
 
 #import "FBConfiguration.h"
 #import "FBLogger.h"
+#import "FBMacros.h"
+#import "FBReflectionUtils.h"
 #import "XCAXClient_iOS.h"
 #import "XCUIDevice.h"
-#import "FBMacros.h"
 
 static id FBAXClient = nil;
 
@@ -35,28 +36,9 @@ static id FBAXClient = nil;
 {
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
-      Class class = [self class];
-
-      SEL originalSelector = @selector(defaultParameters);
-      SEL swizzledSelector = @selector(fb_getParametersForElementSnapshot);
-
-      Method originalMethod = class_getInstanceMethod(class, originalSelector);
-      Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
-
-      BOOL didAddMethod =
-          class_addMethod(class,
-              originalSelector,
-              method_getImplementation(swizzledMethod),
-              method_getTypeEncoding(swizzledMethod));
-
-      if (didAddMethod) {
-          class_replaceMethod(class,
-              swizzledSelector,
-              method_getImplementation(originalMethod),
-              method_getTypeEncoding(originalMethod));
-      } else {
-          method_exchangeImplementations(originalMethod, swizzledMethod);
-      }
+    SEL originalParametersSelector = @selector(defaultParameters);
+    SEL swizzledParametersSelector = @selector(fb_getParametersForElementSnapshot);
+    FBReplaceMethod([self class], originalParametersSelector, swizzledParametersSelector);
   });
 }
 

package/WebDriverAgentLib/Utilities/FBXMLGenerationOptions.h

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBXMLGenerationOptions : NSObject
+
+/**
+ XML buidling scope. Passing nil means the XML should be built in the default scope,
+ i.e no changes to the original tree structore. If the scope is provided then the resulting
+ XML tree will be put under the root, which name is equal to the given scope value.
+ */
+@property (nonatomic, nullable) NSString *scope;
+/**
+ The list of attribute names to exclude from the resulting document.
+ Passing nil means all the available attributes should be included
+ */
+@property (nonatomic, nullable) NSArray<NSString *> *excludedAttributes;
+
+/**
+ Allows to provide XML scope.
+
+ @param scope See the property description above
+ @return self instance for chaining
+ */
+- (FBXMLGenerationOptions *)withScope:(nullable NSString *)scope;
+
+/**
+ Allows to provide a list of excluded XML attributes.
+
+ @param excludedAttributes See the property description above
+ @return self instance for chaining
+ */
+- (FBXMLGenerationOptions *)withExcludedAttributes:(nullable NSArray<NSString *> *)excludedAttributes;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBXMLGenerationOptions.m

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "FBXMLGenerationOptions.h"
+
+@implementation FBXMLGenerationOptions
+
+- (FBXMLGenerationOptions *)withScope:(NSString *)scope
+{
+  self.scope = scope;
+  return self;
+}
+
+- (FBXMLGenerationOptions *)withExcludedAttributes:(NSArray<NSString *> *)excludedAttributes
+{
+  self.excludedAttributes = excludedAttributes;
+  return self;
+}
+
+@end

package/WebDriverAgentLib/Utilities/FBXPath.h

@@ -27,6 +27,8 @@
 #pragma clang diagnostic pop
 #endif
 
+@class FBXMLGenerationOptions;
+
 NS_ASSUME_NONNULL_BEGIN
 
 @interface FBXPath : NSObject
@@ -47,12 +49,11 @@ NS_ASSUME_NONNULL_BEGIN
  representation, which is used for XPath search
  
  @param root the root element
- @param excludedAttributes the list of attribute names to exclude from the resulting document.
- Passing nil means all the available attributes should be included
+ @param options Optional values that affect the resulting XML creation process
  @return valid XML document as string or nil in case of failure
  */
 + (nullable NSString *)xmlStringWithRootElement:(id<FBElement>)root
-                            excludingAttributes:(nullable NSArray<NSString *> *)excludedAttributes;
+                                        options:(nullable FBXMLGenerationOptions *)options;
 
 @end
 

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -12,6 +12,7 @@
 #import "FBConfiguration.h"
 #import "FBExceptions.h"
 #import "FBLogger.h"
+#import "FBXMLGenerationOptions.h"
 #import "NSString+FBXMLSafeString.h"
 #import "XCElementSnapshot+FBHelpers.h"
 #import "XCUIElement.h"
@@ -117,15 +118,45 @@ static NSString *const topNodeIndexPath = @"top";
 }
 
 + (nullable NSString *)xmlStringWithRootElement:(id<FBElement>)root
-                            excludingAttributes:(nullable NSArray<NSString *> *)excludedAttributes
+                                        options:(nullable FBXMLGenerationOptions *)options
 {
   xmlDocPtr doc;
   xmlTextWriterPtr writer = xmlNewTextWriterDoc(&doc, 0);
-  int rc = [self xmlRepresentationWithRootElement:root
+  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) {
+      rc = [self xmlRepresentationWithRootElement:root
                                            writer:writer
                                      elementStore:nil
                                             query:nil
-                              excludingAttributes:excludedAttributes];
+                              excludingAttributes:options.excludedAttributes];
+    }
+
+    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>xmlXPathNewContext. Error code: %d", rc];
+      }
+    }
+  }
   if (rc < 0) {
     xmlFreeTextWriter(writer);
     xmlFreeDoc(doc);
@@ -141,7 +172,8 @@ static NSString *const topNodeIndexPath = @"top";
   return result;
 }
 
-+ (NSArray<XCElementSnapshot *> *)matchesWithRootElement:(id<FBElement>)root forQuery:(NSString *)xpathQuery
++ (NSArray<XCElementSnapshot *> *)matchesWithRootElement:(id<FBElement>)root
+                                                forQuery:(NSString *)xpathQuery
 {
   xmlDocPtr doc;
 
@@ -151,11 +183,22 @@ static NSString *const topNodeIndexPath = @"top";
     return [self throwException:FBXPathQueryEvaluationException forQuery:xpathQuery];
   }
   NSMutableDictionary *elementStore = [NSMutableDictionary dictionary];
-  int rc = [self xmlRepresentationWithRootElement:root
-                                           writer:writer
-                                     elementStore:elementStore
-                                            query:xpathQuery
-                              excludingAttributes:nil];
+  int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
+  if (rc < 0) {
+    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
+  } else {
+    rc = [self xmlRepresentationWithRootElement:root
+                                         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);
@@ -169,7 +212,8 @@ static NSString *const topNodeIndexPath = @"top";
     return [self throwException:FBInvalidXPathException forQuery:xpathQuery];
   }
 
-  NSArray *matchingSnapshots = [self collectMatchingSnapshots:queryResult->nodesetval elementStore:elementStore];
+  NSArray *matchingSnapshots = [self collectMatchingSnapshots:queryResult->nodesetval
+                                                 elementStore:elementStore];
   xmlXPathFreeObject(queryResult);
   xmlFreeTextWriter(writer);
   xmlFreeDoc(doc);
@@ -179,7 +223,8 @@ static NSString *const topNodeIndexPath = @"top";
   return matchingSnapshots;
 }
 
-+ (NSArray *)collectMatchingSnapshots:(xmlNodeSetPtr)nodeSet elementStore:(NSMutableDictionary *)elementStore
++ (NSArray *)collectMatchingSnapshots:(xmlNodeSetPtr)nodeSet
+                         elementStore:(NSMutableDictionary *)elementStore
 {
   if (xmlXPathNodeSetIsEmpty(nodeSet)) {
     return @[];
@@ -243,26 +288,15 @@ static NSString *const topNodeIndexPath = @"top";
   }
   [FBLogger logFmt:@"The following attributes were requested to be included into the XML: %@", includedAttributes];
 
-  int rc = xmlTextWriterStartDocument(writer, NULL, _UTF8Encoding, NULL);
-  if (rc < 0) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartDocument. Error code: %d", rc];
-    return rc;
-  }
-
-  rc = [self writeXmlWithRootElement:root
-                           indexPath:(elementStore != nil ? topNodeIndexPath : nil)
-                        elementStore:elementStore
-                  includedAttributes:includedAttributes.copy
-                              writer:writer];
+  int rc = [self writeXmlWithRootElement:root
+                               indexPath:(elementStore != nil ? topNodeIndexPath : nil)
+                            elementStore:elementStore
+                      includedAttributes:includedAttributes.copy
+                                  writer:writer];
   if (rc < 0) {
     [FBLogger log:@"Failed to generate XML presentation of a screen element"];
     return rc;
   }
-  rc = xmlTextWriterEndDocument(writer);
-  if (rc < 0) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlXPathNewContext. Error code: %d", rc];
-    return rc;
-  }
   return 0;
 }
 
@@ -290,7 +324,10 @@ static NSString *const topNodeIndexPath = @"top";
   return [str fb_xmlSafeStringWithReplacement:@""];
 }
 
-+ (int)recordElementAttributes:(xmlTextWriterPtr)writer forElement:(XCElementSnapshot *)element indexPath:(nullable NSString *)indexPath includedAttributes:(nullable NSSet<Class> *)includedAttributes
++ (int)recordElementAttributes:(xmlTextWriterPtr)writer
+                    forElement:(XCElementSnapshot *)element
+                     indexPath:(nullable NSString *)indexPath
+            includedAttributes:(nullable NSSet<Class> *)includedAttributes
 {
   for (Class attributeCls in FBElementAttribute.supportedAttributes) {
     // include all supported attributes by default unless enumerated explicitly

package/WebDriverAgentRunner/UITestingUITests.m

@@ -25,6 +25,7 @@
   [FBDebugLogDelegateDecorator decorateXCTestLogger];
   [FBConfiguration disableRemoteQueryEvaluation];
   [FBConfiguration configureDefaultKeyboardPreferences];
+  [FBConfiguration disableApplicationUIInterruptionsHandling];
   if (NSProcessInfo.processInfo.environment[@"ENABLE_AUTOMATIC_SCREENSHOTS"]) {
     [FBConfiguration enableScreenshots];
   } else {

package/WebDriverAgentTests/IntegrationTests/FBAlertTests.m

@@ -29,6 +29,7 @@
   dispatch_once(&onceToken, ^{
     [self launchApplication];
     [self goToAlertsPage];
+    [FBConfiguration disableApplicationUIInterruptionsHandling];
   });
   [self clearAlert];
 }

package/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m

@@ -13,6 +13,7 @@
 #import "FBTestMacros.h"
 #import "FBXPath.h"
 #import "FBXCodeCompatibility.h"
+#import "FBXMLGenerationOptions.h"
 #import "XCUIElement.h"
 #import "XCUIElement+FBFind.h"
 #import "XCUIElement+FBUtilities.h"
@@ -52,16 +53,29 @@
 - (void)testSingleDescendantXMLRepresentation
 {
   XCElementSnapshot *snapshot = self.destinationSnapshot;
-  NSString *xmlStr = [FBXPath xmlStringWithRootElement:snapshot excludingAttributes:nil];
+  NSString *xmlStr = [FBXPath xmlStringWithRootElement:snapshot options:nil];
   XCTAssertNotNil(xmlStr);
   NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n", snapshot.wdType, snapshot.wdType, snapshot.wdName, snapshot.wdLabel, snapshot.wdEnabled ? @"true" : @"false", snapshot.wdVisible ? @"true" : @"false", snapshot.wdAccessible ? @"true" : @"false", [snapshot.wdRect[@"x"] stringValue], [snapshot.wdRect[@"y"] stringValue], [snapshot.wdRect[@"width"] stringValue], [snapshot.wdRect[@"height"] stringValue], snapshot.wdIndex];
   XCTAssertEqualObjects(xmlStr, expectedXml);
 }
 
+- (void)testSingleDescendantXMLRepresentationWithScope
+{
+  XCElementSnapshot *snapshot = self.destinationSnapshot;
+  NSString *scope = @"AppiumAUT";
+  FBXMLGenerationOptions *options = [[FBXMLGenerationOptions new] withScope:scope];
+  NSString *xmlStr = [FBXPath xmlStringWithRootElement:snapshot options:options];
+  XCTAssertNotNil(xmlStr);
+  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@>\n  <%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n</%@>\n", scope, snapshot.wdType, snapshot.wdType, snapshot.wdName, snapshot.wdLabel, snapshot.wdEnabled ? @"true" : @"false", snapshot.wdVisible ? @"true" : @"false", snapshot.wdAccessible ? @"true" : @"false", [snapshot.wdRect[@"x"] stringValue], [snapshot.wdRect[@"y"] stringValue], [snapshot.wdRect[@"width"] stringValue], [snapshot.wdRect[@"height"] stringValue], snapshot.wdIndex, scope];
+  XCTAssertEqualObjects(xmlStr, expectedXml);
+}
+
 - (void)testSingleDescendantXMLRepresentationWithoutAttributes
 {
   XCElementSnapshot *snapshot = self.destinationSnapshot;
-  NSString *xmlStr = [FBXPath xmlStringWithRootElement:snapshot excludingAttributes:@[@"visible", @"enabled", @"index", @"blabla"]];
+  FBXMLGenerationOptions *options = [[FBXMLGenerationOptions new]
+                                     withExcludedAttributes:@[@"visible", @"enabled", @"index", @"blabla"]];
+  NSString *xmlStr = [FBXPath xmlStringWithRootElement:snapshot options:options];
   XCTAssertNotNil(xmlStr);
   NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\"/>\n", snapshot.wdType, snapshot.wdType, snapshot.wdName, snapshot.wdLabel, snapshot.wdAccessible ? @"true" : @"false", [snapshot.wdRect[@"x"] stringValue], [snapshot.wdRect[@"y"] stringValue], [snapshot.wdRect[@"width"] stringValue], [snapshot.wdRect[@"height"] stringValue]];
   XCTAssertEqualObjects(xmlStr, expectedXml);