@applitools/driver 1.18.0 → 1.19.1

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [1.19.1](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.19.0...js/driver@1.19.1) (2024-09-16)
+
+
+### Bug Fixes
+
+* stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.5.0
+  #### Features
+
+  * add playwright fixture ([#2412](https://github.com/Applitools-Dev/sdk/issues/2412)) ([0632e93](https://github.com/Applitools-Dev/sdk/commit/0632e93dd7f53029a8c5f4230d22a05abf5fefd4))
+
+
+  #### Bug Fixes
+
+  * stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+
+## [1.19.0](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.18.0...js/driver@1.19.0) (2024-09-10)
+
+
+### Features
+
+* add support for env var APPLITOOLS_IS_IC ([#2469](https://github.com/Applitools-Dev/sdk/issues/2469)) ([87d7b5c](https://github.com/Applitools-Dev/sdk/commit/87d7b5cc1f7ea774c6b90504e85296f0681d0b1e))
+
+
+### Bug Fixes
+
+* handle userAgent.brands returned as string ([#2453](https://github.com/Applitools-Dev/sdk/issues/2453)) ([dd6328b](https://github.com/Applitools-Dev/sdk/commit/dd6328be3e7d885714124a8e43aabaae3abecde9))
+* searching for scrollable element multiple times ([#2493](https://github.com/Applitools-Dev/sdk/issues/2493)) ([d98db80](https://github.com/Applitools-Dev/sdk/commit/d98db8016c6312f467f244444c6f1a87bc09b7da))
+
 ## [1.18.0](https://github.com/Applitools-Dev/sdk/compare/js/driver@1.17.5...js/driver@1.18.0) (2024-07-23)
 
 

package/dist/context.js

@@ -38,6 +38,13 @@ class Context {
     constructor(options) {
         var _a, _b, _c, _d;
         this._state = {};
+        /**
+         * The purpose of this state is to make sure we don't search for the SRE multiple times.
+         * This is unwanted to have but needed, search for `.setScrollingElement(settings.scrollRootElement ?? null)`,
+         * I don't want to risk breaking it.
+         * e.g in js/packages/core/src/classic/check.ts
+         */
+        this._searchScrollingElement = true;
         this._spec = options.spec;
         if (options.context) {
             if ((_c = (_b = (_a = this._spec).isContext) === null || _b === void 0 ? void 0 : _b.call(_a, options.context)) !== null && _c !== void 0 ? _c : this._spec.isDriver(options.context)) {
@@ -392,6 +399,8 @@ class Context {
         return (_a = this._element) !== null && _a !== void 0 ? _a : null;
     }
     async getScrollingElement() {
+        if (!this._searchScrollingElement)
+            return this._scrollingElement;
         if (!(0, element_1.isElementInstance)(this._scrollingElement)) {
             await this.focus();
             if (this._scrollingElement) {
@@ -415,6 +424,9 @@ class Context {
                     this._scrollingElement = await this.element({ type: 'xpath', selector: '//*[@scrollable="true"]' });
                 }
             }
+            if (this._scrollingElement === null) {
+                this._searchScrollingElement = false;
+            }
         }
         return this._scrollingElement;
     }

package/dist/driver.js

@@ -284,7 +284,10 @@ class Driver {
                 this._environment.isEmulation = true;
             }
             const driverUrl = (_d = (await this.getDriverUrl())) !== null && _d !== void 0 ? _d : '';
-            this._environment.isEC = this._environment.isECClient || /exec-wus.applitools.com/.test(driverUrl);
+            this._environment.isEC =
+                this._environment.isECClient ||
+                    utils.general.getEnvValue('IS_EC', 'boolean') ||
+                    /exec-wus\.applitools\.com/.test(driverUrl);
             this._environment.isKobiton = /kobiton/.test(driverUrl);
             this._logger.log('Extracted environment', this._environment);
         }

package/dist/fake/mock-driver.js

@@ -142,16 +142,12 @@ class MockDriver {
         this.mockScript(snippets.blurElement, () => {
             return null;
         });
-        this.mockScript(snippets.addElementIds, ([elements, ids]) => {
-            const selectors = [];
-            for (const [index, element] of elements.entries()) {
-                const elementId = ids[index];
+        this.mockScript(snippets.addElementIds, elementsWithIds => {
+            return elementsWithIds.map(([elements, id]) => elements.map(element => {
                 element.attributes = element.attributes || [];
-                element.attributes.push({ name: 'data-applitools-selector', value: elementId });
-                const selector = `[data-applitools-selector~="${elementId}"]`;
-                selectors.push([selector]);
-            }
-            return selectors;
+                element.attributes.push({ name: 'data-applitools-marker', value: id });
+                return [`[data-applitools-marker~="${id}"]`]; // no shadow is mocked here
+            }));
         });
         this.mockScript(snippets.cleanupElementIds, ([elements]) => {
             for (const el of elements) {

package/dist/user-agent.js

@@ -143,9 +143,18 @@ function extractUserAgentLegacyBrowser(userAgent) {
     };
 }
 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;
+    var _a, _b, _c, _d, _e, _f;
+    if (typeof userAgent.brands === 'string') {
+        try {
+            userAgent.brands = JSON.parse(userAgent.brands);
+        }
+        catch (e) {
+            userAgent.brands = [];
+        }
+    }
+    // we assume the structure of the brands array, but since it's an experimental API, we use optional chaining to stay on the safe side
+    const chromiumBrand = (_b = (_a = userAgent.brands) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, brand => /Chromium/i.test(brand.brand));
+    const browserBrand = (_e = (_d = (_c = userAgent.brands) === null || _c === void 0 ? void 0 : _c.find) === null || _d === void 0 ? void 0 : _d.call(_c, brand => brand !== chromiumBrand && !/Not.?A.?Brand/i.test(brand.brand))) !== null && _e !== void 0 ? _e : chromiumBrand;
     const environment = {
         browserName: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.brand,
         browserVersion: browserBrand === null || browserBrand === void 0 ? void 0 : browserBrand.version,
@@ -161,7 +170,7 @@ function extractUserAgentObjectEnvironment(userAgent) {
     }
     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('.');
+        environment.platformVersion = (_f = environment.platformVersion) === null || _f === void 0 ? void 0 : _f.split(/[._]/, 2).join('.');
     }
     return environment;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/driver",
-  "version": "1.18.0",
+  "version": "1.19.1",
   "description": "Applitools universal framework wrapper",
   "keywords": [
     "applitools",
@@ -74,7 +74,7 @@
   },
   "dependencies": {
     "@applitools/logger": "2.0.18",
-    "@applitools/snippets": "2.4.27",
+    "@applitools/snippets": "2.5.0",
     "@applitools/utils": "1.7.4",
     "semver": "7.6.2"
   },

package/types/context.d.ts

@@ -29,6 +29,13 @@ export declare class Context<T extends SpecType> {
     private _state;
     private _isReference;
     protected readonly _spec: SpecDriver<T>;
+    /**
+     * The purpose of this state is to make sure we don't search for the SRE multiple times.
+     * This is unwanted to have but needed, search for `.setScrollingElement(settings.scrollRootElement ?? null)`,
+     * I don't want to risk breaking it.
+     * e.g in js/packages/core/src/classic/check.ts
+     */
+    private _searchScrollingElement;
     constructor(options: ContextOptions<T>);
     get logger(): import("@applitools/logger").Logger;
     get target(): T['driver'];
@@ -59,7 +66,7 @@ export declare class Context<T extends SpecType> {
         pollTimeout?: number;
     }): Promise<any>;
     getContextElement(): Promise<Element<T> | null>;
-    getScrollingElement(): Promise<Element<T> | null>;
+    getScrollingElement(): Promise<Element<T> | null | undefined>;
     setScrollingElement(scrollingElement: Element<T> | ElementReference<T> | undefined | null): Promise<void>;
     blurElement(element?: Element<T>): Promise<T['element'] | null>;
     focusElement(element: Element<T>): Promise<any>;