appium-webdriveragent 8.12.2 → 9.0.1

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.h

@@ -10,6 +10,8 @@
 #import <WebDriverAgentLib/WebDriverAgentLib.h>
 #import "XCPointerEvent.h"
 
+@class FBXCElementSnapshot;
+
 /**
  The version of testmanagerd process which is running on the device.
 
@@ -46,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param error The error instance if there was a failure while retrieveing the snapshot
  @returns The cached unqiue snapshot or nil if the element is stale
  */
-- (nullable XCElementSnapshot *)fb_uniqueSnapshotWithError:(NSError **)error;
+- (nullable id<FBXCElementSnapshot>)fb_uniqueSnapshotWithError:(NSError **)error;
 
 @end
 

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m

@@ -20,9 +20,9 @@
 
 @implementation XCUIElementQuery (FBCompatibility)
 
-- (XCElementSnapshot *)fb_uniqueSnapshotWithError:(NSError **)error
+- (id<FBXCElementSnapshot>)fb_uniqueSnapshotWithError:(NSError **)error
 {
-  return [self uniqueMatchingSnapshotWithError:error];
+  return (id<FBXCElementSnapshot>)[self uniqueMatchingSnapshotWithError:error];
 }
 
 - (XCUIElement *)fb_firstMatch

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -368,15 +368,12 @@ static NSString *const topNodeIndexPath = @"top";
   NSArray<id<FBXCElementSnapshot>> *children;
   if ([root isKindOfClass:XCUIElement.class]) {
     XCUIElement *element = (XCUIElement *)root;
-    NSMutableArray<NSString *> *snapshotAttributes = [NSMutableArray arrayWithArray:FBStandardAttributeNames()];
     if (nil == includedAttributes || [includedAttributes containsObject:FBVisibleAttribute.class]) {
-      [snapshotAttributes addObject:FB_XCAXAIsVisibleAttributeName];
       // If the app is not idle state while we retrieve the visiblity state
       // then the snapshot retrieval operation might freeze and time out
       [element.application fb_waitUntilStableWithTimeout:FBConfiguration.animationCoolOffTimeout];
     }
-    currentSnapshot = [element fb_snapshotWithAttributes:snapshotAttributes.copy
-                                                maxDepth:nil];
+    currentSnapshot = [element fb_takeSnapshot:YES];
     children = currentSnapshot.children;
   } else {
     currentSnapshot = (id<FBXCElementSnapshot>)root;

package/WebDriverAgentLib/Utilities/XCTestPrivateSymbols.h

@@ -19,6 +19,9 @@ extern NSString *FB_XCAXAIsVisibleAttributeName;
 extern NSNumber *FB_XCAXAIsElementAttribute;
 extern NSString *FB_XCAXAIsElementAttributeName;
 
+/*!  Accessibility identifier for visible frame attribute */
+extern NSString *FB_XCAXAVisibleFrameAttributeName;
+
 /*! Getter for  XCTest logger */
 extern id<XCDebugLogDelegate> (*XCDebugLogger)(void);
 

package/WebDriverAgentLib/Utilities/XCTestPrivateSymbols.m

@@ -18,6 +18,7 @@ NSNumber *FB_XCAXAIsVisibleAttribute;
 NSString *FB_XCAXAIsVisibleAttributeName = @"XC_kAXXCAttributeIsVisible";
 NSNumber *FB_XCAXAIsElementAttribute;
 NSString *FB_XCAXAIsElementAttributeName = @"XC_kAXXCAttributeIsElement";
+NSString *FB_XCAXAVisibleFrameAttributeName = @"XC_kAXXCAttributeVisibleFrame";
 
 void (*XCSetDebugLogger)(id <XCDebugLogDelegate>);
 id<XCDebugLogDelegate> (*XCDebugLogger)(void);

package/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m

@@ -71,6 +71,7 @@
   XCTAssertEqualObjects(element.wdLabel, @"Button");
   XCTAssertNil(element.wdValue);
   XCTAssertFalse(element.wdSelected);
+  XCTAssertTrue(element.fb_isVisible);
   [element tap];
   XCTAssertTrue(element.wdValue.boolValue);
   XCTAssertTrue(element.wdSelected);
@@ -133,7 +134,7 @@
   XCTAssertEqualObjects(element.wdType, @"XCUIElementTypeSlider");
   XCTAssertNil(element.wdName);
   XCTAssertNil(element.wdLabel);
-  XCTAssertEqualObjects(element.wdValue, @"50%");
+  XCTAssertTrue([element.wdValue containsString:@"50"]);
 }
 
 - (void)testActivityIndicatorAttributes

