@applitools/core 2.5.2 → 2.5.3-legacy

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

@@ -28,239 +28,174 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
-const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
-const take_vhses_1 = require("./utils/take-vhses");
-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_environments_1 = require("../automation/utils/uniquify-environments");
+const to_environment_key_1 = require("../automation/utils/to-environment-key");
 const abort_error_1 = require("../errors/abort-error");
 const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
-function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger: defaultLogger, }) {
-    return async function checkAndClose({ target = defaultTarget, settings = {}, logger = defaultLogger, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+const take_snapshots_1 = require("./take-snapshots");
+const create_render_target_from_snapshot_1 = require("./create-render-target-from-snapshot");
+function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
+    return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
+        var _a;
+        logger = logger.extend(mainLogger);
         logger.log('Command "checkAndClose" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
             logger.warn('Command "checkAndClose" was called after test was already aborted');
             throw new abort_error_1.AbortError('Command "checkAndClose" was called after test was already aborted');
         }
-        const { elementReferencesToCalculate, elementReferenceToTarget, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
-            settings,
-        });
-        const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
+        const uniqueEnvironments = (0, uniquify_environments_1.uniquifyEnvironments)((_a = settings.environments) !== null && _a !== void 0 ? _a : defaultEnvironments);
         const ufgClient = await eyes.core.getUFGClient({
-            config: { ...eyes.test.ufgServer },
-            concurrency: uniqueRenderers.length || 5,
+            settings: {
+                ...eyes.test.ufgServer,
+                eyesServerUrl: eyes.test.eyesServer.eyesServerUrl,
+                apiKey: eyes.test.eyesServer.apiKey,
+            },
             logger,
         });
         let snapshots;
-        let snapshotUrl;
-        let snapshotTitle;
-        let userAgent;
-        let regionToTarget;
-        let scrollRootSelector;
-        let selectorsToCalculate;
-        const driver = spec && (0, driver_1.isDriver)(target, spec) ? await (0, driver_1.makeDriver)({ spec, driver: target, logger }) : 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 = (_b = (await driver.getUserAgentLegacy())) !== null && _b !== void 0 ? _b : undefined;
-                const generated = await (0, generate_safe_selectors_1.generateSafeSelectors)({
-                    context: driver.currentContext,
-                    elementReferences: [
-                        ...(elementReferenceToTarget ? [elementReferenceToTarget] : []),
-                        ...(settings.scrollRootElement ? [settings.scrollRootElement] : []),
-                        ...elementReferencesToCalculate,
-                    ],
-                });
-                cleanupGeneratedSelectors = generated.cleanupGeneratedSelectors;
-                selectorsToCalculate = generated.selectors;
-                if (elementReferenceToTarget) {
-                    if (!((_c = selectorsToCalculate[0]) === null || _c === void 0 ? void 0 : _c.safeSelector))
-                        throw new Error('Target element not found');
-                    regionToTarget = selectorsToCalculate[0].safeSelector;
-                    selectorsToCalculate = selectorsToCalculate.slice(1);
-                }
-                if (settings.scrollRootElement) {
-                    scrollRootSelector = (_d = selectorsToCalculate[0].safeSelector) !== null && _d !== void 0 ? _d : undefined;
-                    selectorsToCalculate = selectorsToCalculate.slice(1);
-                }
-            }
-            else {
-                regionToTarget = (0, driver_1.isSelector)(elementReferenceToTarget)
-                    ? (_f = (_e = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _e === void 0 ? void 0 : _e.call(spec, settings.scrollRootElement)) !== null && _f !== void 0 ? _f : undefined
-                    : undefined;
-                scrollRootSelector = (0, driver_1.isSelector)(settings.scrollRootElement)
-                    ? (_h = (_g = spec === null || spec === void 0 ? void 0 : spec.untransformSelector) === null || _g === void 0 ? void 0 : _g.call(spec, settings.scrollRootElement)) !== null && _h !== void 0 ? _h : undefined
-                    : undefined;
-            }
-            const currentContext = driver.currentContext;
-            const snapshotOptions = {
-                settings: {
-                    ...eyes.test.server,
-                    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 });
-            }
-            else {
-                const nmlClient = await eyes.core.getNMLClient({ config: eyes.test.server, driver, logger });
-                if (nmlClient) {
-                    snapshots = (await nmlClient.takeSnapshots({ ...snapshotOptions, logger }));
-                }
-                else {
-                    snapshots = await (0, take_vhses_1.takeVHSes)({ driver, ...snapshotOptions, logger });
-                }
-            }
-            await currentContext.focus();
-            snapshotUrl = await driver.getUrl();
-            snapshotTitle = await driver.getTitle();
-            await (cleanupGeneratedSelectors === null || cleanupGeneratedSelectors === void 0 ? void 0 : cleanupGeneratedSelectors());
+        let driver;
+        if (spec && (0, driver_1.isDriver)(target, spec)) {
+            const takeSnapshots = (0, take_snapshots_1.makeTakeSnapshots)({ core: eyes.core, spec, signal, logger });
+            driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+            snapshots = await takeSnapshots({
+                driver,
+                account: eyes.test.account,
+                settings: { ...settings, environments: uniqueEnvironments },
+                logger,
+            });
         }
         else {
-            snapshots = !utils.types.isArray(target) ? Array(uniqueRenderers.length).fill(target) : target;
-            snapshotUrl = utils.types.has(snapshots[0], 'url') ? snapshots[0].url : undefined;
+            // TODO (amit)
+            snapshots = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
         }
-        regionToTarget !== null && regionToTarget !== void 0 ? regionToTarget : (regionToTarget = (_j = elementReferenceToTarget) !== null && _j !== void 0 ? _j : settings.region);
-        selectorsToCalculate !== null && selectorsToCalculate !== void 0 ? selectorsToCalculate : (selectorsToCalculate = elementReferencesToCalculate.map(selector => ({
-            originalSelector: selector,
-            safeSelector: selector,
-        })));
-        const promises = uniqueRenderers.map(async (renderer, index) => {
-            if (utils.types.has(renderer, 'name') && renderer.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.`);
-                logger.console.log(message);
+        const promises = snapshots.map(async (snapshot, i) => {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
+            const { target } = snapshot;
+            const environment = uniqueEnvironments[i];
+            if (utils.types.has(environment, 'name') && environment.name === 'edge') {
+                environmentLogger.console.log(chalk_1.default.yellow(lang.edgeUfgEnvironmentDeprecatedWarning));
             }
             try {
                 if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                    logger.warn('Command "check" was aborted before rendering');
+                    environmentLogger.warn('Command "check" was aborted before rendering');
                     throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                 }
-                const { cookies, ...snapshot } = snapshots[index];
-                const snapshotType = utils.types.has(snapshot, 'cdt') ? 'web' : 'native';
-                const renderTargetPromise = ufgClient.createRenderTarget({
-                    snapshot,
-                    settings: {
-                        renderer,
-                        referer: snapshotUrl,
-                        cookies,
-                        proxy: eyes.test.server.proxy,
-                        autProxy: settings.autProxy,
-                        userAgent,
-                    },
-                });
-                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, type: snapshotType }, logger });
+                if (utils.types.has(environment, 'iosDeviceInfo') || utils.types.has(environment, 'androidDeviceInfo')) {
+                    environment.type = utils.types.has(target, 'cdt') ? 'web' : 'native';
+                }
+                const renderTargetPromise = (0, create_render_target_from_snapshot_1.createRenderTargetFromSnapshot)({ ufgClient, snapshot, logger: environmentLogger });
+                const baseEyes = await eyes.getBaseEyes({ settings: { environment, driver }, logger });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        logger.warn('Command "check" was aborted before rendering');
+                        environmentLogger.warn('Command "check" was aborted before rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_a = baseEyes.test.environment) === null || _a === void 0 ? void 0 : _a.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_b = baseEyes.test.environment) === null || _b === void 0 ? void 0 : _b.environmentId}" was aborted during one of the previous steps`);
                     }
                     const renderTarget = await renderTargetPromise;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        logger.warn('Command "check" was aborted before rendering');
+                        environmentLogger.warn('Command "check" was aborted before rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted before rendering');
                     }
                     else if (!baseEyes.running) {
-                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_c = baseEyes.test.environment) === null || _c === void 0 ? void 0 : _c.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_d = baseEyes.test.environment) === null || _d === void 0 ? void 0 : _d.environmentId}" was aborted during one of the previous steps`);
                     }
