appium-webdriveragent 4.6.1 → 4.7.0

package/PrivateHeaders/XCTest/XCUIElement.h

@@ -37,12 +37,12 @@
 - (void)resolveHandleUIInterruption:(BOOL)arg1;
 - (BOOL)waitForExistenceWithTimeout:(double)arg1;
 - (BOOL)_waitForExistenceWithTimeout:(double)arg1;
+- (id)_hitPointByAttemptingToScrollToVisibleSnapshot:(id)arg1 error:(id *)arg2;
 - (BOOL)evaluatePredicateForExpectation:(id)arg1 debugMessage:(id *)arg2;
 - (void)_swipe:(unsigned long long)arg1;
 - (void)_tapWithNumberOfTaps:(unsigned long long)arg1 numberOfTouches:(unsigned long long)arg2 activityTitle:(id)arg3;
 - (id)_highestNonWindowAncestorOfElement:(id)arg1 notSharedWithElement:(id)arg2;
 - (id)_pointsInFrame:(CGRect)arg1 numberOfTouches:(unsigned long long)arg2;
-- (CGPoint)_hitPointByAttemptingToScrollToVisibleSnapshot:(id)arg1;
 // Since 11.3
 - (void)pressWithPressure:(double)arg1 duration:(double)arg2;
 - (void)forcePress;

package/WebDriverAgentLib/Categories/XCUIElement+FBScrolling.h

@@ -60,6 +60,16 @@ typedef NS_ENUM(NSUInteger, FBXCUIElementScrollDirection) {
  */
 - (BOOL)fb_scrollToVisibleWithError:(NSError **)error;
 
+/**
+ Scrolls parent scroll view till the current element is visible.
+ This call is fast as it uses a native XCTest implementation.
+ The element must be hittable.
+
+ @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_nativeScrollToVisibleWithError:(NSError **)error;
+
 /**
  Scrolls parent scroll view till receiver is visible. Whenever element is invisible it scrolls by normalizedScrollDistance
  in its direction. E.g. if normalizedScrollDistance is equal to 0.5, each step will scroll by half of scroll view's size.

package/WebDriverAgentLib/Categories/XCUIElement+FBScrolling.m

@@ -47,6 +47,15 @@ const CGFloat FBScrollTouchProportion = 0.75f;
 
 @implementation XCUIElement (FBScrolling)
 
+- (BOOL)fb_nativeScrollToVisibleWithError:(NSError **)error
+{
+  XCElementSnapshot *snapshot = self.fb_isResolvedFromCache.boolValue
+    ? self.lastSnapshot
+    : self.fb_takeSnapshot;
+  return nil != [self _hitPointByAttemptingToScrollToVisibleSnapshot:snapshot
+                                                               error:error];
+}
+
 - (void)fb_scrollUpByNormalizedDistance:(CGFloat)distance
 {
   XCElementSnapshot *snapshot = self.fb_isResolvedFromCache.boolValue

package/WebDriverAgentLib/Commands/FBElementCommands.m

@@ -84,6 +84,7 @@
     [[FBRoute POST:@"/wda/element/:uuid/tapWithNumberOfTaps"] respondWithTarget:self action:@selector(handleTapWithNumberOfTaps:)],
     [[FBRoute POST:@"/wda/element/:uuid/touchAndHold"] respondWithTarget:self action:@selector(handleTouchAndHold:)],
     [[FBRoute POST:@"/wda/element/:uuid/scroll"] respondWithTarget:self action:@selector(handleScroll:)],
+    [[FBRoute POST:@"/wda/element/:uuid/scrollTo"] respondWithTarget:self action:@selector(handleScrollTo:)],
     [[FBRoute POST:@"/wda/element/:uuid/dragfromtoforduration"] respondWithTarget:self action:@selector(handleDrag:)],
     [[FBRoute POST:@"/wda/element/:uuid/forceTouch"] respondWithTarget:self action:@selector(handleForceTouch:)],
     [[FBRoute POST:@"/wda/dragfromtoforduration"] respondWithTarget:self action:@selector(handleDragCoordinate:)],
@@ -383,6 +384,17 @@
   return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:@"Unsupported scroll type" traceback:nil]);
 }
 
++ (id<FBResponsePayload>)handleScrollTo:(FBRouteRequest *)request
+{
+  FBElementCache *elementCache = request.session.elementCache;
+  XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]];
+  NSError *error;
+  return [element fb_nativeScrollToVisibleWithError:&error]
+    ? FBResponseWithOK()
+    : FBResponseWithStatus([FBCommandStatus invalidElementStateErrorWithMessage:error.description
+                                                                      traceback:nil]);
+}
+
 + (id<FBResponsePayload>)handleDragCoordinate:(FBRouteRequest *)request
 {
   FBSession *session = request.session;
@@ -537,7 +549,8 @@
   NSError *error;
   NSData *screenshotData = [element fb_screenshotWithError:&error];
   if (nil == screenshotData) {
-    return FBResponseWithStatus([FBCommandStatus unableToCaptureScreenErrorWithMessage:error.description traceback:nil]);
+    return FBResponseWithStatus([FBCommandStatus unableToCaptureScreenErrorWithMessage:error.description
+                                                                             traceback:nil]);
   }
   NSString *screenshot = [screenshotData base64EncodedStringWithOptions:NSDataBase64Encoding64CharacterLineLength];
   return FBResponseWithObject(screenshot);

package/WebDriverAgentTests/IntegrationTests/FBScrollingTests.m

@@ -80,6 +80,16 @@
   FBAssertVisibleCell(cellName);
 }
 
+- (void)testNativeFarScrollToVisible
+{
+  NSString *cellName = @"80";
+  NSError *error;
+  FBAssertInvisibleCell(cellName);
+  XCTAssertTrue([FBCellElementWithLabel(cellName) fb_nativeScrollToVisibleWithError:&error]);
+  XCTAssertNil(error);
+  FBAssertVisibleCell(cellName);
+}
+
 - (void)testAttributeWithNullScrollToVisible
 {
   NSError *error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "description": "Package bundling WebDriverAgent",
   "main": "build/index.js",
   "scripts": {