@applitools/core 3.9.1 → 3.10.1

package/dist/open-eyes.js

@@ -31,12 +31,13 @@ const get_typed_eyes_1 = require("./get-typed-eyes");
 const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
 const close_1 = require("./close");
+const abort_1 = require("./abort");
 const get_eyes_results_1 = require("./get-eyes-results");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core, cores, spec, environment, logger: mainLogger, }) {
+function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, }) {
     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;
-        var _u, _v, _w, _x;
+        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;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...settings };
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
@@ -44,10 +45,10 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
         (_f = settings.apiKey) !== null && _f !== void 0 ? _f : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         (_g = settings.useDnsCache) !== null && _g !== void 0 ? _g : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
         settings.batch = { ...batch, ...settings.batch };
-        (_h = (_u = settings.batch).id) !== null && _h !== void 0 ? _h : (_u.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
-        (_k = (_v = settings.batch).name) !== null && _k !== void 0 ? _k : (_v.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_l = (_w = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_w.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_m = (_x = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_x.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_h = (_v = settings.batch).id) !== null && _h !== void 0 ? _h : (_v.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
+        (_k = (_w = settings.batch).name) !== null && _k !== void 0 ? _k : (_w.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_l = (_x = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_x.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_m = (_y = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_y.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
         (_o = settings.keepBatchOpen) !== null && _o !== void 0 ? _o : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
         (_p = settings.branchName) !== null && _p !== void 0 ? _p : (settings.branchName = utils.general.getEnvValue('BRANCH'));
         (_q = settings.parentBranchName) !== null && _q !== void 0 ? _q : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
@@ -55,6 +56,7 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
         (_s = settings.ignoreBaseline) !== null && _s !== void 0 ? _s : (settings.ignoreBaseline = false);
         (_t = settings.compareWithParentBranch) !== null && _t !== void 0 ? _t : (settings.compareWithParentBranch = false);
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }));
+        const renderers = (_u = config === null || config === void 0 ? void 0 : config.check) === null || _u === void 0 ? void 0 : _u.renderers;
         core.logEvent({
             settings: {
                 ...settings,
@@ -73,8 +75,8 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
             settings: settings,
             target: driver,
             cores: cores !== null && cores !== void 0 ? cores : {
-                ufg: (0, core_2.makeCore)({ spec, base: core.base, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, logger }),
-                classic: (0, core_1.makeCore)({ spec, base: core.base, logger }),
+                ufg: (0, core_2.makeCore)({ spec, clients, base: core.base, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, logger }),
+                classic: (0, core_1.makeCore)({ spec, clients, base: core.base, logger }),
             },
             logger,
         });
@@ -83,7 +85,8 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
             getTypedEyes,
             check: (0, check_1.makeCheck)({ type, eyes, target: driver, spec, logger }),
             checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, eyes, target: driver, spec, logger }),
-            close: (0, close_1.makeClose)({ eyes, logger }),
+            close: (0, close_1.makeClose)({ eyes, renderers, logger }),
+            abort: (0, abort_1.makeAbort)({ eyes, renderers, logger }),
             getResults: (0, get_eyes_results_1.makeGetEyesResults)({ eyes, logger }),
         })); // TODO solve the types issue
     };

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

@@ -32,11 +32,12 @@ const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
-const uniquify_renderers_1 = require("./utils/uniquify-renderers");
+const uniquify_renderers_1 = require("../automation/utils/uniquify-renderers");
+const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal, logger: mainLogger, }) {
+function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRenderers = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         logger = logger.extend(mainLogger);
@@ -48,7 +49,7 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
         const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings,
         });