+                    const { elementReferences: selectors, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
+                        settings: snapshot.settings,
+                    });
                     const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
-                            ...settings,
-                            region: regionToTarget,
-                            scrollRootElement: scrollRootSelector,
-                            selectorsToCalculate: selectorsToCalculate.flatMap(({ safeSelector }) => safeSelector !== null && safeSelector !== void 0 ? safeSelector : []),
-                            includeFullPageSize: Boolean(settings.pageId),
-                            type: snapshotType,
-                            renderer,
-                            rendererUniqueId: baseEyes.test.rendererUniqueId,
-                            rendererId: baseEyes.test.rendererId,
+                            ...snapshot.settings,
+                            region: (_e = selectors.target) !== null && _e !== void 0 ? _e : snapshot.settings.region,
+                            scrollRootElement: selectors.scrolling,
+                            selectorsToCalculate: selectors.calculate,
+                            includeFullPageSize: Boolean(snapshot.settings.pageId),
+                            environment: { ...environment, environmentId: baseEyes.test.environment.environmentId },
+                            uploadUrl: baseEyes.test.uploadUrl,
+                            stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
                         },
                         signal,
+                        logger: environmentLogger,
                     });
-                    let offset = 0;
                     const baseSettings = getBaseCheckSettings({
-                        calculatedRegions: selectorsToCalculate.map(({ originalSelector, safeSelector }) => ({
-                            selector: originalSelector !== null && originalSelector !== void 0 ? originalSelector : undefined,
-                            regions: safeSelector ? selectorRegions[offset++] : [],
-                        })),
+                        calculatedRegions: selectors.calculate.map((_, index) => {
+                            var _a;
+                            return ({
+                                regions: (_a = selectorRegions === null || selectorRegions === void 0 ? void 0 : selectorRegions[index]) !== null && _a !== void 0 ? _a : [],
+                            });
+                        }),
                     });
                     baseSettings.renderId = renderId;
