@applitools/driver 1.11.37 → 1.11.38

package/dist/element.js

@@ -88,7 +88,8 @@ class Element {
         if (this.isRef)
             return false;
         element = element instanceof Element ? element.target : element;
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             return this._spec
                 .executeScript(this.context.target, snippets.isEqualElements, [this.target, element])
                 .catch(() => false);
@@ -102,7 +103,8 @@ class Element {
             var _a, _b;
             var _c;
             innerElement = innerElement instanceof Element ? innerElement.target : innerElement;
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 this._logger.log('Checking if web element with selector', this.selector, 'contains element', innerElement);
                 return false; // TODO implement a snipped for web
             }
@@ -140,7 +142,8 @@ class Element {
     }
     async getRegion() {
         const region = await this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 this._logger.log('Extracting region of web element with selector', this.selector);
                 return this.context.execute(snippets.getElementRect, [this, false]);
             }
@@ -161,7 +164,8 @@ class Element {
     }
     async getClientRegion() {
         const region = await this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 this._logger.log('Extracting region of web element with selector', this.selector);
                 return this.context.execute(snippets.getElementRect, [this, true]);
             }
@@ -174,13 +178,14 @@ class Element {
     }
     async getContentRegion(options = {}) {
         var _a, _b;
-        if (!this.driver.isNative)
+        const environment = await this.driver.getEnvironment();
+        if (!environment.isNative)
             return null;
         this._logger.log('Extracting content region of native element with selector', this.selector);
         const helper = await this.driver.getHelper();
         let contentRegion = await (helper === null || helper === void 0 ? void 0 : helper.getContentRegion(this, options));
         this._logger.log('Extracted content region using helper library', contentRegion);
-        if (!contentRegion || !this.driver.isAndroid) {
+        if (!contentRegion || !environment.isAndroid) {
             let attrContentRegion = null;
             try {
                 const size = JSON.parse(await this.getAttribute('contentSize'));
@@ -188,7 +193,7 @@ class Element {
                     x: size.left,
                     y: size.top,
                     width: size.width,
-                    height: this.driver.isIOS
+                    height: environment.isIOS
                         ? Math.max(size.height, size.scrollableOffset)
                         : size.height + size.scrollableOffset,
                 };
@@ -198,7 +203,7 @@ class Element {
             }
             this._logger.log('Extracted content region using attribute', attrContentRegion);
             // ios workaround
-            if (!attrContentRegion && this.driver.isIOS) {
+            if (!attrContentRegion && environment.isIOS) {
                 try {
                     const type = await this.getAttribute('type');
                     if (type === 'XCUIElementTypeScrollView') {
@@ -236,7 +241,8 @@ class Element {
         if (this._state.contentSize)
             return this._state.contentSize;
         const size = await this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 this._logger.log('Extracting content size of web element with selector', this.selector);
                 return this.context.execute(snippets.getElementContentSize, [this]);
             }
@@ -245,11 +251,12 @@ class Element {
                 try {
                     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);
+                    const viewport = await this.driver.getViewport();
+                    if (environment.isAndroid) {
+                        this._state.contentSize = utils.geometry.scale(this._state.contentSize, 1 / viewport.pixelRatio);
                     }
-                    if (contentRegion.y < this.driver.statusBarSize) {
-                        this._state.contentSize.height -= this.driver.statusBarSize - contentRegion.y;
+                    if (contentRegion.y < viewport.statusBarSize) {
+                        this._state.contentSize.height -= viewport.statusBarSize - contentRegion.y;
                     }
                     return this._state.contentSize;
                 }
@@ -266,7 +273,8 @@ class Element {
     async isPager() {
         this._logger.log('Check if element with selector', this.selector, 'is scrollable by pages');
         const isPager = await this.withRefresh(async () => {
-            if (this.driver.isAndroid) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isAndroid) {
                 const className = await this.getAttribute('className');
                 return ['androidx.viewpager.widget.ViewPager'].includes(className);
             }
@@ -280,14 +288,15 @@ class Element {
     async isScrollable() {
         this._logger.log('Check if element with selector', this.selector, 'is scrollable');
         const isScrollable = await this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 return this.context.execute(snippets.isElementScrollable, [this]);
             }
-            else if (this.driver.isAndroid) {
+            else if (environment.isAndroid) {
                 const data = JSON.parse(await this.getAttribute('scrollable'));
                 return Boolean(data) || false;
             }
-            else if (this.driver.isIOS) {
+            else if (environment.isIOS) {
                 const type = await this.getAttribute('type');
                 return ['XCUIElementTypeScrollView', 'XCUIElementTypeTable', 'XCUIElementTypeCollectionView'].includes(type);
             }
@@ -298,7 +307,8 @@ class Element {
     async isRoot() {
         // TODO replace with snippet
         return this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 const rootElement = await this.context.element({ type: 'css', selector: 'html' });
                 return this.equals(rootElement);
             }
@@ -308,7 +318,8 @@ class Element {
         });
     }
     async getShadowRoot() {
-        if (!this.driver.isWeb)
+        const environment = await this.driver.getEnvironment();
+        if (!environment.isWeb)
             return null;
         return this._spec.executeScript(this.context.target, snippets.getShadowRoot, [this.target]);
     }
@@ -316,11 +327,12 @@ class Element {
         var _a;
         var _b;
         if (this._state.touchPadding == null) {
-            if (this.driver.isWeb)
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb)
                 this._state.touchPadding = 0;
-            else if (this.driver.isIOS)
+            else if (environment.isIOS)
                 this._state.touchPadding = 10;
-            else if (this.driver.isAndroid) {
+            else if (environment.isAndroid) {
                 const helper = await this.driver.getHelper();
                 if ((helper === null || helper === void 0 ? void 0 : helper.name) === 'android') {
                     this._state.touchPadding = await helper.getTouchPadding();
@@ -342,7 +354,8 @@ class Element {
     }
     async getText() {
         const text = await this.withRefresh(async () => {
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 return '';
             }
             else {
@@ -364,7 +377,8 @@ class Element {
         const value = await this.withRefresh(async () => {
             var _a;
             var _b;
-            if (this.driver.isWeb) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 const properties = await this.context.execute(snippets.getElementProperties, [this, [name]]);
                 return properties[name];
             }
@@ -380,7 +394,7 @@ class Element {
                     throw err;
                 }
                 finally {
-                    if (this.driver.isAndroid && name === 'contentSize') {
+                    if (environment.isAndroid && name === 'contentSize') {
                         // android has a bug when after extracting 'contentSize' attribute the element is being scrolled by undetermined number of pixels
                         this._logger.log('Stabilizing android scroll offset');
                         const originalScrollOffset = await this.getScrollOffset();
@@ -394,7 +408,8 @@ class Element {
         return value;
     }
     async setAttribute(name, value) {
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             await this.context.execute(snippets.setElementAttributes, [this, { [name]: value }]);
         }
     }
@@ -402,10 +417,11 @@ class Element {
         return this.withRefresh(async () => {
             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) {
+            const environment = await this.driver.getEnvironment();
+            if (environment.isWeb) {
                 let actualOffset = await this.context.execute(snippets.scrollTo, [this, offset]);
                 // iOS has an issue when scroll offset is read immediately after it is been set it will always return the exact value that was set
-                if (this.driver.isIOS)
+                if (environment.isIOS)
                     actualOffset = await this.getScrollOffset();
                 return actualOffset;
             }
@@ -413,7 +429,7 @@ 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 (utils.geometry.equals(offset, { x: 0, y: 0 }) && this.driver.isAndroid) {
+                if (utils.geometry.equals(offset, { x: 0, y: 0 }) && environment.isAndroid) {
                     const helper = await this.driver.getHelper();
                     if ((helper === null || helper === void 0 ? void 0 : helper.name) === 'android') {
                         await helper.scrollToTop(this);
@@ -432,9 +448,10 @@ class Element {
                 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
                     : utils.geometry.offsetNegative(requiredOffset, currentScrollOffset);
-                if (this.driver.isAndroid) {
-                    remainingOffset = utils.geometry.round(utils.geometry.scale(remainingOffset, this.driver.pixelRatio));
-                    effectiveRegion = utils.geometry.round(utils.geometry.scale(effectiveRegion, this.driver.pixelRatio));
+                if (environment.isAndroid) {
+                    const viewport = await this.driver.getViewport();
+                    remainingOffset = utils.geometry.round(utils.geometry.scale(remainingOffset, viewport.pixelRatio));
+                    effectiveRegion = utils.geometry.round(utils.geometry.scale(effectiveRegion, viewport.pixelRatio));
                 }
                 const isPager = await this.isPager();
                 const touchPadding = await this.getTouchPadding();
@@ -463,7 +480,7 @@ class Element {
                             { action: 'release' },
                         ]);
                     }
-                    else if (this.driver.isAndroid) {
+                    else if (environment.isAndroid) {
                         actions.push([
                             // move through scrolling gap (actual scrolling will be triggered only after that)
                             { action: 'press', y: yTrack, x: xStart - xGap },
@@ -477,7 +494,7 @@ class Element {
                             { action: 'release' },
                         ]);
                     }
-                    else if (this.driver.isIOS) {
+                    else if (environment.isIOS) {
                         actions.push([
                             // move through scrolling gap (actual scrolling will be triggered only after that)
                             { action: 'press', y: yTrack, x: xStart - xGap },
@@ -518,7 +535,7 @@ class Element {
                             { action: 'release' },
                         ]);
                     }
-                    else if (this.driver.isAndroid) {
+                    else if (environment.isAndroid) {
                         actions.push([
                             // move through scrolling gap (actual scrolling will be triggered only after that)
                             { action: 'press', x: xTrack, y: yStart - yGap },
@@ -532,7 +549,7 @@ class Element {
                             { action: 'release' },
                         ]);
                     }
-                    else if (this.driver.isIOS) {
+                    else if (environment.isIOS) {
                         actions.push([
                             // move through scrolling gap (actual scrolling will be triggered only after that)
                             { action: 'press', x: xTrack, y: yStart - yGap },
@@ -551,7 +568,7 @@ class Element {
                 }
                 // ios actions should be executed one-by-one sequentially, otherwise the result isn't stable
                 // pages should be scrolled one-by-one as well
-                if (isPager || this.driver.isIOS) {
+                if (isPager || environment.isIOS) {
                     for (const action of actions) {
                         await this._spec.performAction(this.driver.target, action);
                     }
@@ -570,7 +587,8 @@ class Element {
     }
     async translateTo(offset) {
         offset = { x: Math.round(offset.x), y: Math.round(offset.y) };
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             return this.withRefresh(async () => this.context.execute(snippets.translateTo, [this, offset]));
         }
         else {
@@ -579,7 +597,8 @@ class Element {
     }
     async getScrollOffset() {
         var _a;
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             return this.withRefresh(() => this.context.execute(snippets.getElementScrollOffset, [this]));
         }
         else {
@@ -587,7 +606,8 @@ class Element {
         }
     }
     async getTranslateOffset() {
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             return this.withRefresh(() => this.context.execute(snippets.getElementTranslateOffset, [this]));
         }
         else {
@@ -595,7 +615,8 @@ class Element {
         }
     }
     async getInnerOffset() {
-        if (this.driver.isWeb) {
+        const environment = await this.driver.getEnvironment();
+        if (environment.isWeb) {
             return this.withRefresh(() => this.context.execute(snippets.getElementInnerOffset, [this]));
         }
         else {
@@ -614,7 +635,8 @@ class Element {
     }
     async preserveState() {
         const scrollOffset = await this.getScrollOffset();
-        const transforms = this.driver.isWeb
+        const environment = await this.driver.getEnvironment();
+        const transforms = environment.isWeb
             ? await this.context.execute(snippets.getElementStyleProperties, [this, ['transform', '-webkit-transform']])
             : null;
         if (!utils.types.has(this._state, ['scrollOffset', 'transforms'])) {
@@ -634,7 +656,8 @@ class Element {
         }
     }
     async hideScrollbars() {
-        if (this.driver.isNative)
+        const environment = await this.driver.getEnvironment();
+        if (environment.isNative)
             return;
         if (this._originalOverflow)
             return;
@@ -644,7 +667,8 @@ class Element {
         });
     }
     async restoreScrollbars() {
-        if (this.driver.isNative)
+        const environment = await this.driver.getEnvironment();
+        if (environment.isNative)
             return;
         if (!this._originalOverflow)
             return;

package/dist/fake/mock-driver.js

@@ -120,17 +120,14 @@ class MockDriver {
         this.mockScript(snippets.getShadowRoot, ([element]) => {
             return element;
         });
-        this.mockScript(snippets.getBrowserInfo, () => {
+        this.mockScript(snippets.getUserAgent, () => {
             return JSON.stringify({
                 status: 'SUCCESS',
-                value: {
-                    userAgent: this._ua !== undefined ? this._ua : this.info.isMobile ? DEFAULT_MOBILE_UA : DEFAULT_DESKTOP_UA,
-                    pixelRatio: 1,
-                },
+                value: this._ua !== undefined ? this._ua : this.environment.isMobile ? DEFAULT_MOBILE_UA : DEFAULT_DESKTOP_UA,
             });
         });
-        this.mockScript(snippets.getViewportSize, () => {
-            return { width: this._window.rect.width, height: this._window.rect.height };
+        this.mockScript(snippets.getViewport, () => {
+            return { viewportSize: { width: this._window.rect.width, height: this._window.rect.height }, pixelRation: 1 };
         });
         this.mockScript(snippets.getElementXpath, ([element]) => {
             if (element.xpath)
@@ -254,7 +251,7 @@ class MockDriver {
             return;
         this[name] = method;
     }
-    get info() {
+    get environment() {
         return {
             isMobile: this._device ? Boolean(this._device.isMobile) : false,
             isNative: this._device ? Boolean(this._device.isNative) : false,
@@ -266,7 +263,7 @@ class MockDriver {
         };
     }
     async executeScript(script, args = []) {
-        if (this.info.isNative)
+        if (this.environment.isNative)
             throw new Error("Native context doesn't support this method");
         let result = this._scripts.get(String(script));
         if (!result) {
@@ -327,17 +324,17 @@ class MockDriver {
         Object.assign(this._window.rect, rect);
     }
     async getUrl() {
-        if (this.info.isNative)
+        if (this.environment.isNative)
             throw new Error("Native context doesn't support this method");
         return this._window.url;
     }
     async getTitle() {
-        if (this.info.isNative)
+        if (this.environment.isNative)
             throw new Error("Native context doesn't support this method");
         return this._window.title;
     }
     async visit(url) {
-        if (this.info.isNative)
+        if (this.environment.isNative)
             throw new Error("Native context doesn't support this method");
         this._window.url = url;
     }

package/dist/fake/spec-driver.js

@@ -106,7 +106,7 @@ async function takeScreenshot(driver) {
 }
 exports.takeScreenshot = takeScreenshot;
 async function getDriverInfo(driver) {
-    return driver.info;
+    return { environment: driver.environment };
 }
 exports.getDriverInfo = getDriverInfo;
 async function getWindowSize(driver) {

package/dist/user-agent.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseBrowser = exports.parsePlatform = exports.parseUserAgent = void 0;
+exports.extractUserAgentEnvironment = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const MAJOR_MINOR = '(\\d+)(?:[_.](\\d+))?';
 const PLATFORM_REGEXES = [
@@ -52,16 +52,35 @@ const BROWSER_REGEXPES = [
 ];
 const HIDDEN_IE_REGEX = new RegExp(`(?:rv:${MAJOR_MINOR}\\) like Gecko)`);
 const BROWSER_VERSION_REGEX = new RegExp(`(?:Version/${MAJOR_MINOR})`);
-function parseUserAgent(userAgent) {
-    utils.guard.notNull(userAgent, { name: 'userAgent' });
-    userAgent = userAgent.trim();
-    return {
-        ...parsePlatform(userAgent),
-        ...parseBrowser(userAgent),
+const WINDOWS_VERSIONS = {
+    '0.1.0': '7',
+    '0.2.0': '8',
+    '0.3.0': '8.1',
+    '10.0.0': '10',
+    '15.0.0': '11',
+};
+function extractUserAgentEnvironment(userAgent) {
+    var _a, _b;
+    let userAgentLegacy, userAgentObject;
+    if (utils.types.isString(userAgent)) {
+        userAgentLegacy = userAgent.trim();
+    }
+    else {
+        userAgentLegacy = userAgent.legacy.trim();
+        userAgentObject = userAgent;
+    }
+    const userAgentLegacyEnvironment = {
+        ...extractUserAgentLegacyPlatform(userAgentLegacy),
+        ...extractUserAgentLegacyBrowser(userAgentLegacy),
     };
+    const userAgentEnvironment = userAgentObject && extractUserAgentObjectEnvironment(userAgentObject);
+    const environment = { ...userAgentLegacyEnvironment, ...userAgentEnvironment };
+    environment.browserName = (_a = userAgentLegacyEnvironment.browserName) !== null && _a !== void 0 ? _a : userAgentEnvironment === null || userAgentEnvironment === void 0 ? void 0 : userAgentEnvironment.browserName;
+    environment.browserVersion = (_b = userAgentLegacyEnvironment.browserVersion) !== null && _b !== void 0 ? _b : userAgentEnvironment === null || userAgentEnvironment === void 0 ? void 0 : userAgentEnvironment.browserVersion;
+    return environment;
 }
-exports.parseUserAgent = parseUserAgent;
-function parsePlatform(userAgent) {
+exports.extractUserAgentEnvironment = extractUserAgentEnvironment;
+function extractUserAgentLegacyPlatform(userAgent) {
     const platformRegExp = PLATFORM_REGEXES.find(regexp => regexp.test(userAgent));
     if (!platformRegExp)
         return { platformName: 'Unknown' };
@@ -95,8 +114,7 @@ function parsePlatform(userAgent) {
         return { platformName, platformVersion: platformMajorVersion };
     }
 }
-exports.parsePlatform = parsePlatform;
-function parseBrowser(userAgent) {
+function extractUserAgentLegacyBrowser(userAgent) {
     const browserRegExp = BROWSER_REGEXPES.find(regexp => regexp.test(userAgent));
     if (!browserRegExp) {
         if (HIDDEN_IE_REGEX.test(userAgent)) {
@@ -117,4 +135,25 @@ function parseBrowser(userAgent) {
     }
     return result;
 }
-exports.parseBrowser = parseBrowser;
+function extractUserAgentObjectEnvironment(userAgent) {
+    var _a, _b, _c, _d;
+    const chromiumBrand = (_a = userAgent.brands) === null || _a === void 0 ? void 0 : _a.find(brand => /Chromium/i.test(brand.brand));
+    const browserBrand = (_c = (_b = userAgent.brands) === null || _b === void 0 ? void 0 : _b.find(brand => brand !== chromiumBrand && !/Not.?A.?Brand/i.test(brand.brand))) !== null && _c !== void 0 ? _c : chromiumBrand;
+    const environment = {
+        browserName: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.brand,
+        browserVersion: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.version,
+        platformName: userAgent.platform || undefined,
+        platformVersion: userAgent.platformVersion || undefined,
+        deviceName: userAgent.model || undefined,
+        isMobile: userAgent.mobile,
+        isChromium: Boolean(chromiumBrand),
+    };
+    if (environment.platformName === 'Windows') {
+        environment.platformVersion = WINDOWS_VERSIONS[environment.platformVersion];
+    }
+    else if (environment.platformName === 'macOS') {
+        environment.platformName = 'Mac OS X';
+        environment.platformVersion = (_d = environment.platformVersion) === null || _d === void 0 ? void 0 : _d.split(/[._]/, 2).join('.');
+    }
+    return environment;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.11.37",
+  "version": "1.11.38",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -82,12 +82,12 @@
   },
   "dependencies": {
     "@applitools/logger": "1.1.48",
-    "@applitools/snippets": "2.4.17",
+    "@applitools/snippets": "2.4.18",
     "@applitools/utils": "1.3.32",
     "semver": "7.3.7"
   },
   "devDependencies": {
-    "@applitools/bongo": "^3.0.1",
+    "@applitools/bongo": "^3.0.3",
     "@types/node": "^12.20.55"
   },
   "engines": {

package/types/capabilities.d.ts

@@ -1,4 +1,3 @@
-import { type DriverInfo } from './spec-driver';
-type Capabilities = Record<string, any>;
-export declare function parseCapabilities(capabilities: Capabilities): DriverInfo;
-export {};
+import type { Capabilities, Environment, Viewport } from './types';
+export declare function extractCapabilitiesEnvironment(capabilities: Capabilities): Partial<Environment>;
+export declare function extractCapabilitiesViewport(capabilities: Capabilities): Partial<Viewport>;