Add support for JSONWP and W3C touch actions (#10)

* Add support for JSONWP and W3C touch actions

* Update merge issues

Author: Mykola Mokhnach

WebDriverAgent.xcodeproj/project.pbxproj

@@ -0,0 +1,68 @@
+/**
+ * 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>
+#import "FBElementCache.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIApplication (FBTouchAction)
+
+/**
+ Perform complex touch action in scope of the current application.
+ Touch actions are represented as lists of dictionaries with predefined sets of values and keys.
+ Each dictionary must contain 'action' key, which is one of the following:
+ - 'tap' to perform a single tap
+ - 'longPress' to perform long tap
+ - 'press' to perform press
+ - 'release' to release the finger
+ - 'moveTo' to move the virtual finger
+ - 'wait' to modify the duration of the preceeding action
+ - 'cancel' to cancel the preceeding action in the chain
+ Each dictionary can also contain 'options' key with additional parameters dictionary related to the appropriate action.
+ 
+ The following options are mandatory for 'tap', 'longPress', 'press' and 'moveTo' actions:
+ - 'x' the X coordinate of the action
+ - 'y' the Y coordinate of the action
+ - 'element' the corresponding element instance, for which the action is going to be performed
+ If only 'element' is set then hit point coordinates of this element will be used.
+ If only 'x' and 'y' are set then these will be considered as absolute coordinates.
+ If both 'element' and 'x'/'y' are set then these will act as relative element coordinates.
+ 
+ It is also mandatory, that 'release' and 'wait' actions are preceeded with at least one chain item, which contains absolute coordinates, like 'tap', 'press' or 'longPress'. Empty chains are not allowed.
+ 
+ The following additional options are available for different actions:
+ - 'tap': 'count' (defines count of taps to be performed in a row; 1 by default)
+ - 'longPress': 'duration' (number of milliseconds to hold/move the virtual finger; 500.0 ms by default)
+ - 'wait': 'ms' (number of milliseconds to wait for the preceeding action; 0.0 ms by default)
+ - 'press', 'longPress': 'pressure' (float number, which defines pressure value; 0.0 by default)
+ 
+ List of lists can be passed there is order to perform multi-finger touch action. Each single actions chain is going to be executed by a separate virtual finger in such case.
+ 
+ @param actions Either array of dictionaries, whose format is described above to peform single-finger touch action or array of array to perform multi-finger touch action.
+ @param elementCache Cached elements mapping for the currrent application. The method assumes all elements are already represented by their actual instances if nil value is set
+ @param error If there is an error, upon return contains an NSError object that describes the problem
+ @return YES If the touch action has been successfully performed without errors
+ */
+- (BOOL)fb_performAppiumTouchActions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError **)error;
+
+/**
+ Perform complex touch action in scope of the current application.
+ 
+ @param actions Array of dictionaries, whose format is described in W3C spec (https://github.com/jlipps/simple-wd-spec#perform-actions)
+ @param elementCache Cached elements mapping for the currrent application. The method assumes all elements are already represented by their actual instances if nil value is set
+ @param error If there is an error, upon return contains an NSError object that describes the problem
+ @return YES If the touch action has been successfully performed without errors
+ */
+- (BOOL)fb_performW3CTouchActions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.h