-        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
+        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : defaultRenderers);
         const ufgClient = await eyes.core.getUFGClient({
             settings: {
                 ...eyes.test.ufgServer,
@@ -69,15 +70,6 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
             : null;
         if (driver) {
             const environment = await driver.getEnvironment();
-            if (uniqueRenderers.length === 0) {
-                if (environment.isWeb) {
-                    const viewportSize = await driver.getViewportSize();
-                    uniqueRenderers.push({ name: 'chrome', ...viewportSize });
-                }
-                else {
-                    // TODO add default nmg renderers
-                }
-            }
             let cleanupGeneratedSelectors;
             if (environment.isWeb) {
                 userAgent = await driver.getUserAgentLegacy();
@@ -111,37 +103,49 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                     : undefined;
             }
             const currentContext = driver.currentContext;
-            const snapshotOptions = {
-                settings: {
-                    ...eyes.test.eyesServer,
-                    waitBeforeCapture: settings.waitBeforeCapture,
-                    disableBrowserFetching: settings.disableBrowserFetching,
-                    layoutBreakpoints: settings.layoutBreakpoints,
-                    renderers: uniqueRenderers,
-                    skipResources: ufgClient.getCachedResourceUrls(),
-                },
-                hooks: {
-                    async beforeSnapshots() {
-                        if (settings.lazyLoad && environment.isWeb) {
-                            await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-                                context: driver.currentContext,
-                                settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-                                logger,
-                            });
-                        }
-                    },
-                },
-                provides: {
-                    getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
-                    getIOSDevices: ufgClient.getIOSDevices,
-                },
-            };
             if (environment.isWeb) {
-                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, ...snapshotOptions, logger });
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+                    driver,
+                    settings: {
+                        ...eyes.test.eyesServer,
+                        waitBeforeCapture: settings.waitBeforeCapture,
+                        disableBrowserFetching: settings.disableBrowserFetching,
+                        layoutBreakpoints: settings.layoutBreakpoints,
+                        renderers: uniqueRenderers,
+                        skipResources: ufgClient.getCachedResourceUrls(),
+                    },
+                    hooks: {
+                        async beforeSnapshots() {
+                            if (settings.lazyLoad && environment.isWeb) {
+                                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                                    context: driver.currentContext,
+                                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                                    logger,
+                                });
+                            }
+                        },
+                    },
+                    provides: {
+                        getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
+                        getIOSDevices: ufgClient.getIOSDevices,
+                    },
+                    logger,
+                });
             }
             else {
-                const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.eyesServer, driver, logger });
-                snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
+                const nmlClient = await eyes.core.getNMLClient({
+                    driver,
+                    settings: { ...eyes.test.eyesServer, renderEnvironmentsUrl: eyes.test.renderEnvironmentsUrl },
+                    logger,
+                });
+                snapshots = (await nmlClient.takeSnapshots({
+                    settings: {
+                        ...eyes.test.eyesServer,
+                        waitBeforeCapture: settings.waitBeforeCapture,
+                        renderers: uniqueRenderers,
+                    },
+                    logger,
+                }));
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
@@ -157,9 +161,10 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
             originalSelector: selector,
             safeSelector: selector,
         })));