-                    baseTarget.source = snapshotUrl;
-                    baseTarget.name = snapshotTitle;
+                    baseTarget.source = snapshot.url;
+                    baseTarget.name = snapshot.title;
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
-                        logger.warn('Command "check" was aborted after rendering');
+                        environmentLogger.warn('Command "check" was aborted after rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted after rendering');
                     }
                     else if (!baseEyes.running) {
-                        logger.warn(`Renderer with id ${baseEyes.test.rendererId} was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Renderer with id "${baseEyes.test.rendererId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_f = baseEyes.test.environment) === null || _f === void 0 ? void 0 : _f.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_g = baseEyes.test.environment) === null || _g === void 0 ? void 0 : _g.environmentId}" was aborted during one of the previous steps`);
+                    }
+                    if (settings.assumesMutability) {
+                        void eyes.core.logEvent({
+                            settings: {
+                                level: 'Notice',
+                                event: {
+                                    type: 'eyes.check',
+                                    message: 'Assuming mutability for check Target',
+                                    test: {
+                                        checkName: settings.name,
+                                        batchId: baseEyes.test.batchId,
+                                        sessionId: baseEyes.test.sessionId,
+                                        testName: baseEyes.test.testName,
+                                        testId: baseEyes.test.testId,
+                                        userTestId: baseEyes.test.userTestId,
+                                        appId: baseEyes.test.appId,
+                                        baselineId: baseEyes.test.baselineId,
+                                        environmentId: (_h = baseEyes.test.environment) === null || _h === void 0 ? void 0 : _h.environmentId,
+                                    },
+                                    isNew: baseEyes.test.isNew,
+                                    resultsUrl: baseEyes.test.resultsUrl,
+                                },
+                                ...eyes.test.eyesServer,
+                            },
+                        });
                     }
-                    const [result] = await baseEyes.checkAndClose({
+                    await baseEyes.checkAndClose({
                         target: { ...baseTarget, isTransformed: true },
                         settings: baseSettings,
-                        logger,
+                        logger: environmentLogger,
                     });
-                    return { ...result, eyes: baseEyes, renderer };
                 }
                 catch (error) {
-                    await baseEyes.abort();
-                    error.info = { eyes: baseEyes };
-                    throw error;
+                    environmentLogger.error(`Render on environment with id "${(_j = baseEyes.test.environment) === null || _j === void 0 ? void 0 : _j.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) {
-                error.info = { ...error.info, userTestId: eyes.test.userTestId, renderer };
+                environmentLogger.error(`Environment with id ${environment.environmentId} failed before rendering started due to an error`, error);
+                error.info = { ...error.info, userTestId: eyes.test.userTestId, environment };
                 throw error;
             }
         });
-        return Promise.all(promises.map(async (promise) => {
-            var _a, _b;
-            try {
-                const result = await promise;
-                return { ...result, userTestId: eyes.test.userTestId };
+        uniqueEnvironments.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);
             }
-            catch (error) {
-                await ((_b = (_a = error.info) === null || _a === void 0 ? void 0 : _a.eyes) === null || _b === void 0 ? void 0 : _b.abort({ logger }));
-                throw error;
-            }
-        }));
+            item.jobs.push(promises[index]);
+        });
     };
 }
 exports.makeCheckAndClose = makeCheckAndClose;