chore: Raise more helpful error if a W3C action contains a web element (

#2435)

lib/commands/gesture.js

@@ -104,6 +104,7 @@ const commands = {
    */
   async performActions(actions) {
     this.log.debug(`Received the following W3C actions: ${JSON.stringify(actions, null, '  ')}`);
+    assertNoWebElements(actions);
     // This is mandatory, since WDA only supports TOUCH pointer type
     // and Selenium API uses MOUSE as the default one
     const preprocessedActions = actions
@@ -564,6 +565,25 @@ const helpers = {
 
 export default {...helpers, ...commands};
 
+/**
+ * @param {import('@appium/types').ActionSequence[]} actionSeq
+ */
+function assertNoWebElements(actionSeq) {
+  const isOriginWebElement = (gesture) =>
+    _.isPlainObject(gesture) && 'origin' in gesture && JSON.stringify(gesture.origin).includes(':wdc:');
+  const hasWebElements = actionSeq
+    .some((action) => (action?.actions || []).some(isOriginWebElement));
+  if (hasWebElements) {
+    throw new errors.InvalidArgumentError(
+      `The XCUITest driver only supports W3C actions execution in the native context. ` +
+      `Although, your W3C action contains one or more web elements, ` +
+      `which cannot be automatically mapped to the native context. ` +
+      `Consider mapping their absolute web coordinates to native context coordinates ` +
+      `and passing them to your gesture instead.`
+    );
+  }
+}
+
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  * @typedef {import('@appium/types').Element} Element