@applitools/core 4.28.0 → 4.29.0

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # 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)
 
 

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.28.0",
+  "version": "4.29.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -75,17 +75,17 @@
   },
   "dependencies": {
     "@applitools/core-base": "1.22.0",
-    "@applitools/dom-capture": "11.5.3",
-    "@applitools/dom-snapshot": "4.11.13",
-    "@applitools/driver": "1.20.2",
-    "@applitools/ec-client": "1.10.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.21",
+    "@applitools/nml-client": "1.8.22",
     "@applitools/req": "1.7.6",
-    "@applitools/screenshoter": "3.10.2",
-    "@applitools/snippets": "2.6.3",
+    "@applitools/screenshoter": "3.10.3",
+    "@applitools/snippets": "2.6.4",
     "@applitools/socket": "1.2.0",
-    "@applitools/spec-driver-webdriver": "1.1.22",
+    "@applitools/spec-driver-webdriver": "1.1.23",
     "@applitools/ufg-client": "1.16.0",
     "@applitools/utils": "1.7.7",
     "@types/ws": "8.5.5",
@@ -100,8 +100,8 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.22",
-    "@applitools/spec-driver-selenium": "^1.5.93",
+    "@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.6.0",

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[]>;