@applitools/core 4.24.2 → 4.26.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## [4.26.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.25.0...js/core@4.26.0) (2024-12-05)
+
+
+### Features
+
+* deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+
+
+### Bug Fixes
+
+* coded regions dynamic regions with `By` locators ([#2660](https://github.com/Applitools-Dev/sdk/issues/2660)) ([e71b3ae](https://github.com/Applitools-Dev/sdk/commit/e71b3aec7241e61c9ba0d637e6242cedd8f4be7b))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.15.0
+  #### Features
+
+  * deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+* @applitools/core-base bumped to 1.20.0
+  #### Features
+
+  * deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+* @applitools/ec-client bumped to 1.9.16
+
+
+## [4.25.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.2...js/core@4.25.0) (2024-11-29)
+
+
+### Features
+
+* offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
+
 ## [4.24.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.1...js/core@4.24.2) (2024-11-27)
 
 

package/dist/cli/cli.js

@@ -32,7 +32,6 @@ const core_server_1 = require("../universal/core-server");
 const core_server_process_1 = require("../universal/core-server-process");
 const logs_1 = require("../troubleshoot/logs");
 const check_network_1 = require("../troubleshoot/check-network");
-const run_offline_snapshots_1 = require("../run-offline-snapshots");
 const yargs_1 = __importDefault(require("yargs"));
 const utils = __importStar(require("@applitools/utils"));
 const fs_1 = __importDefault(require("fs"));
@@ -152,29 +151,5 @@ void yargs_1.default
     handler: async () => {
         await (0, check_network_1.checkNetwork)();
     },
-})
-    .command({
-    command: 'run-offline-snapshots',
-    builder: yargs => yargs
-        .options({
-        offlineLocationPath: {
-            description: 'path to offline snapshots folder',
-            type: 'string',
-        },
-        failOnDiff: {
-            description: 'should exit process with non-zero exit code, thereby failing the CI job',
-            type: 'boolean',
-            default: false,
-        },
-    })
-        .fail((_msg, err, _yargs) => {
-        if (err) {
-            console.error(err.message);
-            process.exit(1);
-        }
-    }),
-    handler: async (args) => {
-        await (0, run_offline_snapshots_1.runOfflineSnapshots)(args);
-    },
 })
     .wrap(yargs_1.default.terminalWidth()).argv;

package/dist/index.js

@@ -35,3 +35,4 @@ __exportStar(require("./autonomous/core"), exports);
 __exportStar(require("@applitools/driver/dist/debug"), exports);
 exports.formatters = __importStar(require("./utils/format-results"));
 exports.logs = __importStar(require("./troubleshoot/logs"));
+__exportStar(require("./offline/run-offline-snapshots"), exports);

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;

package/dist/{run-offline-snapshots.js → offline/run-offline-snapshots.js}

@@ -29,36 +29,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runOfflineSnapshots = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const core_1 = require("./core");
-const get_ufg_client_1 = require("./ufg/get-ufg-client");
+const core_1 = require("../core");
+const get_ufg_client_1 = require("../ufg/get-ufg-client");
 const logger_1 = require("@applitools/logger");
-const to_base_check_settings_1 = require("./automation/utils/to-base-check-settings");
+const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const chalk_1 = __importDefault(require("chalk"));
 const utils = __importStar(require("@applitools/utils"));
+const merge_configs_1 = require("./merge-configs");
 async function runOfflineSnapshots(options) {
+    var _a, _b;
     if (!options.offlineLocationPath)
         throw new Error('offlineLocationPath is required');
+    const offlineLocationPath = path_1.default.resolve(options.offlineLocationPath);
     const startTime = Date.now();
-    const logger = (0, logger_1.makeLogger)({ format: { label: 'offline-exec' } });
+    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 core = (0, core_1.makeCore)();
-    const account = await core.getAccountInfo({ settings: options });
+    const account = await core.getAccountInfo({ settings: eyesServerSettings });
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
         settings: { ...account.eyesServer, ...account.ufgServer },
     });
