@applitools/core 4.18.1 → 4.19.0

package/CHANGELOG.md

@@ -1,5 +1,101 @@
 # Changelog
 
+## [4.19.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.18.2...js/core@4.19.0) (2024-09-16)
+
+
+### Features
+
+* allow passing arguments to dom-capture from core ([#2531](https://github.com/Applitools-Dev/sdk/issues/2531)) ([9cfc9a5](https://github.com/Applitools-Dev/sdk/commit/9cfc9a5b5d6650afd1e7daf2714d6779a7dc2724))
+
+
+### 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))
+* @applitools/dom-capture bumped to 11.5.0
+  #### Features
+
+  * ability to capture element properties ([#2525](https://github.com/Applitools-Dev/sdk/issues/2525)) ([ab35e1d](https://github.com/Applitools-Dev/sdk/commit/ab35e1dc929ba4bd82e99081527b277c8090f1e0))
+* @applitools/driver bumped to 1.19.1
+  #### Bug Fixes
+
+  * stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.13
+
+* @applitools/spec-driver-selenium bumped to 1.5.84
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.13
+
+* @applitools/screenshoter bumped to 3.8.37
+
+* @applitools/nml-client bumped to 1.8.11
+
+* @applitools/ec-client bumped to 1.9.5
+
+
+## [4.18.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.18.1...js/core@4.18.2) (2024-09-10)
+
+
+### Bug Fixes
+
+* don't call check-network when executing binary and cli ([#2491](https://github.com/Applitools-Dev/sdk/issues/2491)) ([ef00d20](https://github.com/Applitools-Dev/sdk/commit/ef00d205450b7bbe7abc1bc9bce8d6970f769091))
+
+
+### Dependencies
+
+* @applitools/dom-capture bumped to 11.4.0
+  #### Features
+
+  * ability to capture all css props in computed style ([#2484](https://github.com/Applitools-Dev/sdk/issues/2484)) ([8769ee5](https://github.com/Applitools-Dev/sdk/commit/8769ee566f2d9e163437c7bcd385ec993f05f370))
+* @applitools/driver bumped to 1.19.0
+  #### 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))
+* @applitools/spec-driver-webdriver bumped to 1.1.12
+
+* @applitools/spec-driver-selenium bumped to 1.5.83
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.12
+
+* @applitools/screenshoter bumped to 3.8.36
+
+* @applitools/nml-client bumped to 1.8.10
+
+* @applitools/tunnel-client bumped to 1.5.8
+  #### Bug Fixes
+
+  * upgrade execution-grid-tunnel ([#2475](https://github.com/Applitools-Dev/sdk/issues/2475)) ([e5952b4](https://github.com/Applitools-Dev/sdk/commit/e5952b4ca1bd0c065111ce1109b218f1fd68f6fc))
+
+
+
+* @applitools/core-base bumped to 1.16.1
+  #### Bug Fixes
+
+  * infinity concurrency ([#2477](https://github.com/Applitools-Dev/sdk/issues/2477)) ([f488e16](https://github.com/Applitools-Dev/sdk/commit/f488e162f124acc249ed7b43b714f13c18306dc8))
+* @applitools/ec-client bumped to 1.9.4
+
+
 ## [4.18.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.18.0...js/core@4.18.1) (2024-08-12)
 
 

package/dist/classic/utils/take-dom-capture.js

@@ -11,6 +11,7 @@ async function takeDomCapture({ driver, settings, logger, }) {
     const arg = {
         chunkByteLength: (_a = settings === null || settings === void 0 ? void 0 : settings.chunkByteLength) !== null && _a !== void 0 ? _a : (Number(process.env.APPLITOOLS_SCRIPT_RESULT_MAX_BYTE_LENGTH) ||
             (environment.isIOS ? 100000 : 250 * 1024 * 1024)),
+        ...settings === null || settings === void 0 ? void 0 : settings.domCaptureArgs,
     };
     const scripts = {
         main: features.canExecuteOnlyFunctionScripts

package/dist/cli/cli.js

@@ -34,6 +34,7 @@ const logs_1 = require("../troubleshoot/logs");
 const check_network_1 = require("../troubleshoot/check-network");
 const yargs_1 = __importDefault(require("yargs"));
 const utils = __importStar(require("@applitools/utils"));
+const fs_1 = __importDefault(require("fs"));
 yargs_1.default
     .example([
     ['eyes universal', 'Run Eyes Universal server on default port (21077)'],
@@ -43,6 +44,7 @@ yargs_1.default
     ['eyes universal --shutdown-mode stdin', 'Run Eyes Universal server which will close once stdin stream will end'],
     ['eyes check-network', ''],
 ])
+    .version(JSON.parse(fs_1.default.readFileSync(require.resolve('../../package.json'), 'utf-8')).version)
     .command({
     command: 'universal',
     builder: yargs => yargs.options({

package/dist/troubleshoot/ufg.js

@@ -48,16 +48,21 @@ const resource = {
     contentType,
 };
 const UFG_PUT_RESOURCE_URL = `https://render-wus.applitools.com/sha256/${resource.hash.hash}?render-id=fake`;
-const accessTokenPromise = new Promise(async (resolve) => {
-    const { stdout } = await utils.process.execute(`curl -s ${eyes_1.RENDER_INFO_URL} ${(0, utils_1.getProxyCurlArg)()}`, {
-        maxBuffer: 10000000,
-    });
-    const accessToken = JSON.parse(stdout).accessToken;
-    if (!accessToken)
-        throw new Error('could not receive auth token since cURL command to get it failed.');
-    resolve(accessToken);
-});
-const getCmd = async () => `curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: ${await accessTokenPromise}" -d '${resource.rawValue}' ${UFG_PUT_RESOURCE_URL} ${(0, utils_1.getProxyCurlArg)()}`;
+const getAccessToken = (() => {
+    let accessToken;
+    return async () => {
+        if (!accessToken) {
+            const { stdout } = await utils.process.execute(`curl -s ${eyes_1.RENDER_INFO_URL} ${(0, utils_1.getProxyCurlArg)()}`, {
+                maxBuffer: 10000000,
+            });
+            accessToken = JSON.parse(stdout).accessToken;
+            if (!accessToken)
+                throw new Error('could not receive auth token since cURL command to get it failed.');
+        }
+        return accessToken;
+    };
+})();
+const getCmd = async () => `curl -X PUT -H "Content-Type: application/json" -H "X-Auth-Token: ${await getAccessToken()}" -d '${resource.rawValue}' ${UFG_PUT_RESOURCE_URL} ${(0, utils_1.getProxyCurlArg)()}`;
 exports.getCmd = getCmd;
 const validateVgResult = (res, sha) => {
     if (!res || res.hash !== sha) {
@@ -70,7 +75,7 @@ exports.default = {
             method: 'PUT',
             headers: {
                 'Content-Type': 'x-applitools-html/cdt',
-                'X-Auth-Token': await accessTokenPromise,
+                'X-Auth-Token': await getAccessToken(),
             },
             body: resource.value,
         });
@@ -93,7 +98,7 @@ exports.default = {
     testServer: async () => {
         const url = new URL(UFG_PUT_RESOURCE_URL);
         const requests = (0, ufg_client_1.makeUFGRequests)({
-            settings: { ufgServerUrl: url.origin, accessToken: await accessTokenPromise },
+            settings: { ufgServerUrl: url.origin, accessToken: await getAccessToken() },
             logger: (0, logger_1.makeLogger)(),
         });
         await requests.uploadResource({ resource });
@@ -107,7 +112,7 @@ exports.default = {
                 method: 'PUT',
                 headers: {
                     'Content-Type': 'x-applitools-html/cdt',
-                    'X-Auth-Token': await accessTokenPromise,
+                    'X-Auth-Token': await getAccessToken(),
                 },
             });
             request.on('response', response => {

package/dist/ufg/utils/generate-safe-selectors.js

@@ -27,37 +27,37 @@ exports.generateSafeSelectors = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { addElementIds, cleanupElementIds } = require('@applitools/snippets');
 async function generateSafeSelectors({ context, elementReferences, }) {
-    const mapping = {
-        elements: [],
-        ids: [],
-    };
-    for (const elementReference of elementReferences) {
-        const elements = await context.elements(elementReference);
-        mapping.elements.push(elements);
-        mapping.ids.push(Array(elements.length).fill(utils.general.guid()));
-    }
-    const generatedSelectors = await context.execute(addElementIds, [
-        mapping.elements.flat(),
-        mapping.ids.flat(),
-    ]);
+    if (!(elementReferences === null || elementReferences === void 0 ? void 0 : elementReferences.length))
+        return;
+    const mapping = await Promise.all(elementReferences.map(async (ref) => {
+        const elements = await context.elements(ref);
+        return {
+            ref,
+            elements,
+            id: utils.general.guid(), // same id for all elements that match the same ref
+        };
+    }));
+    // we can't structure elementsWithIds as object because it's not supported in safari webdriver (https://stackoverflow.com/questions/78953951/ios-safari-webdriver-executescript-fails-to-serialize-objects-with-elements)
+    const elementsWithIds = mapping.map(({ elements, id }) => [elements, id]);
+    const generatedSelectors = (await context.execute(addElementIds, elementsWithIds)).flat();
     let offset = 0;
-    const selectors = mapping.elements.map((elements, index) => {
+    const selectors = mapping.map(({ elements, ref }) => {
         if (elements.length === 0)
-            return { safeSelector: null, originalSelector: null, elementReference: elementReferences[index] };
+            return { safeSelector: null, originalSelector: null, elementReference: ref };
         const safeSelector = generatedSelectors[offset].reduceRight((selector, value) => {
             return selector ? { type: 'css', selector: value, shadow: selector } : { type: 'css', selector: value };
         }, undefined);
         offset += elements.length;
-        return { safeSelector, originalSelector: elements[0].commonSelector, elementReference: elementReferences[index] };
+        return { safeSelector, originalSelector: elements[0].commonSelector, elementReference: ref };
     });
     return {
         selectors,
         cleanupGeneratedSelectors,
     };
     async function cleanupGeneratedSelectors() {
-        if (!mapping.elements.length)
+        if (!mapping.length)
             return;
-        await context.execute(cleanupElementIds, [mapping.elements.flat()]);
+        await context.execute(cleanupElementIds, [mapping.map(({ elements }) => elements).flat()]);
     }
 }
 exports.generateSafeSelectors = generateSafeSelectors;

package/dist/ufg/utils/take-dom-snapshots.js

@@ -51,13 +51,10 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         logger.log(`taking single dom snapshot`);
         await beforeEachSnapshot();
         // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-        let safeSelectorResult;
-        if (settings.elementReferences) {
-            safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
-                context: currentContext,
-                elementReferences: settings.elementReferences,
-            });
-        }
+        const safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+            context: currentContext,
+            elementReferences: settings.elementReferences,
+        });
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         await ((_b = safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.cleanupGeneratedSelectors) === null || _b === void 0 ? void 0 : _b.call(safeSelectorResult));
         return Array(settings.environments.length).fill({ ...snapshot, generatedSelectors: safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.selectors });
@@ -94,7 +91,11 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
     }
     requiredWidths.forEach((browsers, requiredWidth) => entries.push({ viewportSize: { width: requiredWidth, height: initialViewportSize.height }, browsers }));
     logger.log(`All entries to take dom snapshots for`, entries);
-    let safeSelectorResult;
+    // making safe selectors before any resize in order to make sure fallback selectors are created
+    let safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+        context: currentContext,
+        elementReferences: settings.elementReferences,
+    });
     const snapshots = Array(settings.environments.length);
     for (const [index, { viewportSize, browsers }] of entries.entries()) {
         logger.log(`Taking dom snapshot for viewport size ${viewportSize}`);
@@ -132,12 +133,10 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         }
         await beforeEachSnapshot();
         // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-        if (settings.elementReferences) {
-            safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
-                context: currentContext,
-                elementReferences: settings.elementReferences,
-            });
-        }
+        safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+            context: currentContext,
+            elementReferences: settings.elementReferences,
+        });
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         browsers.forEach(({ index }) => (snapshots[index] = { ...snapshot, generatedSelectors: safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.selectors }));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,18 +74,18 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.16.0",
-    "@applitools/dom-capture": "11.3.1",
+    "@applitools/core-base": "1.16.1",
+    "@applitools/dom-capture": "11.5.0",
     "@applitools/dom-snapshot": "4.11.3",
-    "@applitools/driver": "1.18.0",
-    "@applitools/ec-client": "1.9.3",
+    "@applitools/driver": "1.19.1",
+    "@applitools/ec-client": "1.9.5",
     "@applitools/logger": "2.0.18",
-    "@applitools/nml-client": "1.8.9",
+    "@applitools/nml-client": "1.8.11",
     "@applitools/req": "1.7.2",
-    "@applitools/screenshoter": "3.8.35",
-    "@applitools/snippets": "2.4.27",
+    "@applitools/screenshoter": "3.8.37",
+    "@applitools/snippets": "2.5.0",
     "@applitools/socket": "1.1.18",
-    "@applitools/spec-driver-webdriver": "1.1.11",
+    "@applitools/spec-driver-webdriver": "1.1.13",
     "@applitools/ufg-client": "1.12.3",
     "@applitools/utils": "1.7.4",
     "@types/ws": "8.5.5",
@@ -100,11 +100,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.11",
-    "@applitools/spec-driver-selenium": "^1.5.82",
+    "@applitools/spec-driver-puppeteer": "^1.4.13",
+    "@applitools/spec-driver-selenium": "^1.5.84",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.5.7",
+    "@applitools/tunnel-client": "^1.5.8",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",

package/types/classic/utils/take-dom-capture.d.ts

@@ -8,6 +8,14 @@ export type DomCaptureSettings = {
     chunkByteLength?: number;
     proxy?: Proxy;
     fetch?: Fetch;
+    domCaptureArgs?: {
+        styleProps?: string[] | boolean;
+        rectProps?: string[];
+        elementProps?: string[];
+        capturePseudo?: boolean;
+        addStats?: boolean;
+        fetchTimeLimit?: number;
+    };
 };
 export declare function takeDomCapture<TSpec extends SpecType>({ driver, settings, logger, }: {
     driver: Driver<TSpec>;

package/types/ufg/utils/generate-safe-selectors.d.ts

@@ -1,16 +1,22 @@
 import { type SpecType, type Context, type ElementReference, type CommonSelector } from '@applitools/driver';
-export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
-    context: Context<TSpec>;
-    elementReferences: ElementReference<TSpec>[];
-}): Promise<{
-    selectors: ({
-        safeSelector: null;
-        originalSelector: null;
-        elementReference: ElementReference<TSpec>;
-    } | {
-        safeSelector: CommonSelector;
+type GeneratedSafeSelector<TSpec extends SpecType> = {
+    selectors: {
+        safeSelector: CommonSelector | null;
         originalSelector: CommonSelector | null;
         elementReference: ElementReference<TSpec>;
-    })[];
+    }[];
     cleanupGeneratedSelectors: () => Promise<void>;
-}>;
+};
+export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
+    context: Context<TSpec>;
+    elementReferences: ElementReference<TSpec>[];
+}): Promise<GeneratedSafeSelector<TSpec>>;
+export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
+    context: Context<TSpec>;
+    elementReferences: undefined | [];
+}): Promise<undefined>;
+export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
+    context: Context<TSpec>;
+    elementReferences?: ElementReference<TSpec>[];
+}): Promise<GeneratedSafeSelector<TSpec> | undefined>;
+export {};