fix: Only check existence if firstMatch is applied (#638)

appium · Nov 25, 2022 · 5394fe8 · 5394fe8
1 parent 3ec5a06
commit 5394fe8
Show file tree

Hide file tree

Showing 17 changed files with 123 additions and 96 deletions.
diff --git a/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.m b/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.m
@@ -45,7 +45,7 @@ - (nullable XCUIElement *)fb_alertElementFromSafariWithScrollView:(XCUIElement *
                     descendantsMatchingType:XCUIElementTypeOther]
                    matchingPredicate:dstViewMatchPredicate]
                   containingPredicate:dstViewContainPredicate1]
-                 containingPredicate:dstViewContainPredicate2].fb_firstMatch;
+                 containingPredicate:dstViewContainPredicate2].allElementsBoundByIndex.firstObject;
   } else {
     NSPredicate *webViewPredicate = [NSPredicate predicateWithFormat:@"elementType == %lu", XCUIElementTypeWebView];
     // Find the first XCUIElementTypeOther which is the descendant of the scroll view
@@ -54,7 +54,7 @@ - (nullable XCUIElement *)fb_alertElementFromSafariWithScrollView:(XCUIElement *
                     descendantsMatchingType:XCUIElementTypeOther]
                    matchingPredicate:dstViewMatchPredicate]
                   containingPredicate:dstViewContainPredicate1]
-                 containingPredicate:dstViewContainPredicate2].fb_firstMatch;
+                 containingPredicate:dstViewContainPredicate2].allElementsBoundByIndex.firstObject;
   }
   if (nil == candidate) {
     return nil;
@@ -80,7 +80,7 @@ - (XCUIElement *)fb_alertElement
   NSPredicate *alertCollectorPredicate = [NSPredicate predicateWithFormat:@"elementType IN {%lu,%lu,%lu}",
                                           XCUIElementTypeAlert, XCUIElementTypeSheet, XCUIElementTypeScrollView];
   XCUIElement *alert = [[self descendantsMatchingType:XCUIElementTypeAny]
-                        matchingPredicate:alertCollectorPredicate].fb_firstMatch;
+                        matchingPredicate:alertCollectorPredicate].allElementsBoundByIndex.firstObject;
   if (nil == alert) {
     return nil;
   }

diff --git a/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m b/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m
@@ -192,7 +192,7 @@ - (NSString *)fb_xmlRepresentationWithOptions:(FBXMLGenerationOptions *)options
 - (NSString *)fb_descriptionRepresentation
 {
   NSMutableArray<NSString *> *childrenDescriptions = [NSMutableArray array];
-  for (XCUIElement *child in [self.fb_query childrenMatchingType:XCUIElementTypeAny].allElementsBoundByAccessibilityElement) {
+  for (XCUIElement *child in [self.fb_query childrenMatchingType:XCUIElementTypeAny].allElementsBoundByIndex) {
     [childrenDescriptions addObject:child.debugDescription];
   }
   // debugDescription property of XCUIApplication instance shows descendants addresses in memory

diff --git a/WebDriverAgentLib/Categories/XCUIElement+FBResolve.m b/WebDriverAgentLib/Categories/XCUIElement+FBResolve.m
@@ -50,7 +50,7 @@ - (XCUIElement *)fb_stableInstance
   NSPredicate *predicate = [NSPredicate predicateWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot, NSDictionary *bindings) {
     return [[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot] isEqualToString:uid];
   }];
-  return [query matchingPredicate:predicate].fb_firstMatch ?: self;
+  return [query matchingPredicate:predicate].allElementsBoundByIndex.firstObject ?: self;
 }
 
 @end
diff --git a/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m b/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m
@@ -132,11 +132,11 @@ @implementation XCUIElement (FBUtilities)
   if (0 == snapshots.count) {
     return @[];
   }
-  NSMutableArray<NSString *> *sortedIds = [NSMutableArray new];
+  NSMutableArray<NSString *> *matchedIds = [NSMutableArray new];
   for (id<FBXCElementSnapshot> snapshot in snapshots) {
     NSString *uid = [FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot];
     if (nil != uid) {
-      [sortedIds addObject:uid];
+      [matchedIds addObject:uid];
     }
   }
   NSMutableArray<XCUIElement *> *matchedElements = [NSMutableArray array];
@@ -146,11 +146,13 @@ @implementation XCUIElement (FBUtilities)
       ? [FBXCElementSnapshotWrapper wdUIDWithSnapshot:self.lastSnapshot]
       : self.fb_uid;
   }