-    const executionFolders = (await fs_1.default.promises.readdir(options.offlineLocationPath)).filter(filename => /execution\-\d+/.test(filename));
-    if (executionFolders.length === 1) {
-        logger.console.log(`Running execution ${executionFolders[0]} from folder ${path_1.default.resolve(options.offlineLocationPath)}`);
+    const testFolders = (await fs_1.default.promises.readdir(offlineLocationPath))
+        .filter(filename => filename.startsWith('test-'))
+        .sort();
+    if (testFolders.length === 1) {
+        logger.console.log(`Running single test from folder ${offlineLocationPath}`);
     }
-    else if (executionFolders.length === 0) {
-        logger.console.log('No execution artifacts were found at', options.offlineLocationPath);
+    else if (testFolders.length === 0) {
+        logger.console.log('No test artifacts were found at', offlineLocationPath);
     }
     else {
-        logger.console.log(`Running the following executions from folder ${options.offlineLocationPath} :\n  ${executionFolders.join('\n  ')}`);
+        logger.console.log(`Running ${testFolders.length} tests from folder ${offlineLocationPath}`);
     }
-    if (executionFolders.length === 0) {
-        throw new Error(`Unable to find offline executions in ${options.offlineLocationPath}`);
+    if (testFolders.length === 0) {
+        throw new Error(`Unable to find offline executions in ${offlineLocationPath}`);
     }
-    const allTestResults = (await Promise.all(executionFolders.map(runExecution))).flat();
+    const allTestResults = await runTests(testFolders);
     const { isSuccess, outputStr } = processResults({ testResults: allTestResults, totalTime: Date.now() - startTime });
     if (!isSuccess && options.failOnDiff) {
         throw new Error(outputStr);
@@ -66,29 +72,27 @@ async function runOfflineSnapshots(options) {
     else {
         logger.console.log(outputStr);
     }
-    async function runExecution(executionName) {
-        const executionLogger = logger.extend({ tags: [executionName] });
-        const executionPath = path_1.default.resolve(options.offlineLocationPath, executionName);
-        executionLogger.log('handling execution', executionPath);
-        const testFolders = (await fs_1.default.promises.readdir(executionPath)).filter(foldername => foldername.startsWith('test-'));
-        executionLogger.log('running tests', testFolders);
+    return allTestResults;
+    async function runTests(testFolders) {
+        logger.log('running tests', testFolders);
         const results = await Promise.all(testFolders.map(async (testFolder) => {
             const testLogger = logger.extend({ tags: [testFolder] });
-            const testPath = path_1.default.resolve(executionPath, testFolder);
-            const openSettings = (await fs_1.default.promises
-                .readFile(path_1.default.resolve(testPath, 'settings.json'), 'utf-8')
-                .then(JSON.parse));
+            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)})`);
-            return runTest(executionPath, testPath, openSettings, testLogger);
+            return runTest(testPath, openSettings, testLogger);
         }));
         const batchIds = [...new Set(results.map(t => t.batchId))];
         const allTestResults = results.map(t => t.results);
-        executionLogger.log('done running all tests', allTestResults);
+        logger.log('done running all tests', allTestResults);
         await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
-        executionLogger.log('done execution', executionName);
+        logger.log('done closing batches');
         return allTestResults;
     }
-    async function runTest(executionPath, testPath, openSettings, logger) {
+    async function runTest(testPath, openSettings, logger) {
         const environment = await ufgClient.getActualEnvironment({
             settings: { environment: openSettings.environment.requested },
         });
@@ -106,17 +110,17 @@ async function runOfflineSnapshots(options) {
         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(checkFolder => fs_1.default.promises.readFile(path_1.default.resolve(testPath, checkFolder, 'snapshot.json'), 'utf-8').then(JSON.parse))));
-        await uploadResources(executionPath, targets, logger);
+        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)));
-        await eyes.close({
-            settings: await fs_1.default.promises.readFile(path_1.default.resolve(testPath, 'close.json'), 'utf-8').then(JSON.parse),
-        });
+        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);
         return { batchId: openSettings.batch.id, results: (await eyes.getResults({ logger }))[0] };
     }
-    async function uploadResources(executionPath, targets, logger) {
+    async function uploadResources(targets, logger) {
         const uploadLogger = logger.extend({ tags: ['upload-resources'] });
         const promises = targets.map(async ({ target }) => {
             let resourcePromises = Object.values(target.resources)
@@ -125,7 +129,7 @@ async function runOfflineSnapshots(options) {
                 const contentfuleResource = {
                     id: '',
                     url: '',
-                    value: await fs_1.default.promises.readFile(path_1.default.resolve(executionPath, 'resources', resource.hash)),
+                    value: await fs_1.default.promises.readFile(path_1.default.join(offlineLocationPath, 'resources', resource.hash)),
                     contentType: resource.contentType,
                     hash: resource,
                 };
@@ -135,7 +139,7 @@ async function runOfflineSnapshots(options) {
                 resource: {
                     id: '',
                     url: '',
-                    value: await fs_1.default.promises.readFile(path_1.default.resolve(executionPath, 'resources', target.snapshot.hash)),
+                    value: await fs_1.default.promises.readFile(path_1.default.join(offlineLocationPath, 'resources', target.snapshot.hash)),
                     contentType: target.snapshot.contentType,
                     hash: target.snapshot,
                 },
@@ -180,9 +184,10 @@ async function runOfflineSnapshots(options) {
         baseSettings.stepIndex = index;
         baseTarget.source = target.target.source; // TODO verify
         // baseTarget.name = snapshot.title // TODO figure out
+        const mergedCheckSettings = (0, merge_configs_1.mergeConfigs)(baseSettings, options.config.check);
         await eyes.check({
             target: { ...baseTarget, isTransformed: true },
-            settings: baseSettings,
+            settings: mergedCheckSettings,
             logger: checkLogger,
         });
     }

package/dist/ufg/utils/to-safe-check-settings.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toSafeCheckSettings = void 0;
 const utils = __importStar(require("@applitools/utils"));
-const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility'];
+const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility', 'dynamic'];
 function toSafeCheckSettings({ settings }) {
     const calculate = regionTypes.flatMap(regionType => {
         var _a;

package/dist/utils/ensure-offline-folder.js

@@ -32,7 +32,7 @@ const path_1 = __importDefault(require("path"));
 const utils = __importStar(require("@applitools/utils"));
 function ensureOfflineFolder() {
     const offlineLocationPath = utils.general.getEnvValue('OFFLINE_LOCATION_PATH')
-        ? path_1.default.resolve(utils.general.getEnvValue('OFFLINE_LOCATION_PATH'), `execution-${Date.now()}`)
+        ? path_1.default.resolve(utils.general.getEnvValue('OFFLINE_LOCATION_PATH'))
         : undefined;
     if (offlineLocationPath) {
         fs_1.default.mkdirSync(offlineLocationPath, { recursive: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.24.2",
+  "version": "4.26.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -28,8 +28,8 @@
     "./package.json": "./package.json"
   },
   "bin": {
-    "eyes": "./dist/cli/cli.js",
-    "eyes-check-network": "./dist/troubleshoot/check-network.js"
+    "eyes-check-network": "./dist/troubleshoot/check-network.js",
+    "eyes-core": "./dist/cli/cli.js"
   },
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",
@@ -58,7 +58,7 @@
     "setup": "run --top-level browsers:setup"
   },
   "sea": {
-    "bin": "eyes",
+    "bin": "eyes-core",
     "certs": {
       "win": {
         "cert": "env.CODE_SIGNING_CERT_WIN",
@@ -74,11 +74,11 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.19.3",
+    "@applitools/core-base": "1.20.0",
     "@applitools/dom-capture": "11.5.2",
     "@applitools/dom-snapshot": "4.11.11",
     "@applitools/driver": "1.20.0",
-    "@applitools/ec-client": "1.9.15",
+    "@applitools/ec-client": "1.9.16",
     "@applitools/logger": "2.0.19",
     "@applitools/nml-client": "1.8.19",
     "@applitools/req": "1.7.4",
@@ -86,7 +86,7 @@
     "@applitools/snippets": "2.6.3",
     "@applitools/socket": "1.1.19",
     "@applitools/spec-driver-webdriver": "1.1.20",
-    "@applitools/ufg-client": "1.14.1",
+    "@applitools/ufg-client": "1.15.0",
     "@applitools/utils": "1.7.5",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",

package/types/index.d.ts

@@ -7,3 +7,4 @@ export { type SpecType, type SpecDriver, type Selector } from '@applitools/drive
 export * from '@applitools/driver/dist/debug';
 export * as formatters from './utils/format-results';
 export * as logs from './troubleshoot/logs';
+export * from './offline/run-offline-snapshots';

package/types/offline/merge-configs.d.ts

@@ -0,0 +1 @@
+export declare function mergeConfigs<TBase extends Record<string, any>>(base: TBase, other: Record<string, any>): TBase;

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

@@ -0,0 +1,11 @@
+import { Config, type EyesServerSettings } from '../types';
+import { type Logger } from '@applitools/logger';
+import type { TestResult } from '@applitools/core-base';
+import type { SpecType } from '@applitools/driver';
+export type OfflineSnapshotsSettings = EyesServerSettings & {
+    offlineLocationPath: string;
+    failOnDiff: boolean;
+    config: Config<SpecType, 'ufg'>;
+    logger?: Logger;
+};
+export declare function runOfflineSnapshots(options: OfflineSnapshotsSettings): Promise<TestResult[]>;

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

@@ -1,6 +0,0 @@
-import { type EyesServerSettings } from './types';
-export type OfflineSnapshotsSettings = EyesServerSettings & {
-    offlineLocationPath: string;
-    failOnDiff: boolean;
-};
-export declare function runOfflineSnapshots(options: OfflineSnapshotsSettings): Promise<void>;