@applitools/core 4.31.4 → 4.32.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [4.32.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.31.4...js/core@4.32.0) (2025-03-04)
+
+
+### Features
+
+* limit offline console logs ([#2813](https://github.com/Applitools-Dev/sdk/issues/2813)) ([9bec38b](https://github.com/Applitools-Dev/sdk/commit/9bec38b39cd7a35e574b667e8efa5016d3cf8fb3))
+
+
+### Bug Fixes
+
+* abort offline corrupt tests ([#2827](https://github.com/Applitools-Dev/sdk/issues/2827)) ([eabca07](https://github.com/Applitools-Dev/sdk/commit/eabca07c7575433fb97f63762412ddbb492dd665))
+* stale elements for webdriver sdks ([#2798](https://github.com/Applitools-Dev/sdk/issues/2798)) ([03e5fac](https://github.com/Applitools-Dev/sdk/commit/03e5fac2d3929ebe615293fd899b7e21443fb062))
+
 ## [4.31.4](https://github.com/Applitools-Dev/sdk/compare/js/core@4.31.3...js/core@4.31.4) (2025-02-26)
 
 

package/dist/offline/run-offline-snapshots.js

@@ -37,8 +37,13 @@ const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
 const merge_configs_1 = require("./merge-configs");
 const format_results_1 = require("../utils/format-results");
+function getConsoleLogLimit() {
+    var _a;
+    return (_a = utils.general.getEnvValue('OFFLINE_LOG_LIMIT', 'number')) !== null && _a !== void 0 ? _a : 20;
+}
 async function runOfflineSnapshots(options) {
     var _a;
+    const limitConsoleLogs = getConsoleLogLimit();
     if (!options.offlineLocationPath)
         throw new Error('offlineLocationPath is required');
     const offlineLocationPath = path_1.default.resolve(options.offlineLocationPath);
@@ -80,14 +85,26 @@ async function runOfflineSnapshots(options) {
     return allTestResults;
     async function runTests(testFolders) {
         logger.log('running tests', testFolders);
-        const results = await Promise.all(testFolders.map(async (testFolder) => {
+        const messages = [];
+        const testPromises = testFolders.map(async (testFolder) => {
             const testLogger = logger.extend({ tags: [testFolder] });
             const testPath = path_1.default.join(offlineLocationPath, testFolder);
             const fileOpenSettings = await fs_1.default.promises
                 .readFile(path_1.default.join(testPath, 'settings.json'), 'utf-8')
                 .then(JSON.parse);
             const openSettings = (0, merge_configs_1.mergeConfigs)(fileOpenSettings, options.config.open);
-            logger.console.log(`Running test: ${openSettings.testName} (${formatEnvironment(openSettings.environment)})`);
+            messages.push(`Running test: ${openSettings.testName} (${formatEnvironment(openSettings.environment)})`);
+            return { testPath, openSettings, testLogger };
+        });
+        const preparedTests = await Promise.all(testPromises);
+        if (messages.length > limitConsoleLogs) {
+            const slice = messages.slice(0, limitConsoleLogs);
+            logger.console.log(slice.join('\n') + `\n... ${messages.length - limitConsoleLogs} more tests`);
+        }
+        else {
+            logger.console.log(messages.join('\n'));
+        }
+        const results = await Promise.all(preparedTests.map(async ({ testPath, openSettings, testLogger }) => {
             return runTest(testPath, openSettings, testLogger);
         }));
         const batchIds = [...new Set(results.map(t => t.batchId))];
@@ -115,23 +132,29 @@ async function runOfflineSnapshots(options) {
             },
             logger,
         });
-        const checkFolders = (await fs_1.default.promises.readdir(testPath)).filter(folderpath => folderpath.startsWith('check-'));
-        logger.log('running checks for test', testPath, ':', checkFolders);
-        const targets = await Promise.all(checkFolders.map(async (checkFolder) => {
-            const snapshot = await fs_1.default.promises
-                .readFile(path_1.default.resolve(testPath, checkFolder, 'snapshot.json'), 'utf-8')
-                .then(JSON.parse);
-            snapshot.settings.environment.environmentId = utils.general.guid();
-            return snapshot;
-        }));
-        await uploadResources(targets, logger);
-        // logger.log('resource hashes for test', testFolder, ':', resourceHashes)
-        logger.log('uploaded resources for test', testPath);
-        await Promise.all(targets.map((target, index) => runCheck(eyes, target, index, logger)));
-        const fileCloseSettings = await fs_1.default.promises.readFile(path_1.default.resolve(testPath, 'close.json'), 'utf-8').then(JSON.parse);
-        const closeSettings = (0, merge_configs_1.mergeConfigs)(fileCloseSettings, options.config.close);
-        await eyes.close({ settings: closeSettings });
-        logger.log('done running test', logger);
+        const closeSettingsPath = path_1.default.resolve(testPath, 'close.json');
+        if (fs_1.default.existsSync(closeSettingsPath)) {
+            const checkFolders = (await fs_1.default.promises.readdir(testPath)).filter(folderpath => folderpath.startsWith('check-'));
+            logger.log('running checks for test', testPath, ':', checkFolders);
+            const targets = await Promise.all(checkFolders.map(async (checkFolder) => {
+                const snapshot = await fs_1.default.promises
+                    .readFile(path_1.default.resolve(testPath, checkFolder, 'snapshot.json'), 'utf-8')
+                    .then(JSON.parse);
+                snapshot.settings.environment.environmentId = utils.general.guid();
+                return snapshot;
+            }));
+            await uploadResources(targets, logger);
+            // logger.log('resource hashes for test', testFolder, ':', resourceHashes)
+            logger.log('uploaded resources for test', testPath);
+            await Promise.all(targets.map((target, index) => runCheck(eyes, target, index, logger)));
+            const fileCloseSettings = await fs_1.default.promises.readFile(closeSettingsPath, 'utf-8').then(JSON.parse);
+            const closeSettings = (0, merge_configs_1.mergeConfigs)(fileCloseSettings, options.config.close);
+            await eyes.close({ settings: closeSettings });
+        }
+        else {
+            await eyes.abort();
+        }
+        logger.log('done running test', testPath);
         return { batchId: openSettings.batch.id, results: (await eyes.getResults({ logger }))[0] };
     }
     async function uploadResources(targets, logger) {
@@ -235,16 +258,16 @@ function processResults({ testResults, totalTime, saveNewTests = true, failOnDif
     }
     outputStr += '[EYES: TEST RESULTS]:\n\n';
     if (passedOrNew.length > 0) {
-        outputStr += testResultsOutput(passedOrNew, warnForUnsavedNewTests);
+        outputStr += testResultsOutput(passedOrNew, warnForUnsavedNewTests, 'Passed');
     }
     if (failedTests.length > 0) {
-        outputStr += testResultsOutput(failedTests, warnForUnsavedNewTests);
+        outputStr += testResultsOutput(failedTests, warnForUnsavedNewTests, 'Failed');
     }
     if (unresolved.length > 0) {
-        outputStr += testResultsOutput(unresolved, warnForUnsavedNewTests);
+        outputStr += testResultsOutput(unresolved, warnForUnsavedNewTests, 'Unresolved');
     }
     if (aborted.length > 0) {
-        outputStr += testResultsOutput(aborted, warnForUnsavedNewTests);
+        outputStr += testResultsOutput(aborted, warnForUnsavedNewTests, 'Aborted');
     }
     if (errors.length) {
         const sortedErrors = errors.sort((a, b) => a.title.localeCompare(b.title));
@@ -308,28 +331,39 @@ function processResults({ testResults, totalTime, saveNewTests = true, failOnDif
         isSuccess,
     };
 }
-function testResultsOutput(results, warnForUnsavedNewTests) {
-    let outputStr = '';
+function testResultsOutput(results, warnForUnsavedNewTests, tag) {
+    const limitConsoleLogs = getConsoleLogLimit();
+    const truncated = [];
+    let limitCount = 0;
     const sortedTestResults = results.sort((a, b) => a.name.localeCompare(b.name));
     sortedTestResults.forEach(result => {
         const testTitle = `${result.name} [${result.hostApp}] [${result.hostDisplaySize.width}x${result.hostDisplaySize.height}] - `;
         if (result.isAborted) {
-            outputStr += `${testTitle}${chalk_1.default.keyword('red')(`Aborted`)}\n`;
+            const str = `${testTitle}${chalk_1.default.keyword('red')(`Aborted`)}\n`;
+            truncated.push(str);
         }
         else if (result.isNew) {
             const newResColor = warnForUnsavedNewTests ? 'orange' : 'blue';
-            outputStr += `${testTitle}${chalk_1.default.keyword(newResColor)('New')}\n`;
+            const str = `${testTitle}${chalk_1.default.keyword(newResColor)('New')}\n`;
+            truncated.push(str);
         }
         else if (result.status === 'Passed') {
-            outputStr += `${testTitle}${chalk_1.default.green('Passed')}\n`;
+            const str = `${testTitle}${chalk_1.default.green('Passed')}\n`;
+            truncated.push(str);
         }
         else if (result.status === 'Failed') {
-            outputStr += `${testTitle}${chalk_1.default.keyword('red')('Failed')}\n`;
+            const str = `${testTitle}${chalk_1.default.keyword('red')('Failed')}\n`;
+            truncated.push(str);
         }
         else {
-            outputStr += `${testTitle}${chalk_1.default.keyword('orange')(`Unresolved`)}\n`;
+            const str = `${testTitle}${chalk_1.default.keyword('orange')(`Unresolved`)}\n`;
+            truncated.push(str);
         }
+        if (limitCount < limitConsoleLogs)
+            limitCount++;
     });
+    let outputStr = truncated.slice(0, limitConsoleLogs).join('');
+    outputStr += results.length - limitCount > 0 ? `... ${results.length - limitCount} more ${tag} tests` : '';
     outputStr += '\n';
     return outputStr;
 }

package/dist/open-eyes.js

@@ -39,20 +39,20 @@ const core_base_1 = require("@applitools/core-base");
 const extract_git_info_1 = require("./utils/extract-git-info");
 function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDuplicateTests, core, cores, spec, environment, logger: mainLogger, asyncCache, cwd = process.cwd(), }) {
     return async function openEyes({ type = defaultType, settings: openSettings, config, target, logger = mainLogger, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
-        var _w, _x, _y, _z, _0;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
+        var _z, _0, _1, _2, _3;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
-        const settings = { ...config === null || config === void 0 ? void 0 : config.open, ...openSettings };
+        const settings = { environments: config === null || config === void 0 ? void 0 : config.check.environments, ...config === null || config === void 0 ? void 0 : config.open, ...openSettings };
         const eyesServerSettings = (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
         logger.mask(eyesServerSettings.apiKey);
         logger.mask(eyesServerSettings.eyesServerUrl);
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
         settings.batch = { ...batch, ...settings.batch };
-        (_b = (_w = settings.batch).id) !== null && _b !== void 0 ? _b : (_w.id = (_c = utils.general.getEnvValue('BATCH_ID')) !== null && _c !== void 0 ? _c : `generated-${utils.general.guid()}`);
-        (_d = (_x = settings.batch).buildId) !== null && _d !== void 0 ? _d : (_x.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
-        (_e = (_y = settings.batch).name) !== null && _e !== void 0 ? _e : (_y.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_f = (_z = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : (_z.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_g = (_0 = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : (_0.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_b = (_z = settings.batch).id) !== null && _b !== void 0 ? _b : (_z.id = (_c = utils.general.getEnvValue('BATCH_ID')) !== null && _c !== void 0 ? _c : `generated-${utils.general.guid()}`);
+        (_d = (_0 = settings.batch).buildId) !== null && _d !== void 0 ? _d : (_0.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
+        (_e = (_1 = settings.batch).name) !== null && _e !== void 0 ? _e : (_1.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_f = (_2 = settings.batch).sequenceName) !== null && _f !== void 0 ? _f : (_2.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_g = (_3 = settings.batch).notifyOnCompletion) !== null && _g !== void 0 ? _g : (_3.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'));
@@ -92,6 +92,15 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
         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());
+        const multiDeviceTargets = [];
+        for (const checkEnv of (_u = settings.environments) !== null && _u !== void 0 ? _u : []) {
+            if (utils.types.has(checkEnv, 'iosDeviceInfo') && ((_v = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _v === void 0 ? void 0 : _v.instrumented)) {
+                multiDeviceTargets.push({
+                    deviceInfo: checkEnv.iosDeviceInfo.deviceName,
+                    orientation: (_w = checkEnv.iosDeviceInfo.screenOrientation) !== null && _w !== void 0 ? _w : 'portrait',
+                });
+            }
+        }
         void core.logEvent({
             settings: {
                 ...settings,
@@ -99,7 +108,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                 event: {
                     type: 'openEyes',
                     userTestId: settings.userTestId,
-                    concurrency: (_u = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _u !== void 0 ? _u : core.concurrency,
+                    concurrency: (_x = cores === null || cores === void 0 ? void 0 : cores[type].concurrency) !== null && _x !== void 0 ? _x : core.concurrency,
                     environment,
                     driver: {
                         deviceName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.deviceName,
@@ -107,10 +116,11 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                         browserVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.browserVersion,
                         platformName: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformName,
                         platformVersion: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.platformVersion,
-                        isApplitoolsLib: (_v = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _v === void 0 ? void 0 : _v.instrumented,
+                        isApplitoolsLib: (_y = driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.applitoolsLib) === null || _y === void 0 ? void 0 : _y.instrumented,
                         isEC: driverEnvironment === null || driverEnvironment === void 0 ? void 0 : driverEnvironment.isEC,
                     },
                     driverUrl,
+                    multiDeviceTargets,
                 },
             },
             logger,

package/dist/ufg/open-eyes.js

@@ -32,11 +32,12 @@ const close_1 = require("../automation/close");
 const abort_1 = require("../automation/abort");
 const get_results_1 = require("../automation/get-results");
 const extract_default_environment_1 = require("./utils/extract-default-environment");
+const verify_environment_info_1 = require("./utils/verify-environment-info");
 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, storage = new Map(), logger = mainLogger, }) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         logger = logger.extend(mainLogger);
         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 }));
@@ -54,6 +55,15 @@ function makeOpenEyes({ core, spec, logger: mainLogger }) {
         const controller = new abort_controller_1.AbortController();
         const { signal } = controller;
         const account = await core.getAccountInfo({ settings, logger });
+        const ufgClient = await core.getUFGClient({
+            settings: {
+                ...account.ufgServer,
+                eyesServerUrl: account.eyesServer.eyesServerUrl,
+                apiKey: account.eyesServer.apiKey,
+            },
+            logger,
+        });
+        await (0, verify_environment_info_1.verifyEnvironmentsInfo)({ environments: (_d = settings.environments) !== null && _d !== void 0 ? _d : [], ufgClient });
         return utils.general.extend({}, eyes => {
             var _a, _b, _c, _d;
             return {

package/dist/ufg/take-snapshots.js

@@ -6,9 +6,10 @@ const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
 const to_safe_check_settings_1 = require("./utils/to-safe-check-settings");
 const to_generated_selectors_1 = require("./utils/to-generated-selectors");
 const abort_error_1 = require("../errors/abort-error");
+const filterStaleElements_1 = require("./utils/filterStaleElements");
 function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
     return async function takeSnapshots({ driver, settings = {}, account, logger = mainLogger, }) {
-        var _a;
+        var _a, _b;
         logger = logger.extend(mainLogger);
         logger.log('Command "takeSnapshots" is called with settings', settings);
         if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
@@ -38,7 +39,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
                 },
                 logger,
             });
-            snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+            const takeSnapshotsSettings = {
                 driver,
                 settings: {
                     waitBeforeCapture: settings.waitBeforeCapture,
@@ -54,7 +55,25 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
                     getIOSDevices: ufgClient.getIOSDevices,
                 },
                 logger,
-            });
+            };
+            try {
+                snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)(takeSnapshotsSettings);
+            }
+            catch (err) {
+                if ((_b = err === null || err === void 0 ? void 0 : err.message) === null || _b === void 0 ? void 0 : _b.includes('stale element')) {
+                    snapshots = await (0, take_dom_snapshots_1.takeDomSnapshots)({
+                        ...takeSnapshotsSettings,
+                        settings: await (0, filterStaleElements_1.removeStaleElementsFromDomSnapshotsSettings)({
+                            settings: takeSnapshotsSettings.settings,
+                            context: currentContext,
+                            targetElement: elementReferences.target,
+                        }),
+                    });
+                }
+                else {
+                    throw err;
+                }
+            }
         }
         else {
             // dead code - used for NMG

package/dist/ufg/utils/filterStaleElements.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeStaleElementsFromDomSnapshotsSettings = exports.filterStaleElements = exports.isStale = void 0;
+async function isStale({ context, element, }) {
+    try {
+        await context.execute('return arguments[0]', element);
+    }
+    catch {
+        return true;
+    }
+    return false;
+}
+exports.isStale = isStale;
+async function filterStaleElements({ context, elementReferences, }) {
+    if (!elementReferences)
+        return [];
+    const validElements = [];
+    for (const element of elementReferences) {
+        if (!(await isStale({ context, element }))) {
+            validElements.push(element);
+        }
+    }
+    return validElements;
+}
+exports.filterStaleElements = filterStaleElements;
+async function removeStaleElementsFromDomSnapshotsSettings({ context, settings, targetElement, }) {
+    // if one of the stale elements is the target element, we can't recover from it
+    if (await isStale({ context, element: targetElement })) {
+        throw new Error('Target element is stale - please make sure the element is not detached from the DOM tree. Failed to recover from stale element');
+    }
+    else {
+        // remove other stale elements from the array
+        settings.elementReferences = await filterStaleElements({
+            context,
+            elementReferences: settings.elementReferences,
+        });
+    }
+    return settings;
+}
+exports.removeStaleElementsFromDomSnapshotsSettings = removeStaleElementsFromDomSnapshotsSettings;

package/dist/ufg/utils/verify-environment-info.js

@@ -0,0 +1,89 @@
+"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.verifyEnvironmentsInfo = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const ufg_client_1 = require("@applitools/ufg-client");
+async function verifyEnvironmentsInfo({ environments, ufgClient, }) {
+    const invalid = [];
+    await Promise.all(environments.map(async (environment) => {
+        if (utils.types.has(environment, ['width', 'height'])) {
+            const browserName = environment.name || '';
+            if (!getAllBrowserNames().includes(browserName)) {
+                invalid.push(browserName);
+            }
+        }
+        else if (utils.types.has(environment, 'chromeEmulationInfo')) {
+            const devices = await ufgClient.getChromeEmulationDevices();
+            const deviceName = environment.chromeEmulationInfo.deviceName;
+            if (!devices[deviceName]) {
+                invalid.push(deviceName);
+            }
+        }
+        else if (utils.types.has(environment, 'iosDeviceInfo')) {
+            const devices = await ufgClient.getIOSDevices();
+            const deviceName = environment.iosDeviceInfo.deviceName;
+            if (!devices[deviceName]) {
+                invalid.push(deviceName);
+            }
+        }
+    }));
+    if (invalid.length > 0) {
+        throw new Error(`The specified UFG environment(s): ${invalid
+            .map(item => `"${item}"`)
+            .join(', ')} are either invalid or no longer supported. \nRefer to our current list of supported devices and browsers at: https://applitools.com/tutorials/concepts/test-execution/ultrafast-grid-devices-browsers \nIf you continue to experience issues, ensure that your SDK is updated to the latest version.`);
+    }
+}
+exports.verifyEnvironmentsInfo = verifyEnvironmentsInfo;
+function getAllBrowserNames() {
+    /*
+    Some of the browser names are not part of the enum because they are not user facing. We support them for backward compatibility.
+    do not add them to the enum.
+    */
+    return [
+        ...Object.values(ufg_client_1.BrowserNameEnum),
+        'chrome-1',
+        'firefox-1',
+        'edgechromium-1',
+        'safari-1',
+        'chrome-2',
+        'firefox-2',
+        'edgechromium-2',
+        'safari-2',
+        'chrome-canary',
+        'firefox-canary',
+        'edgechromium-canary',
+        'safari-canary',
+        'chrome-one-versions-back',
+        'firefox-one-versions-back',
+        'edgechromium-one-versions-back',
+        'safari-one-versions-back',
+        'chrome-two-version-back',
+        'firefox-two-version-back',
+        'edgechromium-two-version-back',
+        'safari-two-version-back',
+        'ie11',
+    ];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.31.4",
+  "version": "4.32.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"

package/types/automation/types.d.ts

@@ -171,4 +171,5 @@ export type TestResult = BaseCore.TestResult & {
 };
 export type OpenSettings = BaseCore.OpenSettings & {
     disableBrokerUrlCache?: boolean;
+    environments?: Environment[];
 };

package/types/ufg/utils/filterStaleElements.d.ts

@@ -0,0 +1,22 @@
+import type { Context, ElementReference, SpecType } from '@applitools/driver';
+import { DomSnapshotsSettings } from './take-dom-snapshots';
+export declare function isStale<TSpec extends SpecType>({ context, element, }: {
+    context: Context<TSpec>;
+    element: ElementReference<TSpec>;
+}): Promise<boolean>;
+export declare function filterStaleElements<TSpec extends SpecType>({ context, elementReferences, }: {
+    context: Context<TSpec>;
+    elementReferences: ElementReference<TSpec>[] | undefined;
+}): Promise<(string | TSpec["element"] | TSpec["secondary"]["element"] | TSpec["selector"] | TSpec["secondary"]["selector"] | {
+    selector: string | TSpec["selector"] | TSpec["secondary"]["selector"];
+    type?: string | undefined;
+    child?: TSpec["selector"] | TSpec["secondary"]["selector"] | import("@applitools/driver").CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+    shadow?: TSpec["selector"] | TSpec["secondary"]["selector"] | import("@applitools/driver").CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+    frame?: TSpec["selector"] | TSpec["secondary"]["selector"] | import("@applitools/driver").CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+    fallback?: TSpec["selector"] | TSpec["secondary"]["selector"] | import("@applitools/driver").CommonSelector<TSpec["selector"] | TSpec["secondary"]["selector"]> | undefined;
+})[]>;
+export declare function removeStaleElementsFromDomSnapshotsSettings<TSpec extends SpecType>({ context, settings, targetElement, }: {
+    context: Context<TSpec>;
+    settings: DomSnapshotsSettings<TSpec>;
+    targetElement: ElementReference<TSpec>;
+}): Promise<DomSnapshotsSettings<TSpec>>;

package/types/ufg/utils/verify-environment-info.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from '../../automation/types';
+import { UFGClient } from '@applitools/ufg-client';
+export declare function verifyEnvironmentsInfo({ environments, ufgClient, }: {
+    environments: Environment[];
+    ufgClient: UFGClient;
+}): Promise<void>;