@applitools/driver 1.9.14 → 1.9.17

package/dist/driver.js

@@ -144,8 +144,8 @@ class Driver {
         this._currentContext = context;
     }
     async init() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0;
-        var _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2;
+        var _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14;
         const capabilities = await ((_b = (_a = this._spec).getCapabilities) === null || _b === void 0 ? void 0 : _b.call(_a, this.target));
         this._logger.log('Driver capabilities', capabilities);
         const capabilitiesInfo = capabilities ? (0, capabilities_1.parseCapabilities)(capabilities, this._customConfig) : undefined;
@@ -156,39 +156,46 @@ class Driver {
                 (_e = (await this.getOrientation().catch(() => undefined))) !== null && _e !== void 0 ? _e : this._driverInfo.orientation;
         }
         if (this.isWeb) {
-            (_f = (_1 = this._driverInfo).pixelRatio) !== null && _f !== void 0 ? _f : (_1.pixelRatio = await this.execute(snippets.getPixelRatio));
-            (_g = (_2 = this._driverInfo).viewportScale) !== null && _g !== void 0 ? _g : (_2.viewportScale = await this.execute(snippets.getViewportScale));
-            (_h = (_3 = this._driverInfo).userAgent) !== null && _h !== void 0 ? _h : (_3.userAgent = await this.execute(snippets.getUserAgent));
+            (_f = (_3 = this._driverInfo).pixelRatio) !== null && _f !== void 0 ? _f : (_3.pixelRatio = await this.execute(snippets.getPixelRatio));
+            (_g = (_4 = this._driverInfo).viewportScale) !== null && _g !== void 0 ? _g : (_4.viewportScale = await this.execute(snippets.getViewportScale));
+            (_h = (_5 = this._driverInfo).userAgent) !== null && _h !== void 0 ? _h : (_5.userAgent = await this.execute(snippets.getUserAgent));
             if (this._driverInfo.userAgent) {
                 const userAgentInfo = (0, user_agent_1.parseUserAgent)(this._driverInfo.userAgent);
                 this._driverInfo.browserName = (_j = userAgentInfo.browserName) !== null && _j !== void 0 ? _j : this._driverInfo.browserName;
                 this._driverInfo.browserVersion = (_k = userAgentInfo.browserVersion) !== null && _k !== void 0 ? _k : this._driverInfo.browserVersion;
                 if (this._driverInfo.isMobile) {
-                    (_l = (_4 = this._driverInfo).platformName) !== null && _l !== void 0 ? _l : (_4.platformName = userAgentInfo.platformName);
-                    (_m = (_5 = this._driverInfo).platformVersion) !== null && _m !== void 0 ? _m : (_5.platformVersion = userAgentInfo.platformVersion);
+                    (_l = (_6 = this._driverInfo).platformName) !== null && _l !== void 0 ? _l : (_6.platformName = userAgentInfo.platformName);
+                    (_m = (_7 = this._driverInfo).platformVersion) !== null && _m !== void 0 ? _m : (_7.platformVersion = userAgentInfo.platformVersion);
                 }
                 else {
                     this._driverInfo.platformName = (_o = userAgentInfo.platformName) !== null && _o !== void 0 ? _o : this._driverInfo.platformName;
                     this._driverInfo.platformVersion = (_p = userAgentInfo.platformVersion) !== null && _p !== void 0 ? _p : this._driverInfo.platformVersion;
                 }
             }
-            (_q = (_6 = this._driverInfo).features) !== null && _q !== void 0 ? _q : (_6.features = {});
-            (_r = (_7 = this._driverInfo.features).allCookies) !== null && _r !== void 0 ? _r : (_7.allCookies = /chrome/i.test(this._driverInfo.browserName) && !this._driverInfo.isMobile);
+            (_q = (_8 = this._driverInfo).features) !== null && _q !== void 0 ? _q : (_8.features = {});
+            (_r = (_9 = this._driverInfo.features).allCookies) !== null && _r !== void 0 ? _r : (_9.allCookies = /chrome/i.test(this._driverInfo.browserName) && !this._driverInfo.isMobile);
         }
         else {
             // this value always excludes the height of the navigation bar, and sometimes it also excludes the height of the status bar
             let windowSize = await this._spec.getWindowSize(this.target);
-            (_s = (_8 = this._driverInfo).displaySize) !== null && _s !== void 0 ? _s : (_8.displaySize = windowSize);
+            (_s = (_10 = this._driverInfo).displaySize) !== null && _s !== void 0 ? _s : (_10.displaySize = windowSize);
+            if (((_t = this.orientation) === null || _t === void 0 ? void 0 : _t.startsWith('landscape')) &&
+                this._driverInfo.displaySize.height > this._driverInfo.displaySize.width) {
+                this._driverInfo.displaySize = {
+                    width: this._driverInfo.displaySize.height,
+                    height: this._driverInfo.displaySize.width,
+                };
+            }
             if (this.isAndroid) {
                 // bar sizes could be extracted only on android
-                const systemBars = await ((_u = (_t = this._spec).getSystemBars) === null || _u === void 0 ? void 0 : _u.call(_t, this.target).catch(() => null));
+                const systemBars = await ((_v = (_u = this._spec).getSystemBars) === null || _v === void 0 ? void 0 : _v.call(_u, this.target).catch(() => null));
                 const { statusBar, navigationBar } = systemBars !== null && systemBars !== void 0 ? systemBars : {};
                 if (statusBar === null || statusBar === void 0 ? void 0 : statusBar.visible) {
                     this._logger.log('Driver status bar', statusBar);
                     const statusBarSize = statusBar.height;
                     // when status bar is overlapping content on android it returns status bar height equal to display height
                     if (statusBarSize < this._driverInfo.displaySize.height) {
-                        this._driverInfo.statusBarSize = Math.max((_v = this._driverInfo.statusBarSize) !== null && _v !== void 0 ? _v : 0, statusBarSize);
+                        this._driverInfo.statusBarSize = Math.max((_w = this._driverInfo.statusBarSize) !== null && _w !== void 0 ? _w : 0, statusBarSize);
                     }
                 }
                 if (navigationBar === null || navigationBar === void 0 ? void 0 : navigationBar.visible) {
@@ -197,40 +204,38 @@ class Driver {
                     if (navigationBar.x > 0)
                         this._driverInfo.orientation = 'landscape-secondary';
                     // navigation bar size could be its height or width depending on screen orientation
-                    const navigationBarSize = navigationBar[((_w = this.orientation) === null || _w === void 0 ? void 0 : _w.startsWith('landscape')) ? 'width' : 'height'];
+                    const navigationBarSize = navigationBar[((_x = this.orientation) === null || _x === void 0 ? void 0 : _x.startsWith('landscape')) ? 'width' : 'height'];
                     // when navigation bar is invisible on android it returns navigation bar size equal to display size
                     if (navigationBarSize <
-                        this._driverInfo.displaySize[((_x = this.orientation) === null || _x === void 0 ? void 0 : _x.startsWith('landscape')) ? 'width' : 'height']) {
-                        this._driverInfo.navigationBarSize = Math.max((_y = this._driverInfo.navigationBarSize) !== null && _y !== void 0 ? _y : 0, navigationBarSize);
+                        this._driverInfo.displaySize[((_y = this.orientation) === null || _y === void 0 ? void 0 : _y.startsWith('landscape')) ? 'width' : 'height']) {
+                        this._driverInfo.navigationBarSize = Math.max((_z = this._driverInfo.navigationBarSize) !== null && _z !== void 0 ? _z : 0, navigationBarSize);
                     }
                     else {
                         this._driverInfo.navigationBarSize = 0;
                     }
                 }
                 // bar sizes have to be scaled on android
-                (_9 = this._driverInfo).statusBarSize && (_9.statusBarSize = this._driverInfo.statusBarSize / this.pixelRatio);
-                (_10 = this._driverInfo).navigationBarSize && (_10.navigationBarSize = this._driverInfo.navigationBarSize / this.pixelRatio);
+                (_11 = this._driverInfo).statusBarSize && (_11.statusBarSize = this._driverInfo.statusBarSize / this.pixelRatio);
+                (_12 = this._driverInfo).navigationBarSize && (_12.navigationBarSize = this._driverInfo.navigationBarSize / this.pixelRatio);
                 windowSize = utils.geometry.scale(windowSize, 1 / this.pixelRatio);
-                (_11 = this._driverInfo).displaySize && (_11.displaySize = utils.geometry.scale(this._driverInfo.displaySize, 1 / this.pixelRatio));
+                (_13 = this._driverInfo).displaySize && (_13.displaySize = utils.geometry.scale(this._driverInfo.displaySize, 1 / this.pixelRatio));
+            }
+            if (this.isIOS) {
+                if ((_0 = this.orientation) === null || _0 === void 0 ? void 0 : _0.startsWith('landscape'))
+                    this._driverInfo.statusBarSize = 0;
             }
             // calculate viewport location
-            (_z = (_12 = this._driverInfo).viewportLocation) !== null && _z !== void 0 ? _z : (_12.viewportLocation = {
+            (_1 = (_14 = this._driverInfo).viewportLocation) !== null && _1 !== void 0 ? _1 : (_14.viewportLocation = {
                 x: this.orientation === 'landscape' ? this.navigationBarSize : 0,
                 y: this.statusBarSize,
             });
             // calculate viewport size
             if (!this._driverInfo.viewportSize) {
-                if ((_0 = this.orientation) === null || _0 === void 0 ? void 0 : _0.startsWith('landscape')) {
-                    this._driverInfo.viewportSize = {
-                        width: this._driverInfo.displaySize.height - this.navigationBarSize,
-                        height: this._driverInfo.displaySize.width - this.statusBarSize,
-                    };
-                }
-                else {
-                    this._driverInfo.viewportSize = {
-                        width: this._driverInfo.displaySize.width,
-                        height: this._driverInfo.displaySize.height - this.statusBarSize - this.navigationBarSize,
-                    };
+                this._driverInfo.viewportSize = { ...this._driverInfo.displaySize };
+                this._driverInfo.viewportSize.height -= this.statusBarSize;
+                if (this.isAndroid) {
+                    this._driverInfo.viewportSize[((_2 = this.orientation) === null || _2 === void 0 ? void 0 : _2.startsWith('landscape')) ? 'width' : 'height'] -=
+                        this.navigationBarSize;
                 }
             }
             // calculate safe area

package/dist/element.js

@@ -105,28 +105,33 @@ class Element {
                 if (await this.equals(innerElement))
                     return false;
                 // if the inner element region is contained in this element region, then it then could be assumed that the inner element is contained in this element
-                const contentRegion = await this.getAttribute('contentSize')
-                    .then(data => {
-                    const contentSize = JSON.parse(data);
-                    return {
-                        x: contentSize.left,
-                        y: contentSize.top,
-                        width: contentSize.width,
-                        height: this.driver.isIOS
-                            ? Math.max(contentSize.height, contentSize.scrollableOffset)
-                            : contentSize.height + contentSize.scrollableOffset,
+                let contentRegion = await ((_b = this.driver.helper) === null || _b === void 0 ? void 0 : _b.getContentRegion(this));
+                if (!contentRegion || !this.driver.isAndroid) {
+                    const nativeContentRegion = await this.getAttribute('contentSize')
+                        .then(data => {
+                        const contentSize = JSON.parse(data);
+                        return {
+                            x: contentSize.left,
+                            y: contentSize.top,
+                            width: contentSize.width,
+                            height: this.driver.isIOS
+                                ? Math.max(contentSize.height, contentSize.scrollableOffset)
+                                : contentSize.height + contentSize.scrollableOffset,
+                        };
+                    })
+                        .catch(err => {
+                        this._logger.warn(`Unable to get the attribute 'contentSize' due to the following error: '${err.message}'`);
+                        return this._spec.getElementRegion(this.driver.target, this.target);
+                    });
+                    contentRegion = {
+                        x: nativeContentRegion.x,
+                        y: nativeContentRegion.y,
+                        width: Math.max((_c = contentRegion === null || contentRegion === void 0 ? void 0 : contentRegion.width) !== null && _c !== void 0 ? _c : 0, nativeContentRegion.width),
+                        height: Math.max((_d = contentRegion === null || contentRegion === void 0 ? void 0 : contentRegion.height) !== null && _d !== void 0 ? _d : 0, nativeContentRegion.height),
                     };
-                })
-                    .catch(() => this._spec.getElementRegion(this.driver.target, this.target));
-                const contentSize = await ((_b = this.driver.helper) === null || _b === void 0 ? void 0 : _b.getContentSize(this));
-                const region = {
-                    x: contentRegion.x,
-                    y: contentRegion.y,
-                    width: Math.max((_c = contentSize === null || contentSize === void 0 ? void 0 : contentSize.width) !== null && _c !== void 0 ? _c : 0, contentRegion.width),
-                    height: Math.max((_d = contentSize === null || contentSize === void 0 ? void 0 : contentSize.height) !== null && _d !== void 0 ? _d : 0, contentRegion.height),
-                };
+                }
                 const innerRegion = await this._spec.getElementRegion(this.driver.target, innerElement);
-                const contains = utils.geometry.contains(region, innerRegion);
+                const contains = utils.geometry.contains(contentRegion, innerRegion);
                 (_e = (_f = this._state).containedElements) !== null && _e !== void 0 ? _e : (_f.containedElements = new Map());
                 this._state.containedElements.set(innerElement, contains);
                 return contains;
@@ -194,29 +199,35 @@ class Element {
             else {
                 this._logger.log('Extracting content size of native element with selector', this.selector);
                 try {
-                    const contentRegion = await this.getAttribute('contentSize')
-                        .then(data => {
-                        const contentSize = JSON.parse(data);
-                        return {
-                            x: contentSize.left,
-                            y: contentSize.top,
-                            width: contentSize.width,
-                            height: this.driver.isIOS
-                                ? Math.max(contentSize.height, contentSize.scrollableOffset)
-                                : contentSize.height + contentSize.scrollableOffset,
+                    let contentRegion = await ((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.getContentRegion(this));
+                    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) {
+                        const attrContentRegion = await this.getAttribute('contentSize')
+                            .then(data => {
+                            const contentSize = JSON.parse(data);
+                            return {
+                                x: contentSize.left,
+                                y: contentSize.top,
+                                width: contentSize.width,
+                                height: this.driver.isIOS
+                                    ? Math.max(contentSize.height, contentSize.scrollableOffset)
+                                    : contentSize.height + contentSize.scrollableOffset,
+                            };
+                        })
+                            .catch(err => {
+                            this._logger.warn(`Unable to get the attribute 'contentSize' due to the following error: '${err.message}'`);
+                            return this._spec.getElementRegion(this.driver.target, this.target);
+                        });
+                        this._logger.log('Extracted native content region using attribute', attrContentRegion);
+                        contentRegion = {
+                            x: attrContentRegion.x,
+                            y: attrContentRegion.y,
+                            width: Math.max((_b = contentRegion === null || contentRegion === void 0 ? void 0 : contentRegion.width) !== null && _b !== void 0 ? _b : 0, attrContentRegion.width),
+                            height: Math.max((_c = contentRegion === null || contentRegion === void 0 ? void 0 : contentRegion.height) !== null && _c !== void 0 ? _c : 0, attrContentRegion.height),
                         };
-                    })
-                        .catch(err => {
-                        this._logger.warn(`Unable to get the attribute 'contentSize' due to the following error: '${err.message}'`);
-                        return this._spec.getElementRegion(this.driver.target, this.target);
-                    });
-                    this._logger.log('Extracted native content size attribute', contentRegion);
-                    const contentSize = await ((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.getContentSize(this));
-                    this._logger.log('Extracted native content size with helper library', contentSize);
-                    this._state.contentSize = {
-                        width: Math.max((_b = contentSize === null || contentSize === void 0 ? void 0 : contentSize.width) !== null && _b !== void 0 ? _b : 0, contentRegion.width),
-                        height: Math.max((_c = contentSize === null || contentSize === void 0 ? void 0 : contentSize.height) !== null && _c !== void 0 ? _c : 0, contentRegion.height),
-                    };
+                    }
+                    this._state.contentSize = utils.geometry.size(contentRegion);
                     if (this.driver.isAndroid) {
                         this._state.contentSize = utils.geometry.scale(this._state.contentSize, 1 / this.driver.pixelRatio);
                     }
@@ -293,15 +304,15 @@ class Element {
                 this._state.touchPadding = 10;
             else if (this.driver.isAndroid) {
                 if (((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.name) === 'android') {
-                    this._state.touchPadding = await ((_b = this.driver.helper) === null || _b === void 0 ? void 0 : _b.getTouchPadding());
+                    this._state.touchPadding = (await ((_b = this.driver.helper) === null || _b === void 0 ? void 0 : _b.getTouchPadding())) || 20;
                 }
-                if (!this._state.touchPadding) {
+                else {
                     const touchPadding = await this.getAttribute('contentSize')
                         .then(data => JSON.parse(data).touchPadding)
                         .catch(err => {
                         this._logger.warn(`Unable to get the attribute 'contentSize' when looking up 'touchPadding' due to the following error: '${err.message}'`);
                     });
-                    this._state.touchPadding = touchPadding !== null && touchPadding !== void 0 ? touchPadding : 20;
+                    this._state.touchPadding = touchPadding || 20;
                 }
                 this._logger.log('Touch padding set:', this._state.touchPadding);
             }

package/dist/fake/spec-driver.js

@@ -100,8 +100,7 @@ async function getDriverInfo(driver) {
 }
 exports.getDriverInfo = getDriverInfo;
 async function getWindowSize(driver) {
-    const rect = await driver.getWindowRect();
-    return rect;
+    return utils.geometry.size(await driver.getWindowRect());
 }
 exports.getWindowSize = getWindowSize;
 async function setWindowSize(driver, size) {

package/dist/helper-android.js

@@ -1,30 +1,6 @@
 "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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HelperAndroid = void 0;
-const utils = __importStar(require("@applitools/utils"));
 class HelperAndroid {
     constructor(options) {
         this._spec = options.spec;
@@ -55,7 +31,7 @@ class HelperAndroid {
             return null;
         return resourceId.split('/')[1];
     }
-    async getContentSize(element) {
+    async getContentRegion(element) {
         let contentHeightString;
         if (this._legacy) {
             await this._input.click();
@@ -75,9 +51,9 @@ class HelperAndroid {
         }
         const region = await this._spec.getElementRegion(this._input.driver.target, element.target);
         const contentHeight = Number(contentHeightString);
-        if (Number.isNaN(contentHeight))
-            return utils.geometry.size(region);
-        return { width: region.width, height: contentHeight };
+        return !Number.isNaN(contentHeight) && contentHeight >= region.height
+            ? { x: region.x, y: region.y, width: region.width, height: contentHeight }
+            : null;
     }
     async getRegion(element) {
         if (this._legacy)

package/dist/helper-ios.js

@@ -14,8 +14,9 @@ class HelperIOS {
         const element = await driver.element({ type: 'name', selector: 'applitools_grab_scrollable_data_button' });
         return element ? new HelperIOS({ driver, element, spec, logger }) : null;
     }
-    async getContentSize(_element) {
+    async getContentRegion(element) {
         await this._element.click();
+        const region = await this._spec.getElementRegion(this._driver.target, element.target);
         const sizeLabel = await this._driver.element({ type: 'name', selector: 'applitools_content_size_label' });
         const sizeString = await (sizeLabel === null || sizeLabel === void 0 ? void 0 : sizeLabel.getText());
         if (!sizeString)
@@ -26,15 +27,15 @@ class HelperIOS {
             return null;
         const paddingLabel = await this._driver.element({ type: 'name', selector: 'applitools_content_offset_label' });
         const paddingString = await (paddingLabel === null || paddingLabel === void 0 ? void 0 : paddingLabel.getText());
-        if (!paddingString)
-            return contentSize;
-        const [, x, y] = paddingString.match(/\{(-?\d+(?:\.\d+)?),\s?(-?\d+(?:\.\d+)?)\}/);
-        const contentOffset = { x: Number(x), y: Number(y) };
-        if (!Number.isNaN(contentOffset.x))
-            contentSize.width -= contentOffset.x;
-        if (!Number.isNaN(contentOffset.y))
-            contentSize.height -= contentOffset.y;
-        return contentSize;
+        if (paddingString) {
+            const [, x, y] = paddingString.match(/\{(-?\d+(?:\.\d+)?),\s?(-?\d+(?:\.\d+)?)\}/);
+            const contentOffset = { x: Number(x), y: Number(y) };
+            if (!Number.isNaN(contentOffset.x))
+                contentSize.width -= contentOffset.x;
+            if (!Number.isNaN(contentOffset.y))
+                contentSize.height -= contentOffset.y;
+        }
+        return contentSize.height >= region.height ? { x: region.x, y: region.y, ...contentSize } : null;
     }
 }
 exports.HelperIOS = HelperIOS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.9.14",
+  "version": "1.9.17",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -85,6 +85,7 @@
   },
   "devDependencies": {
     "@applitools/bongo": "^2.1.6",
+    "@applitools/scripts": "^1.1.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^17.0.31",
     "@typescript-eslint/eslint-plugin": "^5.22.0",

package/types/helper-android.d.ts

@@ -22,7 +22,7 @@ export declare class HelperAndroid<TDriver, TContext, TElement, TSelector> {
         logger?: any;
     });
     _getElementId(element: Element<TDriver, TContext, TElement, TSelector>): Promise<string>;
-    getContentSize(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Size>;
+    getContentRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;
     getRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;
     scrollToTop(element: Element<TDriver, TContext, TElement, TSelector>): Promise<void>;
     scrollBy(element: Element<TDriver, TContext, TElement, TSelector>, offset: types.Location): Promise<void>;

package/types/helper-ios.d.ts

@@ -19,5 +19,5 @@ export declare class HelperIOS<TDriver, TContext, TElement, TSelector> {
         spec: types.SpecDriver<TDriver, TContext, TElement, TSelector>;
         logger?: Logger;
     });
-    getContentSize(_element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Size>;
+    getContentRegion(element: Element<TDriver, TContext, TElement, TSelector>): Promise<types.Region>;
 }