@applitools/core 4.38.1 → 4.39.0

package/CHANGELOG.md

@@ -1,5 +1,89 @@
 # Changelog
 
+## [4.39.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.38.2...js/core@4.39.0) (2025-05-14)
+
+
+### Features
+
+* add logging for offline execution startup with system details ([#2971](https://github.com/Applitools-Dev/sdk/issues/2971)) ([82eb5cd](https://github.com/Applitools-Dev/sdk/commit/82eb5cdffe5cf1f88f20e62d50f43600b0a06361))
+* mac arm binary | FLD-3010 ([#2950](https://github.com/Applitools-Dev/sdk/issues/2950)) ([0cb7f59](https://github.com/Applitools-Dev/sdk/commit/0cb7f59b851c746e12b3a8a210a505adf3230903))
+
+
+### Bug Fixes
+
+* missing resources problem ([#2976](https://github.com/Applitools-Dev/sdk/issues/2976)) ([ab0d217](https://github.com/Applitools-Dev/sdk/commit/ab0d217d23a1df4ad24618a9bf00dc84c57cd8bc))
+
+
+### Dependencies
+
+* @applitools/core-base bumped to 1.25.3
+  #### Performance Improvements
+
+  * batchify log event ([#2970](https://github.com/Applitools-Dev/sdk/issues/2970)) ([9b1556f](https://github.com/Applitools-Dev/sdk/commit/9b1556f0c9ddc64a52b8b3f928c18e35f6fbbc17))
+* @applitools/ec-client bumped to 1.10.14
+
+
+## [4.38.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.38.1...js/core@4.38.2) (2025-05-11)
+
+
+### Bug Fixes
+
+* don't kill offline exectuion when one render fails | AD-9892 ([#2962](https://github.com/Applitools-Dev/sdk/issues/2962)) ([add5c43](https://github.com/Applitools-Dev/sdk/commit/add5c43892206dfaa5bf434c45e22a467fa20266))
+* remove redundant file readings and added rendering concurrency limit ([#2956](https://github.com/Applitools-Dev/sdk/issues/2956)) ([b970180](https://github.com/Applitools-Dev/sdk/commit/b97018010fdf12cb0d202192b22f643c16c569d5))
+
+
+### Performance Improvements
+
+* avoid retry when x-applitools-dont-retry header is presented | AD-9834 ([#2959](https://github.com/Applitools-Dev/sdk/issues/2959)) ([492dff6](https://github.com/Applitools-Dev/sdk/commit/492dff6ca431e242eb85a2c87d429f8676490e1a))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.8.2
+  #### Bug Fixes
+
+  * remove redundant file readings and added rendering concurrency limit ([#2956](https://github.com/Applitools-Dev/sdk/issues/2956)) ([b970180](https://github.com/Applitools-Dev/sdk/commit/b97018010fdf12cb0d202192b22f643c16c569d5))
+* @applitools/ufg-client bumped to 1.16.11
+  #### Bug Fixes
+
+  * remove redundant file readings and added rendering concurrency limit ([#2956](https://github.com/Applitools-Dev/sdk/issues/2956)) ([b970180](https://github.com/Applitools-Dev/sdk/commit/b97018010fdf12cb0d202192b22f643c16c569d5))
+
+
+
+* @applitools/logger bumped to 2.1.4
+
+* @applitools/dom-snapshot bumped to 4.11.21
+
+* @applitools/socket bumped to 1.2.5
+
+* @applitools/req bumped to 1.7.12
+
+* @applitools/image bumped to 1.1.20
+
+* @applitools/driver bumped to 1.21.4
+
+* @applitools/spec-driver-webdriver bumped to 1.2.5
+
+* @applitools/spec-driver-selenium bumped to 1.5.101
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.30
+
+* @applitools/screenshoter bumped to 3.11.4
+
+* @applitools/nml-client bumped to 1.9.4
+
+* @applitools/tunnel-client bumped to 1.6.7
+
+* @applitools/core-base bumped to 1.25.2
+  #### Performance Improvements
+
+  * avoid retry when x-applitools-dont-retry header is presented | AD-9834 ([#2959](https://github.com/Applitools-Dev/sdk/issues/2959)) ([492dff6](https://github.com/Applitools-Dev/sdk/commit/492dff6ca431e242eb85a2c87d429f8676490e1a))
+
+
+
+* @applitools/ec-client bumped to 1.10.13
+
+
 ## [4.38.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.38.0...js/core@4.38.1) (2025-05-07)
 
 

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

@@ -38,21 +38,31 @@ const utils = __importStar(require("@applitools/utils"));
 const merge_configs_1 = require("./merge-configs");
 const format_results_1 = require("../utils/format-results");
 const throat_1 = __importDefault(require("throat"));
+const os_1 = __importDefault(require("os"));
 const throttledReadFile = (0, throat_1.default)(Number(process.env.APPLITOOLS_FILE_READING_CONCURRENCY) || 1000, fs_1.default.promises.readFile);
 function getConsoleLogLimit() {
     var _a;
     return (_a = utils.general.getEnvValue('OFFLINE_LOG_LIMIT', 'number')) !== null && _a !== void 0 ? _a : 20;
 }
+function version() {
+    try {
+        return JSON.parse(fs_1.default.readFileSync(require.resolve('../../package.json'), 'utf-8')).version;
+    }
+    catch (e) {
+        return 'unknown';
+    }
+}
 async function runOfflineSnapshots(options) {
     var _a;
     const limitConsoleLogs = getConsoleLogLimit();
+    const throttledRender = (0, throat_1.default)(Number(process.env.APPLITOOLS_RENDER_CONCURRENCY) || 1000, render);
     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 = { ...options.config.open, ...options };
-    const core = (0, core_1.makeCore)();
+    const core = (0, core_1.makeCore)({ agentId: `js/core-offline/${version()}`, logger });
     const account = await core.getAccountInfo({ settings: eyesServerSettings });
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
         settings: { ...account.eyesServer, ...account.ufgServer },
@@ -60,6 +70,7 @@ async function runOfflineSnapshots(options) {
     const testFolders = (await fs_1.default.promises.readdir(offlineLocationPath))
         .filter(filename => filename.startsWith('test-'))
         .sort();
+    void logStartupInfo();
     if (testFolders.length === 1) {
         logger.console.log(`Running single test from folder ${offlineLocationPath}`);
     }
@@ -135,36 +146,53 @@ async function runOfflineSnapshots(options) {
             const uploadResourcePromise = uploadResources(targets, logger).then(() => logger.log('uploaded resources for test', testPath));
             if (targets.length === 1) {
                 logger.log('only one check found for test', testPath);
-                await uploadResourcePromise;
-                const target = targets[0];
-                resultsGetter = await runOpenCheckAndClose({
-                    ...target,
-                    settings: {
-                        ...(0, merge_configs_1.mergeConfigs)((0, merge_configs_1.mergeConfigs)(closeSettings, openSettings), target.settings),
-                        ...account.eyesServer,
-                        environment: {
-                            ...openSettings.environment,
-                            ...target.settings.environment,
+                try {
+                    await uploadResourcePromise;
+                    const target = targets[0];
+                    resultsGetter = await runOpenCheckAndClose({
+                        ...target,
+                        settings: {
+                            ...(0, merge_configs_1.mergeConfigs)((0, merge_configs_1.mergeConfigs)(closeSettings, openSettings), target.settings),
+                            ...account.eyesServer,
+                            environment: {
+                                ...openSettings.environment,
+                                ...target.settings.environment,
+                            },
                         },
-                    },
-                }, logger, environment);
-                logger.log('finished running checks for test', testPath);
+                    }, logger, environment);
+                    logger.log('finished running checks for test', testPath);
+                }
+                catch (err) {
+                    logger.log('error running checks for test', testPath, err);
+                    resultsGetter = await makeAbortedTest(openSettings, environment, logger, err);
+                }
             }
             else {
                 const eyes = await openEyes(openSettings, environment, logger);
                 logger.log('opened eyes for test', testPath);
-                await uploadResourcePromise;
                 const lastTarget = targets.pop();
-                await Promise.all(targets.map((target, index) => runCheck(eyes, target, index, logger)));
-                if (lastTarget) {
-                    lastTarget.settings = (0, merge_configs_1.mergeConfigs)(lastTarget.settings, closeSettings);
-                    await runCheckAndClose(eyes, lastTarget, targets.length - 1, logger);
-                    logger.log('finished running checks for test', testPath);
+                try {
+                    await uploadResourcePromise;
+                    await Promise.all(targets.map((target, index) => runCheck(eyes, target, index, logger)));
+                    if (lastTarget) {
+                        lastTarget.settings = (0, merge_configs_1.mergeConfigs)(lastTarget.settings, closeSettings);
+                        await runCheckAndClose(eyes, lastTarget, targets.length - 1, logger);
+                        logger.log('finished running checks for test', testPath);
+                    }
+                    else {
+                        logger.log('no checks found for test', testPath);
+                        // on empty test, `checkAndClose` will not be called so we need to call `close` instead
+                        await eyes.close({ settings: closeSettings });
+                    }
                 }
-                else {
-                    logger.log('no checks found for test', testPath);
-                    // on empty test, `checkAndClose` will not be called so we need to call `close` instead
-                    await eyes.close({ settings: closeSettings });
+                catch (err) {
+                    logger.log('error running checks for test', testPath, err);
+                    await eyes.abort({
+                        logger,
+                        settings: {
+                            reason: err,
+                        },
+                    });
                 }
                 resultsGetter = eyes;
             }
@@ -197,11 +225,11 @@ async function runOfflineSnapshots(options) {
         }));
         return targets;
     }
-    async function makeAbortedTest(openSettings, environment, logger) {
+    async function makeAbortedTest(openSettings, environment, logger, reason = 'internal') {
         const eyes = await openEyes(openSettings, environment, logger);
         await eyes.abort({
             settings: {
-                reason: 'internal',
+                reason,
             },
         });
         return eyes;
@@ -223,7 +251,7 @@ async function runOfflineSnapshots(options) {
     async function uploadResources(targets, logger) {
         const uploadLogger = logger.extend({ tags: ['upload-resources'] });
         const promises = targets.map(async ({ target }) => {
-            let resourcePromises = Object.values(target.resources)
+            const resourcePromises = Object.values(target.resources)
                 .filter(isHashedResource)
                 .map(async (resource) => {
                 return ufgClient.uploadResource({
@@ -242,13 +270,18 @@ async function runOfflineSnapshots(options) {
                     logger: uploadLogger,
                 });
             });
-            resourcePromises = resourcePromises.concat(ufgClient.uploadResource({
+            resourcePromises.push(ufgClient.uploadResource({
                 resource: {
-                    id: '',
-                    url: '',
-                    value: await throttledReadFile(path_1.default.join(offlineLocationPath, 'resources', target.snapshot.hash)),
-                    contentType: target.snapshot.contentType,
                     hash: target.snapshot,
+                    async getter() {
+                        return {
+                            id: '',
+                            url: '',
+                            value: await throttledReadFile(path_1.default.join(offlineLocationPath, 'resources', target.snapshot.hash)),
+                            contentType: target.snapshot.contentType,
+                            hash: target.snapshot,
+                        };
+                    },
                 },
                 logger: uploadLogger,
             }));
@@ -262,7 +295,7 @@ async function runOfflineSnapshots(options) {
     async function runCheck(eyes, target, index, logger) {
         var _a;
         const checkLogger = logger.extend({ tags: [`check-${index}`] });
-        const { mergedCheckSettings, baseTarget } = await render(target, checkLogger);
+        const { mergedCheckSettings, baseTarget } = await throttledRender(target, checkLogger);
         (_a = mergedCheckSettings.stepIndex) !== null && _a !== void 0 ? _a : (mergedCheckSettings.stepIndex = index);
         await eyes.check({
             target: { ...baseTarget, isTransformed: true },
@@ -275,7 +308,7 @@ async function runOfflineSnapshots(options) {
     async function runCheckAndClose(eyes, target, index, logger) {
         var _a;
         const checkLogger = logger.extend({ tags: [`check-${index}`] });
-        const { mergedCheckSettings, baseTarget } = await render(target, checkLogger);
+        const { mergedCheckSettings, baseTarget } = await throttledRender(target, checkLogger);
         (_a = mergedCheckSettings.stepIndex) !== null && _a !== void 0 ? _a : (mergedCheckSettings.stepIndex = index);
         await eyes.checkAndClose({
             target: { ...baseTarget, isTransformed: true },
@@ -287,7 +320,7 @@ async function runOfflineSnapshots(options) {
     }
     async function runOpenCheckAndClose(target, logger, actualEnvironment) {
         const checkLogger = logger.extend({ tags: ['open-check-and-close'] });
-        const { mergedCheckSettings, baseTarget } = await render(target, checkLogger);
+        const { mergedCheckSettings, baseTarget } = await throttledRender(target, checkLogger);
         const settings = (0, merge_configs_1.mergeConfigs)(target.settings, mergedCheckSettings);
         return core.base.openCheckAndCloseEyes({
             target: { ...baseTarget, isTransformed: true },
@@ -341,6 +374,48 @@ async function runOfflineSnapshots(options) {
         const mergedCheckSettings = (0, merge_configs_1.mergeConfigs)(baseSettings, options.config.check);
         return { mergedCheckSettings, baseTarget };
     }
+    async function logStartupInfo() {
+        await core.logEvent({
+            logger,
+            settings: {
+                ...account.eyesServer,
+                ...account.ufgServer,
+                level: 'Notice',
+                event: {
+                    type: 'offlineExecutionStart',
+                    timestamp: new Date().toISOString(),
+                    offlineLocationPath,
+                    testCount: testFolders.length,
+                    ufgServerUrl: account.ufgServer.ufgServerUrl,
+                    CI: process.env.CI,
+                    config: options.config,
+                    driver: {
+                        platform: os_1.default.platform(),
+                        version: os_1.default.release(),
+                        arch: os_1.default.arch(),
+                        cpu: {
+                            count: os_1.default.cpus().length,
+                            avgSpeed: os_1.default.cpus().reduce((acc, cpu) => acc + cpu.speed, 0) / os_1.default.cpus().length,
+                            model: os_1.default.cpus()[0].model,
+                        },
+                        memory: {
+                            total: os_1.default.totalmem(),
+                            free: os_1.default.freemem(),
+                        },
+                        nodeVersion: process.version,
+                        versions: await Promise.all(['eyes', 'core', 'core-base', 'ufg-client']
+                            .map(async (name) => ({
+                            name,
+                            version: JSON.parse(await throttledReadFile(require.resolve(`@applitools/${name}/package.json`), {
+                                encoding: 'utf-8',
+                            })).version,
+                        }))
+                            .map(promise => promise.catch(e => `failed to get version: ${e}`))),
+                    },
+                },
+            },
+        });
+    }
 }
 exports.runOfflineSnapshots = runOfflineSnapshots;
 function uniq(arr) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.38.1",
+  "version": "4.39.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -71,24 +71,25 @@
       "node20-linux-x64-musl": "./bin/core-alpine",
       "node20-linux-arm64": "./bin/core-linux-arm64",
       "node20-darwin-x64": "./bin/core-macos",
-      "node20-win-x64": "./bin/core-win.exe"
+      "node20-win-x64": "./bin/core-win.exe",
+      "node20-darwin-arm64": "./bin/core-macos-arm64"
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.25.1",
+    "@applitools/core-base": "1.25.3",
     "@applitools/dom-capture": "11.5.5",
-    "@applitools/dom-snapshot": "4.11.20",
-    "@applitools/driver": "1.21.3",
-    "@applitools/ec-client": "1.10.12",
-    "@applitools/logger": "2.1.3",
-    "@applitools/nml-client": "1.9.3",
-    "@applitools/req": "1.7.11",
-    "@applitools/screenshoter": "3.11.3",
+    "@applitools/dom-snapshot": "4.11.21",
+    "@applitools/driver": "1.21.4",
+    "@applitools/ec-client": "1.10.14",
+    "@applitools/logger": "2.1.4",
+    "@applitools/nml-client": "1.9.4",
+    "@applitools/req": "1.7.12",
+    "@applitools/screenshoter": "3.11.4",
     "@applitools/snippets": "2.6.5",
-    "@applitools/socket": "1.2.4",
-    "@applitools/spec-driver-webdriver": "1.2.4",
-    "@applitools/ufg-client": "1.16.10",
-    "@applitools/utils": "1.8.1",
+    "@applitools/socket": "1.2.5",
+    "@applitools/spec-driver-webdriver": "1.2.5",
+    "@applitools/ufg-client": "1.16.11",
+    "@applitools/utils": "1.8.2",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -102,17 +103,18 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.29",
-    "@applitools/spec-driver-selenium": "^1.5.100",
+    "@applitools/spec-driver-puppeteer": "^1.4.30",
+    "@applitools/spec-driver-selenium": "^1.5.101",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.6.6",
+    "@applitools/tunnel-client": "^1.6.7",
     "@types/mocha": "^10.0.7",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",
     "@types/yargs": "^17.0.22",
     "chromedriver": "^131.0.5",
+    "crypto": "^1.0.1",
     "nock": "^13.3.2",
     "png-async": "^0.9.4",
     "puppeteer": "^19.11.1",