@applitools/driver 1.11.8 → 1.11.10

package/dist/element.js

@@ -96,8 +96,8 @@ class Element {
     }
     async contains(innerElement) {
         const contains = await this.withRefresh(async () => {
-            var _a, _b, _c, _d, _e;
-            var _f;
+            var _a, _b;
+            var _c;
             innerElement = innerElement instanceof Element ? innerElement.target : innerElement;
             if (this.driver.isWeb) {
                 this._logger.log('Checking if web element with selector', this.selector, 'contains element', innerElement);
@@ -111,19 +111,10 @@ 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
-                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.getContentSizeFromAttribute();
-                    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),
-                    };
-                }
+                const contentRegion = await this.getContentRegion();
                 const innerRegion = await this._spec.getElementRegion(this.driver.target, innerElement);
                 const contains = utils.geometry.contains(contentRegion, innerRegion);
-                (_e = (_f = this._state).containedElements) !== null && _e !== void 0 ? _e : (_f.containedElements = new Map());
+                (_b = (_c = this._state).containedElements) !== null && _b !== void 0 ? _b : (_c.containedElements = new Map());
                 this._state.containedElements.set(innerElement, contains);
                 return contains;
             }
@@ -178,44 +169,72 @@ class Element {
         this._logger.log('Extracted client region', region);
         return region;
     }
