Zbranzov/scroll (#212)

* fix: scrollTo performance on iOS

* fix: add error in case of wrong imagesPath provided instead of stalling the run

Author: Zdravko

index.ts

@@ -89,7 +89,7 @@ export async function createDriver(args?: INsCapabilitiesArgs) {
         return appiumDriver;
     }
     if (!appiumServer.server && !nsCapabilities.isSauceLab) {
-        logInfo("Server is not available! To start appium server programaticlly use startServer()!");
+        logInfo("Server is not available! To start appium server programmaticаlly use startServer()!");
     }
     if (!nsCapabilities.appiumCapsLocation) {
         throw new Error("Provided path to appium capabilities is not correct!");

lib/appium-driver.d.ts

@@ -155,7 +155,7 @@ export declare class AppiumDriver {
      * @param xOffset
      * @param retryCount
      */
-    scrollTo(direction: Direction, element: any, startPoint: Point, yOffset: number, xOffset?: number, retryCount?: number): Promise<any>;
+    scrollTo(direction: Direction, element: any, startPoint: Point, yOffset: number, xOffset?: number, retryCount?: number): Promise<UIElement>;
     /**
      * Swipe from point with offset and inertia according to duatio
      * @param y

lib/appium-driver.ts

@@ -291,7 +291,7 @@ export class AppiumDriver {
      */
     public async findElementByXPath(xPath: string, waitForElement: number = this.defaultWaitTime) {
         const searchM = "waitForElementByXPath";
-        return await new UIElement(await this._driver.waitForElementByXPath(xPath, waitForElement), this._driver, this._wd, this._webio, this._args, searchM, xPath);
+        return new UIElement(await this._driver.waitForElementByXPath(xPath, waitForElement), this._driver, this._wd, this._webio, this._args, searchM, xPath);
     }
 
     /**
@@ -446,20 +446,18 @@ export class AppiumDriver {
      * @param retryCount
      */
     public async scrollTo(direction: Direction, element: any, startPoint: Point, yOffset: number, xOffset: number = 0, retryCount: number = 7) {
-        let el = null;
-        while (el === null && retryCount > 0) {
+        let el: UIElement = null;
+        let isDisplayed: boolean = false;
+        while ((el === null || !isDisplayed) && retryCount > 0) {
             try {
                 el = await element();
-                if (!(await el.isDisplayed())) {
+                isDisplayed = await el.isDisplayed();
+                if (!isDisplayed) {
                     await scroll(this._wd, this._driver, direction, this._webio.isIOS, startPoint.y, startPoint.x, yOffset, xOffset, this._args.verbose);
+                    el = null;
                 }
             } catch (error) {
-                await scroll(this._wd, this._driver, direction, this._webio.isIOS, startPoint.y, startPoint.x, yOffset, xOffset, this._args.verbose);
-            }
-            if (el !== null && (await el.isDisplayed())) {
-                break;
-            } else {
-                el = null;
+                console.log("scrollTo Error: " + error);
             }
 
             retryCount--;
@@ -750,7 +748,9 @@ export class AppiumDriver {
      * Hides device keyboard
      */
     public async hideDeviceKeyboard() {
-        await this._driver.hideDeviceKeyboard();
+        try {
+            await this._driver.hideDeviceKeyboard();
+        } catch (error) {}
     }
 
     public async isKeyboardShown() {
@@ -892,7 +892,7 @@ export class AppiumDriver {
         const element = await this._driver.elementByXPathIfExists(xPath, waitForElement);
         if (element) {
             const searchMethod = "elementByXPathIfExists";
-            return await new UIElement(element, this._driver, this._wd, this._webio, this._args, searchMethod, xPath);
+            return new UIElement(element, this._driver, this._wd, this._webio, this._args, searchMethod, xPath);
         } else {
             return undefined;
         }

lib/ui-element.d.ts

@@ -110,10 +110,10 @@ export declare class UIElement {
      */
     scrollTo(direction: Direction, elementToSearch: () => Promise<UIElement>, yOffset?: number, xOffset?: number, retries?: number): Promise<UIElement>;
     /**
- * Scroll with offset from element with minimum inertia
+ * Drag element with specific offset
  * @param direction
  * @param yOffset
- * @param xOffset
+ * @param xOffset - default value 0
  */
     drag(direction: Direction, yOffset: number, xOffset?: number): Promise<void>;
     /**

lib/ui-element.ts

@@ -162,23 +162,23 @@ export class UIElement {
      */
     public async element() {
         this._element = await this.refetch();
-        return await this._element;
+        return this._element;
     }
 
     /**
      * Shows if element is displayed. Returns true or false. If the element doesn't exist it will return false
      */
     public async isDisplayed() {
         const displaySize = await this._driver.getWindowSize();
-        const el = (await this.element());
+        const el = this._element;
         let isDisplayed = true;
         if (!el || el === null) {
             return false;
         }
-
         try {
-            const elemCoordinates = await this.getRectangle();
-            isDisplayed = (await el.isDisplayed()) && elemCoordinates.x >= 0 && elemCoordinates.x < displaySize.width
+            const elemCoordinates = await el.getLocation();
+            const isDisplayedWebDriver = await el.isDisplayed();
+            isDisplayed = isDisplayedWebDriver && elemCoordinates.x >= 0 && elemCoordinates.x < displaySize.width
                 && elemCoordinates.y >= 0 && elemCoordinates.y < displaySize.height;
         } catch (error) {
             console.log("ERROR: " + error);
@@ -322,10 +322,10 @@ export class UIElement {
     }
 
     /**
- * Scroll with offset from element with minimum inertia
+ * Drag element with specific offset
  * @param direction
  * @param yOffset 
- * @param xOffset 
+ * @param xOffset - default value 0
  */
     public async drag(direction: Direction, yOffset: number, xOffset: number = 0) {
         const location = await this.location();
@@ -455,7 +455,7 @@ export class UIElement {
         if (this._args.isAndroid) {
             const action = new this._wd.TouchAction(this._driver);
             action.press({ x: centerX, y: centerY })
-                .wait(100)
+                .wait(200)
                 .moveTo({ x: swipeX, y: centerY })
                 .release();
             await action.perform();

lib/utils.ts

@@ -213,7 +213,13 @@ export function getStorageByDeviceName(args: INsCapabilities) {
     if (args.imagesPath) {
         const segments = args.imagesPath.split(/[\/\\]+/);
         storage = join(storage, segments.join(sep));
-        return storage;
+        if (existsSync(storage)) {
+            return storage;
+        } else {
+            const error = `Current imagesPath (${args.imagesPath}) does not exist !!!`;
+            logError(error)
+            throw new Error(error);
+        }
     }
     const appName = resolveSauceLabAppName(getAppName(args));
     storage = createStorageFolder(storage, appName);