-  if ([sortedIds containsObject:uid]) {
+  if (nil != uid && [matchedIds containsObject:uid]) {
+    XCUIElement *stableSelf = self.fb_stableInstance;
+    stableSelf.fb_isResolvedNatively = @NO;
     if (1 == snapshots.count) {
-      return @[self];
+      return @[stableSelf];
     }
-    [matchedElements addObject:self];
+    [matchedElements addObject:stableSelf];
   }
   XCUIElementType type = XCUIElementTypeAny;
   NSArray<NSNumber *> *uniqueTypes = [snapshots valueForKeyPath:[NSString stringWithFormat:@"@distinctUnionOfObjects.%@", FBStringify(XCUIElement, elementType)]];
@@ -161,34 +163,13 @@ @implementation XCUIElement (FBUtilities)
     ? [self.fb_query childrenMatchingType:type]
     : [self.fb_query descendantsMatchingType:type];
   NSPredicate *predicate = [NSPredicate predicateWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot, NSDictionary *bindings) {
-    return [sortedIds containsObject:[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot] ?: @""];
+    return [matchedIds containsObject:[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot] ?: @""];
   }];
-  query = [query matchingPredicate:predicate];
-  if (1 == snapshots.count) {
-    XCUIElement *result = query.fb_firstMatch;
-    result.fb_isResolvedNatively = @NO;
-    return result ? @[result] : @[];
-  }
-  // Rely here on the fact, that XPath always returns query results in the same
-  // order they appear in the document, which means we don't need to resort the resulting
-  // array. Although, if it turns out this is still not the case then we could always
-  // uncomment the sorting procedure below:
-  //  query = [query sorted:(id)^NSComparisonResult(XCElementSnapshot *a, XCElementSnapshot *b) {
-  //    NSUInteger first = [sortedIds indexOfObject:a.wdUID];
-  //    NSUInteger second = [sortedIds indexOfObject:b.wdUID];
-  //    if (first < second) {
-  //      return NSOrderedAscending;
-  //    }
-  //    if (first > second) {
-  //      return NSOrderedDescending;
-  //    }
-  //    return NSOrderedSame;
-  //  }];
-  NSArray<XCUIElement *> *result = query.fb_allMatches;
-  for (XCUIElement *el in result) {
+  [matchedElements addObjectsFromArray:[query matchingPredicate:predicate].allElementsBoundByIndex];
+  for (XCUIElement *el in matchedElements) {
     el.fb_isResolvedNatively = @NO;
   }
-  return result;
+  return matchedElements.copy;
 }
 
 - (void)fb_waitUntilStable

diff --git a/WebDriverAgentLib/Commands/FBElementCommands.m b/WebDriverAgentLib/Commands/FBElementCommands.m
@@ -386,9 +386,11 @@ + (NSArray *)routes
   // what ios-driver did and sadly, we must copy them.
   NSString *const name = request.arguments[@"name"];
   if (name) {
-    XCUIElement *childElement = [[[[element.fb_query descendantsMatchingType:XCUIElementTypeAny] matchingIdentifier:name] allElementsBoundByAccessibilityElement] lastObject];
+    XCUIElement *childElement = [[[[element.fb_query descendantsMatchingType:XCUIElementTypeAny]
+                                   matchingIdentifier:name] allElementsBoundByIndex] lastObject];
     if (!childElement) {
-      return FBResponseWithStatus([FBCommandStatus noSuchElementErrorWithMessage:[NSString stringWithFormat:@"'%@' identifier didn't match any elements", name] traceback:[NSString stringWithFormat:@"%@", NSThread.callStackSymbols]]);
+      return FBResponseWithStatus([FBCommandStatus noSuchElementErrorWithMessage:[NSString stringWithFormat:@"'%@' identifier didn't match any elements", name]
+                                                                       traceback:[NSString stringWithFormat:@"%@", NSThread.callStackSymbols]]);
     }
     return [self.class handleScrollElementToVisible:childElement withRequest:request];
   }
