Updating the swipe coefficients calculation:

- test.resources.settings.json, test.resources.settings.androidwebsession.json, src.resources.settings.json:
-- replacing swipe coefficients with verticalOffset and horizontalOffset
-- replacing swipe timeout with swipe duration

- ITouchActionsConfiguration, TouchActionsConfiguration:
-- replacing getSwipeTimeout() with getSwipeDuration()
-- getSwipePointCoefficients() with getSwipeVerticalOffset() and getSwipeHorizontalOffset()
-- added explicit documentation for getSwipeHorizontalOffset() and getSwipeVerticalOffset()

- actions.TouchActions:
-- replacing call to getSwipeTimeout() with getSwipeDuration()

- elements.actions.ELementTouchActions:
-- replacted getITouchActionsConfiguration() with getConfiguration()
-- replaced getITouchActionsConfiguration().getSwipePointCoefficient() with getSwipeOffset()

- elements.actions.IELementTouchActions:
-- made interface parameters final

- actions.SwipeDirection, action.ITouchActions:
-- updated javadoc

- actions.IActionsModule
-- replaced import

Author: n-verbitsky

src/main/java/aquality/appium/mobile/actions/IActionsModule.java

@@ -1,9 +1,11 @@
 package aquality.appium.mobile.actions;
 
+import aquality.appium.mobile.configuration.IConfigurationsModule;
+
 /**
  * Describes implementations of actions services to be registered in DI container.
  */