-        const promises = uniqueRenderers.map(async ({ properties, ...renderer }, index) => {
+        const promises = uniqueRenderers.map(async (renderer, index) => {
             const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
-            if (utils.types.has(renderer, 'name') && renderer.name === 'edge') {
+            const ufgRenderer = renderer;
+            if (utils.types.has(ufgRenderer, 'name') && ufgRenderer.name === 'edge') {
                 const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
                 rendererLogger.console.log(message);
             }
@@ -169,13 +174,13 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
                 const { cookies, ...snapshot } = snapshots[index];
-                if (utils.types.has(renderer, 'iosDeviceInfo') || utils.types.has(renderer, 'androidDeviceInfo')) {
-                    renderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
+                if (utils.types.has(ufgRenderer, 'iosDeviceInfo') || utils.types.has(ufgRenderer, 'androidDeviceInfo')) {
+                    ufgRenderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
                 }
                 const renderTargetPromise = ufgClient.createRenderTarget({
                     snapshot,
                     settings: {
-                        renderer,
+                        renderer: ufgRenderer,
                         cookies,
                         headers: {
                             Referer: snapshotUrl,
@@ -187,7 +192,7 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                     },
                     logger: rendererLogger,
                 });
-                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, properties }, logger });
+                const baseEyes = await eyes.getBaseEyes({ settings: { renderer }, logger });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                         rendererLogger.warn('Command "check" was aborted before rendering');
@@ -214,7 +219,7 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                             scrollRootElement: scrollRootSelector,
                             selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: !!settings.pageId,
-                            renderer,
+                            renderer: ufgRenderer,
                             renderEnvironmentId: baseEyes.test.renderEnvironmentId,
                             uploadUrl: baseEyes.test.uploadUrl,
                             stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
@@ -245,7 +250,6 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                         settings: baseSettings,
                         logger: rendererLogger,
                     });
-                    return { eyes: baseEyes, renderer };
                 }
                 catch (error) {
                     rendererLogger.error(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" failed due to an error`, error);
@@ -255,15 +259,19 @@ function makeCheckAndClose({ eyes, storage, target: defaultTarget, spec, signal,
                 }
             }
             catch (error) {
-                rendererLogger.error(`Renderer with id ${renderer.id} failed before rendering started due to an error`, error);
-                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
+                rendererLogger.error(`Renderer with id ${ufgRenderer.id} failed before rendering started due to an error`, error);
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer: ufgRenderer };
                 throw error;
             }
         });
         uniqueRenderers.forEach((renderer, index) => {
-            var _a;
-            const key = JSON.stringify(renderer);
-            storage.set(key, [...((_a = storage.get(key)) !== null && _a !== void 0 ? _a : []), promises[index]]);
+            const key = (0, extract_renderer_key_1.extractRendererKey)(renderer);
+            let item = eyes.storage.get(key);
+            if (!item) {
+                item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
+                eyes.storage.set(key, item);
+            }
+            item.jobs.push(promises[index]);
         });
     };
 }

package/dist/ufg/check.js

@@ -32,11 +32,12 @@ const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const generate_safe_selectors_1 = require("./utils/generate-safe-selectors");
-const uniquify_renderers_1 = require("./utils/uniquify-renderers");
+const uniquify_renderers_1 = require("../automation/utils/uniquify-renderers");
+const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger: mainLogger, }) {
+function makeCheck({ eyes, target: defaultTarget, renderers: defaultRenderers = [], spec, signal, logger: mainLogger, }) {
     return async function check({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         logger = logger.extend(mainLogger);
@@ -48,7 +49,7 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
         const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings,
         });
-        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
+        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : defaultRenderers);
         const ufgClient = await eyes.core.getUFGClient({
             settings: {
                 ...eyes.test.ufgServer,
@@ -70,15 +71,6 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
         if (driver) {
             const environment = await driver.getEnvironment();
             await driver.currentContext.setScrollingElement((_b = settings.scrollRootElement) !== null && _b !== void 0 ? _b : null);
-            if (uniqueRenderers.length === 0) {
-                if (environment.isWeb) {
-                    const viewportSize = await driver.getViewportSize();
-                    uniqueRenderers.push({ name: 'chrome', ...viewportSize });
-                }
-                else {
-                    // TODO add default nmg renderers
-                }
-            }
             let cleanupGeneratedSelectors;
             if (environment.isWeb) {
                 userAgent = await driver.getUserAgentLegacy();
@@ -112,37 +104,49 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                     : undefined;
             }
             const currentContext = driver.currentContext;
-            const snapshotOptions = {
-                settings: {
-                    ...eyes.test.eyesServer,
-                    waitBeforeCapture: settings.waitBeforeCapture,
-                    disableBrowserFetching: settings.disableBrowserFetching,
-                    layoutBreakpoints: settings.layoutBreakpoints,
-                    renderers: uniqueRenderers,
-                    skipResources: ufgClient.getCachedResourceUrls(),
-                },
-                hooks: {
-                    async beforeSnapshots() {
-                        if (settings.lazyLoad && environment.isWeb) {
-                            await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-                                context: driver.currentContext,
-                                settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-                                logger,
-                            });
-                        }
-                    },
-                },
-                provides: {
-                    getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
-                    getIOSDevices: ufgClient.getIOSDevices,
-                },
-            };
             if (environment.isWeb) {
-                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({ driver, ...snapshotOptions, logger });
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+                    driver,
+                    settings: {
+                        ...eyes.test.eyesServer,
+                        waitBeforeCapture: settings.waitBeforeCapture,
+                        disableBrowserFetching: settings.disableBrowserFetching,
+                        layoutBreakpoints: settings.layoutBreakpoints,
+                        renderers: uniqueRenderers,
+                        skipResources: ufgClient.getCachedResourceUrls(),
+                    },
+                    hooks: {
+                        async beforeSnapshots() {
+                            if (settings.lazyLoad && environment.isWeb) {
+                                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+                                    context: driver.currentContext,
+                                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+                                    logger,
+                                });
+                            }
+                        },
+                    },
+                    provides: {
+                        getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
+                        getIOSDevices: ufgClient.getIOSDevices,
+                    },
+                    logger,
+                });
             }
             else {
-                const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.eyesServer, driver, logger });
-                snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
+                const nmlClient = await eyes.core.getNMLClient({
+                    driver,
+                    settings: { ...eyes.test.eyesServer, renderEnvironmentsUrl: eyes.test.renderEnvironmentsUrl },
+                    logger,
+                });
+                snapshots = (await nmlClient.takeSnapshots({
+                    settings: {
+                        ...eyes.test.eyesServer,
+                        waitBeforeCapture: settings.waitBeforeCapture,
+                        renderers: uniqueRenderers,
+                    },
+                    logger,
+                }));
             }
             await currentContext.focus();
             snapshotUrl = await driver.getUrl();
