@applitools/core 4.40.0 → 4.42.0

package/CHANGELOG.md

@@ -1,5 +1,183 @@
 # Changelog
 
+## [4.42.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.41.0...js/core@4.42.0) (2025-07-15)
+
+
+### Features
+
+* enable EC healthchecks | AD-10040 ([#3017](https://github.com/Applitools-Dev/sdk/issues/3017)) ([c01c300](https://github.com/Applitools-Dev/sdk/commit/c01c300259427ddae53147a64d30b152960503d9))
+
+
+### Performance Improvements
+
+* yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.12.1
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+* @applitools/req bumped to 1.7.15
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+* @applitools/driver bumped to 1.22.1
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+* @applitools/spec-driver-selenium bumped to 1.6.1
+
+* @applitools/screenshoter bumped to 3.11.7
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+* @applitools/nml-client bumped to 1.9.7
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+* @applitools/ufg-client bumped to 1.16.14
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.3.1
+
+* @applitools/tunnel-client bumped to 1.9.0
+  #### Features
+
+  * enable EC healthchecks | AD-10040 ([#3017](https://github.com/Applitools-Dev/sdk/issues/3017)) ([c01c300](https://github.com/Applitools-Dev/sdk/commit/c01c300259427ddae53147a64d30b152960503d9))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.5.1
+
+* @applitools/core-base bumped to 1.25.6
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+* @applitools/ec-client bumped to 1.11.0
+  #### Features
+
+  * enable EC healthchecks | AD-10040 ([#3017](https://github.com/Applitools-Dev/sdk/issues/3017)) ([c01c300](https://github.com/Applitools-Dev/sdk/commit/c01c300259427ddae53147a64d30b152960503d9))
+
+
+  #### Performance Improvements
+
+  * yarn dedup packages ([#3061](https://github.com/Applitools-Dev/sdk/issues/3061)) ([2fd8951](https://github.com/Applitools-Dev/sdk/commit/2fd8951d6ce9c18a5dbdb648adaa2c454eae9b4e))
+
+
+
+
+## [4.41.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.40.0...js/core@4.41.0) (2025-07-07)
+
+
+### Features
+
+* canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+* support https_proxy and http_proxy env variables | FLD-2702 ([#3046](https://github.com/Applitools-Dev/sdk/issues/3046)) ([0633809](https://github.com/Applitools-Dev/sdk/commit/06338099f44bfb149a5829f62c2f9b19e2392850))
+
+
+### Bug Fixes
+
+* add retries for ConnectEnomem errors | FLD-3015 ([#3052](https://github.com/Applitools-Dev/sdk/issues/3052)) ([92caa45](https://github.com/Applitools-Dev/sdk/commit/92caa452b4a6d6f86c903548b40f8207a0ed11d0))
+* determine storybook 9 version | AD-10406 ([#3054](https://github.com/Applitools-Dev/sdk/issues/3054)) ([23486bf](https://github.com/Applitools-Dev/sdk/commit/23486bf1c9dc905d243239214e0e838d54c0b3c2))
+* support for programmatically added nested css rules | FLD-3212 ([#3049](https://github.com/Applitools-Dev/sdk/issues/3049)) ([5abb0f7](https://github.com/Applitools-Dev/sdk/commit/5abb0f7904c4d9e4b716291abecad54554b9ca01))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.9.0
+  #### Features
+
+  * support https_proxy and http_proxy env variables | FLD-2702 ([#3046](https://github.com/Applitools-Dev/sdk/issues/3046)) ([0633809](https://github.com/Applitools-Dev/sdk/commit/06338099f44bfb149a5829f62c2f9b19e2392850))
+* @applitools/dom-snapshot bumped to 4.12.0
+  #### Features
+
+  * canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+
+
+  #### Bug Fixes
+
+  * support for programmatically added nested css rules | FLD-3212 ([#3049](https://github.com/Applitools-Dev/sdk/issues/3049)) ([5abb0f7](https://github.com/Applitools-Dev/sdk/commit/5abb0f7904c4d9e4b716291abecad54554b9ca01))
+
+
+
+* @applitools/driver bumped to 1.22.0
+  #### Features
+
+  * canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.3.0
+  #### Features
+
+  * canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+  * support https_proxy and http_proxy env variables | FLD-2702 ([#3046](https://github.com/Applitools-Dev/sdk/issues/3046)) ([0633809](https://github.com/Applitools-Dev/sdk/commit/06338099f44bfb149a5829f62c2f9b19e2392850))
+
+
+
+* @applitools/spec-driver-selenium bumped to 1.6.0
+  #### Features
+
+  * canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+
+
+
+* @applitools/spec-driver-puppeteer bumped to 1.5.0
+  #### Features
+
+  * canvas webgl without preserveDrawingBuffer=1 | FLD-3144 ([#3040](https://github.com/Applitools-Dev/sdk/issues/3040)) ([f82d8f1](https://github.com/Applitools-Dev/sdk/commit/f82d8f148f913098752ec7bef8635a46b453d6fa))
+
+
+
+* @applitools/nml-client bumped to 1.9.6
+  #### Bug Fixes
+
+  * add retries for ConnectEnomem errors | FLD-3015 ([#3052](https://github.com/Applitools-Dev/sdk/issues/3052)) ([92caa45](https://github.com/Applitools-Dev/sdk/commit/92caa452b4a6d6f86c903548b40f8207a0ed11d0))
+
+
+
+* @applitools/logger bumped to 2.1.5
+
+* @applitools/socket bumped to 1.2.6
+
+* @applitools/req bumped to 1.7.14
+
+* @applitools/image bumped to 1.1.21
+
+* @applitools/screenshoter bumped to 3.11.6
+
+* @applitools/tunnel-client bumped to 1.8.1
+
+* @applitools/ufg-client bumped to 1.16.13
+
+* @applitools/core-base bumped to 1.25.5
+  #### Bug Fixes
+
+  * add retries for ConnectEnomem errors | FLD-3015 ([#3052](https://github.com/Applitools-Dev/sdk/issues/3052)) ([92caa45](https://github.com/Applitools-Dev/sdk/commit/92caa452b4a6d6f86c903548b40f8207a0ed11d0))
+
+
+
+* @applitools/ec-client bumped to 1.10.16
+
+
 ## [4.40.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.39.3...js/core@4.40.0) (2025-06-15)
 
 

package/dist/ufg/open-eyes.js

@@ -35,6 +35,7 @@ const extract_default_environment_1 = require("./utils/extract-default-environme
 const verify_environment_info_1 = require("./utils/verify-environment-info");
 const abort_controller_1 = require("abort-controller");
 const utils = __importStar(require("@applitools/utils"));
+const register_default_scripts_1 = require("./utils/register-default-scripts");
 function makeOpenEyes({ core, spec, logger: mainLogger }) {
     return async function openEyes({ target, settings, storage = new Map(), logger = mainLogger, }) {
         var _a, _b, _c, _d;
@@ -52,6 +53,9 @@ function makeOpenEyes({ core, spec, logger: mainLogger }) {
             }
         }
         const environments = await (0, extract_default_environment_1.extractDefaultEnvironments)({ driver });
+        if (utils.general.getEnvValue('REGISTER_SCRIPTS_ON_NEW_DOCUMENT', 'boolean') === true) {
+            await (0, register_default_scripts_1.registerDefaultScripts)({ driver, logger });
+        }
         const controller = new abort_controller_1.AbortController();
         const { signal } = controller;
         const account = await core.getAccountInfo({ settings, logger });

package/dist/ufg/utils/register-default-scripts.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerDefaultScripts = void 0;
+const capture_canvas_image_always_1 = require("../../utils/capture-canvas-image-always");
+const utils_1 = require("@applitools/utils");
+function wrapFunctionAsIIFE(fn) {
+    return `(()=>{ ${fn.toString()} return ${fn.name}.call()})()`;
+}
+async function registerDefaultScripts({ driver, logger, }) {
+    if (!driver)
+        return [];
+    try {
+        const captureImagesScript = wrapFunctionAsIIFE(capture_canvas_image_always_1.captureImagesFunc);
+        const scripts = [];
+        if (utils_1.general.getEnvValue('CAPTURE_CANVAS_WITH_WEBGL', 'boolean') === true) {
+            scripts.push({ name: 'captureImagesScript', code: captureImagesScript });
+        }
+        await scripts.forEach(async (script) => {
+            logger.info('running user script', script.name);
+            await driver.addScriptToEvaluateOnNewDocument(script.code);
+        });
+        return scripts;
+    }
+    catch (error) {
+        logger.error(error);
+        return [];
+    }
+}
+exports.registerDefaultScripts = registerDefaultScripts;

package/dist/universal/spec-driver.js

@@ -157,6 +157,9 @@ function makeSpec({ socket, spec, }) {
         async executeUserFunction(userFunction) {
             return socket.request('Driver.executeUserFunction', userFunction);
         },
+        async executeBrowserCommands(driver, commands) {
+            return socket.request('Driver.executeBrowserCommands', { driver, commands });
+        },
     };
     // add default commands to spec (if not already there) such as `isUserFunction`
     spec = addDefaultCommands(spec);

package/dist/utils/capture-canvas-image-always.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.captureImagesFunc = void 0;
+function captureImagesFunc() {
+    async function isNonBlackImage(dataUrl) {
+        const img = new Image();
+        img.src = dataUrl;
+        await new Promise((resolve, reject) => {
+            img.onload = () => resolve();
+            img.onerror = () => reject();
+        });
+        const canvas = document.createElement('canvas');
+        canvas.width = img.width;
+        canvas.height = img.height;
+        const ctx = canvas.getContext('2d');
+        if (!ctx)
+            return false;
+        ctx.drawImage(img, 0, 0);
+        const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height).data;
+        for (let i = 0; i < imageData.length; i += 4) {
+            if (imageData[i] !== 0 || imageData[i + 1] !== 0 || imageData[i + 2] !== 0) {
+                return true;
+            }
+        }
+        return false;
+    }
+    function processWebGLCanvases(win) {
+        Array.from(win.document.getElementsByTagName('canvas')).forEach((canvas) => {
+            const gl = canvas.getContext('webgl') || canvas.getContext('webgl2');
+            if (!gl)
+                return;
+            const attrs = gl.getContextAttributes();
+            if (!attrs)
+                return;
+            const { preserveDrawingBuffer } = attrs;
+            if (!preserveDrawingBuffer && canvas.width > 0 && canvas.height > 0) {
+                const dataUrl = canvas.toDataURL('image/png');
+                if ((canvas.dataset.dataUrl || '') === dataUrl)
+                    return;
+                isNonBlackImage(dataUrl).then(result => {
+                    if (result) {
+                        canvas.dataset.dataUrl = dataUrl;
+                    }
+                });
+            }
+        });
+    }
+    function patchRequestAnimationFrame(win) {
+        var _a;
+        if (win.__rafPatched) {
+            return;
+        }
+        const HTMLCanvasElementCtor = win.HTMLCanvasElement ||
+            (win.constructor && win.constructor.HTMLCanvasElement) ||
+            (win.document && ((_a = win.document.defaultView) === null || _a === void 0 ? void 0 : _a.HTMLCanvasElement));
+        const origGetContext = (HTMLCanvasElementCtor && HTMLCanvasElementCtor.prototype.getContext);
+        if (!origGetContext) {
+            return;
+        }
+        const originalRAF = win.requestAnimationFrame;
+        win.requestAnimationFrame = function (callback) {
+            const rafId = originalRAF.call(this, (time) => {
+                callback.call(win, time);
+                processWebGLCanvases(win);
+            });
+            return rafId;
+        };
+        win.__rafPatched = true;
+    }
+    function takeCanvasScreenshots(win = window) {
+        if (win.__rafPatched) {
+            return;
+        }
+        try {
+            patchRequestAnimationFrame(win);
+        }
+        catch (e) { }
+    }
+    Object.assign(window, { takeCanvasScreenshots });
+    takeCanvasScreenshots();
+}
+exports.captureImagesFunc = captureImagesFunc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.40.0",
+  "version": "4.42.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -47,14 +47,14 @@
     "build:bin": "yarn build && sea",
     "build:bin:zip": "zip -j ./bin/core.zip $(find ./bin -type f -not -name '*.zip' -not -name '*.tar.gz' | xargs)",
     "build:bin:tgz": "tar -czf ./bin/core.tar.gz $(find ./bin -type f -not -name '*.zip' -not -name '*.tar.gz' | xargs)",
-    "test": "run --top-level mocha './test/**/*.spec.ts' --exclude './test/bin/**' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
+    "test": "run --top-level mocha './test/**/*.spec.ts' --exclude './test/bin/**' --parallel --jobs ${MOCHA_JOBS:-15} --exit --require ./test/mocha-global-setup.js",
     "test:local": "MOCHA_OMIT_TAGS=sauce,browserstack run test",
     "test:sauce": "MOCHA_ONLY_TAGS=sauce,browserstack run test",
-    "test:bin": "MOCHA_GROUP=bin run --top-level mocha './test/bin/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15}",
-    "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha './test/e2e/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
-    "test:it": "MOCHA_GROUP=it run --top-level mocha './test/it/**/*.spec.ts'",
-    "test:unit": "MOCHA_GROUP=unit run --top-level mocha './test/unit/**/*.spec.ts'",
-    "setup": "run --top-level browsers:setup",
+    "test:bin": "MOCHA_GROUP=bin run --top-level mocha './test/bin/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15} --require ./test/mocha-global-setup.js",
+    "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha './test/e2e/**/*.spec.ts' --parallel --jobs ${MOCHA_JOBS:-15} --exit --require ./test/mocha-global-setup.js",
+    "test:it": "MOCHA_GROUP=it run --top-level mocha './test/it/**/*.spec.ts' --require ./test/mocha-global-setup.js",
+    "test:unit": "MOCHA_GROUP=unit run --top-level mocha './test/unit/**/*.spec.ts' --require ./test/mocha-global-setup.js",
+    "setup": "run --top-level browsers:setup && run --top-level xvfb:setup",
     "setup:standalone": "sh -c 'yarn chromedriver --port=4444 --verbose &'"
   },
   "sea": {
@@ -75,20 +75,20 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.25.4",
+    "@applitools/core-base": "1.25.6",
     "@applitools/dom-capture": "11.5.6",
-    "@applitools/dom-snapshot": "4.11.22",
-    "@applitools/driver": "1.21.4",
-    "@applitools/ec-client": "1.10.15",
-    "@applitools/logger": "2.1.4",
-    "@applitools/nml-client": "1.9.5",
-    "@applitools/req": "1.7.13",
-    "@applitools/screenshoter": "3.11.5",
+    "@applitools/dom-snapshot": "4.12.1",
+    "@applitools/driver": "1.22.1",
+    "@applitools/ec-client": "1.11.0",
+    "@applitools/logger": "2.1.5",
+    "@applitools/nml-client": "1.9.7",
+    "@applitools/req": "1.7.15",
+    "@applitools/screenshoter": "3.11.7",
     "@applitools/snippets": "2.6.5",
-    "@applitools/socket": "1.2.5",
-    "@applitools/spec-driver-webdriver": "1.2.6",
-    "@applitools/ufg-client": "1.16.12",
-    "@applitools/utils": "1.8.2",
+    "@applitools/socket": "1.2.6",
+    "@applitools/spec-driver-webdriver": "1.3.1",
+    "@applitools/ufg-client": "1.16.14",
+    "@applitools/utils": "1.9.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -102,11 +102,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.30",
-    "@applitools/spec-driver-selenium": "^1.5.101",
+    "@applitools/spec-driver-puppeteer": "^1.5.1",
+    "@applitools/spec-driver-selenium": "^1.6.1",
     "@applitools/test-server": "^1.2.3",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.8.0",
+    "@applitools/tunnel-client": "^1.9.0",
     "@types/mocha": "^10.0.7",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
@@ -116,7 +116,7 @@
     "crypto": "^1.0.1",
     "nock": "^13.3.2",
     "png-async": "^0.9.4",
-    "puppeteer": "^19.11.1",
+    "puppeteer": "^24.11.1",
     "selenium-webdriver": "^4.15.0"
   },
   "engines": {

package/types/automation/types.d.ts

@@ -46,6 +46,10 @@ export type ExactEnvironment = BaseCore.Environment & {
     fallbackBaselineId?: string;
 };
 export type Environment = RenderEnvironment | ExactEnvironment;
+export type Script = {
+    name: string;
+    code: string;
+};
 export interface Core<TSpec extends SpecType> extends Omit<BaseCore.Core, 'openEyes'> {
     readonly base: BaseCore.Core;
     getViewportSize?(options: {

package/types/ufg/utils/register-default-scripts.d.ts

@@ -0,0 +1,7 @@
+import type { Script } from '../types';
+import { type SpecType, type Driver } from '@applitools/driver';
+import { type Logger } from '@applitools/logger';
+export declare function registerDefaultScripts<TSpec extends SpecType>({ driver, logger, }: {
+    driver?: Driver<TSpec>;
+    logger: Logger;
+}): Promise<Script[]>;

package/types/universal/types.d.ts

@@ -194,5 +194,9 @@ export interface UniversalSpecDriver<T extends SpecType> {
     }): Promise<void>;
     isUserFunction(ref: any): Promise<boolean>;
     executeUserFunction(userFunction: Ref): Promise<any>;
+    executeBrowserCommands(options: {
+        driver?: T['driver'];
+        commands: any[];
+    }): Promise<any>;
 }
 export {};

package/types/utils/capture-canvas-image-always.d.ts

@@ -0,0 +1 @@
+export declare function captureImagesFunc(): void;