package/WebDriverAgentTests/IntegrationTests/FBElementSwipingTests.m

@@ -72,7 +72,7 @@
   }
   [self.scrollView fb_swipeWithDirection:@"up" velocity:@2500];
   FBAssertInvisibleCell(@"0");
-  [self.scrollView fb_swipeWithDirection:@"down" velocity:@2500];
+  [self.scrollView fb_swipeWithDirection:@"down" velocity:@3000];
   FBAssertVisibleCell(@"0");
 }
 

package/WebDriverAgentTests/IntegrationTests/FBW3CTouchActionsIntegrationTests.m

@@ -424,7 +424,7 @@
                    timeout:2.0]
                   timeoutErrorMessage:@"Picker wheel value has not been changed after 2 seconds timeout"]
                  spinUntilTrue:^BOOL{
-                   return ![self.pickerWheel.fb_takeSnapshot.value isEqualToString:previousValue];
+    return ![[self.pickerWheel fb_takeSnapshot:NO].value isEqualToString:previousValue];
                  }
                  error:&error]);
   XCTAssertNil(error);

package/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m

@@ -43,9 +43,7 @@
 - (id<FBXCElementSnapshot>)destinationSnapshot
 {
   XCUIElement *matchingElement = self.testedView.buttons.allElementsBoundByIndex.firstObject;
-  FBAssertWaitTillBecomesTrue(nil != matchingElement.fb_takeSnapshot);
-
-  id<FBXCElementSnapshot> snapshot = matchingElement.fb_takeSnapshot;
+  id<FBXCElementSnapshot> snapshot = [matchingElement fb_takeSnapshot:YES];
   // Over iOS13, snapshot returns a child.
   // The purpose of here is return a single element to replace children with an empty array for testing.
   snapshot.children = @[];

package/WebDriverAgentTests/IntegrationTests/XCElementSnapshotHelperTests.m

@@ -44,7 +44,8 @@
     @"Deadlock app",
     @"Touch",
   ]];
-  NSArray<id<FBXCElementSnapshot>> *matchingSnapshots = [[FBXCElementSnapshotWrapper ensureWrapped:self.testedView.fb_takeSnapshot]
+  NSArray<id<FBXCElementSnapshot>> *matchingSnapshots = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                                          [self.testedView fb_takeSnapshot:YES]]
                                                          fb_descendantsMatchingType:XCUIElementTypeButton];
   XCTAssertEqual(matchingSnapshots.count, expectedLabels.count);
   NSArray<NSString *> *labels = [matchingSnapshots valueForKeyPath:@"@distinctUnionOfObjects.label"];
@@ -59,7 +60,8 @@
 {
   XCUIElement *button = self.testedApplication.buttons[@"Alerts"];
   FBAssertWaitTillBecomesTrue(button.exists);
-  id<FBXCElementSnapshot> windowSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:button.fb_takeSnapshot]
+  id<FBXCElementSnapshot> windowSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                             [self.testedView fb_takeSnapshot:YES]]
                                             fb_parentMatchingType:XCUIElementTypeWindow];
   XCTAssertNotNil(windowSnapshot);
   XCTAssertEqual(windowSnapshot.elementType, XCUIElementTypeWindow);
@@ -86,7 +88,8 @@
 {
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
-  id<FBXCElementSnapshot> datePicker = [[FBXCElementSnapshotWrapper ensureWrapped:todayPickerWheel.fb_takeSnapshot]
+  id<FBXCElementSnapshot> datePicker = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                         [todayPickerWheel fb_takeSnapshot:YES]]
                                         fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeDatePicker), @(XCUIElementTypeWindow)]];
   XCTAssertNotNil(datePicker);
   XCTAssertEqual(datePicker.elementType, XCUIElementTypeDatePicker);
@@ -96,7 +99,8 @@
 {
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
-  id<FBXCElementSnapshot> otherSnapshot =[[FBXCElementSnapshotWrapper ensureWrapped:todayPickerWheel.fb_takeSnapshot]
+  id<FBXCElementSnapshot> otherSnapshot =[[FBXCElementSnapshotWrapper ensureWrapped:
+                                           [todayPickerWheel fb_takeSnapshot:YES]]
                                           fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeAny)]];
   XCTAssertNotNil(otherSnapshot);
 }