@@ -413,9 +415,11 @@ + (NSArray *)routes
   if (predicateString) {
     NSPredicate *formattedPredicate = [NSPredicate fb_snapshotBlockPredicateWithPredicate:[NSPredicate
                                                                                            predicateWithFormat:predicateString]];
-    XCUIElement *childElement = [[[[element.fb_query descendantsMatchingType:XCUIElementTypeAny] matchingPredicate:formattedPredicate] allElementsBoundByAccessibilityElement] lastObject];
+    XCUIElement *childElement = [[[[element.fb_query descendantsMatchingType:XCUIElementTypeAny]
+                                   matchingPredicate:formattedPredicate] allElementsBoundByIndex] lastObject];
     if (!childElement) {
-      return FBResponseWithStatus([FBCommandStatus noSuchElementErrorWithMessage:[NSString stringWithFormat:@"'%@' predicate didn't match any elements", predicateString] traceback:[NSString stringWithFormat:@"%@", NSThread.callStackSymbols]]);
+      return FBResponseWithStatus([FBCommandStatus noSuchElementErrorWithMessage:[NSString stringWithFormat:@"'%@' predicate didn't match any elements", predicateString]
+                                                                       traceback:[NSString stringWithFormat:@"%@", NSThread.callStackSymbols]]);
     }
     return [self.class handleScrollElementToVisible:childElement withRequest:request];
   }
@@ -675,7 +679,7 @@ + (XCUICoordinate *)gestureCoordinateWithCoordinate:(CGPoint)coordinate
    */
   XCUIElement *element = application;
   if (isSDKVersionGreaterThanOrEqualTo(@"11.0")) {
-    XCUIElement *window = application.windows.fb_firstMatch;
+    XCUIElement *window = application.windows.allElementsBoundByIndex.firstObject;
     if (window) {
       element = window;
       id<FBXCElementSnapshot> snapshot = element.fb_cachedSnapshot ?: element.fb_takeSnapshot;

diff --git a/WebDriverAgentLib/FBAlert.m b/WebDriverAgentLib/FBAlert.m
@@ -245,7 +245,7 @@ - (BOOL)clickAlertButton:(NSString *)label error:(NSError **)error
 
   NSPredicate *predicate = [NSPredicate predicateWithFormat:@"label == %@", label];
   XCUIElement *requestedButton = [[self.alertElement descendantsMatchingType:XCUIElementTypeButton]
-                                  matchingPredicate:predicate].fb_firstMatch;
+                                  matchingPredicate:predicate].allElementsBoundByIndex.firstObject;
   if (!requestedButton) {
     return [[[FBErrorBuilder builder]
              withDescriptionFormat:@"Failed to find button with label '%@' for alert: %@", label, self.alertElement]

diff --git a/WebDriverAgentLib/Utilities/FBScreen.m b/WebDriverAgentLib/Utilities/FBScreen.m
@@ -31,7 +31,7 @@ + (CGSize)statusBarSizeForApplication:(XCUIApplication *)application
     expectVisibleBar = NO;
   }
 
-  XCUIElement *mainStatusBar = app.statusBars.fb_firstMatch;
+  XCUIElement *mainStatusBar = app.statusBars.allElementsBoundByIndex.firstObject;
   if (!mainStatusBar || (expectVisibleBar && !mainStatusBar.fb_isVisible)) {
     return CGSizeZero;
   }

diff --git a/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m b/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m
@@ -65,10 +65,11 @@ - (XCElementSnapshot *)fb_uniqueSnapshotWithError:(NSError **)error
 
 - (XCUIElement *)fb_firstMatch
 {
-  XCUIElement* match = FBConfiguration.useFirstMatch
-    ? self.firstMatch
-    : self.fb_allMatches.firstObject;
-  return [match exists] ? match : nil;
+  if (FBConfiguration.useFirstMatch) {
+    XCUIElement* match = self.firstMatch;
+    return [match exists] ? match : nil;
+  }
+  return self.fb_allMatches.firstObject;
 }
 
 - (NSArray<XCUIElement *> *)fb_allMatches

diff --git a/WebDriverAgentTests/IntegrationTests/FBAppiumTouchActionsIntegrationTests.m b/WebDriverAgentTests/IntegrationTests/FBAppiumTouchActionsIntegrationTests.m
@@ -298,7 +298,7 @@ - (void)setUp
     [self launchApplication];
     [self goToAttributesPage];
   });
-  self.pickerWheel = self.testedApplication.pickerWheels.fb_firstMatch;
+  self.pickerWheel = self.testedApplication.pickerWheels.allElementsBoundByIndex.firstObject;
 }
 
 - (void)tearDown

