@applitools/core 4.20.2 → 4.21.1

package/CHANGELOG.md

@@ -1,5 +1,99 @@
 # Changelog
 
+## [4.21.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.21.0...js/core@4.21.1) (2024-10-28)
+
+
+### Bug Fixes
+
+* better handling of stale elements ([cab10ff](https://github.com/Applitools-Dev/sdk/commit/cab10ff1ae1e6f9560a7d278c710b3fa03f58c83))
+
+
+### Performance Improvements
+
+* avoid logging entire dom snapshots ([#2573](https://github.com/Applitools-Dev/sdk/issues/2573)) ([e6dc792](https://github.com/Applitools-Dev/sdk/commit/e6dc792c75eb39bd4d3e53775b63ba49fad20740))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.4
+  #### Bug Fixes
+
+  * better handling of stale elements ([cab10ff](https://github.com/Applitools-Dev/sdk/commit/cab10ff1ae1e6f9560a7d278c710b3fa03f58c83))
+
+
+
+* @applitools/snippets bumped to 2.5.2
+  #### Bug Fixes
+
+  * better handling of stale elements ([cab10ff](https://github.com/Applitools-Dev/sdk/commit/cab10ff1ae1e6f9560a7d278c710b3fa03f58c83))
+* @applitools/driver bumped to 1.19.4
+  #### Bug Fixes
+
+  * better handling of stale elements ([cab10ff](https://github.com/Applitools-Dev/sdk/commit/cab10ff1ae1e6f9560a7d278c710b3fa03f58c83))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.16
+
+* @applitools/spec-driver-selenium bumped to 1.5.87
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.16
+
+* @applitools/screenshoter bumped to 3.9.1
+
+* @applitools/nml-client bumped to 1.8.14
+
+* @applitools/ec-client bumped to 1.9.10
+
+
+## [4.21.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.20.2...js/core@4.21.0) (2024-10-21)
+
+
+### Features
+
+* add chrome emulation devices ([#2559](https://github.com/Applitools-Dev/sdk/issues/2559)) ([0499aaf](https://github.com/Applitools-Dev/sdk/commit/0499aaf3bb809d2ac0105b4493e6f6bb8730ea3f))
+* capture status bar ([#2571](https://github.com/Applitools-Dev/sdk/issues/2571)) ([5e1c75e](https://github.com/Applitools-Dev/sdk/commit/5e1c75ef9cf34af80f08806a3bceaf06a94f2780))
+* dynamic regions ([#2538](https://github.com/Applitools-Dev/sdk/issues/2538)) ([d8b5c48](https://github.com/Applitools-Dev/sdk/commit/d8b5c48fb35f9789c702447314dc72b4f415ade1))
+* setting up SCM information automatically ([#2542](https://github.com/Applitools-Dev/sdk/issues/2542)) ([696461a](https://github.com/Applitools-Dev/sdk/commit/696461af3f8e2e3ed94eb78fed5ead6233bd16b2))
+
+
+### Bug Fixes
+
+* don't remove offline execution folder after running ([654e195](https://github.com/Applitools-Dev/sdk/commit/654e195dd50dc7dab93dd907ec26d788549c6e81))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.5.1
+  #### Bug Fixes
+
+  * isStaleElement error ([#2567](https://github.com/Applitools-Dev/sdk/issues/2567)) ([2675086](https://github.com/Applitools-Dev/sdk/commit/2675086aa28589082249e2958942ee29a5f2ef12))
+* @applitools/screenshoter bumped to 3.9.0
+  #### Features
+
+  * capture status bar ([#2571](https://github.com/Applitools-Dev/sdk/issues/2571)) ([5e1c75e](https://github.com/Applitools-Dev/sdk/commit/5e1c75ef9cf34af80f08806a3bceaf06a94f2780))
+
+
+
+* @applitools/driver bumped to 1.19.3
+
+* @applitools/spec-driver-webdriver bumped to 1.1.15
+
+* @applitools/spec-driver-selenium bumped to 1.5.86
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.15
+
+* @applitools/nml-client bumped to 1.8.13
+
+* @applitools/core-base bumped to 1.18.0
+  #### Features
+
+  * ability to download side by side with highlighted diffs (2419) ([#2530](https://github.com/Applitools-Dev/sdk/issues/2530)) ([e06ce69](https://github.com/Applitools-Dev/sdk/commit/e06ce699f30e9e444ac58dafdf5989ff1c96ca1c))
+  * dynamic regions ([#2538](https://github.com/Applitools-Dev/sdk/issues/2538)) ([d8b5c48](https://github.com/Applitools-Dev/sdk/commit/d8b5c48fb35f9789c702447314dc72b4f415ade1))
+  * setting up SCM information automatically ([#2542](https://github.com/Applitools-Dev/sdk/issues/2542)) ([696461a](https://github.com/Applitools-Dev/sdk/commit/696461af3f8e2e3ed94eb78fed5ead6233bd16b2))
+* @applitools/ec-client bumped to 1.9.9
+
+
 ## [4.20.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.20.1...js/core@4.20.2) (2024-10-03)
 
 

package/dist/automation/utils/take-screenshot.js

@@ -54,6 +54,7 @@ async function takeScreenshot({ driver, settings, logger, }) {
         debug: settings.debugImages,
         logger,
         regionsToCalculate: settings.regionsToCalculate,
+        captureStatusBar: settings.captureStatusBar,
     });
 }
 exports.takeScreenshot = takeScreenshot;

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

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toBaseCheckSettings = exports.extractMobileElementsIntoCheckSettings = exports.hasCodedRegions = void 0;
 const utils = __importStar(require("@applitools/utils"));
-const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility'];
+const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility', 'dynamic'];
 function hasCodedRegions(settings) {
     for (const regionType of regionTypes) {
         if (settings[`${regionType}Regions`])

package/dist/autonomous/core.js

@@ -9,9 +9,9 @@ const start_renders_1 = require("./start-renders");
 const get_render_results_1 = require("./get-render-results");
 const create_render_results_1 = require("./create-render-results");
 const open_eyes_1 = require("./open-eyes");
-function makeAutonomousCore({ spec, clients, base: defaultBase, asyncCache, agentId = 'core-autonomous', cwd, logger: defaultLogger, } = {}) {
+function makeAutonomousCore({ spec, clients, base: defaultBase, asyncCache, agentId = 'core-autonomous', logger: defaultLogger, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-autonomous' } });
-    const core = (0, core_1.makeCore)({ spec, clients, base: defaultBase, asyncCache, agentId, cwd, logger });
+    const core = (0, core_1.makeCore)({ spec, clients, base: defaultBase, asyncCache, agentId, logger });
     return {
         type: 'autonomous',
         takeSnapshots: spec && (0, take_snapshots_1.makeTakeSnapshots)({ core, spec, logger }),

package/dist/check.js

@@ -45,7 +45,13 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
         settings.overlap = { top: 10, bottom: 50, ...settings === null || settings === void 0 ? void 0 : settings.overlap };
         (_e = settings.matchLevel) !== null && _e !== void 0 ? _e : (settings.matchLevel = 'Strict');
         (_f = settings.ignoreCaret) !== null && _f !== void 0 ? _f : (settings.ignoreCaret = true);
-        (_g = settings.sendDom) !== null && _g !== void 0 ? _g : (settings.sendDom = eyes.test.account.rcaEnabled || settings.matchLevel === 'Layout' || settings.enablePatterns || settings.useDom);
+        (_g = settings.sendDom) !== null && _g !== void 0 ? _g : (settings.sendDom = eyes.test.account.rcaEnabled ||
+            settings.matchLevel === 'Layout' ||
+            settings.matchLevel === 'Dynamic' ||
+            settings.enablePatterns ||
+            settings.useDom ||
+            !utils.types.isEmpty(settings.dynamicRegions) ||
+            !utils.types.isEmpty(settings.layoutRegions));
         (_h = settings.autProxy) !== null && _h !== void 0 ? _h : (settings.autProxy = eyes.test.eyesServer.proxy);
         (_j = settings.useDom) !== null && _j !== void 0 ? _j : (settings.useDom = false);
         (_k = (_q = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_q.retryTimeout = 0);

package/dist/classic/core.js

@@ -34,10 +34,10 @@ const extract_text_1 = require("../automation/extract-text");
 const get_nml_client_1 = require("../automation/get-nml-client");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, base: defaultBase, concurrency, agentId = 'core-classic', cwd = process.cwd(), logger: defaultLogger, offlineLocationPath, }) {
+function makeCore({ spec, clients, base: defaultBase, concurrency, agentId = 'core-classic', logger: defaultLogger, offlineLocationPath, }) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-classic' } });
     logger.log(`Core classic is initialized ${defaultBase ? 'with' : 'without'} custom base core`);
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath });
     return utils.general.extend(base, core => {
         return {
             type: 'classic',

package/dist/core.js

@@ -53,7 +53,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
     logger.log(`[pid=${process.pid} Core is initialized ${defaultBase ? 'with' : 'without'} custom base core ${offlineLocationPath ? `and offline location ${offlineLocationPath} ` : ''}and environment `, environment);
     if (environment.sdk)
         (0, validate_sdk_version_1.validateSdkVersion)(environment.sdk, { logger });
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath });
     const cores = {
         ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger, offlineLocationPath }),
         classic: (0, core_1.makeCore)({ spec, clients, base, logger, offlineLocationPath }),
@@ -83,7 +83,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
             locate: (0, locate_1.makeLocate)({ spec, core, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
             extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
-            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, cores, environment, asyncCache, logger }),
+            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, cores, environment, asyncCache, cwd, logger }),
             closeBatch: (0, close_batch_1.makeCloseBatch)({ core, logger }),
             deleteTest: (0, delete_test_1.makeDeleteTest)({ core, logger }),
         };

package/dist/make-manager.js

@@ -42,7 +42,7 @@ function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defa
         (_f = (_j = settings.batch).buildId) !== null && _f !== void 0 ? _f : (_j.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
         (_g = settings.agentId) !== null && _g !== void 0 ? _g : (settings.agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId);
         logger.log('Command "makeManager" is called with settings', settings);
-        const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger, offlineLocationPath });
+        const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, logger, offlineLocationPath });
         const fetchConcurrency = settings.fetchConcurrency;
         const cores = {
             ufg: (0, core_2.makeCore)({ spec, clients, base, fetchConcurrency, asyncCache, logger, offlineLocationPath }),
@@ -64,6 +64,7 @@ function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defa
                 cores,
                 environment,
                 asyncCache,
+                cwd,
                 logger,
             }), async (openEyes, options) => {
                 const eyes = await openEyes(options);

package/dist/open-eyes.js

@@ -36,30 +36,58 @@ const get_eyes_results_1 = require("./get-eyes-results");
 const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-settings");
 const utils = __importStar(require("@applitools/utils"));
 const core_base_1 = require("@applitools/core-base");
-function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, }) {
-    return async function openEyes({ type = defaultType, settings, config, target, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
-        var _v, _w, _x, _y, _z;
+const extract_git_info_1 = require("./utils/extract-git-info");
+function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, cwd = process.cwd(), }) {
+    return async function openEyes({ type = defaultType, settings: openSettings, config, target, logger = mainLogger, }) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
+        var _y, _z, _0, _1, _2, _3;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
-        settings = { ...config === null || config === void 0 ? void 0 : config.open, ...settings };
-        (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+        const settings = { ...config === null || config === void 0 ? void 0 : config.open, ...openSettings };
+        const eyesServerSettings = (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
         settings.batch = { ...batch, ...settings.batch };
-        (_b = (_v = settings.batch).id) !== null && _b !== void 0 ? _b : (_v.id = (_c = utils.general.getEnvValue('BATCH_ID')) !== null && _c !== void 0 ? _c : `generated-${utils.general.guid()}`);
-        (_d = (_w = settings.batch).buildId) !== null && _d !== void 0 ? _d : (_w.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
-        (_e = (_x = settings.batch).name) !== null && _e !== void 0 ? _e : (_x.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_f = (_y = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : (_y.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_g = (_z = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : (_z.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
-        (_h = settings.keepBatchOpen) !== null && _h !== void 0 ? _h : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
-        (_j = settings.branchName) !== null && _j !== void 0 ? _j : (settings.branchName = utils.general.getEnvValue('BRANCH'));
-        (_k = settings.parentBranchName) !== null && _k !== void 0 ? _k : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
-        (_l = settings.baselineBranchName) !== null && _l !== void 0 ? _l : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
-        (_m = settings.gitBranchingTimestamp) !== null && _m !== void 0 ? _m : (settings.gitBranchingTimestamp = utils.general.getEnvValue('GIT_MERGE_BASE_TIMESTAMP'));
-        (_o = settings.latestCommitInfo) !== null && _o !== void 0 ? _o : (settings.latestCommitInfo = getLatestCommitInfoFromEnvVars(logger));
-        (_p = settings.ufgServerUrl) !== null && _p !== void 0 ? _p : (settings.ufgServerUrl = utils.general.getEnvValue('UFG_SERVER_URL'));
-        (_q = settings.ignoreBaseline) !== null && _q !== void 0 ? _q : (settings.ignoreBaseline = false);
-        (_r = settings.compareWithParentBranch) !== null && _r !== void 0 ? _r : (settings.compareWithParentBranch = false);
-        (_s = settings.removeDuplicateTests) !== null && _s !== void 0 ? _s : (settings.removeDuplicateTests = removeDuplicateTests);
+        (_b = (_y = settings.batch).id) !== null && _b !== void 0 ? _b : (_y.id = utils.general.getEnvValue('BATCH_ID'));
+        (_c = (_z = settings.batch).buildId) !== null && _c !== void 0 ? _c : (_z.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
+        (_d = (_0 = settings.batch).name) !== null && _d !== void 0 ? _d : (_0.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_e = (_1 = settings.batch).sequenceName) !== null && _e !== void 0 ? _e : (_1.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_f = (_2 = settings.batch).notifyOnCompletion) !== null && _f !== void 0 ? _f : (_2.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_g = settings.keepBatchOpen) !== null && _g !== void 0 ? _g : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
+        (_h = settings.branchName) !== null && _h !== void 0 ? _h : (settings.branchName = utils.general.getEnvValue('BRANCH'));
+        (_j = settings.parentBranchName) !== null && _j !== void 0 ? _j : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
+        (_k = settings.baselineBranchName) !== null && _k !== void 0 ? _k : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
+        (_l = settings.gitBranchingTimestamp) !== null && _l !== void 0 ? _l : (settings.gitBranchingTimestamp = utils.general.getEnvValue('GIT_MERGE_BASE_TIMESTAMP'));
+        (_m = settings.latestCommitInfo) !== null && _m !== void 0 ? _m : (settings.latestCommitInfo = getLatestCommitInfoFromEnvVars(logger));
+        (_o = settings.ufgServerUrl) !== null && _o !== void 0 ? _o : (settings.ufgServerUrl = utils.general.getEnvValue('UFG_SERVER_URL'));
+        (_p = settings.ignoreBaseline) !== null && _p !== void 0 ? _p : (settings.ignoreBaseline = false);
+        (_q = settings.compareWithParentBranch) !== null && _q !== void 0 ? _q : (settings.compareWithParentBranch = false);
+        (_r = settings.removeDuplicateTests) !== null && _r !== void 0 ? _r : (settings.removeDuplicateTests = removeDuplicateTests);
+        (_s = settings.latestCommitInfo) !== null && _s !== void 0 ? _s : (settings.latestCommitInfo = await (0, extract_git_info_1.extractLatestCommitInfo)({ execOptions: { cwd }, logger }));
+        if (settings.latestCommitInfo && !(0, extract_git_info_1.isISODate)(settings.latestCommitInfo.timestamp)) {
+            logger.warn(`latestCommitInfo.timestamp is an invalid ISO date string: ${settings.latestCommitInfo.timestamp}`);
+            settings.latestCommitInfo = undefined;
+        }
+        if (process.env.CI && (((_t = settings.batch) === null || _t === void 0 ? void 0 : _t.id) || settings.latestCommitInfo)) {
+            await populateAutoScmInfo(((_u = settings.batch) === null || _u === void 0 ? void 0 : _u.id) || settings.latestCommitInfo.sha);
+        }
+        (_v = (_3 = settings.batch).id) !== null && _v !== void 0 ? _v : (_3.id = `generated-${utils.general.guid()}`);
+        if (settings.ignoreGitBranching) {
+            settings.gitBranchingTimestamp = undefined;
+        }
+        else if (!settings.gitBranchingTimestamp) {
+            const { branchName, parentBranchName } = settings;
+            if (branchName && parentBranchName && branchName !== parentBranchName) {
+                settings.gitBranchingTimestamp = await (0, extract_git_info_1.extractBranchingTimestamp)({
+                    branchName,
+                    parentBranchName,
+                    execOptions: { cwd },
+                    logger,
+                });
+            }
+        }
+        if (settings.gitBranchingTimestamp && !(0, extract_git_info_1.isISODate)(settings.gitBranchingTimestamp)) {
+            logger.warn(`gitBranchingTimestamp is an invalid ISO date string: ${settings.gitBranchingTimestamp}`);
+            settings.gitBranchingTimestamp = undefined;
+        }
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }));
         const driverEnvironment = await (driver === null || driver === void 0 ? void 0 : driver.getEnvironment());
         const driverUrl = await (driver === null || driver === void 0 ? void 0 : driver.getDriverUrl());
@@ -70,7 +98,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                 event: {
                     type: 'openEyes',
                     userTestId: settings.userTestId,
-                    concurrency: (_t = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _t !== void 0 ? _t : core.concurrency,
+                    concurrency: (_w = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _w !== void 0 ? _w : core.concurrency,
                     environment,
                     driver: {
                         deviceName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.deviceName,
@@ -78,7 +106,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                         browserVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.browserVersion,
                         platformName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformName,
                         platformVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformVersion,
-                        isApplitoolsLib: (_u = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _u === void 0 ? void 0 : _u.instrumented,
+                        isApplitoolsLib: (_x = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _x === void 0 ? void 0 : _x.instrumented,
                         isEC: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.isEC,
                     },
                     driverUrl,
@@ -113,6 +141,34 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                 getResults: (0, get_eyes_results_1.makeGetEyesResults)({ eyes, logger }),
             });
         }); // TODO solve the types issue
+        /////// END FUNCTION BODY ///////////////////
+        async function populateAutoScmInfo(batchId) {
+            var _a, _b, _c, _d, _e;
+            var _f, _g;
+            const branchName = await (0, extract_git_info_1.extractGitBranch)({ execOptions: { cwd }, logger });
+            const { owner: repoOwner, name: repoName } = await (0, extract_git_info_1.extractGitRepo)({ execOptions: { cwd }, logger });
+            const buildId = await (0, extract_git_info_1.extractBuildIdFromCI)();
+            if (branchName && repoOwner && repoName) {
+                const scmInfo = await core.base
+                    .updateIfScm({
+                    settings: { ...eyesServerSettings, batchId, branchName, repoOwner, repoName, buildId },
+                    logger,
+                })
+                    .catch(error => {
+                    throw refineMissingApiKeyException(error, environment === null || environment === void 0 ? void 0 : environment.sdk);
+                });
+                if (scmInfo) {
+                    (_a = settings.batch) !== null && _a !== void 0 ? _a : (settings.batch = {});
+                    (_b = (_f = settings.batch).id) !== null && _b !== void 0 ? _b : (_f.id = batchId);
+                    (_c = (_g = settings.batch).buildId) !== null && _c !== void 0 ? _c : (_g.buildId = buildId);
+                    (_d = settings.branchName) !== null && _d !== void 0 ? _d : (settings.branchName = branchName);
+                    (_e = settings.parentBranchName) !== null && _e !== void 0 ? _e : (settings.parentBranchName = scmInfo.scmTargetBranch);
+                }
+            }
+            else {
+                logger.log(`Skipping check for SCM integration due to missing information: branchName=${branchName} repoName=${repoName} repoOwner=${repoOwner}`);
+            }
+        }
     };
 }
 exports.makeOpenEyes = makeOpenEyes;

package/dist/run-offline-snapshots.js

@@ -84,8 +84,6 @@ async function runOfflineSnapshots(options) {
         const batchIds = [...new Set(results.map(t => t.batchId))];
         const allTestResults = results.map(t => t.results);
         executionLogger.log('done running all tests', allTestResults);
-        // @ts-expect-error // we use node v12 types, therefore it's not aware of the existence of `fs.promises.rm`
-        await fs_1.default.promises.rm(executionPath, { recursive: true });
         await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
         executionLogger.log('done execution', executionName);
         return allTestResults;

package/dist/ufg/core.js

@@ -36,10 +36,10 @@ const take_snapshots_1 = require("./take-snapshots");
 const get_ufg_client_1 = require("./get-ufg-client");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId = 'core-ufg', cwd = process.cwd(), logger: defaultLogger, }) {
+function makeCore({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId = 'core-ufg', logger: defaultLogger, }) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-ufg' } });
     logger.log(`Core ufg is initialized ${defaultBase ? 'with' : 'without'} custom base core`);
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath });
     const ufgClient = clients === null || clients === void 0 ? void 0 : clients.ufg;
     return utils.general.extend(base, core => {
         return {

package/dist/ufg/take-snapshots.js

@@ -1,27 +1,4 @@
 "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.makeTakeSnapshots = void 0;
 const driver_1 = require("@applitools/driver");
@@ -29,7 +6,6 @@ const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const to_safe_check_settings_1 = require("./utils/to-safe-check-settings");
 const to_generated_selectors_1 = require("./utils/to-generated-selectors");
 const abort_error_1 = require("../errors/abort-error");
-const utils = __importStar(require("@applitools/utils"));
 function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
     return async function takeSnapshots({ driver, settings = {}, account, logger = mainLogger, }) {
         var _a;
@@ -48,6 +24,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
         const { elementReferences, getSafeCheckSettings } = (0, to_safe_check_settings_1.toSafeCheckSettings)({ settings });
         const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
             elementReferences,
+            // dead code - `transformElementReference` was used for NMG but it's not longer used anywhere
             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; },
         });
         let snapshots;
@@ -79,6 +56,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
             });
         }
         else {
+            // dead code - used for NMG
             const nmlClient = await core.getNMLClient({
                 driver,
                 settings: { ...account.eyesServer, supportedEnvironmentsUrl: account.supportedEnvironmentsUrl },
@@ -100,7 +78,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
         return snapshots.map((snapshot, index) => ({
             target: snapshot,
             settings: getSafeCheckSettings({
-                selectors: getGeneratedSelectors(utils.types.has(snapshot, 'generatedSelectors') ? snapshot.generatedSelectors : undefined),
+                selectors: getGeneratedSelectors(snapshot.generatedSelectors),
             }),
             environment: uniqueEnvironments[index],
             account,

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

@@ -25,39 +25,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSafeSelectors = void 0;
 const utils = __importStar(require("@applitools/utils"));
-const { addElementIds, cleanupElementIds } = require('@applitools/snippets');
+const { addElementIds } = require('@applitools/snippets');
 async function generateSafeSelectors({ context, elementReferences, }) {
     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
-        };
-    }));
+        return { generatedSelectors: [] };
     // 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.map(({ elements, ref }) => {
-        if (elements.length === 0)
-            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: ref };
-    });
-    return {
-        selectors,
-        cleanupGeneratedSelectors,
-    };
-    async function cleanupGeneratedSelectors() {
-        if (!mapping.length)
-            return;
-        await context.execute(cleanupElementIds, [mapping.map(({ elements }) => elements).flat()]);
+    const elementsWithIds = [];
+    for (const ref of elementReferences) {
+        const elements = await context.elements(ref);
+        elementsWithIds.push([elements, utils.general.guid()]); // same id for all elements that match the same ref
     }
+    return { generatedSelectors: await context.execute(addElementIds, elementsWithIds) };
 }
 exports.generateSafeSelectors = generateSafeSelectors;

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

@@ -23,24 +23,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCrossFrames = exports.takeDomSnapshot = void 0;
+exports.takeDomSnapshot = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { getProcessPagePoll, getPollResult } = require('@applitools/dom-snapshot');
 async function takeDomSnapshot({ context, settings, logger, }) {
-    var _a;
+    var _a, _b;
     const driver = context.driver;
     const environment = await driver.getEnvironment();
     const features = await driver.getFeatures();
-    const cookies = ((_a = settings === null || settings === void 0 ? void 0 : settings.cookies) !== null && _a !== void 0 ? _a : features.allCookies) ? await driver.getCookies().catch(() => []) : [];
-    const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context }));
-    snapshot.cookies = cookies;
+    const cookies = (_a = settings === null || settings === void 0 ? void 0 : settings.cookies) !== null && _a !== void 0 ? _a : [];
+    // assumption is that elementReferences are all in the frame which is `context`
+    // otherwise, the elements would still be found inside other frames, but `takeContextDomSnapshot` should be passed only the specific element references that it needs
+    const elements = [];
+    for (const elementReference of (_b = settings === null || settings === void 0 ? void 0 : settings.elementReferences) !== null && _b !== void 0 ? _b : []) {
+        elements.push(await context.elements(elementReference));
+    }
+    const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context }), elements);
+    snapshot.cookies = features.allCookies ? await driver.getCookies().catch(() => []) : cookies; // intentionally fetching cookies after the dom snapshot runs
     return snapshot;
     async function takeContextDomSnapshot({ context }) {
         // logger.log(`taking dom snapshot. ${context._reference ? `context referece: ${JSON.stringify(context._reference)}` : ''}`)
         var _a, _b, _c;
-        if (!features.allCookies) {
-            cookies.push(...(await context.getCookies()));
-        }
         const arg = {
             dontFetchResources: settings === null || settings === void 0 ? void 0 : settings.disableBrowserFetching,
             skipResources: settings === null || settings === void 0 ? void 0 : settings.skipResources,
@@ -50,6 +53,7 @@ async function takeDomSnapshot({ context, settings, logger, }) {
             serializeResources: true,
             compressResources: false,
             showLogs: settings === null || settings === void 0 ? void 0 : settings.showLogs,
+            elements,
         };
         const scripts = {
             main: features.canExecuteOnlyFunctionScripts
@@ -65,6 +69,10 @@ async function takeDomSnapshot({ context, settings, logger, }) {
             executionTimeout: (_b = settings === null || settings === void 0 ? void 0 : settings.executionTimeout) !== null && _b !== void 0 ? _b : 5 * 60 * 1000,
             pollTimeout: (_c = settings === null || settings === void 0 ? void 0 : settings.pollTimeout) !== null && _c !== void 0 ? _c : 200,
         });
+        // intentionally fetching cookies after the dom snapshot runs
+        if (!features.allCookies) {
+            cookies.push(...(await context.getCookies()));
+        }
         const crossFrames = extractCrossFrames({ snapshot, logger });
         for (const { reference, parentSnapshot, cdtNode } of crossFrames) {
             const frameContext = await context
@@ -88,16 +96,14 @@ async function takeDomSnapshot({ context, settings, logger, }) {
                 cdtNode.attributes.push({ name: 'data-applitools-src', value: frameSnapshot.url });
             }
         }
-        logger.log(`dom snapshot cdt length: ${snapshot.cdt.length}`);
-        logger.log(`blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
-        logger.log(`resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
+        logSnapshot(logger, snapshot);
         return snapshot;
     }
 }
 exports.takeDomSnapshot = takeDomSnapshot;
-function transformRawDomSnapshot(snapshot) {
-    const { blobs, selector: _, crossFrames: __, ...rest } = snapshot;
-    return {
+function transformRawDomSnapshot(snapshot, elements) {
+    const { blobs, safeSelectors, selector: _, crossFrames: __, ...rest } = snapshot;
+    const domSnapshot = {
         ...rest,
         resourceContents: blobs.reduce((resourceContents, blob) => {
             return {
@@ -107,6 +113,16 @@ function transformRawDomSnapshot(snapshot) {
         }, {}),
         frames: snapshot.frames.map(frameSnapshot => transformRawDomSnapshot(frameSnapshot)),
     };
+    if (elements === null || elements === void 0 ? void 0 : elements.length) {
+        domSnapshot.generatedSelectors = elements.map((elements, i) => {
+            var _a, _b;
+            return ({
+                originalSelector: (_b = (_a = elements[0]) === null || _a === void 0 ? void 0 : _a.commonSelector) !== null && _b !== void 0 ? _b : null,
+                safeSelector: safeSelectors[i],
+            });
+        });
+    }
+    return domSnapshot;
 }
 function extractCrossFrames({ snapshot, parent = null, logger, }) {
     var _a;
@@ -128,7 +144,28 @@ function extractCrossFrames({ snapshot, parent = null, logger, }) {
                 : []),
         ];
     });
-    logger.log(`frames paths for ${snapshot.crossFrames}`, crossFrames.map(selector => JSON.stringify(selector)).join(' , '));
+    logger.log(...(snapshot.crossFrames
+        ? [
+            `frames paths for ${JSON.stringify(snapshot.crossFrames)}:`,
+            crossFrames.map(selector => ({
+                // we don't want `selector.parentSnapshot` to be logged - the size of it can be huge
+                cdtNode: selector.cdtNode,
+                reference: selector.reference,
+            })),
+        ]
+        : ['no cross frames found']));
     return crossFrames;
 }
-exports.extractCrossFrames = extractCrossFrames;
+function logSnapshot(logger, snapshot) {
+    try {
+        logger.log(`dom snapshot cdt length: ${snapshot.cdt.length}`);
+        logger.log(`blobs urls (${snapshot.blobs.length}):`, JSON.stringify(snapshot.blobs.map(({ url }) => url)));
+        logger.log(`resource urls (${snapshot.resourceUrls.length}):`, JSON.stringify(snapshot.resourceUrls));
+        logger.log(`cdt nodes with data-applitools-selector: ${JSON.stringify(snapshot.cdt.filter(node => { var _a; return (_a = node.attributes) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === 'data-applitools-selector'); }))}`);
+    }
+    catch (err) {
+        logger.error(`error while logging cdt`, err);
+    }
+    if (snapshot.error)
+        logger.error('snapshot error:', snapshot.error);
+}

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

@@ -38,7 +38,7 @@ 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;
+    var _a, _b;
     // 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(() => []) : [];
@@ -50,16 +50,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
-        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 });
+        return Array(settings.environments.length).fill(snapshot);
     }
-    const isStrictBreakpoints = utils.types.isArray((_c = settings.layoutBreakpoints) === null || _c === void 0 ? void 0 : _c.breakpoints);
+    const isStrictBreakpoints = utils.types.isArray((_b = settings.layoutBreakpoints) === null || _b === void 0 ? void 0 : _b.breakpoints);
     const requiredWidths = await settings.environments.reduce(async (prev, environment, index) => {
         const { name, width } = (await extractEnvironmentInfo(environment));
         const requiredWidths = await prev;
@@ -92,7 +86,7 @@ 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);
     // making safe selectors before any resize in order to make sure fallback selectors are created
-    let safeSelectorResult = await (0, generate_safe_selectors_1.generateSafeSelectors)({
+    await (0, generate_safe_selectors_1.generateSafeSelectors)({
         context: currentContext,
         elementReferences: settings.elementReferences,
     });
@@ -132,22 +126,14 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
             await (0, wait_for_lazy_load_1.waitForLazyLoad)({ context: currentContext, settings: settings.lazyLoad, logger });
         }
         await beforeEachSnapshot();
-        // it's important that we calculate safe selectors as close as possible to taking the dom snapshot
-        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 }));
+        browsers.forEach(({ index }) => (snapshots[index] = snapshot));
     }
     await driver.setViewportSize(initialViewportSize);
     if (settings.layoutBreakpoints.reload) {
         await driver.reloadPage();
         await beforeEachSnapshot();
     }
-    else {
-        await (safeSelectorResult === null || safeSelectorResult === void 0 ? void 0 : safeSelectorResult.cleanupGeneratedSelectors());
-    }
     return snapshots;
     async function beforeEachSnapshot() {
         var _a, _b;

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

@@ -27,6 +27,7 @@ function toGeneratedSelectors({ elementReferences, transformElementReference, })
             calculate = generatedSelectors.slice(offset);
         }
         else {
+            // the entire else statement should be a dead code that was used for NMG, will be removed later
             target = elementReferences.target && transformElementReference(elementReferences.target);
             scrolling = elementReferences.scrolling && transformElementReference(elementReferences.scrolling);
             calculate = ((_c = elementReferences.calculate) !== null && _c !== void 0 ? _c : []).map(elementReference => {

package/dist/universal/core.js

@@ -95,6 +95,10 @@ function makeCore(options) {
             const socket = await socketPromise;
             return socket.request('Core.logEvent', options);
         },
+        async updateIfScm() {
+            // TODO
+            return null;
+        },
     };
     return core;
 }

package/dist/utils/extract-git-info.js

@@ -0,0 +1,165 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isISODate = exports.extractBranchingTimestamp = exports.extractBuildIdFromCI = exports.extractGitRepo = exports.extractGitBranch = exports.extractLatestCommitInfo = exports.cacheKey = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("@applitools/logger");
+exports.cacheKey = 'default';
+exports.extractLatestCommitInfo = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)(), }) {
+    let result;
+    try {
+        const githubPullRequestLastCommitSha = await extractGithubPullRequestLastCommitSha();
+        result = await executeWithLog(`git log ${githubPullRequestLastCommitSha !== null && githubPullRequestLastCommitSha !== void 0 ? githubPullRequestLastCommitSha : ''} -1 --format="%aI %H"`, {
+            execOptions,
+            logger,
+        });
+        if (result.stderr) {
+            logger.log(`Error during extracting commit information from git`, result.stderr);
+        }
+        else {
+            const [timestamp, sha] = result.stdout.trim().split(' ');
+            if (isISODate(timestamp)) {
+                return { sha, timestamp };
+            }
+            else {
+                logger.log(`latestCommitInfo.timestamp is an invalid ISO date string: ${timestamp}`);
+            }
+        }
+    }
+    catch (err) {
+        logger.log(`Error during parsing commit hash from git`, err, result === null || result === void 0 ? void 0 : result.stdout);
+    }
+    async function extractGithubPullRequestLastCommitSha() {
+        var _a, _b, _c;
+        if (((_a = process.env.GITHUB_EVENT_NAME) === null || _a === void 0 ? void 0 : _a.startsWith('pull_request')) && process.env.GITHUB_EVENT_PATH) {
+            await executeWithLog(`git fetch origin --depth=2`, { execOptions, logger });
+            const event = await fs_1.default.promises.readFile(process.env.GITHUB_EVENT_PATH, 'utf-8').then(JSON.parse);
+            return (_c = (_b = event === null || event === void 0 ? void 0 : event.pull_request) === null || _b === void 0 ? void 0 : _b.head) === null || _c === void 0 ? void 0 : _c.sha;
+        }
+    }
+}, () => exports.cacheKey);
+exports.extractGitBranch = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    if (process.env.GITHUB_HEAD_REF) {
+        return process.env.GITHUB_HEAD_REF;
+    }
+    if (process.env.GITHUB_REF) {
+        return process.env.GITHUB_REF.split('/')[2]; // refs/heads/<branch_name>
+    }
+    const result = await executeWithLog('git branch --show-current', { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting current branch from git`, result.stderr);
+    }
+    else {
+        const branch = result.stdout.trim();
+        logger.log(`Extracted current git branch: "${branch}"`);
+        return branch;
+    }
+}, () => exports.cacheKey);
+exports.extractGitRepo = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    const remotes = await extractRemotes();
+    logger.log(`Extracted remotes from git: ${remotes}`);
+    const remote = remotes.includes('origin') ? 'origin' : remotes[0];
+    const result = await executeWithLog(`git remote get-url ${remote}`, { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting remote url from git`, result.stderr);
+        return {};
+    }
+    else {
+        const remoteUrl = result.stdout.trim();
+        logger.log(`Extracted url for git remote ${remote}: ${remoteUrl}`);
+        return extractRepoFromRemoteUrl(remoteUrl);
+    }
+    async function extractRemotes() {
+        const result = await executeWithLog('git remote show', { execOptions, logger });
+        if (result.stderr) {
+            logger.log(`Error during extracting remotes from git`, result.stderr);
+            return [];
+        }
+        else {
+            return result.stdout.trim().split(/\s+/);
+        }
+    }
+    function extractRepoFromRemoteUrl(remoteUrl) {
+        try {
+            const url = new URL(remoteUrl);
+            return { name: path_1.default.basename(url.pathname, '.git'), owner: path_1.default.dirname(url.pathname).replace(/^\//, '') };
+        }
+        catch (err) {
+            return { name: path_1.default.basename(remoteUrl, '.git'), owner: path_1.default.dirname(remoteUrl).replace(/^[^:]+:/, '') };
+        }
+    }
+}, () => exports.cacheKey);
+async function extractBuildIdFromCI() {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    return ((_k = (_j = (_h = (_g = (_f = (_e = (_d = (_c = (_b = (_a = process.env.GITHUB_RUN_ID) !== null && _a !== void 0 ? _a : process.env.CI_JOB_ID) !== null && _b !== void 0 ? _b : process.env.CIRCLE_BUILD_NUM) !== null && _c !== void 0 ? _c : process.env.BUILD_BUILDID) !== null && _d !== void 0 ? _d : process.env.BITBUCKET_BUILD_NUMBER) !== null && _e !== void 0 ? _e : process.env.CODEBUILD_BUILD_ID) !== null && _f !== void 0 ? _f : process.env.BUILD_ID) !== null && _g !== void 0 ? _g : process.env.BUILD_NUMBER) !== null && _h !== void 0 ? _h : process.env.TRAVIS_BUILD_ID) !== null && _j !== void 0 ? _j : process.env.BUILDKITE_BUILD_ID) !== null && _k !== void 0 ? _k : process.env.BAMBOO // TODO: Bamboo
+    );
+}
+exports.extractBuildIdFromCI = extractBuildIdFromCI;
+exports.extractBranchingTimestamp = utils.general.cachify(async function ({ branchName, parentBranchName, execOptions, logger = (0, logger_1.makeLogger)(), }) {
+    var _a;
+    logger = logger.extend({ tags: [`extract-branching-timestamp-${utils.general.shortid()}`] });
+    const command = `HASH=$(git merge-base ${branchName} ${parentBranchName}) && git show -q --format=%aI $HASH`;
+    let result = await executeWithLog(command, { execOptions, logger });
+    if (result.stderr) {
+        const [, missingBranch] = (_a = result.stderr.match(/Not a valid object name ([^\s]+)/)) !== null && _a !== void 0 ? _a : [];
+        if (missingBranch) {
+            result = await executeWithLog(`git fetch origin ${missingBranch}:${missingBranch} && ${command}`, {
+                execOptions,
+                logger,
+            });
+        }
+    }
+    if (!result.stdout) {
+        result = await executeWithLog(`git fetch origin --unshallow && ${command}`, { execOptions, logger });
+    }
+    const timestamp = result.stdout.replace(/\s/g, '');
+    if (isISODate(timestamp)) {
+        logger.log('git branching timestamp successfully extracted', timestamp);
+        return timestamp;
+    }
+    else {
+        logger.log(`Error during extracting merge timestamp: git branching timestamp is an invalid ISO date string: ${timestamp}. stderr: ${result.stderr}, stdout: ${result.stdout}`);
+    }
+}, () => exports.cacheKey);
+async function executeWithLog(command, { execOptions, logger = (0, logger_1.makeLogger)() } = {
+    execOptions: {},
+    logger: (0, logger_1.makeLogger)(),
+}) {
+    logger.log(`executing command: ${command}`);
+    const result = await utils.process.execute(command, execOptions);
+    if (result.stderr && result.code) {
+        logger.log(`exit code: ${result.code}, stderr: ${result.stderr}`);
+    }
+    return result;
+}
+function isISODate(str) {
+    return /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\+\d{2}:\d{2})?/.test(str);
+}
+exports.isISODate = isISODate;

package/dist/utils/populate-eyes-server-settings.js

@@ -31,5 +31,11 @@ function populateEyesServerSettings(settings) {
     (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
     (_e = settings.proxy) !== null && _e !== void 0 ? _e : (settings.proxy = utils.general.getEnvValue('PROXY_URL') ? { url: utils.general.getEnvValue('PROXY_URL') } : undefined);
     (_f = settings.useDnsCache) !== null && _f !== void 0 ? _f : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
+    return {
+        eyesServerUrl: settings.eyesServerUrl,
+        apiKey: settings.apiKey,
+        proxy: settings.proxy,
+        useDnsCache: settings.useDnsCache,
+    };
 }
 exports.populateEyesServerSettings = populateEyesServerSettings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.20.2",
+  "version": "4.21.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,18 +74,18 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.17.2",
+    "@applitools/core-base": "1.18.0",
     "@applitools/dom-capture": "11.5.0",
-    "@applitools/dom-snapshot": "4.11.3",
-    "@applitools/driver": "1.19.2",
-    "@applitools/ec-client": "1.9.8",
+    "@applitools/dom-snapshot": "4.11.4",
+    "@applitools/driver": "1.19.4",
+    "@applitools/ec-client": "1.9.10",
     "@applitools/logger": "2.0.18",
-    "@applitools/nml-client": "1.8.12",
+    "@applitools/nml-client": "1.8.14",
     "@applitools/req": "1.7.2",
-    "@applitools/screenshoter": "3.8.38",
-    "@applitools/snippets": "2.5.0",
+    "@applitools/screenshoter": "3.9.1",
+    "@applitools/snippets": "2.5.2",
     "@applitools/socket": "1.1.18",
-    "@applitools/spec-driver-webdriver": "1.1.14",
+    "@applitools/spec-driver-webdriver": "1.1.16",
     "@applitools/ufg-client": "1.13.1",
     "@applitools/utils": "1.7.4",
     "@types/ws": "8.5.5",
@@ -100,8 +100,8 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.14",
-    "@applitools/spec-driver-selenium": "^1.5.85",
+    "@applitools/spec-driver-puppeteer": "^1.4.16",
+    "@applitools/spec-driver-selenium": "^1.5.87",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.8",

package/types/automation/types.d.ts

@@ -148,6 +148,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
     waitBetweenStitches?: number;
     lazyLoad?: boolean | LazyLoadOptions;
     sendDom?: boolean;
+    captureStatusBar?: boolean;
 }
 export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;
 export type LocateTextSettings<TPattern extends string, TSpec extends SpecType> = BaseCore.LocateTextSettings<TPattern, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;

package/types/autonomous/core.d.ts

@@ -13,8 +13,7 @@ type Options<TSpec extends SpecType> = {
     base?: BaseCore;
     asyncCache?: AsyncCache;
     agentId?: string;
-    cwd?: string;
     logger?: Logger;
 };
-export declare function makeAutonomousCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, agentId, cwd, logger: defaultLogger, }?: Options<TSpec>): AutonomousCore<TSpec>;
+export declare function makeAutonomousCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, agentId, logger: defaultLogger, }?: Options<TSpec>): AutonomousCore<TSpec>;
 export {};

package/types/classic/core.d.ts

@@ -11,9 +11,8 @@ type Options<TSpec extends SpecType> = {
     base?: BaseCore;
     concurrency?: number;
     agentId?: string;
-    cwd?: string;
     logger?: Logger;
     offlineLocationPath?: string;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, agentId, cwd, logger: defaultLogger, offlineLocationPath, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, agentId, logger: defaultLogger, offlineLocationPath, }: Options<TSpec>): Core<TSpec>;
 export {};

package/types/open-eyes.d.ts

@@ -19,8 +19,9 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     environment?: Record<string, any>;
     logger: Logger;
     asyncCache?: AsyncCache;
+    cwd?: string;
 };
-export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
+export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, cwd, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings: openSettings, config, target, logger, }: {
     type?: TType | undefined;
     settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
     config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;

package/types/ufg/core.d.ts

@@ -15,9 +15,8 @@ type Options<TSpec extends SpecType> = {
     concurrency?: number;
     fetchConcurrency?: number;
     agentId?: string;
-    cwd?: string;
     logger?: Logger;
     offlineLocationPath?: string;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
 export {};

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

@@ -1,22 +1,7 @@
-import { type SpecType, type Context, type ElementReference, type CommonSelector } from '@applitools/driver';
-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>;
+import { type SpecType, type Context, type ElementReference } from '@applitools/driver';
 export declare function generateSafeSelectors<TSpec extends SpecType>({ context, elementReferences, }: {
     context: Context<TSpec>;
     elementReferences?: ElementReference<TSpec>[];
-}): Promise<GeneratedSafeSelector<TSpec> | undefined>;
-export {};
+}): Promise<{
+    generatedSelectors: string[][][];
+}>;

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

@@ -1,9 +1,9 @@
 import { type DomSnapshot } from '../types';
 import { type Logger } from '@applitools/logger';
-import { type SpecType, type Context, type Cookie } from '@applitools/driver';
+import { type SpecType, type Context, type Cookie, type ElementReference, type CommonSelector } from '@applitools/driver';
 export type RawDomSnapshot = {
     url: string;
-    selector: string;
+    selector?: string;
     cdt: {
         attributes: {
             name: string;
@@ -22,8 +22,10 @@ export type RawDomSnapshot = {
     }[];
     srcAttr: string | null;
     scriptVersion: string;
+    safeSelectors?: (CommonSelector | null)[];
+    error?: string;
 };
-export type DomSnapshotSettings = {
+export type DomSnapshotSettings<TSpec extends SpecType> = {
     disableBrowserFetching?: boolean;
     skipResources?: string[];
     chunkByteLength?: number;
@@ -31,18 +33,10 @@ export type DomSnapshotSettings = {
     pollTimeout?: number;
     showLogs?: boolean;
     cookies?: Cookie[];
+    elementReferences?: ElementReference<TSpec>[];
 };
 export declare function takeDomSnapshot<TSpec extends SpecType>({ context, settings, logger, }: {
     context: Context<TSpec>;
-    settings?: DomSnapshotSettings;
+    settings?: DomSnapshotSettings<TSpec>;
     logger: Logger;
 }): Promise<DomSnapshot>;
-export declare function extractCrossFrames({ snapshot, parent, logger, }: {
-    snapshot: RawDomSnapshot;
-    parent?: any;
-    logger: Logger;
-}): {
-    cdtNode: RawDomSnapshot['cdt'][number];
-    reference: any;
-    parentSnapshot: RawDomSnapshot;
-}[];

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

@@ -1,11 +1,11 @@
 import type { DomSnapshot, LazyLoadOptions } from '../types';
 import { type Size } from '@applitools/utils';
 import { type Logger } from '@applitools/logger';
-import { type SpecType, type Driver, type ElementReference } from '@applitools/driver';
+import { type SpecType, type Driver } from '@applitools/driver';
 import { type Environment } from '@applitools/ufg-client';
 import { type DomSnapshotSettings } from './take-dom-snapshot';
 export * from './take-dom-snapshot';
-export type DomSnapshotsSettings<TSpec extends SpecType> = DomSnapshotSettings & {
+export type DomSnapshotsSettings<TSpec extends SpecType> = DomSnapshotSettings<TSpec> & {
     environments: Environment[];
     waitBeforeCapture?: number | (() => Promise<void>);
     layoutBreakpoints?: {
@@ -13,7 +13,6 @@ export type DomSnapshotsSettings<TSpec extends SpecType> = DomSnapshotSettings &
         reload?: boolean;
     };
     lazyLoad?: boolean | LazyLoadOptions;
-    elementReferences?: ElementReference<TSpec>[];
 };
 export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
     driver: Driver<TSpec>;

package/types/utils/extract-git-info.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="node" />
+import type { ExecOptions } from 'child_process';
+import { type Logger } from '@applitools/logger';
+type Options = {
+    execOptions?: ExecOptions;
+    logger: Logger;
+};
+type ExtractGitBranchingTimestampOptions = {
+    branchName: string;
+    execOptions?: ExecOptions;
+    logger?: Logger;
+    parentBranchName: string;
+};
+type ExtractCurrentCommitTimestampOptions = {
+    execOptions?: ExecOptions;
+    logger?: Logger;
+};
+export declare const cacheKey = "default";
+export declare const extractLatestCommitInfo: (({ execOptions, logger, }: ExtractCurrentCommitTimestampOptions) => Promise<{
+    timestamp: string;
+    sha: string;
+} | undefined>) & {
+    getCachedValues(): Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>[];
+    setCachedValue(key: any, value: Promise<{
+        timestamp: string;
+        sha: string;
+    } | undefined>): void;
+    clearCache(): void;
+};
+export declare const extractGitBranch: (({ execOptions, logger }: Options) => Promise<string | undefined>) & {
+    getCachedValues(): Promise<string | undefined>[];
+    setCachedValue(key: any, value: Promise<string | undefined>): void;
+    clearCache(): void;
+};
+export declare const extractGitRepo: (({ execOptions, logger }: Options) => Promise<{
+    name?: string;
+    owner?: string;
+}>) & {
+    getCachedValues(): Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>[];
+    setCachedValue(key: any, value: Promise<{
+        name?: string | undefined;
+        owner?: string | undefined;
+    }>): void;
+    clearCache(): void;
+};
+export declare function extractBuildIdFromCI(): Promise<string | undefined>;
+export declare const extractBranchingTimestamp: (({ branchName, parentBranchName, execOptions, logger, }: ExtractGitBranchingTimestampOptions) => Promise<string | undefined>) & {
+    getCachedValues(): Promise<string | undefined>[];
+    setCachedValue(key: any, value: Promise<string | undefined>): void;
+    clearCache(): void;
+};
+export declare function isISODate(str: string): boolean;
+export {};

package/types/utils/populate-eyes-server-settings.d.ts

@@ -1,2 +1,2 @@
 import type { EyesServerSettings } from '../types';
-export declare function populateEyesServerSettings(settings: Partial<EyesServerSettings>): void;
+export declare function populateEyesServerSettings(settings: Partial<EyesServerSettings>): EyesServerSettings;