@@ -158,9 +162,10 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
             originalSelector: selector,
             safeSelector: selector,
         })));
-        const promises = uniqueRenderers.map(async ({ properties, ...renderer }, index) => {
+        const promises = uniqueRenderers.map(async (renderer, index) => {
             const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
-            if (utils.types.has(renderer, 'name') && renderer.name === 'edge') {
+            const ufgRenderer = renderer;
+            if (utils.types.has(ufgRenderer, 'name') && ufgRenderer.name === 'edge') {
                 const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
                 rendererLogger.console.log(message);
             }
@@ -170,13 +175,13 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
                 const { cookies, ...snapshot } = snapshots[index];
-                if (utils.types.has(renderer, 'iosDeviceInfo') || utils.types.has(renderer, 'androidDeviceInfo')) {
-                    renderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
+                if (utils.types.has(ufgRenderer, 'iosDeviceInfo') || utils.types.has(ufgRenderer, 'androidDeviceInfo')) {
+                    ufgRenderer.type = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
                 }
                 const renderTargetPromise = ufgClient.createRenderTarget({
                     snapshot,
                     settings: {
-                        renderer,
+                        renderer: ufgRenderer,
                         cookies,
                         headers: {
                             Referer: snapshotUrl,
@@ -188,7 +193,7 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                     },
                     logger: rendererLogger,
                 });
-                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, properties }, logger: rendererLogger });
+                const baseEyes = await eyes.getBaseEyes({ settings: { renderer }, logger: rendererLogger });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                         rendererLogger.warn('Command "check" was aborted before rendering');
@@ -215,7 +220,7 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                             scrollRootElement: scrollRootSelector,
                             selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
                             includeFullPageSize: Boolean(settings.pageId),
-                            renderer,
+                            renderer: ufgRenderer,
                             renderEnvironmentId: baseEyes.test.renderEnvironmentId,
                             uploadUrl: baseEyes.test.uploadUrl,
                             stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
@@ -246,11 +251,6 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                         settings: baseSettings,
                         logger: rendererLogger,
                     });
-                    if (!baseEyes.running) {
-                        rendererLogger.warn(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" was aborted during one of the previous steps`);
-                    }
-                    return { eyes: baseEyes, renderer };
                 }
                 catch (error) {
                     rendererLogger.error(`Render on environment with id "${baseEyes.test.renderEnvironmentId}" failed due to an error`, error);
@@ -261,16 +261,19 @@ function makeCheck({ eyes, storage, target: defaultTarget, spec, signal, logger:
                 }
             }
             catch (error) {
-                rendererLogger.error(`Renderer with id ${renderer.id} failed before rendering started due to an error`, error);
-                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
+                rendererLogger.error(`Renderer with id ${ufgRenderer.id} failed before rendering started due to an error`, error);
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer: ufgRenderer };
                 throw error;
             }
         });