-    async getContentSizeFromAttribute() {
-        try {
-            const data = await this.getAttribute('contentSize');
-            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}'`);
-        }
-        if (this.driver.isIOS) {
-            const type = await this.getAttribute('type');
-            if (type === 'XCUIElementTypeScrollView') {
-                const elementRegion = await this._spec.getElementRegion(this.driver.target, this.target);
-                const [childElement] = await this.driver.elements({
-                    type: 'xpath',
-                    selector: '//XCUIElementTypeScrollView[1]/*', // We cannot be sure that our element is the first one
-                });
-                const childElementRegion = await this._spec.getElementRegion(this.driver.target, childElement.target);
-                return {
-                    ...elementRegion,
-                    height: childElementRegion.y + childElementRegion.height - elementRegion.y,
+    async getContentRegion(options = {}) {
+        var _a, _b, _c;
+        if (!this.driver.isNative)
+            return;
+        this._logger.log('Extracting content region of native element with selector', this.selector);
+        let contentRegion = await ((_a = this.driver.helper) === null || _a === void 0 ? void 0 : _a.getContentRegion(this, options));
+        this._logger.log('Extracted content region using helper library', contentRegion);
+        if (!contentRegion || !this.driver.isAndroid) {
+            let attrContentRegion;
+            try {
+                const size = JSON.parse(await this.getAttribute('contentSize'));
+                attrContentRegion = {
+                    x: size.left,
+                    y: size.top,
+                    width: size.width,
+                    height: this.driver.isIOS
+                        ? Math.max(size.height, size.scrollableOffset)
+                        : size.height + size.scrollableOffset,
+                };
+            }
+            catch (err) {
+                this._logger.warn(`Unable to get the attribute 'contentSize' due to the following error: '${err.message}'`);
+            }
+            this._logger.log('Extracted content region using attribute', attrContentRegion);
+            // ios workaround
+            if (!attrContentRegion && this.driver.isIOS) {
+                try {
+                    const type = await this.getAttribute('type');
+                    if (type !== 'XCUIElementTypeScrollView') {
+                        const [child] = await this.driver.elements({
+                            type: 'xpath',
+                            selector: '//XCUIElementTypeScrollView[1]/*', // We cannot be sure that our element is the first one
+                        });
+                        if (child) {
+                            const region = await this._spec.getElementRegion(this.driver.target, this.target);
+                            const childRegion = await this._spec.getElementRegion(this.driver.target, child.target);
+                            attrContentRegion = {
+                                ...region,
+                                height: childRegion.y + childRegion.height - region.y,
+                            };
+                        }
+                    }
+                }
+                catch (err) {
+                    this._logger.warn(`Unable to calculate content region using iOS workaround due to the following error: '${err.message}'`);
+                }
+                this._logger.log('Extracted content region using iOS workaround', attrContentRegion);
+            }
+            if (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),
                 };
             }
         }
+        return contentRegion !== null && contentRegion !== void 0 ? contentRegion : (await this._spec.getElementRegion(this.driver.target, this.target));
+    }
+    async getContentSizeIOS() {
         return this._spec.getElementRegion(this.driver.target, this.target);
     }
     async getContentSize(options = {}) {
         if (this._state.contentSize)
             return this._state.contentSize;
         const size = await this.withRefresh(async () => {
-            var _a, _b, _c;
             if (this.driver.isWeb) {
                 this._logger.log('Extracting content size of web element with selector', this.selector);
                 return this.context.execute(snippets.getElementContentSize, [this]);
@@ -223,19 +242,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, 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) {
-                        const attrContentRegion = await this.getContentSizeFromAttribute();
-                        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),
-                        };
-                    }
+                    const contentRegion = await this.getContentRegion(options);
                     this._state.contentSize = utils.geometry.size(contentRegion);
                     if (this.driver.isAndroid) {
                         this._state.contentSize = utils.geometry.scale(this._state.contentSize, 1 / this.driver.pixelRatio);
@@ -338,7 +345,7 @@ class Element {
             }
             else {
                 this._logger.log('Extracting text of native element with selector', this.selector);
-                return this._spec.getElementText(this.driver.target, this.target);
+                return this._spec.getElementText(this.context.target, this.target);
             }
         });
         this._logger.log('Extracted element text', text);
@@ -392,6 +399,7 @@ class Element {
     async scrollTo(offset, options) {
         return this.withRefresh(async () => {
             var _a;
+            this._logger.log(`Scrolling to offset (${offset.x}, ${offset.y}) element with selector`, this.selector);
             offset = utils.geometry.round({ x: Math.max(offset.x, 0), y: Math.max(offset.y, 0) });
             if (this.driver.isWeb) {
                 let actualOffset = await this.context.execute(snippets.scrollTo, [this, offset]);
@@ -483,7 +491,7 @@ class Element {
                     xRemaining -= xRight - xLeft;
                 }
                 // vertical scrolling
-                const yPadding = Math.max(Math.floor(effectiveRegion.height * 0.05), touchPadding + 3);
+                const yPadding = Math.max(Math.floor(effectiveRegion.height * 0.08), touchPadding + 3);
                 const xTrack = Math.floor(effectiveRegion.x + 5); // a little bit off left border
                 const yBottom = effectiveRegion.y + effectiveRegion.height - yPadding;
                 const yDirection = remainingOffset.y > 0 ? 'down' : 'up';
@@ -545,7 +553,7 @@ class Element {
                     }
                 }
                 else if (actions.length > 0) {
-                    await this._spec.performAction(this.driver.target, [].concat(...actions));
+                    await this._spec.performAction(this.driver.target, actions.flat());
                 }
                 const actualScrollableRegion = await this.getClientRegion();
                 this._state.scrollOffset = utils.geometry.offsetNegative(requiredOffset, {
@@ -595,17 +603,13 @@ class Element {
     }
     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);
+        await this._spec.setElementText(this.context.target, this.target, value);
     }
     async preserveState() {
-        if (this.driver.isNative)
-            return;
-        // TODO create single js snippet
         const scrollOffset = await this.getScrollOffset();
-        const transforms = await this.context.execute(snippets.getElementStyleProperties, [
-            this,
-            ['transform', '-webkit-transform'],
-        ]);
+        const transforms = this.driver.isWeb
+            ? await this.context.execute(snippets.getElementStyleProperties, [this, ['transform', '-webkit-transform']])
+            : null;
         if (!utils.types.has(this._state, ['scrollOffset', 'transforms'])) {
             this._state.scrollOffset = scrollOffset;
             this._state.transforms = transforms;
@@ -613,8 +617,6 @@ class Element {
         return { scrollOffset, transforms };
     }
     async restoreState(state = this._state) {
-        if (this.driver.isNative)
-            return;
         if (state.scrollOffset)
             await this.scrollTo(state.scrollOffset);
         if (state.transforms)

package/dist/helper-android.js

@@ -75,9 +75,6 @@ class HelperAndroid {
         return resourceId.split('/')[1];
     }
     async _command(command) {
-        // clean the input before passing value there could
-        // be a left over from previous async calls
-        await this._input.type('');
         await this._input.type(command);
         await this._input.click();
         let text = await this._input.getText();
@@ -96,7 +93,6 @@ class HelperAndroid {
             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, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.11.8",
+  "version": "1.11.10",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -88,7 +88,7 @@
   },
   "dependencies": {
     "@applitools/logger": "1.1.30",
-    "@applitools/snippets": "2.4.8",
+    "@applitools/snippets": "2.4.9",
     "@applitools/utils": "1.3.16",
     "semver": "7.3.7"
   },

package/types/element.d.ts

@@ -41,12 +41,14 @@ export declare class Element<TDriver, TContext, TElement, TSelector> {
     init(context: Context<TDriver, TContext, TElement, TSelector>): Promise<this>;
     getRegion(): Promise<Region>;
     getClientRegion(): Promise<Region>;
-    getContentSizeFromAttribute(): Promise<{
-        x: any;
-        y: any;
-        width: any;
-        height: any;
-    }>;
+    getContentRegion(options?: {
+        lazyLoad?: {
+            scrollLength?: number;
+            waitingTime?: number;
+            maxAmountToScroll?: number;
+        };
+    }): Promise<Region>;
+    getContentSizeIOS(): Promise<Region>;
     getContentSize(options?: {
         lazyLoad?: {
             scrollLength?: number;

package/types/spec-driver.d.ts

@@ -61,6 +61,8 @@ export interface SpecDriver<TDriver, TContext, TElement, TSelector> {
     findElement(context: TContext, selector: TSelector, parent?: TElement): Promise<TElement | null>;
     findElements(context: TContext, selector: TSelector, parent?: TElement): Promise<TElement[]>;
     waitForSelector?(context: TContext, selector: TSelector, parent?: TElement, options?: WaitOptions): Promise<TElement | null>;
+    setElementText?(context: TContext, element: TElement, text: string): Promise<void>;
+    getElementText?(context: TContext, element: TElement): Promise<string>;
     setWindowSize?(driver: TDriver, size: Size): Promise<void>;
     getWindowSize?(driver: TDriver): Promise<Size>;
     setViewportSize?(driver: TDriver, size: Size): Promise<void>;
@@ -72,7 +74,6 @@ export interface SpecDriver<TDriver, TContext, TElement, TSelector> {
     getUrl(driver: TDriver): Promise<string>;
     takeScreenshot(driver: TDriver): Promise<Buffer | string>;
     click?(context: TContext, element: TElement | TSelector): Promise<void>;
-    type?(context: TContext, element: TElement, value: string): Promise<void>;
     visit?(driver: TDriver, url: string): Promise<void>;
     getOrientation?(driver: TDriver): Promise<ScreenOrientation>;
     setOrientation?(driver: TDriver, orientation: ScreenOrientation): Promise<void>;
@@ -94,7 +95,6 @@ export interface SpecDriver<TDriver, TContext, TElement, TSelector> {
     }>;
     getElementRegion?(driver: TDriver, element: TElement): Promise<Region>;
     getElementAttribute?(driver: TDriver, element: TElement, attr: string): Promise<string>;
-    getElementText?(driver: TDriver, element: TElement): Promise<string>;
     performAction?(driver: TDriver, steps: any[]): Promise<void>;
     getCurrentWorld?(driver: TDriver): Promise<string>;
     getWorlds?(driver: TDriver): Promise<string[]>;