@applitools/core 4.27.1 → 4.29.0

package/CHANGELOG.md

@@ -1,5 +1,146 @@
 # Changelog
 
+## [4.29.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.28.0...js/core@4.29.0) (2025-01-13)
+
+
+### Features
+
+* jsonFilePath in offline mode ([#2734](https://github.com/Applitools-Dev/sdk/issues/2734)) ([2f9fbe8](https://github.com/Applitools-Dev/sdk/commit/2f9fbe8fc3c5212db6b7cc58a98b041c3ffd5572))
+
+
+### Bug Fixes
+
+* support batching tests in distributed env - close batch only when required ([#2733](https://github.com/Applitools-Dev/sdk/issues/2733)) ([2e59e4a](https://github.com/Applitools-Dev/sdk/commit/2e59e4a76edcc02b8888dfc78a42749bae76f79c))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.14
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+
+
+
+* @applitools/snippets bumped to 2.6.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/dom-capture bumped to 11.5.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/driver bumped to 1.20.3
+
+* @applitools/spec-driver-webdriver bumped to 1.1.23
+
+* @applitools/spec-driver-selenium bumped to 1.5.94
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.23
+
+* @applitools/screenshoter bumped to 3.10.3
+
+* @applitools/nml-client bumped to 1.8.22
+
+* @applitools/ec-client bumped to 1.10.1
+
+
+## [4.28.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.27.1...js/core@4.28.0) (2024-12-31)
+
+
+### Features
+
+* deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+* logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+### Bug Fixes
+
+* take snapshots with coded regions on pages that has cross origin frames ([#2705](https://github.com/Applitools-Dev/sdk/issues/2705)) ([5972fec](https://github.com/Applitools-Dev/sdk/commit/5972fec890a1454a9f96c4eddcf17634e72111aa))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.7.7
+  #### Bug Fixes
+
+  * shim process execution functions for browser environment ([#2698](https://github.com/Applitools-Dev/sdk/issues/2698)) ([8d77db4](https://github.com/Applitools-Dev/sdk/commit/8d77db48e1c7fd54cad92c89a819a924255e5868))
+* @applitools/logger bumped to 2.1.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/dom-snapshot bumped to 4.11.13
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+
+
+
+* @applitools/socket bumped to 1.2.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/dom-capture bumped to 11.5.3
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+* @applitools/ufg-client bumped to 1.16.0
+  #### Features
+
+  * deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+
+
+  #### Bug Fixes
+
+  * code scanning issue ([#2687](https://github.com/Applitools-Dev/sdk/issues/2687)) ([f301056](https://github.com/Applitools-Dev/sdk/commit/f301056cccfc9cc0c21ceedbd521d8f4b054f058))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.22
+
+* @applitools/spec-driver-selenium bumped to 1.5.93
+
+* @applitools/screenshoter bumped to 3.10.2
+
+* @applitools/nml-client bumped to 1.8.21
+
+* @applitools/tunnel-client bumped to 1.6.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/ec-client bumped to 1.10.0
+  #### Features
+
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+* @applitools/req bumped to 1.7.6
+
+* @applitools/image bumped to 1.1.16
+
+* @applitools/driver bumped to 1.20.2
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.22
+
+* @applitools/core-base bumped to 1.22.0
+  #### Features
+
+  * deterministic output in offline execution ([#2711](https://github.com/Applitools-Dev/sdk/issues/2711)) ([5e8c7ca](https://github.com/Applitools-Dev/sdk/commit/5e8c7ca43c98e7ba6aed0c1a66c5a60b4001aeff))
+  * logger masking  ([#2640](https://github.com/Applitools-Dev/sdk/issues/2640)) ([bd69d21](https://github.com/Applitools-Dev/sdk/commit/bd69d21f6341447b1acdb042f4ee1a6328d7428f))
+
+
+
+
 ## [4.27.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.27.0...js/core@4.27.1) (2024-12-22)
 
 

package/dist/autonomous/open-eyes.js

@@ -5,6 +5,8 @@ const populate_eyes_server_settings_1 = require("../utils/populate-eyes-server-s
 function makeOpenEyes({ core, logger: defaultLogger }) {
     return async function openEyes({ settings, logger = defaultLogger, }) {
         (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+        logger.mask(settings.apiKey);
+        logger.mask(settings.eyesServerUrl);
         return core.base.openEyes({ settings, logger });
     };
 }

package/dist/classic/core.js

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

package/dist/cli/cli.js

@@ -103,6 +103,11 @@ void yargs_1.default
             type: 'string',
             coerce: JSON.parse,
         },
+        maskLog: {
+            description: 'mask sensitive information in the log',
+            type: 'boolean',
+            default: false,
+        },
     }),
     handler: async (args) => {
         if (args.fork) {

package/dist/close-batch.js

@@ -31,6 +31,8 @@ function makeCloseBatch({ core, logger: mainLogger }) {
         logger = logger.extend(mainLogger, { tags: [`close-batch-${utils.general.shortid()}`] });
         (utils.types.isArray(settings) ? settings : [settings]).forEach(settings => {
             (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+            logger.mask(settings.apiKey);
+            logger.mask(settings.eyesServerUrl);
         });
         return core.base.closeBatch({ settings, logger });
     };

package/dist/core.js

@@ -46,18 +46,18 @@ const ensure_offline_folder_1 = require("./utils/ensure-offline-folder");
 const validate_sdk_version_1 = require("./utils/validate-sdk-version");
 const memory_usage_logging_1 = require("./utils/memory-usage-logging");
 const take_snapshots_1 = require("./ufg/take-snapshots");
-function makeCore({ spec, clients, base: defaultBase, concurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, asyncCache, } = {}) {
-    const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
+function makeCore({ spec, clients, base: defaultBase, concurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), maskLog = false, logger: defaultLogger, asyncCache, } = {}) {
+    const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' }, maskLog });
     (0, memory_usage_logging_1.startMemoryUsageLogging)({ logger });
     const environment = (0, extract_test_environment_1.extractTestEnvironment)(defaultEnvironment);
     const offlineLocationPath = (0, ensure_offline_folder_1.ensureOfflineFolder)();
     logger.log(`[pid=${process.pid} Core is initialized ${defaultBase ? 'with' : 'without'} custom base core ${offlineLocationPath ? `and offline location ${offlineLocationPath} ` : ''}and environment `, environment);
     if (environment.sdk)
         void (0, validate_sdk_version_1.validateSdkVersion)(environment.sdk, { logger });
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath, maskLog });
     const cores = {
-        ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger, offlineLocationPath }),
-        classic: (0, core_1.makeCore)({ spec, clients, base, logger, offlineLocationPath }),
+        ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger, offlineLocationPath, maskLog }),
+        classic: (0, core_1.makeCore)({ spec, clients, base, logger, offlineLocationPath, maskLog }),
     };
     return utils.general.extend(base, core => {
         return {
@@ -80,6 +80,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
                 asyncCache,
                 logger,
                 offlineLocationPath,
+                maskLog,
             }),
             locate: (0, locate_1.makeLocate)({ spec, core, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),

package/dist/delete-test.js

@@ -31,6 +31,9 @@ function makeDeleteTest({ core, logger: mainLogger }) {
         logger = logger.extend(mainLogger, { tags: [`delete-test-${utils.general.shortid()}`] });
         (utils.types.isArray(settings) ? settings : [settings]).forEach(settings => {
             (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+            logger.mask(settings.apiKey);
+            logger.mask(settings.eyesServerUrl);
+            logger.mask(settings.secretToken);
         });
         return core.base.deleteTest({ settings, logger });
     };

package/dist/extract-text.js

@@ -36,6 +36,8 @@ function makeExtractText({ spec, core, logger: mainLogger }) {
             settings = { ...config === null || config === void 0 ? void 0 : config.open, ...config === null || config === void 0 ? void 0 : config.screenshot, ...settings };
             (_a = settings.userCommandId) !== null && _a !== void 0 ? _a : (settings.userCommandId = `extract-text--${utils.general.guid()}`);
             (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
+            logger.mask(settings.apiKey);
+            logger.mask(settings.eyesServerUrl);
             return settings;
         });
         const classicCore = (0, core_1.makeCore)({ spec, base: core.base, logger });

package/dist/locate-text.js

@@ -32,6 +32,8 @@ function makeLocateText({ spec, core, 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 };
         (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

@@ -32,6 +32,8 @@ function makeLocate({ spec, core, 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 };
         (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,11 +30,11 @@ 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, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache, offlineLocationPath, }) {
+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()}`] });
+        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 = (_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 = {});
@@ -42,11 +42,11 @@ function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defa
         (_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 });
+        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 }),
-            classic: (0, core_1.makeCore)({ spec, clients, base, logger }),
+            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 {

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

@@ -36,14 +36,15 @@ const to_base_check_settings_1 = require("../automation/utils/to-base-check-sett
 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");
 async function runOfflineSnapshots(options) {
-    var _a, _b;
+    var _a;
     if (!options.offlineLocationPath)
         throw new Error('offlineLocationPath is required');
     const offlineLocationPath = path_1.default.resolve(options.offlineLocationPath);
     const startTime = Date.now();
     const logger = (_a = options.logger) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ format: { label: 'offline-exec' } });
-    const eyesServerSettings = { ...(_b = options.config) === null || _b === void 0 ? void 0 : _b.open, ...options };
+    const eyesServerSettings = { ...options.config.open, ...options };
     const core = (0, core_1.makeCore)();
     const account = await core.getAccountInfo({ settings: eyesServerSettings });
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
@@ -65,7 +66,11 @@ async function runOfflineSnapshots(options) {
         throw new Error(`Unable to find offline executions in ${offlineLocationPath}`);
     }
     const allTestResults = await runTests(testFolders);
-    const { isSuccess, outputStr } = processResults({ testResults: allTestResults, totalTime: Date.now() - startTime });
+    const { isSuccess, outputStr } = processResults({
+        testResults: allTestResults,
+        totalTime: Date.now() - startTime,
+        jsonFilePath: options.jsonFilePath,
+    });
     if (!isSuccess && options.failOnDiff) {
         throw new Error(outputStr);
     }
@@ -88,7 +93,10 @@ async function runOfflineSnapshots(options) {
         const batchIds = [...new Set(results.map(t => t.batchId))];
         const allTestResults = results.map(t => t.results);
         logger.log('done running all tests', allTestResults);
-        await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
+        const keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean') || options.config.open.keepBatchOpen;
+        if (!keepBatchOpen) {
+            await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
+        }
         logger.log('done closing batches');
         return allTestResults;
     }
@@ -196,7 +204,7 @@ exports.runOfflineSnapshots = runOfflineSnapshots;
 function uniq(arr) {
     return [...new Set(arr)];
 }
-function processResults({ testResults, totalTime, saveNewTests = true, failOnDiff = true, }) {
+function processResults({ testResults, totalTime, saveNewTests = true, failOnDiff = true, jsonFilePath, }) {
     let outputStr = '\n';
     const pluralize = utils.general.pluralize;
     const testResultsWithErrors = testResults.filter(r => r && r.reason);
@@ -269,6 +277,10 @@ function processResults({ testResults, totalTime, saveNewTests = true, failOnDif
     else if (passedOrNew.length) {
         outputStr += chalk_1.default.green(`\nNo differences were found!`);
     }
+    if (jsonFilePath) {
+        outputStr += '\n\nWriting test results to ' + jsonFilePath + '\n';
+        fs_1.default.writeFileSync(jsonFilePath, (0, format_results_1.toJsonOutput)(testResults));
+    }
     if (hasResults) {
         outputStr += `\n${seeDetailsStr}\nTotal time: ${Math.round(totalTime / 1000)} seconds\n`;
     }

package/dist/open-eyes.js

@@ -44,6 +44,8 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
         const settings = { ...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()}`);

package/dist/ufg/core.js

@@ -36,10 +36,10 @@ const take_snapshots_1 = require("./take-snapshots");
 const get_ufg_client_1 = require("./get-ufg-client");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId = 'core-ufg', logger: defaultLogger, }) {
-    const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-ufg' } });
+function makeCore({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId = 'core-ufg', logger: defaultLogger, maskLog, }) {
+    const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-ufg' }, maskLog });
     logger.log(`Core ufg is initialized ${defaultBase ? 'with' : 'without'} custom base core`);
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, logger, offlineLocationPath, maskLog });
     const ufgClient = clients === null || clients === void 0 ? void 0 : clients.ufg;
     return utils.general.extend(base, core => {
         return {

package/dist/ufg/utils/take-dom-snapshot.js

@@ -38,10 +38,10 @@ async function takeDomSnapshot({ context, settings, logger, }) {
     for (const elementReference of (_b = settings === null || settings === void 0 ? void 0 : settings.elementReferences) !== null && _b !== void 0 ? _b : []) {
         elements.push(await context.elements(elementReference));
     }
-    const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context }), elements);
+    const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context, isRootFrame: true }), elements);
     snapshot.cookies = features.allCookies ? await driver.getCookies().catch(() => []) : cookies; // intentionally fetching cookies after the dom snapshot runs
     return snapshot;
-    async function takeContextDomSnapshot({ context }) {
+    async function takeContextDomSnapshot({ context, isRootFrame, }) {
         // logger.log(`taking dom snapshot. ${context._reference ? `context referece: ${JSON.stringify(context._reference)}` : ''}`)
         var _a, _b, _c;
         const arg = {
@@ -53,7 +53,7 @@ async function takeDomSnapshot({ context, settings, logger, }) {
             serializeResources: true,
             compressResources: false,
             showLogs: settings === null || settings === void 0 ? void 0 : settings.showLogs,
-            elements,
+            elements: isRootFrame ? elements : [],
         };
         const scripts = {
             main: features.canExecuteOnlyFunctionScripts
@@ -85,7 +85,10 @@ async function takeDomSnapshot({ context, settings, logger, }) {
                 logger.log(`could not switch to frame during takeDomSnapshot. Path to frame: ${JSON.stringify(reference)}`, err);
             });
             if (frameContext) {
-                const frameSnapshot = await takeContextDomSnapshot({ context: frameContext });
+                const frameSnapshot = await takeContextDomSnapshot({
+                    context: frameContext,
+                    isRootFrame: false, // when we're diving into a frame, it's not the root frame anymore and we shouldn't pass the elements
+                });
                 let url = new URL(frameSnapshot.url);
                 if (url.protocol === 'data:')
                     url = new URL(`http://data-url-frame${url.search}`);

package/dist/universal/core-server.js

@@ -15,13 +15,14 @@ const history_1 = require("./history");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 async function makeCoreServer({ environment: defaultEnvironment, agentIdPrefix = `eyes-universal/${require('../../package.json').version}`, debug = false, shutdownMode = 'lazy', idleTimeout = 900000, // 15min
-printStdout = false, isProcess = false, ...handlerOptions } = {}) {
+printStdout = false, isProcess = false, maskLog = false, ...handlerOptions } = {}) {
     var _a, _b;
     const logDirname = (_a = process.env.APPLITOOLS_LOG_DIR) !== null && _a !== void 0 ? _a : path_1.default.resolve(os_1.default.tmpdir(), `applitools-logs`);
     const baseLogger = (0, logger_1.makeLogger)({
         handler: { type: 'rolling file', name: 'universal', dirname: logDirname },
         level: 'info',
         format: { label: 'core-universal', colors: false },
+        maskLog,
     });
     baseLogger.log('Core universal is going to be initialized with options', {
         debug,
@@ -83,6 +84,7 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
                 error: (message) => socket.emit('Logger.log', { level: 'error', message }),
                 fatal: (message) => socket.emit('Logger.log', { level: 'fatal', message }),
             },
+            maskLog,
         });
         logger.console.log(`Logs saved in: ${logDirname}`);
         const corePromise = socket.wait('Core.makeCore', ({ spec, agentId, environment, cwd }) => {
@@ -97,6 +99,7 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
                     universal: true,
                 },
                 logger,
+                maskLog,
             });
         });
         socket.command('Core.getAccountInfo', async (options) => {
@@ -181,7 +184,20 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
             return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.getResults(options);
         });
         socket.command('Debug.getHistory', async () => {
-            return getHistory();
+            return {
+                ...getHistory(),
+                initialArgs: {
+                    environment: defaultEnvironment,
+                    agentIdPrefix,
+                    debug,
+                    shutdownMode,
+                    idleTimeout,
+                    printStdout,
+                    isProcess,
+                    maskLog,
+                    ...handlerOptions,
+                },
+            };
         });
     });
     process.on('unhandledRejection', error => {

package/dist/universal/history.js

@@ -7,6 +7,7 @@ function withHistory(socket) {
         managers: new Map(),
         eyes: new Map(),
         startedAt: new Date().toISOString(),
+        unknownEvents: [],
     };
     const originalCommand = socket.command;
     socket.command = function command(name, fn) {
@@ -64,6 +65,9 @@ function withHistory(socket) {
                         }
                     }
                 }
+                else {
+                    history.unknownEvents.push({ name, payload });
+                }
             }
         });
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.27.1",
+  "version": "4.29.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,20 +74,20 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.21.1",
-    "@applitools/dom-capture": "11.5.2",
-    "@applitools/dom-snapshot": "4.11.12",
-    "@applitools/driver": "1.20.1",
-    "@applitools/ec-client": "1.9.18",
-    "@applitools/logger": "2.0.20",
-    "@applitools/nml-client": "1.8.20",
-    "@applitools/req": "1.7.5",
-    "@applitools/screenshoter": "3.10.1",
-    "@applitools/snippets": "2.6.3",
-    "@applitools/socket": "1.1.20",
-    "@applitools/spec-driver-webdriver": "1.1.21",
-    "@applitools/ufg-client": "1.15.1",
-    "@applitools/utils": "1.7.6",
+    "@applitools/core-base": "1.22.0",
+    "@applitools/dom-capture": "11.5.4",
+    "@applitools/dom-snapshot": "4.11.14",
+    "@applitools/driver": "1.20.3",
+    "@applitools/ec-client": "1.10.1",
+    "@applitools/logger": "2.1.0",
+    "@applitools/nml-client": "1.8.22",
+    "@applitools/req": "1.7.6",
+    "@applitools/screenshoter": "3.10.3",
+    "@applitools/snippets": "2.6.4",
+    "@applitools/socket": "1.2.0",
+    "@applitools/spec-driver-webdriver": "1.1.23",
+    "@applitools/ufg-client": "1.16.0",
+    "@applitools/utils": "1.7.7",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -100,11 +100,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.21",
-    "@applitools/spec-driver-selenium": "^1.5.92",
+    "@applitools/spec-driver-puppeteer": "^1.4.23",
+    "@applitools/spec-driver-selenium": "^1.5.94",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.5.11",
+    "@applitools/tunnel-client": "^1.6.0",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",

package/types/classic/core.d.ts

@@ -13,6 +13,7 @@ type Options<TSpec extends SpecType> = {
     agentId?: string;
     logger?: Logger;
     offlineLocationPath?: string;
+    maskLog?: boolean;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, agentId, logger: defaultLogger, offlineLocationPath, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, agentId, logger: defaultLogger, maskLog, offlineLocationPath, }: Options<TSpec>): Core<TSpec>;
 export {};

package/types/core.d.ts

@@ -17,6 +17,7 @@ type Options<TSpec extends SpecType> = {
     cwd?: string;
     logger?: Logger;
     asyncCache?: AsyncCache;
+    maskLog?: boolean;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, environment: defaultEnvironment, agentId, cwd, logger: defaultLogger, asyncCache, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, concurrency, environment: defaultEnvironment, agentId, cwd, maskLog, logger: defaultLogger, asyncCache, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
 export {};

package/types/make-manager.d.ts

@@ -18,8 +18,9 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
     asyncCache?: AsyncCache;
     offlineLocationPath?: string;
+    maskLog?: boolean;
 };
-export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd, logger: mainLogger, asyncCache, offlineLocationPath, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
+export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd, logger: mainLogger, asyncCache, offlineLocationPath, maskLog, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
     type?: TType | undefined;
     settings?: ManagerSettings | undefined;
     logger?: Logger | undefined;

package/types/offline/run-offline-snapshots.d.ts

@@ -7,5 +7,6 @@ export type OfflineSnapshotsSettings = EyesServerSettings & {
     failOnDiff: boolean;
     config: Config<SpecType, 'ufg'>;
     logger?: Logger;
+    jsonFilePath?: string;
 };
 export declare function runOfflineSnapshots(options: OfflineSnapshotsSettings): Promise<TestResult[]>;

package/types/ufg/core.d.ts

@@ -17,6 +17,7 @@ type Options<TSpec extends SpecType> = {
     agentId?: string;
     logger?: Logger;
     offlineLocationPath?: string;
+    maskLog?: boolean;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, base: defaultBase, asyncCache, concurrency, offlineLocationPath, fetchConcurrency, agentId, logger: defaultLogger, maskLog, }: Options<TSpec>): Core<TSpec>;
 export {};

package/types/universal/core-server.d.ts

@@ -7,9 +7,10 @@ export type Options = ServerOptions & {
     idleTimeout?: number;
     printStdout?: boolean;
     isProcess?: boolean;
+    maskLog?: boolean;
 };
 export declare function makeCoreServer({ environment: defaultEnvironment, agentIdPrefix, debug, shutdownMode, idleTimeout, // 15min
-printStdout, isProcess, ...handlerOptions }?: Options): Promise<{
+printStdout, isProcess, maskLog, ...handlerOptions }?: Options): Promise<{
     port: number;
     close?: () => void;
 }>;

package/dist/universal/core.js

@@ -1,174 +0,0 @@
-"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.makeClientSocket = exports.makeEyes = exports.makeManager = exports.makeCore = void 0;
-const socket_1 = require("@applitools/socket");
-const ws_1 = require("ws");
-const core_server_1 = require("./core-server");
-const utils = __importStar(require("@applitools/utils"));
-//TODO add refer and sanitizing support, solve types issues
-function makeCore(options) {
-    const socketPromise = makeClientSocket(options);
-    const core = {
-        concurrency: undefined,
-        base: null,
-        async getAccountInfo(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.getAccountInfo', options);
-        },
-        async getViewportSize(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.getViewportSize', options);
-        },
-        async setViewportSize(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.setViewportSize', options);
-        },
-        async getNMLClient(_options) {
-            // TODO
-            return null;
-        },
-        async clearNMLClientCache(_driver) {
-            return null;
-        },
-        async getECClient(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.makeECClient', options);
-        },
-        async locate(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.locate', options);
-        },
-        async locateText(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.locateText', options);
-        },
-        async extractText(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.extractText', options);
-        },
-        async openEyes(options) {
-            const socket = await socketPromise;
-            const eyesRef = await socket.request('Core.openEyes', options);
-            return makeEyes({ socket, core, eyesRef });
-        },
-        async openFunctionalSession(_options) {
-            // TODO
-            return null;
-        },
-        async makeManager(options) {
-            const socket = await socketPromise;
-            const managerRef = await socket.request('Core.makeManager', options);
-            return makeManager({ socket, core, managerRef });
-        },
-        async closeBatch(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.closeBatch', options);
-        },
-        async deleteTest(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.deleteTest', options);
-        },
-        async logEvent(options) {
-            const socket = await socketPromise;
-            return socket.request('Core.logEvent', options);
-        },
-        async updateIfScm() {
-            // TODO
-            return null;
-        },
-        async openCheckAndClose() {
-            // TODO
-            return null;
-        },
-    };
-    return core;
-}
-exports.makeCore = makeCore;
-function makeManager({ socket, core, managerRef, }) {
-    const manager = {
-        concurrency: undefined,
-        base: null,
-        async openEyes(options) {
-            const eyesRef = await socket.request('EyesManager.openEyes', { ...options, manager: managerRef });
-            return makeEyes({ socket, core, eyesRef });
-        },
-        async getResults(options) {
-            return socket.request('EyesManager.getResults', { ...options, manager: managerRef });
-        },
-    };
-    return manager;
-}
-exports.makeManager = makeManager;
-function makeEyes({ socket, core, eyesRef, }) {
-    const eyes = {
-        test: null,
-        running: null,
-        storage: null,
-        core,
-        getBaseEyes() {
-            return null;
-        },
-        getTypedEyes() {
-            return null;
-        },
-        async check(options) {
-            return socket.request('Eyes.check', { ...options, eyes: eyesRef });
-        },
-        async checkAndClose(options) {
-            return socket.request('Eyes.checkAndClose', { ...options, eyes: eyesRef });
-        },
-        async close(options) {
-            return socket.request('Eyes.close', { ...options, eyes: eyesRef });
-        },
-        async abort(options) {
-            return socket.request('Eyes.abort', { ...options, eyes: eyesRef });
-        },
-        async getResults(options) {
-            return socket.request('Eyes.getResults', { ...options, eyes: eyesRef });
-        },
-    };
-    return eyes;
-}
-exports.makeEyes = makeEyes;
-async function makeClientSocket({ agentId, environment, spec, }) {
-    const { port } = await (0, core_server_1.makeCoreServer)();
-    const socket = (0, socket_1.makeSocket)(new ws_1.WebSocket(`ws://localhost:${port}/eyes`), {
-        transport: 'ws',
-    });
-    socket.emit('Core.makeCore', {
-        spec: utils.types.isString(spec) ? spec : Object.keys(spec),
-        agentId,
-        environment,
-        cwd: process.cwd(),
-    });
-    if (!utils.types.isString(spec)) {
-        Object.entries(spec).forEach(([name, command]) => {
-            socket.command(`Driver.${name}`, args => command(...args));
-        });
-    }
-    return socket;
-}
-exports.makeClientSocket = makeClientSocket;

package/types/universal/core.d.ts

@@ -1,25 +0,0 @@
-import type { Core, EyesManager, Eyes } from '../types';
-import type { ClientSocket, Ref } from './types';
-import type { SpecType, SpecDriver } from '@applitools/driver';
-import { type Socket } from '@applitools/socket';
-import { WebSocket } from 'ws';
-export declare function makeCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'>(options: {
-    spec: 'webdriver' | SpecDriver<TSpec>;
-    environment?: Record<string, any>;
-    agentId: string;
-}): Core<TSpec, TType>;
-export declare function makeManager<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ socket, core, managerRef, }: {
-    socket: ClientSocket<TSpec, TType>;
-    core: Core<TSpec, TType>;
-    managerRef: Ref<EyesManager<TSpec, TType>>;
-}): EyesManager<TSpec, TType>;
-export declare function makeEyes<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ socket, core, eyesRef, }: {
-    socket: ClientSocket<TSpec, TType>;
-    core: Core<TSpec, TType>;
-    eyesRef: Ref<Eyes<TSpec, TType>>;
-}): Eyes<TSpec, TType>;
-export declare function makeClientSocket<TSpec extends SpecType>({ agentId, environment, spec, }: {
-    agentId: string;
-    environment?: Record<string, any>;
-    spec: 'webdriver' | SpecDriver<TSpec>;
-}): Promise<ClientSocket<TSpec, 'classic' | 'ufg'> & Socket<WebSocket>>;