@applitools/driver 1.15.3 → 1.16.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.16.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/driver@1.16.0...js/driver@1.16.1) (2023-12-19)
+
+
+### Bug Fixes
+
+* fixed bug with screenshot not being properly scaled on ios devices with appium 2 ([#2092](https://github.com/applitools/eyes.sdk.javascript1/issues/2092)) ([26678bf](https://github.com/applitools/eyes.sdk.javascript1/commit/26678bfe254def506ea82e6a645519d6567fb3fd))
+* fixed extraction of the driver server url ([ddc6449](https://github.com/applitools/eyes.sdk.javascript1/commit/ddc6449fc72166ab26c99e9ba7bb83c05fd591d6))
+* fixed infinite loop that may appear during attribute extraction ([#2102](https://github.com/applitools/eyes.sdk.javascript1/issues/2102)) ([6bef680](https://github.com/applitools/eyes.sdk.javascript1/commit/6bef680fbd2d5c26a46cf2a4f00bd083d1d02109))
+
+## [1.16.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/driver@1.15.3...js/driver@1.16.0) (2023-12-18)
+
+
+### Features
+
+* add set of env variables to skip/ignore some optional automations ([#2097](https://github.com/applitools/eyes.sdk.javascript1/issues/2097)) ([bd3b08c](https://github.com/applitools/eyes.sdk.javascript1/commit/bd3b08c3d2997eb98d545b308a1f15501192178e))
+
 ## [1.15.3](https://github.com/applitools/eyes.sdk.javascript1/compare/js/driver@1.15.2...js/driver@1.15.3) (2023-12-12)
 
 

package/dist/driver.js

@@ -85,12 +85,17 @@ class Driver {
     }
     async refresh({ reset } = {}) {
         if (reset) {
-            this._driverInfo = undefined;
-            this._environment = undefined;
-            this._viewport = undefined;
-            this._features = undefined;
-            this._helper = undefined;
-            this._state = {};
+            if (utils.general.getEnvValue('AVOID_DRIVER_STATE_REST', 'boolean')) {
+                this._logger.log(`Skipping reset of the driver state`);
+            }
+            else {
+                this._driverInfo = undefined;
+                this._environment = undefined;
+                this._viewport = undefined;
+                this._features = undefined;
+                this._helper = undefined;
+                this._state = {};
+            }
         }
         const spec = this._spec;
         let currentContext = this.currentContext.target;
@@ -277,8 +282,8 @@ class Driver {
         return this._environment;
     }
     async getViewport() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
-        var _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11;
+        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, _13, _14, _15;
         if (!this._viewport) {
             const environment = await this.getEnvironment();
             const driverInfo = await this.getDriverInfo();
@@ -295,16 +300,15 @@ class Driver {
                 const capabilitiesViewport = capabilities ? (0, capabilities_1.extractCapabilitiesViewport)(capabilities) : null;
                 this._logger.log('Extracted capabilities viewport', capabilitiesViewport);
                 this._viewport = { ...capabilitiesViewport, ...this._viewport };
-                (_a = (_y = this._viewport).pixelRatio) !== null && _a !== void 0 ? _a : (_y.pixelRatio = 1);
                 // 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);
-                (_b = (_z = this._viewport).displaySize) !== null && _b !== void 0 ? _b : (_z.displaySize = windowSize);
-                if (((_c = this._viewport.orientation) === null || _c === void 0 ? void 0 : _c.startsWith('landscape')) &&
+                (_a = (_1 = this._viewport).displaySize) !== null && _a !== void 0 ? _a : (_1.displaySize = windowSize);
+                if (((_b = this._viewport.orientation) === null || _b === void 0 ? void 0 : _b.startsWith('landscape')) &&
                     this._viewport.displaySize.height > this._viewport.displaySize.width) {
                     this._viewport.displaySize = utils.geometry.rotate(this._viewport.displaySize, 90);
                 }
                 if (environment.isAndroid) {
-                    // bar sizes could be extracted only on android
+                    (_c = (_2 = this._viewport).pixelRatio) !== null && _c !== void 0 ? _c : (_2.pixelRatio = 1);
                     const { statusBar, navigationBar } = (_f = (await ((_e = (_d = this._spec).getSystemBars) === null || _e === void 0 ? void 0 : _e.call(_d, this.target).catch(() => undefined)))) !== null && _f !== void 0 ? _f : {};
                     if (statusBar === null || statusBar === void 0 ? void 0 : statusBar.visible) {
                         this._logger.log('Driver status bar', statusBar);
@@ -331,20 +335,26 @@ class Driver {
                         }
                     }
                     // bar sizes have to be scaled on android
-                    (_0 = this._viewport).statusBarSize && (_0.statusBarSize = this._viewport.statusBarSize / this._viewport.pixelRatio);
-                    (_1 = this._viewport).navigationBarSize && (_1.navigationBarSize = this._viewport.navigationBarSize / this._viewport.pixelRatio);
+                    (_3 = this._viewport).statusBarSize && (_3.statusBarSize = this._viewport.statusBarSize / this._viewport.pixelRatio);
+                    (_4 = this._viewport).navigationBarSize && (_4.navigationBarSize = this._viewport.navigationBarSize / this._viewport.pixelRatio);
                     windowSize = utils.geometry.scale(windowSize, 1 / this._viewport.pixelRatio);
-                    (_2 = this._viewport).displaySize && (_2.displaySize = utils.geometry.scale(this._viewport.displaySize, 1 / this._viewport.pixelRatio));
-                    (_l = (_3 = this._viewport).navigationBarSize) !== null && _l !== void 0 ? _l : (_3.navigationBarSize = 0);
+                    (_5 = this._viewport).displaySize && (_5.displaySize = utils.geometry.scale(this._viewport.displaySize, 1 / this._viewport.pixelRatio));
+                    (_l = (_6 = this._viewport).navigationBarSize) !== null && _l !== void 0 ? _l : (_6.navigationBarSize = 0);
                 }
                 else if (environment.isIOS) {
-                    if ((_m = this._viewport.orientation) === null || _m === void 0 ? void 0 : _m.startsWith('landscape'))
+                    if (!this._viewport.pixelRatio || !this._viewport.statusBarSize) {
+                        const screen = await this.execute('mobile:deviceScreenInfo');
+                        this._viewport.pixelRatio = (_m = screen.scale) !== null && _m !== void 0 ? _m : 0;
+                        this._viewport.statusBarSize = (_o = screen.statusBarSize) === null || _o === void 0 ? void 0 : _o.height;
+                    }
+                    if ((_p = this._viewport.orientation) === null || _p === void 0 ? void 0 : _p.startsWith('landscape'))
                         this._viewport.statusBarSize = 0;
                 }
-                (_o = (_4 = this._viewport).statusBarSize) !== null && _o !== void 0 ? _o : (_4.statusBarSize = 0);
+                (_q = (_7 = this._viewport).pixelRatio) !== null && _q !== void 0 ? _q : (_7.pixelRatio = 1);
+                (_r = (_8 = this._viewport).statusBarSize) !== null && _r !== void 0 ? _r : (_8.statusBarSize = 0);
                 // calculate viewport location
-                (_p = (_5 = this._viewport).viewportLocation) !== null && _p !== void 0 ? _p : (_5.viewportLocation = {
-                    x: this._viewport.orientation === 'landscape' ? (_q = this._viewport.navigationBarSize) !== null && _q !== void 0 ? _q : 0 : 0,
+                (_s = (_9 = this._viewport).viewportLocation) !== null && _s !== void 0 ? _s : (_9.viewportLocation = {
+                    x: this._viewport.orientation === 'landscape' ? (_t = this._viewport.navigationBarSize) !== null && _t !== void 0 ? _t : 0 : 0,
                     y: this._viewport.statusBarSize,
                 });
                 // calculate viewport size
@@ -352,7 +362,7 @@ class Driver {
                     this._viewport.viewportSize = { ...this._viewport.displaySize };
                     this._viewport.viewportSize.height -= this._viewport.statusBarSize;
                     if (environment.isAndroid) {
-                        this._viewport.viewportSize[((_r = this._viewport.orientation) === null || _r === void 0 ? void 0 : _r.startsWith('landscape')) ? 'width' : 'height'] -=
+                        this._viewport.viewportSize[((_u = this._viewport.orientation) === null || _u === void 0 ? void 0 : _u.startsWith('landscape')) ? 'width' : 'height'] -=
                             this._viewport.navigationBarSize;
                     }
                 }
@@ -382,13 +392,13 @@ class Driver {
             }
             if (environment.isWeb) {
                 const browserViewport = await this.execute(snippets.getViewport);
-                (_s = (_6 = this._viewport).viewportSize) !== null && _s !== void 0 ? _s : (_6.viewportSize = browserViewport.viewportSize);
-                (_t = (_7 = this._viewport).pixelRatio) !== null && _t !== void 0 ? _t : (_7.pixelRatio = browserViewport.pixelRatio);
-                (_u = (_8 = this._viewport).viewportScale) !== null && _u !== void 0 ? _u : (_8.viewportScale = browserViewport.viewportScale);
-                (_v = (_9 = this._viewport).orientation) !== null && _v !== void 0 ? _v : (_9.orientation = browserViewport.orientation);
+                (_v = (_10 = this._viewport).viewportSize) !== null && _v !== void 0 ? _v : (_10.viewportSize = browserViewport.viewportSize);
+                (_w = (_11 = this._viewport).pixelRatio) !== null && _w !== void 0 ? _w : (_11.pixelRatio = browserViewport.pixelRatio);
+                (_x = (_12 = this._viewport).viewportScale) !== null && _x !== void 0 ? _x : (_12.viewportScale = browserViewport.viewportScale);
+                (_y = (_13 = this._viewport).orientation) !== null && _y !== void 0 ? _y : (_13.orientation = browserViewport.orientation);
             }
-            (_w = (_10 = this._viewport).pixelRatio) !== null && _w !== void 0 ? _w : (_10.pixelRatio = 1);
-            (_x = (_11 = this._viewport).viewportScale) !== null && _x !== void 0 ? _x : (_11.viewportScale = 1);
+            (_z = (_14 = this._viewport).pixelRatio) !== null && _z !== void 0 ? _z : (_14.pixelRatio = 1);
+            (_0 = (_15 = this._viewport).viewportScale) !== null && _0 !== void 0 ? _0 : (_15.viewportScale = 1);
             this._logger.log('Extracted viewport', this._viewport);
         }
         return this._viewport;
@@ -413,17 +423,23 @@ class Driver {
     async getDriverUrl() {
         var _a;
         const driverInfo = await this.getDriverInfo();
-        return (_a = driverInfo.remoteHostname) !== null && _a !== void 0 ? _a : null;
+        return (_a = driverInfo.driverServerUrl) !== null && _a !== void 0 ? _a : null;
     }
     async getHelper() {
         var _a, _b, _c;
         if (this._helper === undefined) {
-            const environment = await this.getEnvironment();
-            this._logger.log(`Extracting helper for ${environment.isIOS ? 'ios' : 'android'}`);
-            this._helper = environment.isIOS
-                ? await helper_ios_1.HelperIOS.make({ spec: this._spec, driver: this })
-                : await helper_android_1.HelperAndroid.make({ spec: this._spec, driver: this });
-            this._logger.log(`Extracted helper of type ${(_a = this._helper) === null || _a === void 0 ? void 0 : _a.name}`);
+            if (utils.general.getEnvValue('IGNORE_HELPER_LIB', 'boolean')) {
+                this._logger.log(`Skipping helper lib extraction`);
+                this._helper = null;
+            }
+            else {
+                const environment = await this.getEnvironment();
+                this._logger.log(`Extracting helper for ${environment.isIOS ? 'ios' : 'android'}`);
+                this._helper = environment.isIOS
+                    ? await helper_ios_1.HelperIOS.make({ spec: this._spec, driver: this })
+                    : await helper_android_1.HelperAndroid.make({ spec: this._spec, driver: this });
+                this._logger.log(`Extracted helper of type ${(_a = this._helper) === null || _a === void 0 ? void 0 : _a.name}`);
+            }
         }
         this._logger.log(`Returning helper for of type ${(_c = (_b = this._helper) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : null}`);
         return this._helper;
@@ -744,24 +760,29 @@ class Driver {
         if (environment.isWeb)
             return (_a = this._viewport) === null || _a === void 0 ? void 0 : _a.orientation;
         if (environment.isAndroid) {
-            this._logger.log('Extracting device orientation using adb command on android');
-            const rotation = await this.execute('mobile:shell', {
-                command: "dumpsys window | grep 'mCurrentRotation' | cut -d = -f2",
-            })
-                .then(rotation => { var _a; return (_a = rotation === null || rotation === void 0 ? void 0 : rotation.trim) === null || _a === void 0 ? void 0 : _a.call(rotation); })
-                .catch(() => null);
-            if (rotation) {
-                let orientation = undefined;
-                if (rotation === 'ROTATION_0' || rotation === '0')
-                    orientation = 'portrait';
-                else if (rotation === 'ROTATION_90' || rotation === '3')
-                    orientation = 'landscape-secondary';
-                else if (rotation === 'ROTATION_180' || rotation === '2')
-                    orientation = 'portrait-secondary';
-                else if (rotation === 'ROTATION_270' || rotation === '1')
-                    orientation = 'landscape';
-                this._logger.log('Extracted device orientation:', orientation);
-                return orientation;
+            if (utils.general.getEnvValue('AVOID_ADB_USAGE', 'boolean')) {
+                this._logger.log(`Skipping device orientation extraction using adb command on android`);
+            }
+            else {
+                this._logger.log('Extracting device orientation using adb command on android');
+                const rotation = await this.execute('mobile:shell', {
+                    command: "dumpsys window | grep 'mCurrentRotation' | cut -d = -f2",
+                })
+                    .then(rotation => { var _a; return (_a = rotation === null || rotation === void 0 ? void 0 : rotation.trim) === null || _a === void 0 ? void 0 : _a.call(rotation); })
+                    .catch(() => null);
+                if (rotation) {
+                    let orientation = undefined;
+                    if (rotation === 'ROTATION_0' || rotation === '0')
+                        orientation = 'portrait';
+                    else if (rotation === 'ROTATION_90' || rotation === '3')
+                        orientation = 'landscape-secondary';
+                    else if (rotation === 'ROTATION_180' || rotation === '2')
+                        orientation = 'portrait-secondary';
+                    else if (rotation === 'ROTATION_270' || rotation === '1')
+                        orientation = 'landscape';
+                    this._logger.log('Extracted device orientation:', orientation);
+                    return orientation;
+                }
             }
         }
         this._logger.log('Extracting device orientation');

package/dist/element.js

@@ -189,14 +189,14 @@ class Element {
         if (!contentRegion || !environment.isAndroid) {
             let attrContentRegion = null;
             try {
-                const size = JSON.parse(await this.getAttribute('contentSize'));
+                const { left, top, width, height, scrollableOffset } = JSON.parse(await this.getAttribute('contentSize'));
+                if ([left, top, width, height, scrollableOffset].some(value => !utils.types.isNumber(value)))
+                    throw new Error('Invalid contentSize');
                 attrContentRegion = {
-                    x: size.left,
-                    y: size.top,
-                    width: size.width,
-                    height: environment.isIOS
-                        ? Math.max(size.height, size.scrollableOffset)
-                        : size.height + size.scrollableOffset,
+                    x: left,
+                    y: top,
+                    width: width,
+                    height: environment.isIOS ? Math.max(height, scrollableOffset) : height + scrollableOffset,
                 };
             }
             catch (err) {
@@ -368,9 +368,8 @@ class Element {
         return text;
     }
     async getAttribute(name) {
-        var _a;
         // we assumes that attributes are not changed during the session
-        if ((_a = this._state.attributes) === null || _a === void 0 ? void 0 : _a[name]) {
+        if (utils.types.has(this._state.attributes, name)) {
             if (this._state.attributes[name] instanceof Error)
                 throw this._state.attributes[name];
             return this._state.attributes[name];

package/dist/fake/spec-driver.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
+exports.performAction = exports.getElementAttribute = exports.getElementRegion = exports.getCurrentWorld = exports.visit = exports.getTitle = exports.getUrl = exports.getOrientation = exports.setWindowSize = exports.getWindowSize = exports.getDriverInfo = exports.takeScreenshot = exports.childContext = exports.parentContext = exports.mainContext = exports.getElementText = exports.findElements = exports.findElement = exports.executeScript = exports.isEqualElements = exports.isStaleElementError = exports.extractSelector = exports.toSimpleCommonSelector = exports.toSelector = exports.isSelector = exports.isElement = exports.isDriver = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function isDriver(driver) {
     return driver && driver.constructor.name === 'MockDriver';
@@ -141,3 +141,15 @@ async function getCurrentWorld(driver) {
     return driver.getCurrentWorld();
 }
 exports.getCurrentWorld = getCurrentWorld;
+async function getElementRegion(_driver, element) {
+    return element.region;
+}
+exports.getElementRegion = getElementRegion;
+async function getElementAttribute(_driver, element, attr) {
+    return element.attrs[attr];
+}
+exports.getElementAttribute = getElementAttribute;
+async function performAction(_driver, _steps) {
+    return;
+}
+exports.performAction = performAction;

package/dist/helper-ios.js

@@ -18,7 +18,12 @@ class HelperIOS {
     }
     async getContentRegion(element) {
         var _a, _b;
-        await this._element.click();
+        const { x, y } = await this._spec.getElementRegion(this._driver.target, this._element.target);
+        await this._spec.performAction(this._driver.target, [
+            { action: 'press', x, y },
+            { action: 'wait', ms: 300 },
+            { action: 'release' },
+        ]);
         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)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.15.3",
+  "version": "1.16.1",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",

package/types/fake/spec-driver.d.ts

@@ -1,4 +1,4 @@
-import type { Size } from '@applitools/utils';
+import type { Region, Size } from '@applitools/utils';
 import type { DriverInfo } from '../types';
 export type Driver = any;
 export type Element = any;
@@ -36,4 +36,7 @@ export declare function getUrl(driver: Driver): Promise<string>;
 export declare function getTitle(driver: Driver): Promise<string>;
 export declare function visit(driver: Driver, url: string): Promise<void>;
 export declare function getCurrentWorld(driver: Driver): Promise<any>;
+export declare function getElementRegion(_driver: Driver, element: Element): Promise<Region>;
+export declare function getElementAttribute(_driver: Driver, element: Element, attr: string): Promise<string>;
+export declare function performAction(_driver: Driver, _steps: any[]): Promise<void>;
 export {};

package/types/types.d.ts

@@ -68,7 +68,7 @@ export type Features = {
 };
 export type DriverInfo = {
     sessionId?: string;
-    remoteHostname?: string;
+    driverServerUrl?: string;
     userAgent?: UserAgent | null;
     capabilities?: Capabilities | null;
     viewport?: Partial<Viewport>;