@applitools/core 4.20.0 → 4.20.2

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## [4.20.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.20.1...js/core@4.20.2) (2024-10-03)
+
+
+### Bug Fixes
+
+* cache key for offline execution ([#2552](https://github.com/Applitools-Dev/sdk/issues/2552)) ([d0d1138](https://github.com/Applitools-Dev/sdk/commit/d0d11386be0f82c9e59e753bd0dc97aa3b05d93e))
+
+
+### Dependencies
+
+* @applitools/driver bumped to 1.19.2
+  #### Bug Fixes
+
+  * cache key for offline execution ([#2552](https://github.com/Applitools-Dev/sdk/issues/2552)) ([d0d1138](https://github.com/Applitools-Dev/sdk/commit/d0d11386be0f82c9e59e753bd0dc97aa3b05d93e))
+* @applitools/spec-driver-selenium bumped to 1.5.85
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.14
+
+* @applitools/ufg-client bumped to 1.13.1
+  #### Bug Fixes
+
+  * cache key for offline execution ([#2552](https://github.com/Applitools-Dev/sdk/issues/2552)) ([d0d1138](https://github.com/Applitools-Dev/sdk/commit/d0d11386be0f82c9e59e753bd0dc97aa3b05d93e))
+* @applitools/spec-driver-webdriver bumped to 1.1.14
+
+* @applitools/screenshoter bumped to 3.8.38
+
+* @applitools/nml-client bumped to 1.8.12
+
+* @applitools/core-base bumped to 1.17.2
+  #### Bug Fixes
+
+  * cache key for offline execution ([#2552](https://github.com/Applitools-Dev/sdk/issues/2552)) ([d0d1138](https://github.com/Applitools-Dev/sdk/commit/d0d11386be0f82c9e59e753bd0dc97aa3b05d93e))
+* @applitools/ec-client bumped to 1.9.8
+
+
+## [4.20.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.20.0...js/core@4.20.1) (2024-10-01)
+
+
+### Bug Fixes
+
+* don't tar with offline ([#2550](https://github.com/Applitools-Dev/sdk/issues/2550)) ([d8b1a83](https://github.com/Applitools-Dev/sdk/commit/d8b1a833d13b01f5306501772e1c831692512360))
+
+
+### Dependencies
+
+* @applitools/core-base bumped to 1.17.1
+  #### Bug Fixes
+
+  * don't tar with offline ([#2550](https://github.com/Applitools-Dev/sdk/issues/2550)) ([d8b1a83](https://github.com/Applitools-Dev/sdk/commit/d8b1a833d13b01f5306501772e1c831692512360))
+* @applitools/ec-client bumped to 1.9.7
+
+
 ## [4.20.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.19.0...js/core@4.20.0) (2024-09-30)
 
 

package/dist/cli/cli.js

@@ -161,6 +161,11 @@ yargs_1.default
             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) {

package/dist/core.js

@@ -49,10 +49,10 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
     (0, memory_usage_logging_1.startMemoryUsageLogging)({ logger });
     const environment = (0, extract_test_environment_1.extractTestEnvironment)(defaultEnvironment);
-    logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment `, environment);
+    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)
         (0, validate_sdk_version_1.validateSdkVersion)(environment.sdk, { logger });
-    const offlineLocationPath = (0, ensure_offline_folder_1.ensureOfflineFolder)();
     const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
     const cores = {
         ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger, offlineLocationPath }),

package/dist/run-offline-snapshots.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.runOfflineSnapshots = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const tar = __importStar(require("tar"));
 const core_1 = require("./core");
 const get_ufg_client_1 = require("./ufg/get-ufg-client");
 const logger_1 = require("@applitools/logger");
@@ -46,36 +45,29 @@ async function runOfflineSnapshots(options) {
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
         settings: { ...account.eyesServer, ...account.ufgServer },
     });
-    const executionFiles = (await fs_1.default.promises.readdir(options.offlineLocationPath)).filter(filename => filename.endsWith('.tar.gz'));
-    if (executionFiles.length === 1) {
-        logger.console.log(`Running execution ${executionFiles[0]} from folder ${path_1.default.resolve(options.offlineLocationPath)}`);
+    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)}`);
     }
-    else if (executionFiles.length === 0) {
+    else if (executionFolders.length === 0) {
         logger.console.log('No execution artifacts were found at', options.offlineLocationPath);
     }
     else {
-        logger.console.log(`Running the following executions from folder ${options.offlineLocationPath} :\n  ${executionFiles.join('\n  ')}`);
+        logger.console.log(`Running the following executions from folder ${options.offlineLocationPath} :\n  ${executionFolders.join('\n  ')}`);
     }
-    if (executionFiles.length === 0) {
+    if (executionFolders.length === 0) {
         throw new Error(`Unable to find offline executions in ${options.offlineLocationPath}`);
     }
-    const allTestResults = (await Promise.all(executionFiles.map(runExecution))).flat();
-    const { exitCode, outputStr } = processResults({ testResults: allTestResults, totalTime: Date.now() - startTime });
-    if (exitCode) {
+    const allTestResults = (await Promise.all(executionFolders.map(runExecution))).flat();
+    const { isSuccess, outputStr } = processResults({ testResults: allTestResults, totalTime: Date.now() - startTime });
+    if (!isSuccess && options.failOnDiff) {
         throw new Error(outputStr);
     }
     else {
         logger.console.log(outputStr);
     }
-    async function runExecution(executionFile) {
-        const executionName = executionFile.replace('.tar.gz', '');
+    async function runExecution(executionName) {
         const executionLogger = logger.extend({ tags: [executionName] });
-        executionLogger.log('unpacking execution', executionFile);
-        await tar.extract({
-            file: path_1.default.resolve(options.offlineLocationPath, executionFile),
-            gzip: true,
-            C: options.offlineLocationPath,
-        });
         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-'));
@@ -95,7 +87,7 @@ async function runOfflineSnapshots(options) {
         // @ts-expect-error // we use node v12 types, therefore it's not aware of the existence of `fs.promises.rm`
         await fs_1.default.promises.rm(executionPath, { recursive: true });
         await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
-        executionLogger.log('one execution', executionFile);
+        executionLogger.log('done execution', executionName);
         return allTestResults;
     }
     async function runTest(executionPath, testPath, openSettings, logger) {
@@ -280,19 +272,19 @@ function processResults({ testResults, totalTime, saveNewTests = true, failOnDif
     // if (Number(testConcurrency) === 5) {
     //   outputStr += `\n${concurrencyMsg}\n`
     // }
-    let exitCode;
+    let isSuccess;
     if (errors.length) {
-        exitCode = 1;
+        isSuccess = false;
     }
     else if (failOnDiff) {
-        exitCode = !warnForUnsavedNewTests && passedOrNew.length && !unresolvedOrFailed.length ? 0 : 1;
+        isSuccess = !warnForUnsavedNewTests && passedOrNew.length && !unresolvedOrFailed.length;
     }
     else {
-        exitCode = 0;
+        isSuccess = true;
     }
     return {
         outputStr,
-        exitCode,
+        isSuccess,
     };
 }
 function testResultsOutput(results, warnForUnsavedNewTests) {

package/dist/ufg/get-ufg-client.js

@@ -29,7 +29,7 @@ const utils = __importStar(require("@applitools/utils"));
 function makeGetUFGClient({ client, fetchConcurrency, offlineLocationPath, logger: mainLogger, asyncCache, }) {
     // we are caching by the server config, therefor if the user creates another Runner / manager with the same server config but different
     // fetchConcurrency, it will not take any affect.
-    const getUFGClientWithCache = utils.general.cachify(getUFGClient, ([options]) => client ? 'default' : [{ ...options.settings, fetchConcurrency: undefined }]);
+    const getUFGClientWithCache = utils.general.cachify(getUFGClient, ([options]) => client ? 'default' : [{ ...options.settings, fetchConcurrency: undefined, offlineLocationPath }]);
     if (client)
         getUFGClientWithCache.setCachedValue('default', Promise.resolve(client));
     return getUFGClientWithCache;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.20.0",
+  "version": "4.20.2",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,26 +74,25 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.17.0",
+    "@applitools/core-base": "1.17.2",
     "@applitools/dom-capture": "11.5.0",
     "@applitools/dom-snapshot": "4.11.3",
-    "@applitools/driver": "1.19.1",
-    "@applitools/ec-client": "1.9.6",
+    "@applitools/driver": "1.19.2",
+    "@applitools/ec-client": "1.9.8",
     "@applitools/logger": "2.0.18",
-    "@applitools/nml-client": "1.8.11",
+    "@applitools/nml-client": "1.8.12",
     "@applitools/req": "1.7.2",
-    "@applitools/screenshoter": "3.8.37",
+    "@applitools/screenshoter": "3.8.38",
     "@applitools/snippets": "2.5.0",
     "@applitools/socket": "1.1.18",
-    "@applitools/spec-driver-webdriver": "1.1.13",
-    "@applitools/ufg-client": "1.13.0",
+    "@applitools/spec-driver-webdriver": "1.1.14",
+    "@applitools/ufg-client": "1.13.1",
     "@applitools/utils": "1.7.4",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
     "node-fetch": "2.6.7",
     "semver": "7.6.2",
-    "tar": "7.4.3",
     "webdriver": "7.31.1",
     "ws": "8.17.1",
     "yargs": "17.7.2"
@@ -101,8 +100,8 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.13",
-    "@applitools/spec-driver-selenium": "^1.5.84",
+    "@applitools/spec-driver-puppeteer": "^1.4.14",
+    "@applitools/spec-driver-selenium": "^1.5.85",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.5.8",

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

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