@applitools/core 2.5.2 → 2.5.3-legacy

package/dist/get-manager-results.js

@@ -1,22 +1,50 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetManagerResults = void 0;
 const test_error_1 = require("./errors/test-error");
 const internal_error_1 = require("./errors/internal-error");
 const separate_duplicate_results_1 = require("./utils/separate-duplicate-results");
-function makeGetManagerResults({ core, storage, logger: defaultLogger, }) {
-    return async function getManagerResults({ settings, logger = defaultLogger, } = {}) {
+const utils = __importStar(require("@applitools/utils"));
+function makeGetManagerResults({ core, storage, logger: mainLogger, }) {
+    return async function getManagerResults({ settings, logger = mainLogger, } = {}) {
         var _a, _b, _c;
+        logger = logger.extend(mainLogger, { tags: [`get-manager-results-${utils.general.shortid()}`] });
         let containers = await storage.reduce(async (promise, eyes) => {
             try {
                 const results = await eyes.getResults({ settings: { ...settings, throwErr: false }, logger });
                 return promise.then(containers => {
-                    return containers.concat(results.map(result => ({
-                        result,
-                        error: result.status !== 'Passed' ? new test_error_1.TestError(result) : undefined,
-                        userTestId: result.userTestId,
-                        renderer: result.renderer,
-                    })));
+                    return containers.concat(results.map(result => {
+                        var _a;
+                        return ({
+                            result,
+                            error: result.status !== 'Passed' ? (_a = result.reason) !== null && _a !== void 0 ? _a : new test_error_1.TestError(result) : undefined,
+                            userTestId: result.userTestId,
+                            environment: result.environment,
+                        });
+                    }));
                 });
             }
             catch (error) {
@@ -32,14 +60,20 @@ function makeGetManagerResults({ core, storage, logger: defaultLogger, }) {
             else {
                 await Promise.all(duplicateContainers.map(async (container) => {
                     if (container.result) {
-                        await core.deleteTest({
-                            settings: {
-                                ...container.result.server,
-                                testId: container.result.id,
-                                batchId: container.result.batchId,
-                                secretToken: container.result.secretToken,
-                            },
-                        });
+                        // the server will also delete the test if it's a duplicate, so in newer server versions it's a redundancy and that's ok if it fails
+                        try {
+                            await core.deleteTest({
+                                settings: {
+                                    ...container.result.eyesServer,
+                                    testId: container.result.id,
+                                    batchId: container.result.batchId,
+                                    secretToken: container.result.secretToken,
+                                },
+                            });
+                        }
+                        catch (err) {
+                            logger.log('Did not delete duplicate test', { testId: container.result.id, error: err });
+                        }
                     }
                 }));
                 logger.log('Done cleaning up duplicate tests!');
@@ -47,8 +81,8 @@ function makeGetManagerResults({ core, storage, logger: defaultLogger, }) {
         }
         const batches = storage.reduce((batches, eyes) => {
             if (!eyes.test.keepBatchOpen) {
-                const settings = { ...eyes.test.server, batchId: eyes.test.batchId };
-                batches[`${settings.serverUrl}:${settings.apiKey}:${settings.batchId}`] = settings;
+                const settings = { ...eyes.test.eyesServer, batchId: eyes.test.batchId, batchBuildId: eyes.test.batchBuildId };
+                batches[`${settings.eyesServerUrl}:${settings.apiKey}:${settings.batchId}`] = settings;
             }
             return batches;
         }, {});

package/dist/get-typed-eyes.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetTypedEyes = void 0;
-function makeGetTypedEyes({ type: defaultType, settings: defaultSettings, target, cores, logger: defaultLogger, }) {
+function makeGetTypedEyes({ type: defaultType, settings: defaultSettings, target, cores, logger: mainLogger, }) {
     let eyes;
-    return async function getTypedEyes({ type = defaultType, settings, logger = defaultLogger, } = {}) {
+    return async function getTypedEyes({ type = defaultType, logger = mainLogger, } = {}) {
+        logger = logger.extend(mainLogger);
         if (!eyes) {
             eyes = await cores[type].openEyes({ target, settings: defaultSettings, logger });
             return eyes;
@@ -12,13 +13,11 @@ function makeGetTypedEyes({ type: defaultType, settings: defaultSettings, target
             return eyes;
         }
         else if (type === 'ufg') {
-            const base = await eyes.getBaseEyes({ logger });
-            const typedEyes = await cores.ufg.openEyes({ target, settings: defaultSettings, base, logger });
+            const typedEyes = await cores.ufg.openEyes({ target, settings: defaultSettings, storage: eyes.storage, logger });
             return typedEyes;
         }
         else {
-            const base = (await Promise.all(settings.map(settings => eyes.getBaseEyes({ settings, logger })))).flat();
-            const typedEyes = await cores.classic.openEyes({ target, settings: defaultSettings, base, logger });
+            const typedEyes = await cores.classic.openEyes({ target, settings: defaultSettings, storage: eyes.storage, logger });
             return typedEyes;
         }
     };

package/dist/index.js

@@ -26,12 +26,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.takeDomSnapshots = exports.formatters = void 0;
+exports.logs = exports.formatters = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./core"), exports);
 __exportStar(require("./universal/core-server"), exports);
 __exportStar(require("./universal/core-server-process"), exports);
+__exportStar(require("./autonomous/core"), exports);
 __exportStar(require("@applitools/driver/dist/debug"), exports);
 exports.formatters = __importStar(require("./utils/format-results"));
-var take_dom_snapshots_1 = require("./ufg/utils/take-dom-snapshots");
-Object.defineProperty(exports, "takeDomSnapshots", { enumerable: true, get: function () { return take_dom_snapshots_1.takeDomSnapshots; } });
+exports.logs = __importStar(require("./troubleshoot/logs"));

package/dist/lang.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applitoolsLibConflictingCapabilitiesWarning = exports.requestedEnvironmentOutOfDriverBoundsWarning = exports.breakpointOutOfDriverBoundsWarning = exports.requestedEnvironmentSmallerThenBreakpointWarning = exports.outdatedSdkVersionWarning = exports.edgeUfgEnvironmentDeprecatedWarning = exports.matchLevelContentDeprecatedWarning = void 0;
+exports.matchLevelContentDeprecatedWarning = `The "Content" match level value has been deprecated, use "IgnoreColors" instead.`;
+exports.edgeUfgEnvironmentDeprecatedWarning = `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.`;
+const outdatedSdkVersionWarning = (options) => {
+    return `You are using "${options.currentVersion}" and there is a newer version "${options.latestVersion}" of the "${options.name}" SDK.`;
+};
+exports.outdatedSdkVersionWarning = outdatedSdkVersionWarning;
+const requestedEnvironmentSmallerThenBreakpointWarning = (options) => {
+    const browsers = options.browsers.map(({ name, width }) => `(${name}, ${width})`).join(', ');
+    return `The following configuration's viewport-widths are smaller than the smallest configured layout breakpoint (${options.breakpoint} pixels): [${browsers}]. As a fallback, the resources that will be used for these configurations have been captured on a viewport-width of ${options.breakpoint} - 1 pixels. If an additional layout breakpoint is needed for you to achieve better results - please add it to your configuration.`;
+};
+exports.requestedEnvironmentSmallerThenBreakpointWarning = requestedEnvironmentSmallerThenBreakpointWarning;
+const breakpointOutOfDriverBoundsWarning = (options) => {
+    const browsers = options.browsers.map(({ name, width }) => `(${name}, ${width})`).join(', ');
+    return `One of the configured layout breakpoints is ${options.requiredWidth} pixels, while your local browser has a limit of ${options.actualWidth}, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for the following configurations: [${browsers}] have been captured on the browser's limit (${options.actualWidth} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`;
+};
+exports.breakpointOutOfDriverBoundsWarning = breakpointOutOfDriverBoundsWarning;
+const requestedEnvironmentOutOfDriverBoundsWarning = (options) => {
+    const browsers = options.browsers.map(({ name }) => `(${name})`).join(', ');
+    return `The following configurations [${browsers}] have a viewport-width of ${options.requiredWidth} pixels, while your local browser has a limit of ${options.actualWidth} pixels, so the SDK couldn't resize it to the desired size. As a fallback, the resources that will be used for these checkpoints have been captured on the browser's limit (${options.actualWidth} pixels). To resolve this, you may use a headless browser as it can be resized to any size.`;
+};
+exports.requestedEnvironmentOutOfDriverBoundsWarning = requestedEnvironmentOutOfDriverBoundsWarning;
+const applitoolsLibConflictingCapabilitiesWarning = (options) => {
+    const conflictingCapabilities = Object.entries(options.conflictingCapabilities)
+        .map(entry => entry.join(': '))
+        .join(', ');
+    return `We have identified ${conflictingCapabilities} in your driver capabilities, this may prevent Applitools Native Library from loading. If you are not sure whether this will cause a problem, contact Support.`;
+};
+exports.applitoolsLibConflictingCapabilitiesWarning = applitoolsLibConflictingCapabilitiesWarning;

package/dist/locate-text.js

@@ -25,13 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeLocateText = void 0;
 const core_1 = require("./classic/core");
+const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-settings");
 const utils = __importStar(require("@applitools/utils"));
-function makeLocateText({ spec, core, logger: defaultLogger }) {
-    return async function locateText({ target, settings, config, logger = defaultLogger, }) {
-        var _a, _b, _c;
+function makeLocateText({ spec, core, logger: mainLogger }) {
+    return async function locateText({ target, settings, config, logger = mainLogger, }) {
+        logger = logger.extend(mainLogger, { tags: [`locate-text-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
-        (_a = settings.serverUrl) !== null && _a !== void 0 ? _a : (settings.serverUrl = (_b = utils.general.getEnvValue('SERVER_URL')) !== null && _b !== void 0 ? _b : 'https://eyesapi.applitools.com');
-        (_c = settings.apiKey) !== null && _c !== void 0 ? _c : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+        logger.mask(settings.apiKey);
+        logger.mask(settings.eyesServerUrl);
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });
         const results = await classicCore.locateText({ target, settings, logger });
         return results;

package/dist/locate.js

@@ -25,13 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeLocate = void 0;
 const core_1 = require("./classic/core");
+const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-settings");
 const utils = __importStar(require("@applitools/utils"));
-function makeLocate({ spec, core, logger: defaultLogger }) {
-    return async function locate({ target, settings, config, logger = defaultLogger, }) {
-        var _a, _b, _c;
+function makeLocate({ spec, core, logger: mainLogger }) {
+    return async function locate({ target, settings, config, logger = mainLogger, }) {
+        logger = logger.extend(mainLogger, { tags: [`locate-${utils.general.shortid()}`] });
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
-        (_a = settings.serverUrl) !== null && _a !== void 0 ? _a : (settings.serverUrl = (_b = utils.general.getEnvValue('SERVER_URL')) !== null && _b !== void 0 ? _b : 'https://eyesapi.applitools.com');
-        (_c = settings.apiKey) !== null && _c !== void 0 ? _c : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+        (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+        logger.mask(settings.apiKey);
+        logger.mask(settings.eyesServerUrl);
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });
         const results = await classicCore.locate({ target, settings, logger });
         return results;

package/dist/make-manager.js

@@ -30,20 +30,43 @@ const core_2 = require("./ufg/core");
 const open_eyes_1 = require("./open-eyes");
 const get_manager_results_1 = require("./get-manager-results");
 const utils = __importStar(require("@applitools/utils"));
-function makeMakeManager({ spec, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), core, base, agentId: defaultAgentId, cwd = process.cwd(), logger: defaultLogger, }) {
-    return async function makeManager({ type = 'classic', settings, logger = defaultLogger, } = {}) {
-        var _a, _b, _c, _d, _e;
-        var _f;
+function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache, offlineLocationPath, maskLog, }) {
+    return async function makeManager({ type = 'classic', settings, logger = mainLogger, } = {}) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        var _h, _j;
+        logger = logger.extend(mainLogger, { tags: [`manager-${type}-${utils.general.shortid()}`], maskLog });
         settings !== null && settings !== void 0 ? settings : (settings = {});
-        (_a = settings.concurrency) !== null && _a !== void 0 ? _a : (settings.concurrency = defaultConcurrency !== null && defaultConcurrency !== void 0 ? defaultConcurrency : (utils.types.isInteger(settings.legacyConcurrency) ? settings.legacyConcurrency * 5 : 5));
-        (_b = settings.batch) !== null && _b !== void 0 ? _b : (settings.batch = {});
-        (_c = (_f = settings.batch).id) !== null && _c !== void 0 ? _c : (_f.id = (_d = utils.general.getEnvValue('BATCH_ID')) !== null && _d !== void 0 ? _d : `generated-${utils.general.guid()}`);
-        (_e = settings.agentId) !== null && _e !== void 0 ? _e : (settings.agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId);
-        base !== null && base !== void 0 ? base : (base = (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger }));
-        const cores = { ufg: (0, core_2.makeCore)({ spec, base, logger }), classic: (0, core_1.makeCore)({ spec, base, logger }) };
+        (_a = settings.concurrency) !== null && _a !== void 0 ? _a : (settings.concurrency = (_b = utils.general.getEnvValue('CONCURRENCY', 'number')) !== null && _b !== void 0 ? _b : (utils.types.isInteger(settings.legacyConcurrency) ? settings.legacyConcurrency * 5 : 100));
+        (_c = settings.batch) !== null && _c !== void 0 ? _c : (settings.batch = {});
+        (_d = (_h = settings.batch).id) !== null && _d !== void 0 ? _d : (_h.id = (_e = utils.general.getEnvValue('BATCH_ID')) !== null && _e !== void 0 ? _e : `generated-${utils.general.guid()}`);
+        (_f = (_j = settings.batch).buildId) !== null && _f !== void 0 ? _f : (_j.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
+        (_g = settings.agentId) !== null && _g !== void 0 ? _g : (settings.agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId);
+        logger.log('Command "makeManager" is called with settings', settings);
+        const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, logger, offlineLocationPath, maskLog });
+        const fetchConcurrency = settings.fetchConcurrency;
+        const cores = {
+            ufg: (0, core_2.makeCore)({ spec, clients, base, fetchConcurrency, asyncCache, logger, offlineLocationPath, maskLog }),
+            classic: (0, core_1.makeCore)({ spec, clients, base, logger, maskLog }),
+        };
         const storage = [];
         return {
-            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, batch: settings.batch, spec, core, cores, logger }), async (openEyes, options) => {
+            get concurrency() {
+                return base.concurrency;
+            },
+            base,
+            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({
+                type,
+                clients,
+                batch: settings.batch,
+                removeDuplicateTests: settings.removeDuplicateTests,
+                spec,
+                core,
+                cores,
+                environment,
+                asyncCache,
+                cwd,
+                logger,
+            }), async (openEyes, options) => {
                 const eyes = await openEyes(options);
                 storage.push(eyes);
                 return eyes;

package/dist/offline/merge-configs.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeConfigs = void 0;
+const utils = __importStar(require("@applitools/utils"));
+function mergeConfigs(base, other) {
+    return Object.entries(other).reduce((base, [key, value]) => {
+        if (utils.types.has(base, key) &&
+            utils.types.isObject(value) &&
+            !(value instanceof String) &&
+            !utils.types.isArray(value)) {
+            base[key] = mergeConfigs(base[key], value);
+        }
+        else if (value !== undefined) {
+            base[key] = value;
+        }
+        return base;
+    }, { ...base });
+}
+exports.mergeConfigs = mergeConfigs;