@@ -0,0 +1,69 @@
+/**
+ * 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+FBTouchAction.h"
+
+#import "FBAppiumActionsSynthesizer.h"
+#import "FBBaseActionsSynthesizer.h"
+#import "FBLogger.h"
+#import "FBRunLoopSpinner.h"
+#import "FBW3CActionsSynthesizer.h"
+#import "XCEventGenerator.h"
+#import "XCTRunnerDaemonSession.h"
+
+@implementation XCUIApplication (FBTouchAction)
+
+- (BOOL)fb_performActionsWithSynthesizerType:(Class)synthesizerType actions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError **)error
+{
+  FBBaseActionsSynthesizer *synthesizer = [[synthesizerType alloc] initWithActions:actions forApplication:self elementCache:elementCache error:error];
+  if (nil == synthesizer) {
+    return NO;
+  }
+  XCSynthesizedEventRecord *eventRecord = [synthesizer synthesizeWithError:error];
+  if (nil == eventRecord) {
+    return NO;
+  }
+  return [self fb_synthesizeEvent:eventRecord error:error];
+}
+
+- (BOOL)fb_performAppiumTouchActions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError **)error
+{
+  return [self fb_performActionsWithSynthesizerType:FBAppiumActionsSynthesizer.class actions:actions elementCache:elementCache error:error];
+}
+
+- (BOOL)fb_performW3CTouchActions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError **)error
+{
+  return [self fb_performActionsWithSynthesizerType:FBW3CActionsSynthesizer.class actions:actions elementCache:elementCache error:error];
+}
+
+- (BOOL)fb_synthesizeEvent:(XCSynthesizedEventRecord *)event error:(NSError *__autoreleasing*)error
+{
+  __block BOOL didSucceed;
+  [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
+    XCEventGeneratorHandler handlerBlock = ^(XCSynthesizedEventRecord *record, NSError *commandError) {
+      if (commandError) {
+        [FBLogger logFmt:@"Failed to perform complex gesture: %@", commandError];
+      }
+      if (error) {
+        *error = commandError;
+      }
+      didSucceed = (commandError == nil);
+      completion();
+    };
+
+    [[XCTRunnerDaemonSession sharedSession] synthesizeEvent:event completion:^(NSError *invokeError){
+      handlerBlock(event, invokeError);
+    }];
+  }];
+  return didSucceed;
+}
+
+
+@end

WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.m

@@ -9,69 +9,37 @@
 
 #import "XCUIElement+FBTap.h"
 
-#import "FBRunLoopSpinner.h"
-#import "FBLogger.h"
-#import "FBMacros.h"
-#import "FBMathUtils.h"
-#import "FBRuntimeUtils.h"
+#import "XCUIApplication+FBTouchAction.h"
 #import "XCUIElement+FBUtilities.h"
-#import "XCEventGenerator.h"
-#import "XCSynthesizedEventRecord.h"
-#import "XCElementSnapshot+FBHitPoint.h"
 
-const CGFloat FBTapDuration = 0.01f;
 
 @implementation XCUIElement (FBTap)
 
 - (BOOL)fb_tapWithError:(NSError **)error
 {
-  XCElementSnapshot *snapshot = self.fb_lastSnapshot;
-  CGPoint hitpoint = snapshot.fb_hitPoint;
-  if (CGPointEqualToPoint(hitpoint, CGPointMake(-1, -1))) {
-    hitpoint = [snapshot.suggestedHitpoints.lastObject CGPointValue];
-  }
-  return [self fb_performTapAtPoint:hitpoint error:error];
+  NSArray<NSDictionary<NSString *, id> *> *tapGesture =
+  @[
+    @{@"action": @"tap",
+      @"options": @{@"element": self}
+      }
+    ];
+  [self fb_waitUntilFrameIsStable];
+  return [self.application fb_performAppiumTouchActions:tapGesture elementCache:nil error:error];
 }
 
 - (BOOL)fb_tapCoordinate:(CGPoint)relativeCoordinate error:(NSError **)error
 {
-  CGPoint hitPoint = CGPointMake(self.frame.origin.x + relativeCoordinate.x, self.frame.origin.y + relativeCoordinate.y);
-  if (SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"10.0")) {
-    /*
-     Since iOS 10.0 XCTest has a bug when it always returns portrait coordinates for UI elements
-     even if the device is not in portait mode. That is why we need to recalculate them manually
-     based on the current orientation value
-     */
-    hitPoint = FBInvertPointForApplication(hitPoint, self.application.frame.size, self.application.interfaceOrientation);
-  }
-  return [self fb_performTapAtPoint:hitPoint error:error];
-}
-
-- (BOOL)fb_performTapAtPoint:(CGPoint)hitPoint error:(NSError *__autoreleasing*)error
-{
-  [self fb_waitUntilFrameIsStable];
-  __block BOOL didSucceed;
-  [FBRunLoopSpinner spinUntilCompletion:^(void(^completion)(void)){
-    XCEventGeneratorHandler handlerBlock = ^(XCSynthesizedEventRecord *record, NSError *commandError) {
-      if (commandError) {
-        [FBLogger logFmt:@"Failed to perform tap: %@", commandError];
-      }
-      if (error) {
-        *error = commandError;
+  NSArray<NSDictionary<NSString *, id> *> *tapGesture =
+  @[
+    @{@"action": @"tap",
+      @"options": @{@"element": self,
+                    @"x": @(relativeCoordinate.x),
+                    @"y": @(relativeCoordinate.y)
+                    }
       }
-      didSucceed = (commandError == nil);
-      completion();
-    };
-
-    // Xcode 10.2 and below
-    XCEventGenerator *eventGenerator = [XCEventGenerator sharedGenerator];
-    if ([eventGenerator respondsToSelector:@selector(tapAtTouchLocations:numberOfTaps:orientation:handler:)]) {
-      [eventGenerator tapAtTouchLocations:@[[NSValue valueWithCGPoint:hitPoint]] numberOfTaps:1 orientation:self.interfaceOrientation handler:handlerBlock];
-    } else {
-      [eventGenerator tapAtPoint:hitPoint orientation:self.interfaceOrientation handler:handlerBlock];
-    }
-  }];
-  return didSucceed;
+    ];
+  [self fb_waitUntilFrameIsStable];
+  return [self.application fb_performAppiumTouchActions:tapGesture elementCache:nil error:error];
 }
 
 @end

WebDriverAgentLib/Categories/XCUIElement+FBTap.m

@@ -0,0 +1,20 @@
+/**
+ * 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>
+
+#import <WebDriverAgentLib/FBCommandHandler.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBTouchActionCommands : NSObject <FBCommandHandler>
+
+@end
+
+NS_ASSUME_NONNULL_END

WebDriverAgentLib/Commands/FBTouchActionCommands.h

@@ -0,0 +1,56 @@
+/**
+ * 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 "FBTouchActionCommands.h"
+
+#import "FBApplication.h"
+#import "FBRoute.h"
+#import "FBRouteRequest.h"
+#import "FBSession.h"
+#import "XCUIApplication+FBTouchAction.h"
+
+@implementation FBTouchActionCommands
+
+#pragma mark - <FBCommandHandler>
+
++ (NSArray *)routes
+{
+  return
+  @[
+    [[FBRoute POST:@"/wda/touch/perform"] respondWithTarget:self action:@selector(handlePerformAppiumTouchActions:)],
+    [[FBRoute POST:@"/wda/touch/multi/perform"] respondWithTarget:self action:@selector(handlePerformAppiumTouchActions:)],
+    [[FBRoute POST:@"/actions"] respondWithTarget:self action:@selector(handlePerformW3CTouchActions:)],
+  ];
+}
+
+#pragma mark - Commands
+
++ (id<FBResponsePayload>)handlePerformAppiumTouchActions:(FBRouteRequest *)request
+{
+  XCUIApplication *application = request.session.activeApplication;
+  NSArray *actions = (NSArray *)request.arguments[@"actions"];
+  NSError *error;
+  if (![application fb_performAppiumTouchActions:actions elementCache:request.session.elementCache error:&error]) {
+    return FBResponseWithError(error);
+  }
+  return FBResponseWithOK();
+}
+
++ (id<FBResponsePayload>)handlePerformW3CTouchActions:(FBRouteRequest *)request
+{
+  XCUIApplication *application = request.session.activeApplication;
+  NSArray *actions = (NSArray *)request.arguments[@"actions"];
+  NSError *error;
+  if (![application fb_performW3CTouchActions:actions elementCache:request.session.elementCache error:&error]) {
+    return FBResponseWithError(error);
+  }
+  return FBResponseWithOK();
+}
+
+@end

WebDriverAgentLib/Commands/FBTouchActionCommands.m

@@ -0,0 +1,18 @@
+/**
+ * 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 "FBBaseActionsSynthesizer.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBAppiumActionsSynthesizer : FBBaseActionsSynthesizer
+
+@end
+
+NS_ASSUME_NONNULL_END