@@ -105,7 +109,8 @@
 {
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
-  id<FBXCElementSnapshot> otherSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:todayPickerWheel.fb_takeSnapshot]
+  id<FBXCElementSnapshot> otherSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                            [todayPickerWheel fb_takeSnapshot:YES]]
                                       fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeTab), @(XCUIElementTypeLink)]];
   XCTAssertNil(otherSnapshot);
 }
@@ -136,8 +141,9 @@
                                @(XCUIElementTypeCollectionView),
                                @(XCUIElementTypeTable),
                                ];
-  id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:threeStaticText.fb_takeSnapshot]
-                                   fb_parentMatchingOneOfTypes:acceptedParents                                  
+  id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                         [threeStaticText fb_takeSnapshot:YES]]
+                                   fb_parentMatchingOneOfTypes:acceptedParents
                                                         filter:^BOOL(id<FBXCElementSnapshot> snapshot) {
     return [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] isWDVisible];
   }];
@@ -153,7 +159,8 @@
                                @(XCUIElementTypeCollectionView),
                                @(XCUIElementTypeTable),
                                ];
-  id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:threeStaticText.fb_takeSnapshot]
+  id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                         [threeStaticText fb_takeSnapshot:YES]]
                                         fb_parentMatchingOneOfTypes:acceptedParents
                                                              filter:^BOOL(id<FBXCElementSnapshot> snapshot) {
     return NO;
@@ -165,7 +172,9 @@
 {
   XCUIElement *scrollView = self.testedApplication.scrollViews[@"scrollView"];
   FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts[@"3"].fb_isVisible);
-  NSArray *cells = [[FBXCElementSnapshotWrapper ensureWrapped:scrollView.fb_takeSnapshot] fb_descendantsCellSnapshots];
+  NSArray *cells = [[FBXCElementSnapshotWrapper ensureWrapped:
+                     [scrollView fb_takeSnapshot:YES]]
+                    fb_descendantsCellSnapshots];
   XCTAssertGreaterThanOrEqual(cells.count, 10);
   id<FBXCElementSnapshot> element = cells.firstObject;
   XCTAssertEqualObjects(element.label, @"0");
@@ -192,7 +201,9 @@
 {
   FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts[@"3"].fb_isVisible);
   XCUIElement *threeStaticText = self.testedApplication.staticTexts[@"3"];
-  id<FBXCElementSnapshot> xcuiElementCell = [[FBXCElementSnapshotWrapper ensureWrapped:threeStaticText.fb_takeSnapshot] fb_parentCellSnapshot];
+  id<FBXCElementSnapshot> xcuiElementCell = [[FBXCElementSnapshotWrapper ensureWrapped:
+                                              [threeStaticText fb_takeSnapshot:YES]]
+                                             fb_parentCellSnapshot];
   XCTAssertEqual(xcuiElementCell.elementType, 75);
 }
 

package/WebDriverAgentTests/IntegrationTests/XCElementSnapshotHitPointTests.m

@@ -23,7 +23,7 @@
   [self launchApplication];
   [self goToAttributesPage];
   XCUIElement *dstBtn = self.testedApplication.buttons[@"not_accessible"];
-  CGPoint hitPoint = [FBXCElementSnapshotWrapper ensureWrapped:dstBtn.fb_takeSnapshot].fb_hitPoint.CGPointValue;
+  CGPoint hitPoint = [FBXCElementSnapshotWrapper ensureWrapped:[dstBtn fb_takeSnapshot:NO]].fb_hitPoint.CGPointValue;
   XCTAssertTrue(hitPoint.x > 0 && hitPoint.y > 0);
 }
 

package/WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m

@@ -15,6 +15,7 @@
 #import "FBTestMacros.h"
 #import "XCUIElement.h"
 #import "XCUIElement+FBFind.h"
+#import "XCUIElement+FBUID.h"
 #import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "XCUIElement+FBClassChain.h"
@@ -93,7 +94,10 @@
   NSArray<XCUIElement *> *matchingSnapshots = [self.testedView fb_descendantsMatchingIdentifier:@"Alerts"
                                                                     shouldReturnAfterFirstMatch:YES];
   XCTAssertEqual(matchingSnapshots.count, 1);