-public interface IActionsModule extends aquality.selenium.core.configurations.IConfigurationsModule {
+public interface IActionsModule extends IConfigurationsModule {
 
     /**
      * @return class which implements {@link ITouchActions}

src/main/java/aquality/appium/mobile/actions/ITouchActions.java

@@ -16,7 +16,7 @@ public interface ITouchActions {
     void swipe(Point startPoint, Point endPoint);
 
     /**
-     * Performs long press action and moves cursor from a start point to an end end point imitating the swipe action
+     * Performs long press action and moves cursor from a start point to an end end point imitating the swipe action.
      *
      * @param startPoint point on screen to swipe from.
      * @param endPoint   point on screen to swipe to.

src/main/java/aquality/appium/mobile/actions/SwipeDirection.java

@@ -1,5 +1,8 @@
 package aquality.appium.mobile.actions;
 
+/**
+ * The enum describing the possible swipe directions.
+ */
 public enum SwipeDirection {
     UP,
     DOWN,

src/main/java/aquality/appium/mobile/actions/TouchActions.java

@@ -20,8 +20,8 @@ public void swipe(Point startPoint, Point endPoint) {
                 endPoint.getX(),
                 endPoint.getY());
         performTouchAction(touchAction -> touchAction
-                .press(PointOption.point(startPoint))
-                .waitAction(waitOptions(AqualityServices.get(ITouchActionsConfiguration.class).getSwipeTimeout())),
+                        .press(PointOption.point(startPoint))
+                        .waitAction(waitOptions(AqualityServices.get(ITouchActionsConfiguration.class).getSwipeDuration())),
                 endPoint);
     }
 

src/main/java/aquality/appium/mobile/configuration/ITouchActionsConfiguration.java

@@ -14,66 +14,43 @@ public interface ITouchActionsConfiguration {
     int getSwipeRetries();
 
     /**
-     * Gets the timeout to perform a swipe.
+     * Gets the number of seconds required to perform a swipe action.
      *
-     * @return timeout to perform swipe.
+     * @return number of seconds required to perform a swipe action.
      */
-    Duration getSwipeTimeout();
+    Duration getSwipeDuration();
 
     /**
-     * Gets the coefficient to calculate the 'x' coordinate of top point for swipe action.
+     * Gets the offset coefficient to adjust the start/end point for swipe action relatively to the parallel screen edge.
+     * Example for swipe down action:
+     * The offset coefficient is used to calculate start/end point's Y coordinate.
+     * If offset coefficient == 0.2, then the start point's Y coordinate == screen's length * (1 - 0.2).
+     * If offset coefficient == 0.2, then the end point's Y coordinate == screen's length * 0.2.
+     * The vice versa for swipe up action.
+     * Example for swipe left action:
+     * The offset coefficient is used to calculate start/end point's X coordinate.
+     * If offset coefficient == 0.2, then the start point's X coordinate == screen's width * (1 - 0.2).
+     * If offset coefficient == 0.2, then the end point's X coordinate == screen's width * 0.2.
+     * The vice versa for swipe right action.
      *
-     * @return coefficient to calculate the 'x' coordinate of top point for swipe action
+     * @return offset coefficient to adjust the start/end point for swipe action relatively to the parallel screen edge
      */
-    double getHorizontalSwipeTopPointXCoefficient();
+    double getSwipeVerticalOffset();
 
     /**
-     * Gets the coefficient to calculate the 'x' coordinate of bottom point for swipe action.
+     * Gets the offset coefficient to adjust the start/end point for swipe action relatively to the perpendicular screen edge.
+     * Example for swipe down action:
+     * The offset coefficient is used to calculate start/end point's X coordinate.
+     * If offset coefficient == 0.5, then the start point's X coordinate == screen's width * (1 - 0.5).
+     * If offset coefficient == 0.5, then the end point's X coordinate == screen's width * 0.5.
+     * The vice versa for swipe up action.
+     * Example for swipe left action:
+     * The offset coefficient is used to calculate start/end point's X coordinate.
+     * If offset coefficient == 0.5, then the start point's Y coordinate == screen's length * (1 - 0.5).
+     * If offset coefficient == 0.5, then the end point's Y coordinate == screen's length * 0.5.
+     * The vice versa for swipe right action.
      *
-     * @return coefficient to calculate the 'x' coordinate of bottom point for swipe action
+     * @return offset coefficient to adjust the start/end point for swipe action relatively to the perpendicular screen edge
      */
-    double getHorizontalSwipeBottomPointXCoefficient();
-
-    /**
-     * Gets the coefficient to calculate the 'y' coordinate of top point for swipe action.
-     *
-     * @return coefficient to calculate the 'y' coordinate of top point for swipe action
-     */
-    double getHorizontalSwipeTopPointYCoefficient();
-
-    /**
-     * Gets the coefficient to calculate the 'y' coordinate of bottom point for swipe action.
-     *
-     * @return coefficient to calculate the 'y' coordinate of bottom point for swipe action
-     */
-    double getHorizontalSwipeBottomPointYCoefficient();
-
-    /**
-     * Gets the coefficient to calculate the 'x' coordinate of top point for swipe action.
-     *
-     * @return timeout to perform swipe.
-     */
-    double getVerticalSwipeLeftPointXCoefficient();
-
-    /**
-     * Gets the coefficient to calculate the 'x' coordinate of right-hand point for swipe action.
-     *
-     * @return coefficient to calculate the 'x' coordinate of right-hand point for swipe action
-     */
-    double getVerticalSwipeRightPointXCoefficient();
-
-    /**
-     * Gets the coefficient to calculate the 'y' coordinate of left-hand point for swipe action.
-     *
-     * @return coefficient to calculate the 'y' coordinate of left-hand point for swipe action
-     */
-    double getVerticalSwipeLeftPointYCoefficient();
-
-
-    /**
-     * Gets the coefficient to calculate the 'y' coordinate of right-hand point for swipe action.
-     *
-     * @return coefficient to calculate the 'y' coordinate of right-hand point for swipe action
-     */
-    double getVerticalSwipeRightPointYCoefficient();
+    double getSwipeHorizontalOffset();
 }

src/main/java/aquality/appium/mobile/configuration/TouchActionsConfiguration.java

@@ -6,37 +6,17 @@
 import java.time.Duration;
 
 public class TouchActionsConfiguration implements ITouchActionsConfiguration {
+    private final Duration swipeDuration;
     private final int swipeRetries;
-    private final Duration swipeTimeout;
-    private final double horizontalSwipeTopPointXCoefficient;
-    private final double horizontalSwipeBottomPointXCoefficient;
-    private final double horizontalSwipeTopPointYCoefficient;
-    private final double horizontalSwipeBottomPointYCoefficient;
-    private final double verticalSwipeLeftPointXCoefficient;
-    private final double verticalSwipeRightPointXCoefficient;
-    private final double verticalSwipeLeftPointYCoefficient;
-    private final double verticalSwipeRightPointYCoefficient;
+    private final double swipeVerticalOffset;
+    private final double swipeHorizontalOffset;
 
     @Inject
     public TouchActionsConfiguration(ISettingsFile settingsFile) {
+        this.swipeDuration = Duration.ofSeconds(Long.parseLong(settingsFile.getValue("/touchActions/swipe/duration").toString()));
         this.swipeRetries = (int) settingsFile.getValue("/touchActions/swipe/retries");
-        this.swipeTimeout = Duration.ofSeconds(Long.parseLong(settingsFile.getValue("/touchActions/swipe/timeout").toString()));
-        this.horizontalSwipeTopPointXCoefficient = getSwipeCoefficient(
-                settingsFile, "horizontalSwipeTopPointXCoefficient");
-        this.horizontalSwipeBottomPointXCoefficient = getSwipeCoefficient(
-                settingsFile, "horizontalSwipeBottomPointXCoefficient");
-        this.horizontalSwipeTopPointYCoefficient = getSwipeCoefficient(
-                settingsFile, "horizontalSwipeTopPointYCoefficient");
-        this.horizontalSwipeBottomPointYCoefficient = getSwipeCoefficient(
-                settingsFile, "horizontalSwipeBottomPointYCoefficient");
-        this.verticalSwipeLeftPointXCoefficient = getSwipeCoefficient(
-                settingsFile, "verticalSwipeLeftPointXCoefficient");
-        this.verticalSwipeRightPointXCoefficient = getSwipeCoefficient(
-                settingsFile, "verticalSwipeRightPointXCoefficient");
-        this.verticalSwipeLeftPointYCoefficient = getSwipeCoefficient(
-                settingsFile, "verticalSwipeLeftPointYCoefficient");
-        this.verticalSwipeRightPointYCoefficient = getSwipeCoefficient(
-                settingsFile, "verticalSwipeRightPointYCoefficient");
+        this.swipeVerticalOffset = (double) settingsFile.getValue("/touchActions/swipe/verticalOffset");
+        this.swipeHorizontalOffset = (double) settingsFile.getValue("/touchActions/swipe/horizontalOffset");
     }
 
     @Override
@@ -45,51 +25,17 @@ public int getSwipeRetries() {
     }
 
     @Override
-    public Duration getSwipeTimeout() {
-        return this.swipeTimeout;
+    public Duration getSwipeDuration() {
+        return this.swipeDuration;
     }
 
     @Override
-    public double getHorizontalSwipeTopPointXCoefficient() {
-        return this.horizontalSwipeTopPointXCoefficient;
+    public double getSwipeVerticalOffset() {
+        return this.swipeVerticalOffset;
     }
 
     @Override
-    public double getHorizontalSwipeBottomPointXCoefficient() {
-        return this.horizontalSwipeBottomPointXCoefficient;
-    }
-
-    @Override
-    public double getHorizontalSwipeTopPointYCoefficient() {
-        return this.horizontalSwipeTopPointYCoefficient;
-    }
-
-    @Override
-    public double getHorizontalSwipeBottomPointYCoefficient() {
-        return this.horizontalSwipeBottomPointYCoefficient;
-    }
-
-    @Override
-    public double getVerticalSwipeLeftPointXCoefficient() {
-        return this.verticalSwipeLeftPointXCoefficient;
-    }
-
-    @Override
-    public double getVerticalSwipeRightPointXCoefficient() {
-        return this.verticalSwipeRightPointXCoefficient;
-    }
-
-    @Override
-    public double getVerticalSwipeLeftPointYCoefficient() {
-        return this.verticalSwipeLeftPointYCoefficient;
-    }
-
-    @Override
-    public double getVerticalSwipeRightPointYCoefficient() {
-        return this.verticalSwipeRightPointYCoefficient;
-    }
-
-    private double getSwipeCoefficient(ISettingsFile settingsFile, String swipeCoefficientKey) {
-        return Double.parseDouble(settingsFile.getValue(String.format("/touchActions/swipe/%s", swipeCoefficientKey)).toString());
+    public double getSwipeHorizontalOffset() {
+        return this.swipeHorizontalOffset;
     }
 }

src/main/java/aquality/appium/mobile/elements/actions/ElementTouchActions.java

@@ -23,20 +23,20 @@ public ElementTouchActions(IElement element) {
         this.element = element;
         this.scrollDownStartPoint = recalculatePointCoordinates(
                 getBottomRightCornerPoint(),
-                getITouchActionsConfiguration().getHorizontalSwipeBottomPointXCoefficient(),
-                getITouchActionsConfiguration().getHorizontalSwipeBottomPointYCoefficient());
+                (1 - getConfiguration().getSwipeHorizontalOffset()),
+                (1 - getConfiguration().getSwipeVerticalOffset()));
         this.scrollDownEndPoint = recalculatePointCoordinates(
                 getBottomRightCornerPoint(),
-                getITouchActionsConfiguration().getHorizontalSwipeTopPointXCoefficient(),
-                getITouchActionsConfiguration().getHorizontalSwipeTopPointYCoefficient());
+                getConfiguration().getSwipeHorizontalOffset(),
+                getConfiguration().getSwipeVerticalOffset());
         this.swipeLeftStartPoint = recalculatePointCoordinates(
                 getBottomRightCornerPoint(),
-                getITouchActionsConfiguration().getVerticalSwipeRightPointXCoefficient(),
-                getITouchActionsConfiguration().getVerticalSwipeRightPointYCoefficient());
+                (1 - getConfiguration().getSwipeVerticalOffset()),
+                (1 - getConfiguration().getSwipeHorizontalOffset()));
         this.swipeLeftEndPoint = recalculatePointCoordinates(
                 getBottomRightCornerPoint(),
-                getITouchActionsConfiguration().getVerticalSwipeLeftPointXCoefficient(),
-                getITouchActionsConfiguration().getVerticalSwipeLeftPointYCoefficient());
+                getConfiguration().getSwipeVerticalOffset(),
+                getConfiguration().getSwipeHorizontalOffset());
         this.scrollUpStartPoint = this.scrollDownEndPoint;
         this.scrollUpEndPoint = this.scrollDownStartPoint;
         this.swipeRightStartPoint = this.swipeLeftEndPoint;
@@ -92,23 +92,23 @@ private Point getBottomRightCornerPoint() {
     /**
      * Returns the point with recalculated coordinates.
      *
-     * @param point        point to recalculate coordinates
-     * @param coefficientX coefficient to recalculate the point's x coordinate. Example: x' = x * coefficientX
-     * @param coefficientY coefficient to recalculate the point's y coordinate. Example: y' = y * coefficientY
-     * @return point with recalculated coordinates according to the xCoefficient and yCoefficient
+     * @param point            point to recalculate coordinates
+     * @param horizontalOffset coefficient to recalculate the point with horizontal offset.
+     * @param verticalOffset   coefficient to recalculate the point with vertical offset.
+     * @return point with recalculated coordinates with horizontal and vertical offset.
      */
-    private Point recalculatePointCoordinates(Point point, double coefficientX, double coefficientY) {
+    private Point recalculatePointCoordinates(Point point, double horizontalOffset, double verticalOffset) {
         return new Point(
-                (int) (point.getX() * coefficientX),
-                (int) (point.getY() * coefficientY));
+                (int) (point.getX() * horizontalOffset),
+                (int) (point.getY() * verticalOffset));
     }
 
     /**
      * Returns ITouchActionsConfiguration class.
      *
      * @return ITouchActionsConfiguration class
      */
-    private ITouchActionsConfiguration getITouchActionsConfiguration() {
+    private ITouchActionsConfiguration getConfiguration() {
         return AqualityServices.get(ITouchActionsConfiguration.class);
     }
 }

src/main/java/aquality/appium/mobile/elements/actions/IElementTouchActions.java

@@ -13,19 +13,19 @@ public interface IElementTouchActions {
      *
      * @param endPoint point on screen to swipe to.
      */
-    void swipe(Point endPoint);
+    void swipe(final Point endPoint);
 
     /**
      * Swipes from element to end point using LongPress.
      *
      * @param endPoint point on screen to swipe to.
      */
-    void swipeWithLongPress(Point endPoint);
+    void swipeWithLongPress(final Point endPoint);
 
     /**
      * Scrolls current screen in provided direction until element is displayed.
      *
      * @param direction direction to swipe.
      */
-    void scrollToElement(SwipeDirection direction);
+    void scrollToElement(final SwipeDirection direction);
 }

src/main/resources/settings.json

@@ -1,9 +1,8 @@
 {
-  "platformName" : "android",
+  "platformName": "android",
   "isRemote": false,
   "remoteConnectionUrl": "http://127.0.0.1:4723/wd/hub",
   "screensLocation": "<NAME_OF_PACKAGE_WITH_SCREENS>",
-
   "driverSettings": {
     "android": {
       "deviceKey": "<KEY_OF_ANDROID_DEVICE_FROM_DEVICES_JSON>",
@@ -47,16 +46,10 @@
   },
   "touchActions": {
     "swipe": {
-      "timeout": 1,
+      "duration": 1,
       "retries": 5,
-      "horizontalSwipeTopPointXCoefficient": 0.5,
-      "horizontalSwipeBottomPointXCoefficient": 0.5,
-      "horizontalSwipeTopPointYCoefficient": 0.2,
-      "horizontalSwipeBottomPointYCoefficient": 0.8,
-      "verticalSwipeLeftPointXCoefficient": 0.2,
-      "verticalSwipeRightPointXCoefficient": 0.8,
-      "verticalSwipeLeftPointYCoefficient": 0.5,
-      "verticalSwipeRightPointYCoefficient": 0.5
+      "verticalOffset": 0.2,
+      "horizontalOffset": 0.5
     }
   }
 }