-        return uniqueRenderers.map((renderer, index) => {
-            var _a;
-            const key = JSON.stringify(renderer);
-            storage.set(key, [...((_a = storage.get(key)) !== null && _a !== void 0 ? _a : []), promises[index]]);
-            return { asExpected: true, userTestId: eyes.test.userTestId, renderer };
+        uniqueRenderers.forEach((renderer, index) => {
+            const key = (0, extract_renderer_key_1.extractRendererKey)(renderer);
+            let item = eyes.storage.get(key);
+            if (!item) {
+                item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
+                eyes.storage.set(key, item);
+            }
+            item.jobs.push(promises[index]);
         });
     };
 }

package/dist/ufg/core.js

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

package/dist/ufg/get-base-eyes.js

@@ -25,17 +25,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetBaseEyes = void 0;
 const utils = __importStar(require("@applitools/utils"));
-function makeGetBaseEyes({ settings: defaultSettings, eyes, base, logger: mainLogger, }) {
-    const getBaseEyesWithCache = utils.general.cachify(getBaseEyes, ([options]) => { var _a; return (_a = options === null || options === void 0 ? void 0 : options.settings) === null || _a === void 0 ? void 0 : _a.renderer; });
-    if (base) {
-        base.forEach(baseEyes => getBaseEyesWithCache.setCachedValue(baseEyes.test.renderer, Promise.resolve([baseEyes])));
-    }
+function makeGetBaseEyes({ settings: defaultSettings, eyes, logger: mainLogger, }) {
+    const getBaseEyesWithCache = utils.general.wrap(getBaseEyes, (getBaseEyes, options) => {
+        const key = JSON.stringify(options.settings.renderer);
+        let item = eyes.storage.get(key);
+        if (!item) {
+            item = { eyes: utils.promises.makeControlledPromise(), jobs: [] };
+            eyes.storage.set(key, item);
+        }
+        if (!item.eyes.settled)
+            item.eyes.resolve(getBaseEyes(options));
+        return item.eyes;
+    });
     return getBaseEyesWithCache;
-    async function getBaseEyes({ settings, logger = mainLogger, } = {}) {
+    async function getBaseEyes({ settings, logger = mainLogger, }) {
         logger = logger.extend(mainLogger);
         logger.log(`Command "getBaseEyes" is called with settings`, settings);
-        if (!settings)
-            throw new Error('');
         const ufgClient = await eyes.core.getUFGClient({
             settings: {
                 ...eyes.test.ufgServer,
@@ -44,13 +49,17 @@ function makeGetBaseEyes({ settings: defaultSettings, eyes, base, logger: mainLo
             },
             logger,
         });
-        const environment = await ufgClient.getRenderEnvironment({ settings, logger });
-        environment.properties = settings.properties;
-        const baseEyes = await eyes.core.base.openEyes({
-            settings: { ...defaultSettings, environment: { ...defaultSettings.environment, ...environment } },
+        const environment = await ufgClient.getRenderEnvironment({
+            settings: { renderer: settings.renderer },
+            logger,
+        });
+        return eyes.core.base.openEyes({
+            settings: {
+                ...defaultSettings,
+                environment: { ...defaultSettings.environment, ...environment, properties: settings.renderer.properties },
+            },
             logger,
         });
-        return [baseEyes];
     }
 }
 exports.makeGetBaseEyes = makeGetBaseEyes;

package/dist/ufg/open-eyes.js

@@ -28,35 +28,33 @@ const driver_1 = require("@applitools/driver");
 const get_base_eyes_1 = require("./get-base-eyes");
 const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
-const close_1 = require("./close");
-const abort_1 = require("./abort");
-const get_results_1 = require("./get-results");
+const close_1 = require("../automation/close");
+const abort_1 = require("../automation/abort");
+const get_results_1 = require("../automation/get-results");
+const extract_default_renderers_1 = require("./utils/extract-default-renderers");
 const abort_controller_1 = require("abort-controller");
 const utils = __importStar(require("@applitools/utils"));
 function makeOpenEyes({ core, spec, logger: mainLogger }) {
-    return async function openEyes({ target, settings, base, logger = mainLogger, }) {
-        var _a, _b;
+    return async function openEyes({ target, settings, storage = new Map(), logger = mainLogger, }) {
+        var _a, _b, _c;
         logger = logger.extend(mainLogger);
-        logger.log(`Command "openEyes" is called with ${target ? 'default driver and' : ''}`, ...(settings ? ['settings', settings] : []), base ? 'predefined eyes' : '');
+        logger.log(`Command "openEyes" is called with ${target ? 'default driver' : ''}`, ...(settings ? ['and settings', settings] : []), storage.size > 0 ? 'and default eyes storage' : '');
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger }));
-        if (driver && !base) {
-            const environment = await (driver === null || driver === void 0 ? void 0 : driver.getEnvironment());
-            const currentContext = driver.currentContext;
-            (_a = settings.environment) !== null && _a !== void 0 ? _a : (settings.environment = {});
-            if (environment.isEC) {
-                settings.environment.ecSessionId = (_b = (await driver.getSessionId())) !== null && _b !== void 0 ? _b : undefined;
-            }
-            if (settings.environment.viewportSize) {
+        if (driver && storage.size === 0) {
+            const environment = await driver.getEnvironment();
+            if (((_a = settings.environment) === null || _a === void 0 ? void 0 : _a.viewportSize) && !environment.isMobile) {
                 await driver.setViewportSize(settings.environment.viewportSize);
             }
-            await currentContext.focus();
+            (_b = settings.environment) !== null && _b !== void 0 ? _b : (settings.environment = {});
+            if (environment.isEC) {
+                settings.environment.ecSessionId = (_c = (await driver.getSessionId())) !== null && _c !== void 0 ? _c : undefined;
+            }
         }
+        const renderers = await (0, extract_default_renderers_1.extractDefaultRenderers)({ driver });
         const controller = new abort_controller_1.AbortController();
         const account = await core.getAccountInfo({ settings, logger });
         return utils.general.extend({}, eyes => {
             var _a;
-            const storage = new Map();
-            let running = true;
             return {
                 type: 'ufg',
                 core,
@@ -68,28 +66,17 @@ function makeOpenEyes({ core, spec, logger: mainLogger }) {
                     ufgServer: account.ufgServer,
                     uploadUrl: account.uploadUrl,
                     stitchingServiceUrl: account.stitchingServiceUrl,
+                    renderEnvironmentsUrl: account.renderEnvironmentsUrl,
                     account,
                 },
-                get running() {
-                    return running;
-                },
-                getBaseEyes: (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, base, logger }),
-                // check with indexing and storage
-                check: (0, check_1.makeCheck)({ eyes, storage, target: driver, spec, signal: controller.signal, logger }),
-                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, storage, target: driver, spec, signal: controller.signal, logger }),
-                close: utils.general.wrap((0, close_1.makeClose)({ storage, target: driver, logger }), async (close, options) => {
-                    if (!running)
-                        return;
-                    running = false;
-                    return close(options);
-                }),
-                abort: utils.general.wrap((0, abort_1.makeAbort)({ storage, target: driver, spec, controller, logger }), async (abort, options) => {
-                    if (!running)
-                        return;
-                    running = false;
-                    return abort(options);
-                }),
-                getResults: (0, get_results_1.makeGetResults)({ storage, logger }),
+                running: true,
+                storage,
+                getBaseEyes: (0, get_base_eyes_1.makeGetBaseEyes)({ settings, eyes, logger }),
+                check: (0, check_1.makeCheck)({ eyes, target: driver, renderers, spec, signal: controller.signal, logger }),
+                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ eyes, target: driver, renderers, spec, signal: controller.signal, logger }),
+                close: (0, close_1.makeClose)({ eyes, target: driver, logger }),
+                abort: (0, abort_1.makeAbort)({ eyes, target: driver, spec, controller, logger }),
+                getResults: (0, get_results_1.makeGetResults)({ eyes, logger }),
             };
         });
     };