@applitools/driver 1.5.0 → 1.5.3

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 ## Unreleased
 
 
+ ## 1.5.3 - 2022/3/12
+
+- when handling shadowRoot, send the element containing the doc frage and the root itself to element constructor 
+- change the sensible default value for touchPadding when running on Android to 20 (from 24)
+- add error logging in element.ts when unable to complete a getAttribute lookup
+- updated to @applitools/snippets@2.2.1 (from 2.2.0)
+- updated to @applitools/types@1.2.1 (from 1.2.0)
+
+## 1.5.2 - 2022/3/7
+
+- exclude iOS Safari from dynamic SRE calculation
+
+## 1.5.1 - 2022/3/7
+
+- fix `getScrollingElement` in mobile native
+
 ## 1.5.0 - 2022/3/6
 
 - add `waitForSelector` method
@@ -228,4 +244,4 @@
 
 ## 1.0.0 - 2020/12/1
 
-- Provide a framework-agnostic way to work with webdriver/cdp drivers
+- Provide a framework-agnostic way to work with webdriver/cdp drivers

package/dist/context.js

@@ -214,10 +214,11 @@ class Context {
         if ((_a = this.driver.features) === null || _a === void 0 ? void 0 : _a.shadowSelector)
             return { context, selector: elementSelector };
         let root = null;
+        let element = null;
         let currentSelector = elementSelector;
         while (specUtils.isCommonSelector(this._spec, currentSelector) &&
             specUtils.isSelector(this._spec, currentSelector.shadow)) {
-            const element = await this._spec.findElement(this.target, specUtils.transformSelector(this._spec, currentSelector, this.driver), root);
+            element = await this._spec.findElement(this.target, specUtils.transformSelector(this._spec, currentSelector, this.driver), root);
             if (!element)
                 return null;
             root = await this._spec.executeScript(this.target, snippets.getShadowRoot, [element]);
@@ -227,7 +228,7 @@ class Context {
         }
         return {
             context,
-            shadow: root ? new element_1.Element({ spec: this._spec, context, element: root, logger: this._logger }) : null,
+            shadow: root ? new element_1.Element({ spec: this._spec, context, element, logger: this._logger, root }) : null,
             selector: currentSelector,
         };
     }
@@ -352,10 +353,14 @@ class Context {
             if (this._scrollingElement) {
                 this._scrollingElement = await this.element(this._scrollingElement);
             }
+            else if (this.driver.isWeb) {
+                const isIOS = this.driver.isIOS;
+                const selector = isIOS ? 'html' : await this.execute(snippets.getDocumentScrollingElement);
+                this._logger.log(`default SRE is ${selector}${isIOS ? ' (because Safari on iOS)' : ''}`);
+                this._scrollingElement = await this.element({ type: 'css', selector });
+            }
             else {
-                const selector = await this.execute(snippets.getDocumentScrollingElement);
-                this._logger.log(`default SRE is ${selector}`);
-                this._scrollingElement = await this.element(this.driver.isWeb ? { type: 'css', selector } : { type: 'xpath', selector: '//*[@scrollable="true"]' });
+                this._scrollingElement = await this.element({ type: 'xpath', selector: '//*[@scrollable="true"]' });
             }
         }
         return this._scrollingElement;

package/dist/element.js

@@ -46,9 +46,13 @@ class Element {
         if (options.logger)
             this._logger = options.logger;
         if (this._spec.isElement(options.element)) {
-            this._target = (_c = (_b = (_a = this._spec).transformElement) === null || _b === void 0 ? void 0 : _b.call(_a, options.element)) !== null && _c !== void 0 ? _c : options.element;
+            let elementToUse = options.element;
+            if (options.root) {
+                elementToUse = options.root;
+            }
+            this._target = (_c = (_b = (_a = this._spec).transformElement) === null || _b === void 0 ? void 0 : _b.call(_a, elementToUse)) !== null && _c !== void 0 ? _c : elementToUse;
             // Some frameworks contains information about the selector inside an element
-            this._selector = (_d = options.selector) !== null && _d !== void 0 ? _d : (_f = (_e = this._spec).extractSelector) === null || _f === void 0 ? void 0 : _f.call(_e, options.element);
+            this._selector = (_d = options.selector) !== null && _d !== void 0 ? _d : (_f = (_e = this._spec).extractSelector) === null || _f === void 0 ? void 0 : _f.call(_e, elementToUse);
             this._index = options.index;
         }
         else if (specUtils.isSelector(this._spec, options.selector)) {
@@ -151,7 +155,8 @@ class Element {
                             height: (this.driver.isAndroid ? contentSize.height : 0) + contentSize.scrollableOffset,
                         };
                     })
-                        .catch(() => {
+                        .catch(err => {
+                        this._logger.log(`Unable to get the attribute 'contentSize' when looking up touchPadding due to the following error:`, `'${err.message}'`);
                         return this._spec.getElementRegion(this.driver.target, this.target);
                     }), { touchPadding } = _d, contentRegion = __rest(_d, ["touchPadding"]);
                     this._logger.log('Extracted native content size attribute', contentRegion);
@@ -162,6 +167,7 @@ class Element {
                         height: Math.max((_c = contentSize === null || contentSize === void 0 ? void 0 : contentSize.height) !== null && _c !== void 0 ? _c : 0, contentRegion.height),
                     };
                     this._touchPadding = touchPadding !== null && touchPadding !== void 0 ? touchPadding : this._touchPadding;
+                    this._logger.log('touchPadding', this._touchPadding);
                     if (this.driver.isAndroid) {
                         this._state.contentSize = utils.geometry.scale(this._state.contentSize, 1 / this.driver.pixelRatio);
                     }
@@ -228,8 +234,11 @@ class Element {
             else if (this.driver.isAndroid) {
                 const data = await this.getAttribute('contentSize')
                     .then(JSON.parse)
-                    .catch(() => null);
-                this._touchPadding = (_a = data === null || data === void 0 ? void 0 : data.touchPadding) !== null && _a !== void 0 ? _a : 24;
+                    .catch(err => {
+                    this._logger.log(`Unable to get the attribute 'contentSize' when looking up touchPadding due to the following error:`, `'${err.message}'`);
+                });
+                this._touchPadding = (_a = data === null || data === void 0 ? void 0 : data.touchPadding) !== null && _a !== void 0 ? _a : 20;
+                this._logger.log('touchPadding', this._touchPadding);
             }
         }
         return this._touchPadding;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.5.0",
+  "version": "1.5.3",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -73,8 +73,8 @@
     }
   },
   "dependencies": {
-    "@applitools/snippets": "2.2.0",
-    "@applitools/types": "1.2.0",
+    "@applitools/snippets": "2.2.1",
+    "@applitools/types": "1.2.1",
     "@applitools/utils": "1.2.13"
   },
   "devDependencies": {

package/types/element.d.ts

@@ -22,6 +22,7 @@ export declare class Element<TDriver, TContext, TElement, TSelector> {
         selector?: types.Selector<TSelector>;
         index?: number;
         logger?: any;
+        root?: TElement;
     });
     get target(): TElement;
     get selector(): types.Selector<TSelector>;

package/types/spec-utils.d.ts

@@ -1,5 +1,11 @@
 import type * as types from '@applitools/types';
-export declare function isCommonSelector<TSelector>(spec: Pick<types.SpecDriver<unknown, unknown, unknown, TSelector>, 'isSelector'>, selector: any): selector is types.CommonSelector<TSelector>;
+declare type CommonSelector<TSelector = never> = {
+    selector: TSelector | string;
+    type?: string;
+    shadow?: CommonSelector<TSelector> | TSelector | string;
+    frame?: CommonSelector<TSelector> | TSelector | string;
+};
+export declare function isCommonSelector<TSelector>(spec: Pick<types.SpecDriver<unknown, unknown, unknown, TSelector>, 'isSelector'>, selector: any): selector is CommonSelector<TSelector>;
 export declare function isSelector<TSelector>(spec: Pick<types.SpecDriver<unknown, unknown, unknown, TSelector>, 'isSelector'>, selector: any): selector is types.Selector<TSelector>;
 export declare function transformSelector<TSelector>(spec: Pick<types.SpecDriver<unknown, unknown, unknown, TSelector>, 'isSelector' | 'transformSelector'>, selector: types.Selector<TSelector>, environment?: {
     isWeb?: boolean;
@@ -11,3 +17,4 @@ export declare function splitSelector<TSelector>(spec: Pick<types.SpecDriver<unk
     contextSelectors: types.Selector<TSelector>[];
     elementSelector: types.Selector<TSelector>;
 };
+export {};