@applitools/core 4.20.2 → 4.21.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [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/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.0",
   "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/driver": "1.19.3",
+    "@applitools/ec-client": "1.9.9",
     "@applitools/logger": "2.0.18",
-    "@applitools/nml-client": "1.8.12",
+    "@applitools/nml-client": "1.8.13",
     "@applitools/req": "1.7.2",
-    "@applitools/screenshoter": "3.8.38",
-    "@applitools/snippets": "2.5.0",
+    "@applitools/screenshoter": "3.9.0",
+    "@applitools/snippets": "2.5.1",
     "@applitools/socket": "1.1.18",
-    "@applitools/spec-driver-webdriver": "1.1.14",
+    "@applitools/spec-driver-webdriver": "1.1.15",
     "@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.15",
+    "@applitools/spec-driver-selenium": "^1.5.86",
     "@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/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;