@applitools/core 4.3.0 → 4.5.0

package/CHANGELOG.md

@@ -1,5 +1,84 @@
 # Changelog
 
+## [4.5.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.4.0...js/core@4.5.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))
+
+
+### Bug Fixes
+
+* fixed issue when page wasn't reloaded for one of the breakpoints if the initial viewport size matches it ([9038723](https://github.com/applitools/eyes.sdk.javascript1/commit/9038723ee68515f7d4fe20ed31ec501df9a381dc))
+
+
+### Dependencies
+
+* @applitools/spec-driver-webdriver bumped to 1.0.53
+
+* @applitools/spec-driver-selenium bumped to 1.5.67
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.3
+
+* @applitools/driver bumped to 1.16.0
+  #### 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))
+* @applitools/screenshoter bumped to 3.8.19
+
+* @applitools/nml-client bumped to 1.6.1
+
+* @applitools/ec-client bumped to 1.7.19
+
+
+## [4.4.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.3.0...js/core@4.4.0) (2023-12-12)
+
+
+### Features
+
+* sign windows binaries ([87fd29c](https://github.com/applitools/eyes.sdk.javascript1/commit/87fd29c8953fc512489c3bb00841ca91c5b2f030))
+* support updated applitools lib protocol ([#2086](https://github.com/applitools/eyes.sdk.javascript1/issues/2086)) ([31b49fc](https://github.com/applitools/eyes.sdk.javascript1/commit/31b49fc411c452d0b3da341fd701309714484485))
+
+
+### Bug Fixes
+
+* layout breakpoints reload and lazy load ([#2073](https://github.com/applitools/eyes.sdk.javascript1/issues/2073)) ([ab2c49e](https://github.com/applitools/eyes.sdk.javascript1/commit/ab2c49ea1ecff3fef337637a83aa5bef755a7b01))
+
+
+### Code Refactoring
+
+* fix safe selector generation ([#2072](https://github.com/applitools/eyes.sdk.javascript1/issues/2072)) ([373f11b](https://github.com/applitools/eyes.sdk.javascript1/commit/373f11b0dfea6eab417eb7077e0cfec79877dc1b))
+
+
+### Dependencies
+
+* @applitools/spec-driver-webdriver bumped to 1.0.52
+
+* @applitools/spec-driver-selenium bumped to 1.5.66
+
+* @applitools/spec-driver-puppeteer bumped to 1.3.2
+
+* @applitools/driver bumped to 1.15.3
+  #### Bug Fixes
+
+  * layout breakpoints reload and lazy load ([#2073](https://github.com/applitools/eyes.sdk.javascript1/issues/2073)) ([ab2c49e](https://github.com/applitools/eyes.sdk.javascript1/commit/ab2c49ea1ecff3fef337637a83aa5bef755a7b01))
+* @applitools/screenshoter bumped to 3.8.18
+
+* @applitools/nml-client bumped to 1.6.0
+  #### Features
+
+  * support updated applitools lib protocol ([#2086](https://github.com/applitools/eyes.sdk.javascript1/issues/2086)) ([31b49fc](https://github.com/applitools/eyes.sdk.javascript1/commit/31b49fc411c452d0b3da341fd701309714484485))
+
+
+
+* @applitools/tunnel-client bumped to 1.4.0
+  #### Features
+
+  * sign windows binaries ([87fd29c](https://github.com/applitools/eyes.sdk.javascript1/commit/87fd29c8953fc512489c3bb00841ca91c5b2f030))
+* @applitools/ec-client bumped to 1.7.18
+
+
 ## [4.3.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@4.2.0...js/core@4.3.0) (2023-12-05)
 
 

package/dist/automation/utils/to-base-check-settings.js

@@ -27,22 +27,23 @@ exports.toBaseCheckSettings = void 0;
 const utils = __importStar(require("@applitools/utils"));
 function toBaseCheckSettings({ settings }) {
     const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility'];
-    const elementReferencesToCalculate = regionTypes.flatMap(regionType => {
+    const calculate = regionTypes.flatMap(regionType => {
         var _a;
         return ((_a = settings[`${regionType}Regions`]) !== null && _a !== void 0 ? _a : []).reduce((regions, reference) => {
             const { region } = utils.types.has(reference, 'region') ? reference : { region: reference };
             return !isRegion(region) ? regions.concat(region) : regions;
         }, []);
     });
-    const elementReferenceToTarget = !isRegion(settings.region) ? settings.region : undefined;
-    return { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings };
+    const target = !isRegion(settings.region) ? settings.region : undefined;
+    const scrolling = settings.scrollRootElement;
+    return { elementReferences: { target, scrolling, calculate }, getBaseCheckSettings };
     function getBaseCheckSettings({ calculatedRegions, preserveTransformation, }) {
         const transformedSettings = { ...settings };
         if (!preserveTransformation) {
             delete transformedSettings.region;
             delete transformedSettings.normalization;
         }
-        else if (elementReferenceToTarget) {
+        else if (target) {
             delete transformedSettings.region;
         }
         regionTypes.forEach(regionType => {

package/dist/automation/utils/wait-for-lazy-load.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForLazyLoad = void 0;
 const { lazyLoad } = require('@applitools/snippets');
-async function waitForLazyLoad({ context, settings, logger, }) {
-    var _a, _b;
-    logger.log('lazy loading the page before capturing a screenshot');
-    const { scrollLength = 300, waitingTime = 2000, maxAmountToScroll = 15000, } = typeof settings === 'boolean' ? {} : settings;
+async function waitForLazyLoad({ context, settings = {}, logger, }) {
+    var _a;
+    logger.log('Running scrolling sequence to lazy load a view content');
+    const { scrollLength = 300, waitingTime = 2000, maxAmountToScroll = 15000 } = settings;
     await context.executePoll(lazyLoad, {
         main: [
             await context.getScrollingElement(),
@@ -16,8 +16,8 @@ async function waitForLazyLoad({ context, settings, logger, }) {
             },
         ],
         poll: [],
-        executionTimeout: 5 * 60 * 1000,
-        pollTimeout: (_b = (_a = settings.pollTimeout) !== null && _a !== void 0 ? _a : settings.waitingTime) !== null && _b !== void 0 ? _b : 2000,
+        executionTimeout: 300000 /* 5min */,
+        pollTimeout: (_a = settings.pollTimeout) !== null && _a !== void 0 ? _a : waitingTime,
     });
 }
 exports.waitForLazyLoad = waitForLazyLoad;

package/dist/classic/check-and-close.js

@@ -74,7 +74,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     logger,
                 });
             }
-            const { elementReferencesToCalculate, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+            const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
             if (driverEnvironment.isWeb ||
                 !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) ||
                 settings.screenshotMode === 'default') {
@@ -83,7 +83,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     settings: {
                         ...settings,
                         environments: uniqueEnvironments,
-                        regionsToCalculate: elementReferencesToCalculate,
+                        regionsToCalculate: elementReferences.calculate,
                         calculateView: !!settings.pageId,
                         domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : undefined,
                     },

package/dist/classic/check.js

@@ -74,7 +74,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     logger,
                 });
             }
-            const { elementReferencesToCalculate, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+            const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
             if (driverEnvironment.isWeb ||
                 !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) ||
                 settings.screenshotMode === 'default') {
@@ -83,7 +83,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     settings: {
                         ...settings,
                         environments: uniqueEnvironments,
-                        regionsToCalculate: elementReferencesToCalculate,
+                        regionsToCalculate: elementReferences.calculate,
                         calculateView: !!settings.pageId,
                         domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : undefined,
                     },

package/dist/cli/cli.js

@@ -123,12 +123,19 @@ yargs_1.default
             description: 'group logs by tag names',
             type: 'boolean',
         },
+        analyze: {
+            description: 'group logs by tag names',
+            type: 'boolean',
+        },
     }),
     handler: async (args) => {
         var _a;
         const input = (_a = args.input) !== null && _a !== void 0 ? _a : (await utils.streams.toBuffer(process.stdin)).toString('utf8');
         const logs = (0, logs_1.parseLogs)(input);
-        if (args.structure) {
+        if (args.analyze) {
+            console.log(JSON.stringify((0, logs_1.analyzeLogs)((0, logs_1.structureLogs)(logs)), null, 2));
+        }
+        else if (args.structure) {
             console.log(JSON.stringify((0, logs_1.structureLogs)(logs), null, 2));
         }
         else {

package/dist/core.js

@@ -40,9 +40,11 @@ const close_batch_1 = require("./close-batch");
 const delete_test_1 = require("./delete-test");
 const extract_test_environment_1 = require("./utils/extract-test-environment");
 const validate_sdk_version_1 = require("./utils/validate-sdk-version");
+const memory_usage_logging_1 = require("./utils/memory-usage-logging");
 const utils = __importStar(require("@applitools/utils"));
 function makeCore({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, asyncCache, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
+    (0, memory_usage_logging_1.startMemoryUsageLogging)({ logger });
     const environment = (0, extract_test_environment_1.extractTestEnvironment)(defaultEnvironment);
     logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment`, environment);
     if (environment.sdk)

package/dist/troubleshoot/logs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.structureLogs = exports.parseLogs = void 0;
+exports.analyzeLogs = exports.structureLogs = exports.stringifyLog = exports.parseLogs = void 0;
 function parseLogs(logs) {
     const regexp = /^(?<label>[^\s]+) (?:\((?<tags>[^\)]+)\) )?\| (?<timestamp>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)? (?:\[(?<level>[A-Z]+)\s*\])? (?<message>.+)$/;
     const lines = logs.split('\n');
@@ -20,8 +20,15 @@ function parseLogs(logs) {
     }, []);
 }
 exports.parseLogs = parseLogs;
+function stringifyLog(log) {
+    var _a;
+    // eslint-disable-next-line
+    return `${log.label} (${(_a = log.tags) === null || _a === void 0 ? void 0 : _a.map(tags => tags.join('/')).join(' & ')}) ${log.timestamp} [${log.level}] ${log.message}`;
+}
+exports.stringifyLog = stringifyLog;
 function structureLogs(logs) {
     const groups = {};
+    groups.logs;
     logs.forEach(log => {
         var _a;
         const tags = (_a = log.tags) !== null && _a !== void 0 ? _a : [[]];
@@ -39,3 +46,31 @@ function structureLogs(logs) {
     return groups;
 }
 exports.structureLogs = structureLogs;
+function analyzeLogs({ logs, ...groups }) {
+    var _a, _b;
+    const analysis = {};
+    analysis.logs = logs === null || logs === void 0 ? void 0 : logs.map(stringifyLog);
+    const groupAnalyses = Object.fromEntries(Object.entries(groups).map(([name, group]) => [name, analyzeLogs(group)]));
+    analysis.startedAt = Math.min(Date.parse((_a = logs === null || logs === void 0 ? void 0 : logs[0]) === null || _a === void 0 ? void 0 : _a.timestamp) || Infinity, ...Object.values(groupAnalyses).map(group => group.startedAt));
+    analysis.finishedAt = Math.max(Date.parse((_b = logs === null || logs === void 0 ? void 0 : logs[logs.length - 1]) === null || _b === void 0 ? void 0 : _b.timestamp) || 0, ...Object.values(groupAnalyses).map(group => group.finishedAt));
+    analysis.time = analysis.finishedAt - analysis.startedAt;
+    analysis.conclusion = '';
+    analysis.conclusion += `Time taken: ${formatTime(analysis.time)};`;
+    if (Object.keys(groupAnalyses).length > 0) {
+        analysis.conclusion += `Longest group: ${Object.keys(groupAnalyses).reduce((prev, cur) => groupAnalyses[cur].time > groupAnalyses[prev].time ? cur : prev)}`;
+    }
+    return { ...analysis, ...groupAnalyses };
+}
+exports.analyzeLogs = analyzeLogs;
+function formatTime(ms) {
+    const h = Math.floor(ms / 3600000);
+    if (h)
+        ms -= h * 3600000;
+    const m = Math.floor(ms / 60000);
+    if (m)
+        ms -= m * 60000;
+    const s = Math.floor(ms / 1000);
+    if (s)
+        ms -= s * 1000;
+    return [h && `${h}h`, m && `${m}m`, s && `${s}s`, ms && `${ms}ms`].filter(Boolean).join(' ');
+}

package/dist/ufg/check-and-close.js

@@ -30,6 +30,7 @@ exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
+const to_generated_selectors_1 = require("./utils/to-generated-selectors");
 const uniquify_environments_1 = require("../automation/utils/uniquify-environments");
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
@@ -38,15 +39,17 @@ const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
 function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
-        var _a, _b, _c;
+        var _a, _b;
         logger = logger.extend(mainLogger);
         logger.log('Command "checkAndClose" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
             logger.warn('Command "checkAndClose" was called after test was already aborted');
             throw new abort_error_1.AbortError('Command "checkAndClose" was called after test was already aborted');
         }
-        const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
-            settings,
+        const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+        const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
+            elementReferences,
+            transformElementReference: elementReference => { var _a; return ((0, driver_1.isSelector)(elementReference) && ((_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, elementReference))) || undefined; },
         });
         const uniqueEnvironments = (0, uniquify_environments_1.uniquifyEnvironments)((_a = settings.environments) !== null && _a !== void 0 ? _a : defaultEnvironments);
         const ufgClient = await eyes.core.getUFGClient({
@@ -57,7 +60,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
             },
             logger,
         });
-        let snapshotResults;
+        let snapshots;
         let snapshotUrl;
         let snapshotTitle;
         let userAgent;
@@ -70,7 +73,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
             await currentContext.setScrollingElement((_b = settings.scrollRootElement) !== null && _b !== void 0 ? _b : null);
             if (environment.isWeb) {
                 userAgent = await driver.getUserAgentLegacy();
-                snapshotResults = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
                     driver,
                     settings: {
                         ...eyes.test.eyesServer,
@@ -80,11 +83,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                         environments: uniqueEnvironments,
                         skipResources: ufgClient.getCachedResourceUrls(),
                         lazyLoad: settings.lazyLoad,
-                        calculateRegionsOptions: {
-                            elementReferencesToCalculate,
-                            elementReferenceToTarget,
-                            scrollRootElement: settings.scrollRootElement,
-                        },
+                        elementReferences: elementReferencesToMark,
                     },
                     provides: {
                         getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
@@ -99,7 +98,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
                     logger,
                 });
-                const snapshots = (await nmlClient.takeSnapshots({
+                snapshots = (await nmlClient.takeSnapshots({
                     settings: {
                         ...eyes.test.eyesServer,
                         waitBeforeCapture: settings.waitBeforeCapture,
@@ -107,27 +106,16 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     },
                     logger,
                 }));
-                snapshotResults = snapshots.map(snapshot => {
-                    var _a, _b, _c, _d;
-                    return ({
-                        snapshot,
-                        regionToTarget: (0, driver_1.isSelector)(elementReferenceToTarget)
-                            ? (_b = (_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, settings.scrollRootElement)) !== null && _b !== void 0 ? _b : undefined
-                            : undefined,
-                        scrollRootSelector: (0, driver_1.isSelector)(settings.scrollRootElement)
-                            ? (_d = (_c = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _c === void 0 ? void 0 : _c.call(spec, settings.scrollRootElement)) !== null && _d !== void 0 ? _d : undefined
-                            : undefined,
-                    });
-                });
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
             snapshotTitle = await driver.getTitle();
         }
         else {
-            snapshotResults = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
-            snapshotUrl = utils.types.has((_c = snapshotResults[0]) === null || _c === void 0 ? void 0 : _c.snapshot, 'url') ? snapshotResults[0].snapshot.url : undefined;
+            snapshots = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
+            snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
         }
+        const generatedSelectors = snapshots.map(snapshot => getGeneratedSelectors(utils.types.has(snapshot, 'generatedSelectors') ? snapshot.generatedSelectors : undefined));
         const promises = uniqueEnvironments.map(async (environment, index) => {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
@@ -140,13 +128,8 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     environmentLogger.warn('Command "check" was aborted before rendering');
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
-                const { snapshot: snapshotFromResult, selectorsToCalculate: selectorsToCalculateFromSnapshot, regionToTarget, scrollRootSelector, } = snapshotResults[index];
-                const { cookies, ...snapshot } = snapshotFromResult;
-                const region = (_a = regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : elementReferenceToTarget) !== null && _a !== void 0 ? _a : settings.region;
-                const selectorsToCalculate = selectorsToCalculateFromSnapshot !== null && selectorsToCalculateFromSnapshot !== void 0 ? selectorsToCalculateFromSnapshot : elementReferencesToCalculate.map(selector => ({
-                    originalSelector: selector,
-                    safeSelector: selector,
-                }));
+                const { cookies, ...snapshot } = snapshots[index];
+                const selectors = generatedSelectors[index];
                 if (utils.types.has(ufgEnvironment, 'iosDeviceInfo') || utils.types.has(ufgEnvironment, 'androidDeviceInfo')) {
                     ufgEnvironment.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
                 }
@@ -172,8 +155,8 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        environmentLogger.warn(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_a = baseEyes.test.environment) === null || _a === void 0 ? void 0 : _a.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
                     }
                     const renderTarget = await renderTargetPromise;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
@@ -181,16 +164,16 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        environmentLogger.warn(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${(_e = baseEyes.test.environment) === null || _e === void 0 ? void 0 : _e.environmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
                     }
                     const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
                             ...settings,
-                            region,
-                            scrollRootElement: scrollRootSelector,
-                            selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
+                            region: (_e = selectors.target) !== null && _e !== void 0 ? _e : settings.region,
+                            scrollRootElement: selectors.scrolling,
+                            selectorsToCalculate: selectors.calculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: !!settings.pageId,
                             environment: ufgEnvironment,
                             environmentId: baseEyes.test.environment.environmentId,
@@ -202,7 +185,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     });
                     let offset = 0;
                     const baseSettings = getBaseCheckSettings({
-                        calculatedRegions: selectorsToCalculate.map(({ originalSelector, safeSelector }) => ({
+                        calculatedRegions: selectors.calculate.map(({ originalSelector, safeSelector }) => ({
                             selector: originalSelector !== null && originalSelector !== void 0 ? originalSelector : undefined,
                             regions: safeSelector ? selectorRegions[offset++] : [],
                         })),

package/dist/ufg/check.js

@@ -30,6 +30,7 @@ exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
+const to_generated_selectors_1 = require("./utils/to-generated-selectors");
 const uniquify_environments_1 = require("../automation/utils/uniquify-environments");
 const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
@@ -38,15 +39,17 @@ const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
 function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
-        var _a, _b, _c;
+        var _a, _b;
         logger = logger.extend(mainLogger);
         logger.log('Command "check" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
             logger.warn('Command "check" was called after test was already aborted');
             throw new abort_error_1.AbortError('Command "check" was called after test was already aborted');
         }
-        const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
-            settings,
+        const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+        const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
+            elementReferences,
+            transformElementReference: elementReference => { var _a; return ((0, driver_1.isSelector)(elementReference) && ((_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, elementReference))) || undefined; },
         });
         const uniqueEnvironments = (0, uniquify_environments_1.uniquifyEnvironments)((_a = settings.environments) !== null && _a !== void 0 ? _a : defaultEnvironments);
         const ufgClient = await eyes.core.getUFGClient({
@@ -57,7 +60,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
             },
             logger,
         });
-        let snapshotResults;
+        let snapshots;
         let snapshotUrl;
         let snapshotTitle;
         let userAgent;
@@ -70,7 +73,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
             await currentContext.setScrollingElement((_b = settings.scrollRootElement) !== null && _b !== void 0 ? _b : null);
             if (environment.isWeb) {
                 userAgent = await driver.getUserAgentLegacy();
-                snapshotResults = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
                     driver,
                     settings: {
                         ...eyes.test.eyesServer,
@@ -80,11 +83,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                         environments: uniqueEnvironments,
                         skipResources: ufgClient.getCachedResourceUrls(),
                         lazyLoad: settings.lazyLoad,
-                        calculateRegionsOptions: {
-                            elementReferencesToCalculate,
-                            elementReferenceToTarget,
-                            scrollRootElement: settings.scrollRootElement,
-                        },
+                        elementReferences: elementReferencesToMark,
                     },
                     provides: {
                         getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
@@ -99,7 +98,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
                     logger,
                 });
-                const snapshots = (await nmlClient.takeSnapshots({
+                snapshots = (await nmlClient.takeSnapshots({
                     settings: {
                         ...eyes.test.eyesServer,
                         waitBeforeCapture: settings.waitBeforeCapture,
@@ -107,27 +106,16 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     },
                     logger,
                 }));
-                snapshotResults = snapshots.map(snapshot => {
-                    var _a, _b, _c, _d;
-                    return ({
-                        snapshot,
-                        regionToTarget: (0, driver_1.isSelector)(elementReferenceToTarget)
-                            ? (_b = (_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, settings.scrollRootElement)) !== null && _b !== void 0 ? _b : undefined
-                            : undefined,
-                        scrollRootSelector: (0, driver_1.isSelector)(settings.scrollRootElement)
-                            ? (_d = (_c = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _c === void 0 ? void 0 : _c.call(spec, settings.scrollRootElement)) !== null && _d !== void 0 ? _d : undefined
-                            : undefined,
-                    });
-                });
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
             snapshotTitle = await driver.getTitle();
         }
         else {
-            snapshotResults = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
-            snapshotUrl = utils.types.has((_c = snapshotResults[0]) === null || _c === void 0 ? void 0 : _c.snapshot, 'url') ? snapshotResults[0].snapshot.url : undefined;
+            snapshots = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
+            snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
         }
+        const generatedSelectors = snapshots.map(snapshot => getGeneratedSelectors(utils.types.has(snapshot, 'generatedSelectors') ? snapshot.generatedSelectors : undefined));
         const promises = uniqueEnvironments.map(async (environment, index) => {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
@@ -140,13 +128,8 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     environmentLogger.warn('Command "check" was aborted before rendering');
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
-                const { snapshot: snapshotFromResult, selectorsToCalculate: selectorsToCalculateFromSnapshot, regionToTarget, scrollRootSelector, } = snapshotResults[index];
-                const { cookies, ...snapshot } = snapshotFromResult;
-                const region = (_a = regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : elementReferenceToTarget) !== null && _a !== void 0 ? _a : settings.region;
-                const selectorsToCalculate = selectorsToCalculateFromSnapshot !== null && selectorsToCalculateFromSnapshot !== void 0 ? selectorsToCalculateFromSnapshot : elementReferencesToCalculate.map(selector => ({
-                    originalSelector: selector,
-                    safeSelector: selector,
-                }));
+                const { cookies, ...snapshot } = snapshots[index];
+                const selectors = generatedSelectors[index];
                 if (utils.types.has(ufgEnvironment, 'iosDeviceInfo') || utils.types.has(ufgEnvironment, 'androidDeviceInfo')) {
                     ufgEnvironment.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
                 }
@@ -172,8 +155,8 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        environmentLogger.warn(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_a = baseEyes.test.environment) === null || _a === void 0 ? void 0 : _a.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
                     }
                     const renderTarget = await renderTargetPromise;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
@@ -181,16 +164,16 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        environmentLogger.warn(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${(_e = baseEyes.test.environment) === null || _e === void 0 ? void 0 : _e.environmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
                     }
                     const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
                             ...settings,
-                            region,
-                            scrollRootElement: scrollRootSelector,
-                            selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
+                            region: (_e = selectors.target) !== null && _e !== void 0 ? _e : settings.region,
+                            scrollRootElement: selectors.scrolling,
+                            selectorsToCalculate: selectors.calculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: Boolean(settings.pageId),
                             environment: ufgEnvironment,
                             environmentId: baseEyes.test.environment.environmentId,
@@ -202,7 +185,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                     });
                     let offset = 0;
                     const baseSettings = getBaseCheckSettings({
-                        calculatedRegions: selectorsToCalculate.map(({ originalSelector, safeSelector }) => ({
+                        calculatedRegions: selectors.calculate.map(({ originalSelector, safeSelector }) => ({
                             selector: originalSelector !== null && originalSelector !== void 0 ? originalSelector : undefined,
                             regions: safeSelector ? selectorRegions[offset++] : [],
                         })),

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

@@ -31,50 +31,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.takeDomSnapshots = void 0;
 const take_dom_snapshot_1 = require("./take-dom-snapshot");
-const calculate_regions_1 = require("./calculate-regions");
+const generate_safe_selectors_1 = require("./generate-safe-selectors");
 const wait_for_lazy_load_1 = require("../../automation/utils/wait-for-lazy-load");
 const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
 const lang = __importStar(require("../../lang"));
 __exportStar(require("./take-dom-snapshot"), exports);
 async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c;
     // calculating cookies here once so that we (a) don't do it for each dom snapshot, and (b) do it before generating safe selectors
     const features = await driver.getFeatures();
     settings.cookies = features.allCookies ? await driver.getCookies().catch(() => []) : [];
+    settings.lazyLoad = settings.lazyLoad !== true ? settings.lazyLoad : {};
     const currentContext = driver.currentContext;
-    let calculateRegionsResults = {};
-    const waitBeforeCapture = async () => {
-        if (utils.types.isFunction(settings.waitBeforeCapture)) {
-            await settings.waitBeforeCapture();
-        }
-        else if (settings.waitBeforeCapture) {
-            await utils.general.sleep(settings.waitBeforeCapture);
-        }
-    };
-    if (settings.lazyLoad) {
-        await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-            context: driver.currentContext,
-            settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-            logger,
-        });
-    }
     if (!((_a = settings.layoutBreakpoints) === null || _a === void 0 ? void 0 : _a.breakpoints)) {
+        if (settings.lazyLoad) {
+            await (0, wait_for_lazy_load_1.waitForLazyLoad)({ context: currentContext, settings: settings.lazyLoad, logger });
+        }
         logger.log(`taking single dom snapshot`);
-        await ((_b = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _b === void 0 ? void 0 : _b.call(hooks));
-        await waitBeforeCapture();
+        await beforeEachSnapshot();
         // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-        if (settings.calculateRegionsOptions) {
-            calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
-                ...settings.calculateRegionsOptions,
-                driver,
+        let safeSelectorResult;
+        if (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 });
-        await ((_c = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _c === void 0 ? void 0 : _c.call(calculateRegionsResults));
-        return Array(settings.environments.length).fill({ snapshot, ...calculateRegionsResults });
+        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 });
     }
-    const isStrictBreakpoints = utils.types.isArray((_d = settings.layoutBreakpoints) === null || _d === void 0 ? void 0 : _d.breakpoints);
+    const isStrictBreakpoints = utils.types.isArray((_c = settings.layoutBreakpoints) === null || _c === void 0 ? void 0 : _c.breakpoints);
     const requiredWidths = await settings.environments.reduce(async (prev, environment, index) => {
         const { name, width } = (await extractEnvironmentInfo(environment));
         const requiredWidths = await prev;
@@ -95,81 +83,83 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         });
         logger.console.log(chalk_1.default.yellow(message));
     }
-    logger.log(`taking multiple dom snapshots for breakpoints:`, settings.layoutBreakpoints.breakpoints);
-    logger.log(`required widths: ${[...requiredWidths.keys()].join(', ')}`);
-    const viewportSize = await driver.getViewportSize();
-    const snapshotsResults = Array(settings.environments.length);
-    if (requiredWidths.has(viewportSize.width)) {
-        logger.log(`taking dom snapshot for existing width ${viewportSize.width}`);
-        await ((_e = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _e === void 0 ? void 0 : _e.call(hooks));
-        await waitBeforeCapture();
-        // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-        if (settings.calculateRegionsOptions) {
-            calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
-                ...settings.calculateRegionsOptions,
-                driver,
-            });
-        }
-        const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
-        requiredWidths.get(viewportSize.width).forEach(({ index }) => {
-            snapshotsResults[index] = { snapshot, ...calculateRegionsResults };
-        });
+    logger.log(`Taking multiple dom snapshots for the breakpoints`, settings.layoutBreakpoints);
+    const initialViewportSize = await driver.getViewportSize();
+    const entries = [];
+    const initialsBrowsers = requiredWidths.get(initialViewportSize.width);
+    if (initialsBrowsers) {
+        logger.log(`The first dom snapshot is going to be taking for initial viewport size`, initialViewportSize);
+        requiredWidths.delete(initialViewportSize.width);
+        entries.push({ browsers: initialsBrowsers });
     }
-    for (const [requiredWidth, browsersInfo] of requiredWidths.entries()) {
-        logger.log(`taking dom snapshot for width ${requiredWidth}`);
-        try {
-            await driver.setViewportSize({ width: requiredWidth, height: viewportSize.height });
-        }
-        catch (error) {
-            logger.error(`Failed to set viewport size to ${requiredWidth} du to error: `, error);
-            const actualViewportSize = await driver.getViewportSize();
-            if (isStrictBreakpoints) {
-                const message = lang.breakpointOutOfDriverBoundsWarning({
-                    requiredWidth,
-                    actualWidth: actualViewportSize.width,
-                    browsers: browsersInfo,
-                });
-                logger.console.log(chalk_1.default.yellow(message));
-                logger.log(message);
+    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;
+    const snapshots = Array(settings.environments.length);
+    for (const [index, { viewportSize, browsers }] of entries.entries()) {
+        logger.log(`Taking dom snapshot for viewport size ${viewportSize}`);
+        if (viewportSize) {
+            try {
+                await driver.setViewportSize(viewportSize);
             }
-            else {
-                const message = lang.requestedEnvironmentOutOfDriverBoundsWarning({
-                    requiredWidth,
-                    actualWidth: actualViewportSize.width,
-                    browsers: browsersInfo,
-                });
-                logger.console.log(chalk_1.default.yellow(message));
-                logger.log(message);
+            catch (error) {
+                logger.error(`Failed to set viewport size to ${viewportSize} due to the error`, error);
+                const actualViewportSize = await driver.getViewportSize();
+                if (isStrictBreakpoints) {
+                    const message = lang.breakpointOutOfDriverBoundsWarning({
+                        requiredWidth: viewportSize.width,
+                        actualWidth: actualViewportSize.width,
+                        browsers,
+                    });
+                    logger.console.log(chalk_1.default.yellow(message));
+                    logger.log(message);
+                }
+                else {
+                    const message = lang.requestedEnvironmentOutOfDriverBoundsWarning({
+                        requiredWidth: viewportSize.width,
+                        actualWidth: actualViewportSize.width,
+                        browsers,
+                    });
+                    logger.console.log(chalk_1.default.yellow(message));
+                    logger.log(message);
+                }
             }
         }
-        if (settings.layoutBreakpoints.reload) {
+        if (settings.layoutBreakpoints.reload)
             await driver.reloadPage();
+        if (settings.lazyLoad && (index === 0 || settings.layoutBreakpoints.reload)) {
+            await (0, wait_for_lazy_load_1.waitForLazyLoad)({ context: currentContext, settings: settings.lazyLoad, logger });
         }
-        await ((_f = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _f === void 0 ? void 0 : _f.call(hooks));
-        await waitBeforeCapture();
-        if (settings.layoutBreakpoints.reload) {
-            // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-            if (settings.calculateRegionsOptions) {
-                calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
-                    ...settings.calculateRegionsOptions,
-                    driver,
-                });
-            }
+        await beforeEachSnapshot();
+        // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
+        if (settings.elementReferences && (index === 0 || settings.layoutBreakpoints.reload)) {
+            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 });
-        browsersInfo.forEach(({ index }) => {
-            snapshotsResults[index] = { snapshot, ...calculateRegionsResults };
-        });
+        browsers.forEach(({ index }) => (snapshots[index] = { ...snapshot, generatedSelectors: safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.selectors }));
     }
-    await driver.setViewportSize(viewportSize);
+    await driver.setViewportSize(initialViewportSize);
     if (settings.layoutBreakpoints.reload) {
         await driver.reloadPage();
-        await waitBeforeCapture();
+        await beforeEachSnapshot();
     }
     else {
-        (_g = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _g === void 0 ? void 0 : _g.call(calculateRegionsResults);
+        await (safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.cleanupGeneratedSelectors());
+    }
+    return snapshots;
+    async function beforeEachSnapshot() {
+        var _a, _b;
+        await ((_a = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _a === void 0 ? void 0 : _a.call(hooks));
+        if (utils.types.isNumber(settings.waitBeforeCapture)) {
+            await utils.general.sleep(settings.waitBeforeCapture);
+        }
+        else {
+            await ((_b = settings.waitBeforeCapture) === null || _b === void 0 ? void 0 : _b.call(settings));
+        }
     }
-    return snapshotsResults;
     function calculateBreakpoint({ breakpoints, value }) {
         const nextBreakpointIndex = breakpoints
             .sort((item1, item2) => (item1 > item2 ? 1 : -1))

package/dist/ufg/utils/to-generated-selectors.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toGeneratedSelectors = void 0;
+function toGeneratedSelectors({ elementReferences, transformElementReference, }) {
+    var _a, _b, _c;
+    const elementReferencesToMark = [
+        (_a = elementReferences.target) !== null && _a !== void 0 ? _a : [],
+        (_b = elementReferences.scrolling) !== null && _b !== void 0 ? _b : [],
+        (_c = elementReferences.calculate) !== null && _c !== void 0 ? _c : [],
+    ].flat();
+    return { elementReferencesToMark, getGeneratedSelectors };
+    function getGeneratedSelectors(generatedSelectors) {
+        var _a, _b, _c;
+        let target = undefined;
+        let scrolling = undefined;
+        let calculate = [];
+        if (generatedSelectors) {
+            let offset = 0;
+            if (elementReferences.target) {
+                target = (_a = generatedSelectors[offset++].safeSelector) !== null && _a !== void 0 ? _a : undefined;
+                if (!target)
+                    throw new Error('Target element not found');
+            }
+            if (elementReferences.scrolling) {
+                scrolling = (_b = generatedSelectors[offset++].safeSelector) !== null && _b !== void 0 ? _b : undefined;
+            }
+            calculate = generatedSelectors.slice(offset);
+        }
+        else {
+            target = elementReferences.target && transformElementReference(elementReferences.target);
+            scrolling = elementReferences.scrolling && transformElementReference(elementReferences.scrolling);
+            calculate = ((_c = elementReferences.calculate) !== null && _c !== void 0 ? _c : []).map(elementReference => {
+                var _a;
+                const selector = (_a = transformElementReference(elementReference)) !== null && _a !== void 0 ? _a : null;
+                return { originalSelector: selector, safeSelector: selector };
+            });
+        }
+        return { target, scrolling, calculate };
+    }
+}
+exports.toGeneratedSelectors = toGeneratedSelectors;

package/dist/utils/memory-usage-logging.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startMemoryUsageLogging = void 0;
+const utils = __importStar(require("@applitools/utils"));
+function startMemoryUsageLogging({ timeout = 30000, logger }) {
+    var _a;
+    logger = logger.extend({ tags: [`mem-usage-${utils.general.shortid()}`] });
+    const interval = setInterval(() => logger.log(formatMemoryUsage(process.memoryUsage())), (_a = utils.general.getEnvValue('MEMORY_LOG_TIMEOUT', 'number')) !== null && _a !== void 0 ? _a : timeout);
+    interval.unref();
+    return { stop };
+    function stop() {
+        clearInterval(interval);
+    }
+}
+exports.startMemoryUsageLogging = startMemoryUsageLogging;
+function formatMemoryUsage(usage) {
+    return `Memory usage: ${Object.entries(usage)
+        .map(([key, value]) => `${key}: ${toMB(value)}MB`)
+        .join(', ')}`;
+}
+function toMB(size) {
+    return Math.round((size / 1024 / 1024) * 100) / 100;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.3.0",
+  "version": "4.5.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -59,6 +59,12 @@
   },
   "sea": {
     "bin": "eyes",
+    "certs": {
+      "win": {
+        "cert": "env.CODE_SIGNING_CERT_WIN",
+        "pass": "env.CODE_SIGNING_PASS_WIN"
+      }
+    },
     "targets": {
       "node20-linux-x64-glibc-217": "./bin/core-linux",
       "node20-linux-x64-musl": "./bin/core-alpine",
@@ -71,15 +77,15 @@
     "@applitools/core-base": "1.7.4",
     "@applitools/dom-capture": "11.2.4",
     "@applitools/dom-snapshot": "4.7.14",
-    "@applitools/driver": "1.15.2",
-    "@applitools/ec-client": "1.7.17",
+    "@applitools/driver": "1.16.0",
+    "@applitools/ec-client": "1.7.19",
     "@applitools/logger": "2.0.14",
-    "@applitools/nml-client": "1.5.17",
+    "@applitools/nml-client": "1.6.1",
     "@applitools/req": "1.6.4",
-    "@applitools/screenshoter": "3.8.17",
+    "@applitools/screenshoter": "3.8.19",
     "@applitools/snippets": "2.4.24",
     "@applitools/socket": "1.1.14",
-    "@applitools/spec-driver-webdriver": "1.0.51",
+    "@applitools/spec-driver-webdriver": "1.0.53",
     "@applitools/ufg-client": "1.9.9",
     "@applitools/utils": "1.7.0",
     "@types/ws": "8.5.5",
@@ -94,11 +100,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.7.6",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.3.1",
-    "@applitools/spec-driver-selenium": "^1.5.65",
+    "@applitools/spec-driver-puppeteer": "^1.3.3",
+    "@applitools/spec-driver-selenium": "^1.5.67",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.3.2",
+    "@applitools/tunnel-client": "^1.4.0",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.4",

package/types/automation/utils/to-base-check-settings.d.ts

@@ -5,8 +5,11 @@ import { type SpecType, type ElementReference, type Selector } from '@applitools
 export declare function toBaseCheckSettings<TSpec extends SpecType>({ settings }: {
     settings: CheckSettings<TSpec>;
 }): {
-    elementReferencesToCalculate: ElementReference<TSpec>[];
-    elementReferenceToTarget: ElementReference<TSpec> | undefined;
+    elementReferences: {
+        target: ElementReference<TSpec> | undefined;
+        scrolling: ElementReference<TSpec> | undefined;
+        calculate: ElementReference<TSpec>[];
+    };
     getBaseCheckSettings: ({ calculatedRegions, preserveTransformation, }: {
         calculatedRegions: {
             selector?: Selector;

package/types/automation/utils/wait-for-lazy-load.d.ts

@@ -3,9 +3,8 @@ import { type SpecType, type Context } from '@applitools/driver';
 import { type LazyLoadOptions } from '../types';
 export declare function waitForLazyLoad<TSpec extends SpecType>({ context, settings, logger, }: {
     context: Context<TSpec>;
-    settings: LazyLoadOptions & {
+    settings?: LazyLoadOptions & {
         pollTimeout?: number;
-        waitingTime?: number;
     };
     logger: Logger;
 }): Promise<void>;

package/types/troubleshoot/logs.d.ts

@@ -5,6 +5,21 @@ interface Log {
     level?: string;
     message: string;
 }
+interface GroupedLog<TGroupedLog extends GroupedLog<TGroupedLog>> {
+    [key: string]: TGroupedLog;
+}
+type StructuredLog = GroupedLog<StructuredLog> & {
+    logs?: Log[];
+};
+type AnalyzedLog = GroupedLog<AnalyzedLog> & {
+    logs?: string[];
+    startedAt: number;
+    finishedAt: number;
+    time: number;
+    conclusion: string;
+};
 export declare function parseLogs(logs: string): Log[];
-export declare function structureLogs(logs: Log[]): any;
+export declare function stringifyLog(log: Log): string;
+export declare function structureLogs(logs: Log[]): StructuredLog;
+export declare function analyzeLogs({ logs, ...groups }: StructuredLog): AnalyzedLog;
 export {};

package/types/ufg/check.d.ts

@@ -11,8 +11,8 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeCheck<TSpec extends SpecType>({ eyes, target: defaultTarget, environments: defaultEnvironments, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }?: {
-    settings?: CheckSettings<TSpec> | undefined;
     target?: Target<TSpec> | undefined;
+    settings?: CheckSettings<TSpec> | undefined;
     logger?: Logger | undefined;
 }) => Promise<void>;
 export {};

package/types/ufg/types.d.ts

@@ -1,21 +1,20 @@
-import type { MaybeArray, Region } from '@applitools/utils';
+import type { MaybeArray } from '@applitools/utils';
 import type * as AutomationCore from '../automation/types';
-import { type Selector, type SpecType } from '@applitools/driver';
+import { type SpecType, type CommonSelector } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
-import { type UFGClient, type UFGClientSettings, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import { type UFGClient, type UFGClientSettings, type DomSnapshot as UFGDomSnapshot, type AndroidSnapshot as UFGAndroidSnapshot, type IOSSnapshot as UFGIOSSnapshot } from '@applitools/ufg-client';
 export * from '../automation/types';
-export type SnapshotTarget = MaybeArray<SnapshotResult<DomSnapshot>> | MaybeArray<AndroidSnapshot> | MaybeArray<IOSSnapshot>;
-export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
-export type SnapshotResult<TSnapshotType extends DomSnapshot | AndroidSnapshot | IOSSnapshot> = {
-    snapshot: TSnapshotType;
-    selectorsToCalculate?: {
-        originalSelector: Selector | null;
-        safeSelector: Selector | null;
+export type DomSnapshot = UFGDomSnapshot & {
+    generatedSelectors?: {
+        originalSelector: CommonSelector | null;
+        safeSelector: CommonSelector | null;
     }[];
-    regionToTarget?: Selector | Region;
-    scrollRootSelector?: Selector;
 };
+export type AndroidSnapshot = UFGAndroidSnapshot;
+export type IOSSnapshot = UFGIOSSnapshot;
+export type SnapshotTarget = MaybeArray<DomSnapshot> | MaybeArray<AndroidSnapshot> | MaybeArray<IOSSnapshot>;
+export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
 export interface Core<TSpec extends SpecType> extends AutomationCore.Core<TSpec> {
     readonly type: 'ufg';
     getUFGClient(options?: {

package/types/ufg/utils/take-dom-snapshot.d.ts

@@ -1,6 +1,6 @@
+import { type DomSnapshot } from '../types';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type Context, type Cookie } from '@applitools/driver';
-import { type DomSnapshot } from '@applitools/ufg-client';
 export type RawDomSnapshot = {
     url: string;
     selector: string;

package/types/ufg/utils/take-dom-snapshots.d.ts

@@ -1,24 +1,23 @@
-import type { LazyLoadOptions, SnapshotResult } from '../types';
+import type { DomSnapshot, LazyLoadOptions } from '../types';
 import { type Size } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver } from '@applitools/driver';
-import { type DomSnapshot, type Environment } from '@applitools/ufg-client';
+import { type SpecType, type Driver, type ElementReference } from '@applitools/driver';
+import { type Environment } from '@applitools/ufg-client';
 import { type DomSnapshotSettings } from './take-dom-snapshot';
-import { type CalculateRegionsOptions } from './calculate-regions';
 export * from './take-dom-snapshot';
-export type DomSnapshotsSettings = DomSnapshotSettings & {
+export type DomSnapshotsSettings<TSpec extends SpecType> = DomSnapshotSettings & {
     environments: Environment[];
-    waitBeforeCapture?: number | (() => void);
+    waitBeforeCapture?: number | (() => Promise<void>);
     layoutBreakpoints?: {
         breakpoints: number[] | boolean;
         reload?: boolean;
     };
-    calculateRegionsOptions?: CalculateRegionsOptions;
     lazyLoad?: boolean | LazyLoadOptions;
+    elementReferences?: ElementReference<TSpec>[];
 };
 export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
     driver: Driver<TSpec>;
-    settings: DomSnapshotsSettings;
+    settings: DomSnapshotsSettings<TSpec>;
     hooks?: {
         beforeEachSnapshot?(): void | Promise<void>;
     };
@@ -27,4 +26,4 @@ export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, setti
         getIOSDevices(): Promise<Record<string, Record<string, Size>>>;
     };
     logger: Logger;
-}): Promise<SnapshotResult<DomSnapshot>[]>;
+}): Promise<DomSnapshot[]>;

package/types/ufg/utils/to-generated-selectors.d.ts

@@ -0,0 +1,29 @@
+import { type SpecType, type ElementReference, type CommonSelector } from '@applitools/driver';
+export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementReferences, transformElementReference, }: {
+    elementReferences: {
+        target?: ElementReference<TSpec>;
+        scrolling?: ElementReference<TSpec>;
+        calculate?: ElementReference<TSpec>[];
+    };
+    transformElementReference: (elementReference: ElementReference<TSpec>) => CommonSelector | undefined;
+}): {
+    elementReferencesToMark: (string | TSpec["element"] | TSpec["secondary"]["element"] | TSpec["selector"] | TSpec["secondary"]["selector"] | {
+        selector: string | TSpec["selector"] | TSpec["secondary"]["selector"];
+        type?: string | undefined;
+        child?: TSpec["selector"] | TSpec["secondary"]["selector"] | CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+        shadow?: TSpec["selector"] | TSpec["secondary"]["selector"] | CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+        frame?: TSpec["selector"] | TSpec["secondary"]["selector"] | CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+        fallback?: TSpec["selector"] | TSpec["secondary"]["selector"] | CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+    } | (NonNullable<TSpec["element"]> extends infer T ? T extends NonNullable<TSpec["element"]> ? T extends readonly (infer InnerArr)[] ? InnerArr : T : never : never) | (NonNullable<TSpec["secondary"]["element"]> extends infer T_1 ? T_1 extends NonNullable<TSpec["secondary"]["element"]> ? T_1 extends readonly (infer InnerArr)[] ? InnerArr : T_1 : never : never) | (NonNullable<TSpec["selector"]> extends infer T_2 ? T_2 extends NonNullable<TSpec["selector"]> ? T_2 extends readonly (infer InnerArr)[] ? InnerArr : T_2 : never : never) | (NonNullable<TSpec["secondary"]["selector"]> extends infer T_3 ? T_3 extends NonNullable<TSpec["secondary"]["selector"]> ? T_3 extends readonly (infer InnerArr)[] ? InnerArr : T_3 : never : never))[];
+    getGeneratedSelectors: (generatedSelectors?: {
+        originalSelector: CommonSelector | null;
+        safeSelector: CommonSelector | null;
+    }[]) => {
+        target: CommonSelector | undefined;
+        scrolling: CommonSelector | undefined;
+        calculate: {
+            originalSelector: CommonSelector | null;
+            safeSelector: CommonSelector | null;
+        }[];
+    };
+};

package/types/utils/memory-usage-logging.d.ts

@@ -0,0 +1,7 @@
+import { type Logger } from '@applitools/logger';
+export declare function startMemoryUsageLogging({ timeout, logger }: {
+    timeout?: number;
+    logger: Logger;
+}): {
+    stop(): void;
+};

package/dist/ufg/utils/calculate-regions.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateRegions = void 0;
-const generate_safe_selectors_1 = require("../utils/generate-safe-selectors");
-async function calculateRegions({ driver, elementReferencesToCalculate, elementReferenceToTarget, scrollRootElement, }) {
-    var _a, _b;
-    const elementReferences = [
-        ...(elementReferenceToTarget ? [elementReferenceToTarget] : []),
-        ...(scrollRootElement ? [scrollRootElement] : []),
-        ...elementReferencesToCalculate,
-    ];
-    const { cleanupGeneratedSelectors, selectors } = await (0, generate_safe_selectors_1.generateSafeSelectors)({
-        context: driver.currentContext,
-        elementReferences,
-    });
-    let selectorsToCalculate = selectors;
-    let regionToTarget;
-    let scrollRootSelector;
-    if (elementReferenceToTarget) {
-        if (!((_a = selectorsToCalculate[0]) === null || _a === void 0 ? void 0 : _a.safeSelector))
-            throw new Error('Target element not found');
-        regionToTarget = selectorsToCalculate[0].safeSelector;
-        selectorsToCalculate = selectorsToCalculate.slice(1);
-    }
-    if (scrollRootElement) {
-        scrollRootSelector = (_b = selectorsToCalculate[0].safeSelector) !== null && _b !== void 0 ? _b : undefined;
-        selectorsToCalculate = selectorsToCalculate.slice(1);
-    }
-    return { cleanupGeneratedSelectors, selectorsToCalculate, regionToTarget, scrollRootSelector };
-}
-exports.calculateRegions = calculateRegions;

package/types/ufg/utils/calculate-regions.d.ts

@@ -1,22 +0,0 @@
-import type { SpecType, Driver, ElementReference } from '@applitools/driver';
-export type CalculateRegionsOptions = {
-    elementReferencesToCalculate: ElementReference<SpecType>[];
-    elementReferenceToTarget?: ElementReference<SpecType>;
-    scrollRootElement?: ElementReference<SpecType>;
-};
-export declare function calculateRegions<TSpec extends SpecType>({ driver, elementReferencesToCalculate, elementReferenceToTarget, scrollRootElement, }: {
-    driver: Driver<TSpec>;
-} & CalculateRegionsOptions): Promise<{
-    cleanupGeneratedSelectors: () => Promise<void>;
-    selectorsToCalculate: ({
-        safeSelector: null;
-        originalSelector: null;
-        elementReference: ElementReference<TSpec>;
-    } | {
-        safeSelector: import("@applitools/driver").CommonSelector;
-        originalSelector: import("@applitools/driver").CommonSelector | null;
-        elementReference: ElementReference<TSpec>;
-    })[];
-    regionToTarget: import("@applitools/driver").CommonSelector | undefined;
-    scrollRootSelector: import("@applitools/driver").CommonSelector | undefined;
-}>;