@applitools/driver 1.9.23 → 1.9.26

package/dist/driver.js

@@ -255,6 +255,7 @@ class Driver {
                     this._driverInfo.safeArea.height -= bottomOffset;
                 }
             }
+            // TODO: if user opts into NML, skip initializing the helpers
             // init helper lib
             if (!((_3 = this._customConfig) === null || _3 === void 0 ? void 0 : _3.disableHelper)) {
                 this._helper = this.isIOS

package/dist/element.js

@@ -190,7 +190,7 @@ class Element {
         this._logger.log('Extracted client region', region);
         return region;
     }
-    async getContentSize() {
+    async getContentSize(options = {}) {
         if (this._state.contentSize)
             return this._state.contentSize;
         const size = await this.withRefresh(async () => {
@@ -202,7 +202,7 @@ class Element {
             else {
                 this._logger.log('Extracting content size of native element with selector', this.selector);
                 try {
-                    let contentRegion = await ((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.getContentRegion(this));
+                    let contentRegion = await ((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.getContentRegion(this, options));
                     this._logger.log('Extracted native content region using helper library', contentRegion);
                     // on android extraction of this argument will perform non-deterministic touch action, so it is better to avoid it
                     if (!contentRegion || !this.driver.isAndroid) {
@@ -398,6 +398,11 @@ class Element {
                 const currentScrollOffset = await this.getScrollOffset();
                 if (!(options === null || options === void 0 ? void 0 : options.force) && utils.geometry.equals(offset, currentScrollOffset))
                     return currentScrollOffset;
+                if (((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.name) === 'android' && utils.geometry.equals(offset, { x: 0, y: 0 })) {
+                    await this.driver.helper.scrollToTop(this);
+                    this._state.scrollOffset = offset;
+                    return this._state.scrollOffset;
+                }
                 const contentSize = await this.getContentSize();
                 const scrollableRegion = await this.getClientRegion();
                 const maxOffset = {
@@ -405,11 +410,6 @@ class Element {
                     y: Math.round(scrollableRegion.height * (contentSize.height / scrollableRegion.height - 1)),
                 };
                 const requiredOffset = { x: Math.min(offset.x, maxOffset.x), y: Math.min(offset.y, maxOffset.y) };
-                if (((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.name) === 'android' && utils.geometry.equals(requiredOffset, { x: 0, y: 0 })) {
-                    await this.driver.helper.scrollToTop(this);
-                    this._state.scrollOffset = requiredOffset;
-                    return this._state.scrollOffset;
-                }
                 let effectiveRegion = scrollableRegion;
                 let remainingOffset = utils.geometry.equals(requiredOffset, { x: 0, y: 0 })
                     ? { x: -maxOffset.x, y: -maxOffset.y } // if it has to be scrolled to the very beginning, then scroll maximum amount of pixels
@@ -588,6 +588,7 @@ class Element {
         await this._spec.click(this.context.target, this.target);
     }
     async type(value) {
+        this._logger.log(`Typing text "${value}" in element with selector`, this.selector);
         await this._spec.type(this.context.target, this.target, value);
     }
     async preserveState() {

package/dist/helper-android.js

@@ -1,16 +1,47 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HelperAndroid = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const gte_1 = __importDefault(require("semver/functions/gte"));
 class HelperAndroid {
     constructor(options) {
+        this._supportAsync = false;
         this._spec = options.spec;
         this._input = options.input;
         this._action = options.action;
         this._legacy = options.legacy;
         this._logger = options.logger;
         this.name = this._legacy ? 'android-legacy' : 'android';
+        this._supportAsync = options.supportAsync === true;
     }
     static async make(options) {
+        var _a;
         const { spec, driver, logger } = options;
         let legacy = false;
         let input = await driver.element({ type: 'xpath', selector: '//*[@content-desc="EyesAppiumHelperEDT"]' });
@@ -18,11 +49,23 @@ class HelperAndroid {
             legacy = true;
             input = await driver.element({ type: 'xpath', selector: '//*[@content-desc="EyesAppiumHelper"]' });
         }
+        const versionElement = await driver.element({
+            type: 'xpath',
+            selector: '//*[@content-desc="EyesAppiumHelper_Version"]',
+        });
+        const version = (_a = (await (versionElement === null || versionElement === void 0 ? void 0 : versionElement.getText()))) !== null && _a !== void 0 ? _a : '0.0.0';
         const action = !legacy
             ? await driver.element({ type: 'xpath', selector: '//*[@content-desc="EyesAppiumHelper_Action"]' })
             : null;
         return input
-            ? new HelperAndroid({ spec, input, action, legacy, logger })
+            ? new HelperAndroid({
+                spec,
+                input,
+                action,
+                legacy,
+                logger,
+                supportAsync: (0, gte_1.default)(version, '1.8.0'),
+            })
             : null;
     }
     async _getElementId(element) {
@@ -39,31 +82,49 @@ class HelperAndroid {
             await this._action.type('1').catch(() => null);
             text = await this._input.getText();
         }
+        // wait until the JAVA complete the async operation
+        const timeout = 5 * 60 * 1000;
+        const finishAt = Date.now() + timeout;
+        while (text === 'WAIT' && finishAt > Date.now()) {
+            await utils.general.sleep(1000);
+            text = await this._input.getText();
+        }
+        if (text === 'WAIT') {
+            this._logger.warn(`Helper library didn't provide a response for async command (${command}) during ${timeout}ms`);
+            text = null;
+        }
         await this._input.type('');
         return text;
     }
-    async getContentRegion(element) {
+    async getContentRegion(element, options) {
+        var _a, _b, _c;
+        const elementId = await this._getElementId(element);
+        if (!elementId)
+            return null;
         let contentHeightString;
         if (this._legacy) {
             await this._input.click();
             contentHeightString = await this._input.getText();
         }
+        else if (this._supportAsync && ((_a = options === null || options === void 0 ? void 0 : options.lazyLoad) === null || _a === void 0 ? void 0 : _a.waitingTime)) {
+            const result = await this._command(`offset_async;${elementId};0;0;0;${(_c = (_b = options === null || options === void 0 ? void 0 : options.lazyLoad) === null || _b === void 0 ? void 0 : _b.waitingTime) !== null && _c !== void 0 ? _c : 0}`);
+            contentHeightString = result.split(';')[0];
+        }
         else {
-            const elementId = await this._getElementId(element);
-            if (!elementId)
-                return null;
-            contentHeightString = await this._command(`offset;${elementId};0;0;0`);
+            contentHeightString = await this._command(`offset;${elementId};0;0;0;0`);
         }
-        const region = await this._spec.getElementRegion(this._input.driver.target, element.target);
         const contentHeight = Number(contentHeightString);
-        return !Number.isNaN(contentHeight) && contentHeight >= region.height
-            ? { x: region.x, y: region.y, width: region.width, height: contentHeight }
-            : null;
+        if (Number.isNaN(contentHeight))
+            return null;
+        const region = await this._spec.getElementRegion(this._input.driver.target, element.target);
+        if (contentHeight < region.height)
+            return null;
+        return { x: region.x, y: region.y, width: region.width, height: contentHeight };
     }
     async getTouchPadding() {
         if (this._legacy)
             return null;
-        const touchPaddingString = await this._command(`getTouchPadding;0;0;0;0`);
+        const touchPaddingString = await this._command(`getTouchPadding;0;0;0;0;0`);
         const touchPadding = Number(touchPaddingString);
         if (!touchPadding || Number.isNaN(touchPadding))
             return null;
@@ -75,7 +136,7 @@ class HelperAndroid {
         const elementId = await this._getElementId(element);
         if (!elementId)
             return null;
-        const regionString = await this._command(`getRect;${elementId};0;0`);
+        const regionString = await this._command(`getRect;${elementId};0;0;0`);
         if (!regionString)
             return null;
         const [, x, y, height, width] = regionString.match(/\[(-?\d+(?:\.\d+)?);(-?\d+(?:\.\d+)?);(-?\d+(?:\.\d+)?);(-?\d+(?:\.\d+)?)\]/);
@@ -90,7 +151,7 @@ class HelperAndroid {
         const elementId = await this._getElementId(element);
         if (!elementId)
             return null;
-        await this._command(`moveToTop;${elementId};0;-1`);
+        await this._command(`moveToTop;${elementId};0;-1;0`);
     }
     async scrollBy(element, offset) {
         if (this._legacy)
@@ -98,7 +159,7 @@ class HelperAndroid {
         const elementId = await this._getElementId(element);
         if (!elementId)
             return null;
-        await this._command(`scroll;${elementId};${offset.y};0;0`);
+        await this._command(`scroll;${elementId};${offset.y};0;0;0`);
     }
 }
 exports.HelperAndroid = HelperAndroid;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.9.23",
+  "version": "1.9.26",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -81,10 +81,11 @@
     "@applitools/logger": "1.1.16",
     "@applitools/snippets": "2.4.5",
     "@applitools/types": "1.5.9",
-    "@applitools/utils": "1.3.10"
+    "@applitools/utils": "1.3.10",
+    "semver": "7.3.7"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.6",
+    "@applitools/bongo": "^2.2.0",
     "@applitools/scripts": "^1.1.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^17.0.31",

package/types/element.d.ts

@@ -39,7 +39,9 @@ export declare class Element<TDriver, TContext, TElement, TSelector> {
     init(context: Context<TDriver, TContext, TElement, TSelector>): Promise<this>;
     getRegion(): Promise<types.Region>;
     getClientRegion(): Promise<types.Region>;
-    getContentSize(): Promise<types.Size>;
+    getContentSize(options?: {
+        lazyLoad?: types.LazyLoadOptions;
+    }): Promise<types.Size>;
     isPager(): Promise<boolean>;
     isScrollable(): Promise<boolean>;
     isRoot(): Promise<boolean>;

package/types/helper-android.d.ts

@@ -12,6 +12,7 @@ export declare class HelperAndroid<TDriver, TContext, TElement, TSelector> {
     private readonly _input;
     private readonly _action?;
     private readonly _legacy;
+    private readonly _supportAsync;
     private _logger;
     readonly name: 'android' | 'android-legacy';
     constructor(options: {
@@ -20,10 +21,13 @@ export declare class HelperAndroid<TDriver, TContext, TElement, TSelector> {
         action?: Element<TDriver, TContext, TElement, TSelector>;
         legacy: boolean;
         logger?: any;
+        supportAsync?: boolean;
     });
     private _getElementId;
     private _command;
-    getContentRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;
+    getContentRegion(element: Element<TDriver, TContext, TElement, TSelector>, options?: {
+        lazyLoad?: types.LazyLoadOptions;
+    }): Promise<types.Region>;
     getTouchPadding(): Promise<number>;
     getRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;
     scrollToTop(element: Element<TDriver, TContext, TElement, TSelector>): Promise<void>;