-  for (XCUIElement *el in @[matchingSnapshots.lastObject, matchingSnapshots.lastObject.fb_stableInstance]) {
+  for (XCUIElement *el in @[
+    matchingSnapshots.lastObject,
+    [matchingSnapshots.lastObject fb_stableInstanceWithUid:[matchingSnapshots.lastObject fb_uid]]
+  ]) {
     XCTAssertEqual(el.elementType, XCUIElementTypeButton);
     XCTAssertEqualObjects(el.label, @"Alerts");
   }

package/WebDriverAgentTests/IntegrationTests/XCUIElementHelperIntegrationTests.m

@@ -41,9 +41,10 @@
   [allElements addObjectsFromArray:windows];
   
   NSMutableArray<id<FBXCElementSnapshot>> *buttonSnapshots = [NSMutableArray array];
-  [buttonSnapshots addObject:[buttons.firstObject fb_takeSnapshot]];
-  
-  NSArray<XCUIElement *> *result = [self.testedApplication fb_filterDescendantsWithSnapshots:buttonSnapshots selfUID:nil onlyChildren:NO];
+  [buttonSnapshots addObject:[buttons.firstObject fb_takeSnapshot:YES]];
+
+  NSArray<XCUIElement *> *result = [self.testedApplication fb_filterDescendantsWithSnapshots:buttonSnapshots
+                                                                                onlyChildren:NO];
   XCTAssertEqual(1, result.count);
   XCTAssertEqual([result.firstObject elementType], XCUIElementTypeButton);
 }

package/WebDriverAgentTests/UnitTests/Doubles/XCElementSnapshotDouble.m

@@ -98,4 +98,14 @@
   return @[];
 }
 
+- (NSArray *)_allDescendants
+{
+  return @[];
+}
+
+- (CGRect)visibleFrame
+{
+  return CGRectZero;
+}
+
 @end

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.h

@@ -19,7 +19,6 @@
 @property (nonatomic, readwrite, nullable) id lastSnapshot;
 @property (nonatomic, assign) BOOL fb_isObstructedByAlert;
 @property (nonatomic, readonly, nonnull) NSString *fb_cacheId;
-@property (nonatomic, nullable) NSNumber *fb_isResolvedFromCache;
 @property (nonatomic, readwrite, copy, nonnull) NSDictionary *wdRect;
 @property (nonatomic, readwrite, assign) CGRect wdFrame;
 @property (nonatomic, readwrite, copy, nonnull) NSString *wdUID;
@@ -39,7 +38,7 @@
 @property (nonatomic, readwrite, getter=isWDAccessibilityContainer) BOOL wdAccessibilityContainer;
 
 - (void)resolve;
-- (id _Nonnull)fb_takeSnapshot;
+- (id _Nonnull)fb_takeSnapshot:(BOOL)inDepth;
 - (nullable id)query;
 
 // Checks

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.m

@@ -68,7 +68,7 @@
   self.didResolve = YES;
 }
 
-- (id)fb_takeSnapshot
+- (id _Nonnull)fb_takeSnapshot:(BOOL)inDepth;
 {
   return [self lastSnapshot];
 }

package/WebDriverAgentTests/UnitTests/FBElementCacheTests.m

@@ -43,10 +43,8 @@
   XCUIElement *element = (XCUIElement *)XCUIElementDouble.new;
   NSString *uuid = [self.cache storeElement:element];
   XCTAssertNotNil(uuid, @"Stored index should be higher than 0");
-  XCTAssertFalse(element.fb_isResolvedFromCache.boolValue);
   XCUIElement *cachedElement = [self.cache elementForUUID:uuid];
   XCTAssertEqual(element, cachedElement);
-  XCTAssertTrue(element.fb_isResolvedFromCache.boolValue);
 }
 
 - (void)testFetchingBadIndex

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.h

@@ -18,7 +18,6 @@
 @property (nonatomic, readwrite, assign) CGRect frame;
 @property (nonatomic, readwrite, nullable) id lastSnapshot;
 @property (nonatomic, assign) BOOL fb_isObstructedByAlert;
-@property (nonatomic, nullable) NSNumber *fb_isResolvedFromCache;
 @property (nonatomic, readwrite, copy, nonnull) NSDictionary *wdRect;
 @property (nonatomic, readwrite, assign) CGRect wdFrame;
 @property (nonatomic, readwrite, copy, nonnull) NSString *wdUID;

package/package.json

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