diff --git a/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m b/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m
@@ -61,7 +61,7 @@ - (void)testContainerAccessibilityAttributes
 - (void)testIgnoredAccessibilityAttributes
 {
   // Images are neither accessibility elements nor contain them, so both checks should fail
-  XCUIElement *imageElement = self.testedApplication.images.fb_firstMatch;
+  XCUIElement *imageElement = self.testedApplication.images.allElementsBoundByIndex.firstObject;
   XCTAssertTrue(imageElement.exists);
   XCTAssertFalse(imageElement.fb_isAccessibilityElement);
   XCTAssertFalse(imageElement.isWDAccessibilityContainer);

diff --git a/WebDriverAgentTests/IntegrationTests/FBElementVisibilityTests.m b/WebDriverAgentTests/IntegrationTests/FBElementVisibilityTests.m
@@ -36,7 +36,7 @@ - (void)testSpringBoardIcons
   XCTAssertTrue(self.springboard.icons[@"Reminders"].fb_isVisible);
 
   // Check Icons on second screen screen
-  XCTAssertFalse(self.springboard.icons[@"IntegrationApp"].query.fb_firstMatch.fb_isVisible);
+  XCTAssertFalse(self.springboard.icons[@"IntegrationApp"].firstMatch.fb_isVisible);
 }
 
 - (void)testSpringBoardSubfolder
@@ -59,7 +59,7 @@ - (void)disabled_testIconsFromSearchDashboard
   XCTAssertFalse(self.springboard.icons[@"Reminders"].fb_isVisible);
   XCTAssertFalse([[[self.springboard descendantsMatchingType:XCUIElementTypeIcon]
                    matchingIdentifier:@"IntegrationApp"]
-                  fb_firstMatch].fb_isVisible);
+                  firstMatch].fb_isVisible);
 }
 
 - (void)testTableViewCells
@@ -72,8 +72,8 @@ - (void)testTableViewCells
   [self launchApplication];
   [self goToScrollPageWithCells:YES];
   for (int i = 0 ; i < 10 ; i++) {
-    FBAssertWaitTillBecomesTrue(self.testedApplication.cells.allElementsBoundByAccessibilityElement[i].fb_isVisible);
-    FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts.allElementsBoundByAccessibilityElement[i].fb_isVisible);
+    FBAssertWaitTillBecomesTrue(self.testedApplication.cells.allElementsBoundByIndex[i].fb_isVisible);
+    FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts.allElementsBoundByIndex[i].fb_isVisible);
   }
 }
 

diff --git a/WebDriverAgentTests/IntegrationTests/FBPasteboardTests.m b/WebDriverAgentTests/IntegrationTests/FBPasteboardTests.m
@@ -44,7 +44,7 @@ - (void)testSetPasteboard
   if (![pastItemsQuery.firstMatch waitForExistenceWithTimeout:2.0]) {
     XCTFail(@"No matched element named 'Paste'");
   }
-  XCUIElement *pasteItem = pastItemsQuery.fb_firstMatch;
+  XCUIElement *pasteItem = pastItemsQuery.firstMatch;
   XCTAssertNotNil(pasteItem);
   [pasteItem tap];
   FBAssertWaitTillBecomesTrue([textField.value isEqualToString:text]);

diff --git a/WebDriverAgentTests/IntegrationTests/FBPickerWheelSelectTests.m b/WebDriverAgentTests/IntegrationTests/FBPickerWheelSelectTests.m
@@ -33,7 +33,7 @@ - (void)setUp
 
 - (void)testSelectNextPickerValue
 {
-  XCUIElement *element = self.testedApplication.pickerWheels.fb_firstMatch;
+  XCUIElement *element = self.testedApplication.pickerWheels.allElementsBoundByIndex.firstObject;
   XCTAssertTrue(element.exists);
   XCTAssertEqualObjects(element.wdType, @"XCUIElementTypePickerWheel");
   NSError *error;

diff --git a/WebDriverAgentTests/IntegrationTests/FBW3CTouchActionsIntegrationTests.m b/WebDriverAgentTests/IntegrationTests/FBW3CTouchActionsIntegrationTests.m
@@ -415,7 +415,7 @@ - (void)setUp
     [self launchApplication];
     [self goToAttributesPage];
   });
-  self.pickerWheel = self.testedApplication.pickerWheels.fb_firstMatch;
+  self.pickerWheel = self.testedApplication.pickerWheels.allElementsBoundByIndex.firstObject;
 }
 
 - (void)tearDown

diff --git a/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m b/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m
@@ -41,7 +41,7 @@ - (void)setUp
 
 - (id<FBXCElementSnapshot>)destinationSnapshot
 {
-  XCUIElement *matchingElement = self.testedView.buttons.fb_firstMatch;
+  XCUIElement *matchingElement = self.testedView.buttons.allElementsBoundByIndex.firstObject;
   FBAssertWaitTillBecomesTrue(nil != matchingElement.fb_takeSnapshot);
 
   id<FBXCElementSnapshot> snapshot = matchingElement.fb_takeSnapshot;