@applitools/core 4.13.1 → 4.15.0

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # Changelog
 
+## [4.15.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.14.0...js/core@4.15.0) (2024-05-07)
+
+
+### Features
+
+* expose git latest commit info in env vars ([#2349](https://github.com/Applitools-Dev/sdk/issues/2349)) ([1db248c](https://github.com/Applitools-Dev/sdk/commit/1db248c83ee1cbc83f905163fe5bd63dd5e293c2))
+
+
+### Dependencies
+
+* @applitools/dom-capture bumped to 11.2.7
+  #### Bug Fixes
+
+  * capture user input from input elements ([#2347](https://github.com/Applitools-Dev/sdk/issues/2347)) ([f82d3bb](https://github.com/Applitools-Dev/sdk/commit/f82d3bbc79c624ab7e8eeade7559b523f6adfeac))
+* @applitools/ec-client bumped to 1.8.5
+
+* @applitools/core-base bumped to 1.14.0
+  #### Features
+
+  * expose git latest commit info in env vars ([#2349](https://github.com/Applitools-Dev/sdk/issues/2349)) ([1db248c](https://github.com/Applitools-Dev/sdk/commit/1db248c83ee1cbc83f905163fe5bd63dd5e293c2))
+  * long eyes requests with custom domain ([#2343](https://github.com/Applitools-Dev/sdk/issues/2343)) ([d54beea](https://github.com/Applitools-Dev/sdk/commit/d54beea8c33a56a0516904773daaa5095340fd12))
+
+## [4.14.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.13.1...js/core@4.14.0) (2024-05-01)
+
+
+### Features
+
+* `matchTimeout` ([#2309](https://github.com/Applitools-Dev/sdk/issues/2309)) ([626529e](https://github.com/Applitools-Dev/sdk/commit/626529e839fd2a96ac0de98332f42873c0f387a4))
+
+
+### Bug Fixes
+
+* cache nml client per driver ([#2336](https://github.com/Applitools-Dev/sdk/issues/2336)) ([02c09a5](https://github.com/Applitools-Dev/sdk/commit/02c09a53eb6ca6340c93365908f4c485ab389c21))
+* support for using unicode and just using escape with numbers ([#2241](https://github.com/Applitools-Dev/sdk/issues/2241)) ([c59f47f](https://github.com/Applitools-Dev/sdk/commit/c59f47f73585d7f308c43c9ee1845e097a2111a3))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.1
+  #### Bug Fixes
+
+  * support for using unicode and just using escape with numbers ([#2241](https://github.com/Applitools-Dev/sdk/issues/2241)) ([c59f47f](https://github.com/Applitools-Dev/sdk/commit/c59f47f73585d7f308c43c9ee1845e097a2111a3))
+* @applitools/spec-driver-webdriver bumped to 1.1.7
+
+* @applitools/spec-driver-selenium bumped to 1.5.78
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.7
+
+* @applitools/driver bumped to 1.17.2
+  #### Bug Fixes
+
+  * cache nml client per driver ([#2336](https://github.com/Applitools-Dev/sdk/issues/2336)) ([02c09a5](https://github.com/Applitools-Dev/sdk/commit/02c09a53eb6ca6340c93365908f4c485ab389c21))
+* @applitools/screenshoter bumped to 3.8.31
+
+* @applitools/nml-client bumped to 1.8.4
+
+* @applitools/ec-client bumped to 1.8.4
+
+* @applitools/core-base bumped to 1.13.0
+  #### Features
+
+  * `matchTimeout` ([#2309](https://github.com/Applitools-Dev/sdk/issues/2309)) ([626529e](https://github.com/Applitools-Dev/sdk/commit/626529e839fd2a96ac0de98332f42873c0f387a4))
+
 ## [4.13.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.13.0...js/core@4.13.1) (2024-04-22)
 
 

package/dist/check.js

@@ -48,7 +48,7 @@ function makeCheck({ type: defaultType = 'classic', eyes, target: defaultTarget,
         (_g = settings.sendDom) !== null && _g !== void 0 ? _g : (settings.sendDom = eyes.test.account.rcaEnabled || settings.matchLevel === 'Layout' || settings.enablePatterns || settings.useDom);
         (_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 = 2000);
+        (_k = (_q = settings).retryTimeout) !== null && _k !== void 0 ? _k : (_q.retryTimeout = 0);
         settings.lazyLoad = settings.lazyLoad === true ? {} : settings.lazyLoad;
         if (settings.lazyLoad) {
             (_l = (_r = settings.lazyLoad).scrollLength) !== null && _l !== void 0 ? _l : (_r.scrollLength = 300);

package/dist/classic/check.js

@@ -40,9 +40,11 @@ const utils = __importStar(require("@applitools/utils"));
 const lang = __importStar(require("../lang"));
 function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
-        var _a, _b, _c;
+        var _a;
+        // logging
         logger = logger.extend(mainLogger);
         logger.log('Command "check" is called with settings', settings);
+        // input validation and sanitization
         if (!target)
             throw new Error('Method was called with no target');
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
@@ -50,173 +52,275 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
             throw new abort_error_1.AbortError('Command "check" was called after test was already aborted');
         }
         const uniqueEnvironments = (0, uniquify_environments_1.uniquifyEnvironments)((_a = settings.environments) !== null && _a !== void 0 ? _a : defaultEnvironments);
-        const baseTargets = [];
-        const baseSettings = [];
-        const exactEnvironments = [];
-        let driver;
+        let driver = undefined;
         if ((0, driver_1.isDriver)(target, spec)) {
             driver = await (0, driver_1.makeDriver)({ spec, driver: target, reset: target === defaultTarget, logger });
-            await driver.currentContext.setScrollingElement((_b = settings.scrollRootElement) !== null && _b !== void 0 ? _b : null);
-            const driverEnvironment = await driver.getEnvironment();
-            uniqueEnvironments.forEach(environment => {
-                var _a, _b;
-                var _c, _d;
-                if (utils.types.has(environment, 'iosDeviceInfo')) {
-                    (_a = (_c = environment.iosDeviceInfo).version) !== null && _a !== void 0 ? _a : (_c.version = driverEnvironment.platformVersion);
+            if (settings.retryTimeout) {
+                // when retry timeout is set, retry checking until it passes or timeout is reached. This will stall the client test execution until it passes or timeout is reached to prevent the test from continuing and changing the state of the app
+                logger.log(`Retry timeout is set to ${settings.retryTimeout}ms - will retry checking until it passes or timeout is reached`);
+                const start = Date.now();
+                if (await isNewTest({ eyes, driver, environments: uniqueEnvironments, logger })) {
+                    await new Promise(resolve => setTimeout(resolve, settings.retryTimeout));
                 }
-                else if (utils.types.has(environment, 'androidDeviceInfo')) {
-                    (_b = (_d = environment.androidDeviceInfo).version) !== null && _b !== void 0 ? _b : (_d.version = driverEnvironment.platformVersion);
-                }
-                return environment;
-            });
-            if (settings.lazyLoad && driverEnvironment.isWeb) {
-                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-                    context: driver.currentContext,
-                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-                    logger,
-                });
-            }
-            if (driverEnvironment.isWeb ||
-                !((_c = driverEnvironment.applitoolsLib) === null || _c === void 0 ? void 0 : _c.instrumented) ||
-                settings.webview ||
-                settings.screenshotMode === 'default') {
-                let actualEnvironments = uniqueEnvironments;
-                if (settings.screenshotMode === 'default') {
-                    const { localEnvironment, renderEnvironments } = await (0, nml_client_1.getNMLEnvironmentsInfo)({
-                        environments: uniqueEnvironments,
-                        supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl,
-                        proxy: eyes.test.eyesServer.proxy,
-                        logger,
+                let asExpected = false, retries = 0;
+                do {
+                    retries++;
+                    // generate base targets (images to be compared) and settings for each environment
+                    const baseScreenshotsAndSettings = await generateBaseScreenshotsAndSettings(settings, uniqueEnvironments, eyes, logger, driver);
+                    const promises = baseScreenshotsAndSettings.map(async ({ exactEnvironment: environment, baseSetting: settings, baseTarget: target }) => {
+                        return await checkEnvironment({
+                            eyes,
+                            driver,
+                            target,
+                            environment,
+                            signal,
+                            logger,
+                            settings: {
+                                ...settings,
+                                replaceLast: retries > 1,
+                            },
+                        });
                     });
-                    actualEnvironments = localEnvironment ? [localEnvironment] : renderEnvironments;
-                }
-                const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
-                const screenshots = await (0, take_screenshots_1.takeScreenshots)({
-                    driver,
-                    settings: {
-                        ...settings,
-                        environments: actualEnvironments,
-                        regionsToCalculate: elementReferences.calculate,
-                        calculateView: !!settings.pageId,
-                        domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : undefined,
-                    },
-                    logger,
-                });
-                exactEnvironments.push(...actualEnvironments);
-                screenshots.forEach(({ calculatedRegions, ...baseTarget }) => {
-                    baseTargets.push(baseTarget);
-                    baseSettings.push(getBaseCheckSettings({ calculatedRegions }));
-                });
+                    const results = await Promise.all(promises);
+                    asExpected = results.every(result => result.asExpected);
+                    if (retries === 1) {
+                        baseScreenshotsAndSettings.forEach(({ exactEnvironment }) => {
+                            // put dummy promises in storage to tell eyes.close that all checks hepped
+                            putInStorage(exactEnvironment, eyes, Promise.resolve());
+                        });
+                    }
+                } while (!asExpected && Date.now() - start < settings.retryTimeout);
             }
             else {
-                if (driverEnvironment.applitoolsLib.conflictingCapabilities) {
-                    const message = lang.applitoolsLibConflictingCapabilitiesWarning({
-                        conflictingCapabilities: driverEnvironment.applitoolsLib.conflictingCapabilities,
-                    });
-                    logger.console.log(chalk_1.default.yellow(message));
-                    logger.log(message);
-                }
-                const nmlClient = await eyes.core.getNMLClient({
-                    driver,
-                    settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
-                    logger,
+                // generate base targets (images to be compared) and settings for each environment
+                const baseScreenshotsAndSettings = await generateBaseScreenshotsAndSettings(settings, uniqueEnvironments, eyes, logger, driver);
+                // when no retry timeout is set, queue all environment checks against the server without stalling the client test execution
+                baseScreenshotsAndSettings.forEach(({ exactEnvironment: environment, baseSetting, baseTarget }) => {
+                    checkInTheBackground(environment, baseTarget, baseSetting);
                 });
-                if (settings.scrollRootElement || settings.region || (0, to_base_check_settings_1.hasCodedRegions)(settings))
-                    await nmlClient.preTakeScreenshot({ logger });
-                const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
-                    settings: {
-                        ...settings,
-                        ...(await (0, to_base_check_settings_1.extractMobileElementsIntoCheckSettings)({ settings, driver, logger })),
-                    },
-                });
-                const calculate = elementReferences.calculate;
-                const screenshots = await nmlClient.takeScreenshots({
-                    settings: {
-                        environments: uniqueEnvironments,
-                        fully: settings.fully,
-                        stitchMode: settings.stitchMode,
-                        hideScrollbars: settings.hideScrollbars,
-                        hideCaret: settings.hideScrollbars,
-                        overlap: settings.overlap,
-                        waitBeforeCapture: settings.waitBeforeCapture,
-                        waitBetweenStitches: settings.waitBetweenStitches,
-                        lazyLoad: settings.lazyLoad,
-                        name: settings.name,
-                        region: elementReferences.target,
-                        selectorsToFindRegionsFor: calculate.map(({ name }) => name),
-                        scrollRootElement: elementReferences.scrolling,
-                    },
-                    logger,
+            }
+        }
+        else {
+            uniqueEnvironments.forEach(environment => checkInTheBackground(environment, target, settings));
+        }
+        function checkInTheBackground(environment, target, settings) {
+            putInStorage(environment, eyes, checkEnvironment({ eyes, driver, target, environment, signal, logger, settings }));
+        }
+    };
+    function putInStorage(environment, eyes, promise) {
+        const key = (0, to_environment_key_1.toEnvironmentKey)(environment);
+        let item = eyes.storage.get(key);
+        if (!item) {
+            item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
+            eyes.storage.set(key, item);
+        }
+        item.jobs.push(promise.then());
+        return item;
+    }
+}
+exports.makeCheck = makeCheck;
+async function isNewTest({ eyes, driver, environments, logger, }) {
+    const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
+    return (await Promise.all(environments.map(async (environment) => await eyes.getBaseEyes({ settings: { environment, driver }, logger: environmentLogger }))))
+        .map(baseEyes => baseEyes.test.isNew)
+        .some(isNew => isNew);
+}
+async function checkEnvironment({ eyes, driver, target, environment, signal, logger, settings, }) {
+    var _a, _b;
+    const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
+    environmentLogger.log('Command "check" is called with settings', settings);
+    try {
+        if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+            abortError({ logger: environmentLogger, message: 'Command "check" was aborted before checking' });
+        }
+        const baseEyes = await eyes.getBaseEyes({ settings: { environment, driver }, logger: environmentLogger });
+        try {
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                abortError({
+                    logger: environmentLogger,
+                    message: `Command "check" was aborted before checking`,
                 });
-                screenshots.forEach(({ environment, calculateRegions, ...baseTarget }) => {
-                    const aggregateCalculatedRegions = [];
-                    calculate.forEach(({ reference }, index) => {
-                        const regions = calculateRegions === null || calculateRegions === void 0 ? void 0 : calculateRegions[index];
-                        if (regions) {
-                            aggregateCalculatedRegions.push({ regions, selector: reference });
-                        }
-                        else {
-                            logger.log(`Regions "${reference}" was not found in the screenshot`);
-                        }
-                    });
-                    exactEnvironments.push(environment);
-                    baseTargets.push({ ...baseTarget, isTransformed: true });
-                    baseSettings.push(getBaseCheckSettings({
-                        calculatedRegions: aggregateCalculatedRegions,
-                    }));
+            }
+            else if (!baseEyes.running) {
+                abortError({
+                    logger: environmentLogger,
+                    message: `Check on environment with id "${(_a = baseEyes.test.environment) === null || _a === void 0 ? void 0 : _a.environmentId}" was aborted during one of the previous steps`,
                 });
             }
+            return await baseEyes.check({
+                target,
+                settings: settings,
+                logger: environmentLogger,
+            });
         }
-        else {
-            exactEnvironments.push(...uniqueEnvironments);
-            baseTargets.push(target);
-            baseSettings.push(settings);
+        catch (error) {
+            environmentLogger.error(`Check on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" failed due to an error`, error);
+            if (baseEyes.running && !(signal === null || signal === void 0 ? void 0 : signal.aborted))
+                baseEyes.abort({ logger: environmentLogger, settings: { reason: error } });
         }
-        const promises = exactEnvironments.map(async (environment, index) => {
-            var _a, _b, _c;
-            const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
-            try {
-                if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                    environmentLogger.warn('Command "check" was aborted before checking');
-                    throw new abort_error_1.AbortError('Command "check" was aborted before checking');
-                }
-                const baseEyes = await eyes.getBaseEyes({ settings: { environment, driver }, logger: environmentLogger });
-                try {
-                    if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        environmentLogger.warn('Command "check" was aborted before checking');
-                        throw new abort_error_1.AbortError('Command "check" was aborted before checking');
-                    }
-                    else if (!baseEyes.running) {
-                        environmentLogger.warn(`Check on environment with id "${(_a = baseEyes.test.environment) === null || _a === void 0 ? void 0 : _a.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Check on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
-                    }
-                    await baseEyes.check({
-                        target: baseTargets[index],
-                        settings: baseSettings[index],
-                        logger: environmentLogger,
-                    });
-                }
-                catch (error) {
-                    environmentLogger.error(`Check on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" failed due to an error`, error);
-                    if (baseEyes.running && !(signal === null || signal === void 0 ? void 0 : signal.aborted))
-                        await baseEyes.abort({ logger: environmentLogger, settings: { reason: error } });
-                }
+    }
+    catch (error) {
+        environmentLogger.error(`Environment with id ${environment.environmentId} failed before checking started due to an error`, error);
+        error.info = { ...error.info, userTestId: eyes.test.userTestId, environment };
+        throw error;
+    }
+    return { asExpected: false };
+}
+/**
+ * @throws {AbortError}
+ */
+function abortError({ logger, message }) {
+    logger.warn(message);
+    throw new abort_error_1.AbortError(message);
+}
+/**
+ * create base targets (array of screenshots) and base settings (array of check settings) for each environment
+ */
+async function generateBaseScreenshotsAndSettings(settings, uniqueEnvironments, eyes, logger, driver) {
+    var _a;
+    const driverEnvironment = await driver.getEnvironment();
+    uniqueEnvironments = addMobileDeviceInfo(uniqueEnvironments, driverEnvironment);
+    await beforeScreenshot();
+    const shouldTakeWebScreenshot = driverEnvironment.isWeb ||
+        !((_a = driverEnvironment.applitoolsLib) === null || _a === void 0 ? void 0 : _a.instrumented) ||
+        settings.webview ||
+        settings.screenshotMode === 'default';
+    if (shouldTakeWebScreenshot) {
+        return await takeWebScreenshot({
+            driver,
+            settings,
+            environments: uniqueEnvironments,
+            logger,
+            eyes,
+        });
+    }
+    else {
+        // take screenshot using NML
+        checkConflictingCapabilities();
+        return await takeNMLScreenshot({
+            driver,
+            settings,
+            environments: uniqueEnvironments,
+            logger,
+            eyes,
+        });
+    }
+    async function beforeScreenshot() {
+        var _a;
+        await driver.currentContext.setScrollingElement((_a = settings.scrollRootElement) !== null && _a !== void 0 ? _a : null);
+        if (settings.lazyLoad && driverEnvironment.isWeb) {
+            await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                context: driver.currentContext,
+                settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                logger,
+            });
+        }
+    }
+    function checkConflictingCapabilities() {
+        var _a;
+        if ((_a = driverEnvironment.applitoolsLib) === null || _a === void 0 ? void 0 : _a.conflictingCapabilities) {
+            const message = lang.applitoolsLibConflictingCapabilitiesWarning({
+                conflictingCapabilities: driverEnvironment.applitoolsLib.conflictingCapabilities,
+            });
+            logger.console.log(chalk_1.default.yellow(message));
+            logger.log(message);
+        }
+    }
+    function addMobileDeviceInfo(environments, driverEnvironment) {
+        return environments.map(environment => {
+            var _a, _b;
+            var _c, _d;
+            if (utils.types.has(environment, 'iosDeviceInfo')) {
+                (_a = (_c = environment.iosDeviceInfo).version) !== null && _a !== void 0 ? _a : (_c.version = driverEnvironment.platformVersion);
             }
-            catch (error) {
-                environmentLogger.error(`Environment with id ${environment.environmentId} failed before checking started due to an error`, error);
-                error.info = { ...error.info, userTestId: eyes.test.userTestId, environment };
-                throw error;
+            else if (utils.types.has(environment, 'androidDeviceInfo')) {
+                (_b = (_d = environment.androidDeviceInfo).version) !== null && _b !== void 0 ? _b : (_d.version = driverEnvironment.platformVersion);
             }
+            return environment;
+        });
+    }
+}
+async function takeWebScreenshot({ driver, settings, environments, logger, eyes, }) {
+    let actualEnvironments = environments;
+    if (settings.screenshotMode === 'default') {
+        const { localEnvironment, renderEnvironments } = await (0, nml_client_1.getNMLEnvironmentsInfo)({
+            environments: environments,
+            supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl,
+            proxy: eyes.test.eyesServer.proxy,
+            logger,
         });
-        exactEnvironments.forEach((environment, index) => {
-            const key = (0, to_environment_key_1.toEnvironmentKey)(environment);
-            let item = eyes.storage.get(key);
-            if (!item) {
-                item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
-                eyes.storage.set(key, item);
+        actualEnvironments = localEnvironment ? [localEnvironment] : renderEnvironments;
+    }
+    const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({ settings });
+    const screenshots = await (0, take_screenshots_1.takeScreenshots)({
+        driver,
+        settings: {
+            ...settings,
+            environments: actualEnvironments,
+            regionsToCalculate: elementReferences.calculate,
+            calculateView: !!settings.pageId,
+            domSettings: settings.sendDom ? { proxy: eyes.test.eyesServer.proxy } : undefined,
+        },
+        logger,
+    });
+    return screenshots.map(({ calculatedRegions, ...baseTarget }, i) => {
+        return {
+            baseTarget,
+            baseSetting: getBaseCheckSettings({ calculatedRegions }),
+            exactEnvironment: actualEnvironments[i],
+        };
+    });
+}
+async function takeNMLScreenshot({ driver, settings, environments, logger, eyes, }) {
+    const nmlClient = await eyes.core.getNMLClient({
+        driver,
+        settings: { ...eyes.test.eyesServer, supportedEnvironmentsUrl: eyes.test.supportedEnvironmentsUrl },
+        logger,
+    });
+    if (settings.scrollRootElement || settings.region || (0, to_base_check_settings_1.hasCodedRegions)(settings))
+        await nmlClient.preTakeScreenshot({ logger });
+    const { elementReferences, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
+        settings: {
+            ...settings,
+            ...(await (0, to_base_check_settings_1.extractMobileElementsIntoCheckSettings)({ settings, driver, logger })),
+        },
+    });
+    const calculate = elementReferences.calculate;
+    const screenshots = await nmlClient.takeScreenshots({
+        settings: {
+            environments: environments,
+            fully: settings.fully,
+            stitchMode: settings.stitchMode,
+            hideScrollbars: settings.hideScrollbars,
+            hideCaret: settings.hideScrollbars,
+            overlap: settings.overlap,
+            waitBeforeCapture: settings.waitBeforeCapture,
+            waitBetweenStitches: settings.waitBetweenStitches,
+            lazyLoad: settings.lazyLoad,
+            name: settings.name,
+            region: elementReferences.target,
+            selectorsToFindRegionsFor: calculate.map(({ name }) => name),
+            scrollRootElement: elementReferences.scrolling,
+        },
+        logger,
+    });
+    return screenshots.map(({ calculateRegions, ...baseTarget }) => {
+        const aggregateCalculatedRegions = [];
+        calculate.forEach(({ reference }, index) => {
+            const regions = calculateRegions === null || calculateRegions === void 0 ? void 0 : calculateRegions[index];
+            if (regions) {
+                aggregateCalculatedRegions.push({ regions, selector: reference });
+            }
+            else {
+                logger.log(`Regions "${reference}" was not found in the screenshot`);
             }
-            item.jobs.push(promises[index]);
         });
-    };
+        return {
+            baseTarget: { ...baseTarget, isTransformed: true },
+            baseSetting: getBaseCheckSettings({
+                calculatedRegions: aggregateCalculatedRegions,
+            }),
+            exactEnvironment: baseTarget.environment,
+        };
+    });
 }
-exports.makeCheck = makeCheck;

package/dist/core.js

@@ -26,6 +26,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCore = void 0;
 const logger_1 = require("@applitools/logger");
 const core_base_1 = require("@applitools/core-base");
+const core_1 = require("./classic/core");
+const core_2 = require("./ufg/core");
 const get_viewport_size_1 = require("./automation/get-viewport-size");
 const set_viewport_size_1 = require("./automation/set-viewport-size");
 const get_account_info_1 = require("./get-account-info");
@@ -50,6 +52,10 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
     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 });
+    const cores = {
+        ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger }),
+        classic: (0, core_1.makeCore)({ spec, clients, base, logger }),
+    };
     return utils.general.extend(base, core => {
         return {
             base: base,
@@ -58,11 +64,23 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
             getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
             getECClient: (0, get_ec_client_1.makeGetECClient)({ logger }),
             getAccountInfo: (0, get_account_info_1.makeGetAccountInfo)({ core, logger }),
-            makeManager: (0, make_manager_1.makeMakeManager)({ spec, clients, core, agentId, cwd, environment, asyncCache, logger }),
+            // Note: `defaultBase` is passesd for `base`, and `cores` is not passed here on purpose, so that a manager will create its own base, which would apply the correct concurrency value that was passed to the manager.
+            // `defaultBase` is here for testing purposes
+            makeManager: (0, make_manager_1.makeMakeManager)({
+                spec,
+                clients,
+                core,
+                base: defaultBase,
+                agentId,
+                cwd,
+                environment,
+                asyncCache,
+                logger,
+            }),
             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, environment, asyncCache, logger }),
+            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, cores, environment, asyncCache, logger }),
             closeBatch: (0, close_batch_1.makeCloseBatch)({ core, logger }),
             deleteTest: (0, delete_test_1.makeDeleteTest)({ core, logger }),
         };

package/dist/make-manager.js

@@ -44,8 +44,8 @@ function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defa
         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 });
         const cores = {
-            ufg: (0, core_2.makeCore)({ spec, base, fetchConcurrency: settings.fetchConcurrency, asyncCache, logger }),
-            classic: (0, core_1.makeCore)({ spec, base, logger }),
+            ufg: (0, core_2.makeCore)({ spec, clients, base, fetchConcurrency: settings.fetchConcurrency, asyncCache, logger }),
+            classic: (0, core_1.makeCore)({ spec, clients, base, logger }),
         };
         const storage = [];
         return {

package/dist/open-eyes.js

@@ -37,26 +37,27 @@ const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-se
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ type: defaultType = 'classic', clients, batch, 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;
-        var _t, _u, _v, _w, _x;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+        var _u, _v, _w, _x, _y;
         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);
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
         settings.batch = { ...batch, ...settings.batch };
-        (_b = (_t = settings.batch).id) !== null && _b !== void 0 ? _b : (_t.id = (_c = utils.general.getEnvValue('BATCH_ID')) !== null && _c !== void 0 ? _c : `generated-${utils.general.guid()}`);
-        (_d = (_u = settings.batch).buildId) !== null && _d !== void 0 ? _d : (_u.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
-        (_e = (_v = settings.batch).name) !== null && _e !== void 0 ? _e : (_v.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_f = (_w = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : (_w.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_g = (_x = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : (_x.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_b = (_u = settings.batch).id) !== null && _b !== void 0 ? _b : (_u.id = (_c = utils.general.getEnvValue('BATCH_ID')) !== null && _c !== void 0 ? _c : `generated-${utils.general.guid()}`);
+        (_d = (_v = settings.batch).buildId) !== null && _d !== void 0 ? _d : (_v.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
+        (_e = (_w = settings.batch).name) !== null && _e !== void 0 ? _e : (_w.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_f = (_x = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : (_x.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_g = (_y = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : (_y.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.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);
+        (_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);
         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());
@@ -67,7 +68,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, core, cor
                 event: {
                     type: 'openEyes',
                     userTestId: settings.userTestId,
-                    concurrency: (_r = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _r !== void 0 ? _r : core.concurrency,
+                    concurrency: (_s = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _s !== void 0 ? _s : core.concurrency,
                     environment,
                     driver: {
                         deviceName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.deviceName,
@@ -75,7 +76,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, core, cor
                         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: (_s = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _s === void 0 ? void 0 : _s.instrumented,
+                        isApplitoolsLib: (_t = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _t === void 0 ? void 0 : _t.instrumented,
                         isEC: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.isEC,
                     },
                     driverUrl,
@@ -108,3 +109,17 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, core, cor
     };
 }
 exports.makeOpenEyes = makeOpenEyes;
+function getLatestCommitInfoFromEnvVars(logger) {
+    const timestamp = utils.general.getEnvValue('GIT_LATEST_COMMIT_TIMESTAMP');
+    const sha = utils.general.getEnvValue('GIT_LATEST_COMMIT_SHA');
+    if (timestamp && sha) {
+        return { timestamp, sha };
+    }
+    else if (timestamp && !sha) {
+        logger.warn(`APPLITOOLS_GIT_LATEST_COMMIT_TIMESTAMP was provided without APPLITOOLS_GIT_LATEST_COMMIT_SHA. Proceeding provided timestamp ${timestamp} and NO_SHA_PROVIDED`);
+        return { timestamp, sha: 'NO_SHA_PROVIDED' };
+    }
+    else if (sha && !timestamp) {
+        logger.warn(`APPLITOOLS_GIT_LATEST_COMMIT_SHA was provided without APPLITOOLS_GIT_LATEST_COMMIT_TIMESTAMP. Not populating latestCommitInfo with the provided sha ${sha}.`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.13.1",
+  "version": "4.15.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,18 +74,18 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.12.1",
-    "@applitools/dom-capture": "11.2.6",
-    "@applitools/dom-snapshot": "4.11.0",
-    "@applitools/driver": "1.17.1",
-    "@applitools/ec-client": "1.8.3",
+    "@applitools/core-base": "1.14.0",
+    "@applitools/dom-capture": "11.2.7",
+    "@applitools/dom-snapshot": "4.11.1",
+    "@applitools/driver": "1.17.2",
+    "@applitools/ec-client": "1.8.5",
     "@applitools/logger": "2.0.16",
-    "@applitools/nml-client": "1.8.3",
+    "@applitools/nml-client": "1.8.4",
     "@applitools/req": "1.6.7",
-    "@applitools/screenshoter": "3.8.30",
+    "@applitools/screenshoter": "3.8.31",
     "@applitools/snippets": "2.4.25",
     "@applitools/socket": "1.1.16",
-    "@applitools/spec-driver-webdriver": "1.1.6",
+    "@applitools/spec-driver-webdriver": "1.1.7",
     "@applitools/ufg-client": "1.11.2",
     "@applitools/utils": "1.7.2",
     "@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.6",
-    "@applitools/spec-driver-selenium": "^1.5.77",
+    "@applitools/spec-driver-puppeteer": "^1.4.7",
+    "@applitools/spec-driver-selenium": "^1.5.78",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.2",

package/types/automation/types.d.ts

@@ -46,7 +46,7 @@ export type ExactEnvironment = BaseCore.Environment & {
     fallbackBaselineId?: string;
 };
 export type Environment = RenderEnvironment | ExactEnvironment;
-export interface Core<TSpec extends SpecType> extends BaseCore.Core {
+export interface Core<TSpec extends SpecType> extends Omit<BaseCore.Core, 'openEyes'> {
     readonly base: BaseCore.Core;
     getViewportSize?(options: {
         target: DriverTarget<TSpec>;
@@ -84,7 +84,7 @@ export interface Core<TSpec extends SpecType> extends BaseCore.Core {
         logger?: Logger;
     }): Promise<string[]>;
 }
-export interface Eyes<TSpec extends SpecType> extends BaseCore.Eyes {
+export interface Eyes<TSpec extends SpecType> extends Omit<BaseCore.Eyes, 'core' | 'check' | 'checkAndClose'> {
     readonly core: Core<TSpec>;
     readonly storage: EyesStorage;
     getBaseEyes(options: {