@applitools/core 4.24.0 → 4.24.2

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # Changelog
 
+## [4.24.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.1...js/core@4.24.2) (2024-11-27)
+
+
+### Bug Fixes
+
+* don't populate branchName and parentBranchName when scm integration exists ([#2634](https://github.com/Applitools-Dev/sdk/issues/2634)) ([e45d671](https://github.com/Applitools-Dev/sdk/commit/e45d671e11ed40a82de1bd5ab22e757aff00b63f))
+* enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
+
+
+### Dependencies
+
+* @applitools/dom-shared bumped to 1.0.16
+  #### Bug Fixes
+
+  * enhance error logging in takeScreenshots and pollify functions ([#2644](https://github.com/Applitools-Dev/sdk/issues/2644)) ([2428fa5](https://github.com/Applitools-Dev/sdk/commit/2428fa500a9fd47a803aa5aca9f79e5c5b3584f9))
+* @applitools/dom-snapshot bumped to 4.11.11
+
+* @applitools/req bumped to 1.7.4
+  #### Bug Fixes
+
+  * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
+* @applitools/dom-capture bumped to 11.5.2
+
+* @applitools/nml-client bumped to 1.8.19
+
+* @applitools/tunnel-client bumped to 1.5.10
+
+* @applitools/ufg-client bumped to 1.14.1
+
+* @applitools/core-base bumped to 1.19.3
+  #### Bug Fixes
+
+  * set heartbeat request timeout as the request interval ([#2587](https://github.com/Applitools-Dev/sdk/issues/2587)) ([0251d27](https://github.com/Applitools-Dev/sdk/commit/0251d27d9ed44ec247732f66904ae3d4fa4123f1))
+
+
+
+* @applitools/ec-client bumped to 1.9.15
+
+
+## [4.24.1](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.0...js/core@4.24.1) (2024-11-14)
+
+
+### Bug Fixes
+
+* don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.10
+  #### Bug Fixes
+
+  * don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+
+
+
+* @applitools/snippets bumped to 2.6.3
+  #### Bug Fixes
+
+  * don't throw error on stale/missing non-target regions ([#2598](https://github.com/Applitools-Dev/sdk/issues/2598)) ([ae39ad9](https://github.com/Applitools-Dev/sdk/commit/ae39ad9fdb129a3f987ee5076660071b66dc1342))
+* @applitools/driver bumped to 1.20.1
+
+* @applitools/spec-driver-webdriver bumped to 1.1.21
+
+* @applitools/spec-driver-selenium bumped to 1.5.92
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.21
+
+* @applitools/screenshoter bumped to 3.10.1
+
+* @applitools/nml-client bumped to 1.8.19
+
+* @applitools/ec-client bumped to 1.9.15
+
+
 ## [4.24.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.23.1...js/core@4.24.0) (2024-11-12)
 
 

package/dist/classic/utils/take-screenshots.js

@@ -44,7 +44,10 @@ async function takeScreenshots({ driver, settings, logger, }) {
             await ((_a = screenshot.scrollingElement) === null || _a === void 0 ? void 0 : _a.setAttribute('data-applitools-scroll', 'true'));
         else
             await ((_b = screenshot.element) === null || _b === void 0 ? void 0 : _b.setAttribute('data-applitools-scroll', 'true'));
-        baseTarget.dom = await (0, take_dom_capture_1.takeDomCapture)({ driver, settings: settings.domSettings, logger }).catch(() => undefined);
+        baseTarget.dom = await (0, take_dom_capture_1.takeDomCapture)({ driver, settings: settings.domSettings, logger }).catch(error => {
+            logger.error('failed to capture DOM', error);
+            return undefined;
+        });
     }
     if (settings.calculateView) {
         const scrollingElement = await driver.mainContext.getScrollingElement();

package/dist/open-eyes.js

@@ -142,8 +142,8 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
         }); // TODO solve the types issue
         /////// END FUNCTION BODY ///////////////////
         async function populateAutoScmInfo(batchId) {
-            var _a, _b, _c, _d;
-            var _e;
+            var _a, _b;
+            var _c;
             const branchName = await (0, extract_git_info_1.extractGitBranch)({ execOptions: { cwd }, logger });
             const { owner: repoOwner, name: repoName } = await (0, extract_git_info_1.extractGitRepo)({ execOptions: { cwd }, logger });
             const buildId = await (0, extract_git_info_1.extractBuildIdFromCI)();
@@ -159,9 +159,8 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
                 if (scmInfo) {
                     (_a = settings.batch) !== null && _a !== void 0 ? _a : (settings.batch = {});
                     settings.batch.id = isRealBatchId(settings.batch.id) ? settings.batch.id : batchId;
-                    (_b = (_e = settings.batch).buildId) !== null && _b !== void 0 ? _b : (_e.buildId = buildId);
-                    (_c = settings.branchName) !== null && _c !== void 0 ? _c : (settings.branchName = branchName);
-                    (_d = settings.parentBranchName) !== null && _d !== void 0 ? _d : (settings.parentBranchName = scmInfo.scmTargetBranch);
+                    (_b = (_c = settings.batch).buildId) !== null && _b !== void 0 ? _b : (_c.buildId = buildId);
+                    // Intentionally not auto populating branchName and parentBranchName. If there is scmInfo then Eyes already knows these values.
                 }
             }
             else {

package/dist/ufg/take-snapshots.js

@@ -24,6 +24,7 @@ function makeTakeSnapshots({ core, spec, signal, logger: mainLogger }) {
         const { elementReferences, getSafeCheckSettings } = (0, to_safe_check_settings_1.toSafeCheckSettings)({ settings });
         const { elementReferencesToMark, getGeneratedSelectors } = (0, to_generated_selectors_1.toGeneratedSelectors)({
             elementReferences,
+            logger,
             // dead code - `transformElementReference` was used for NMG but it's not longer used anywhere
             transformElementReference: elementReference => { var _a; return ((0, driver_1.isSelector)(elementReference) && ((_a = spec === null || spec === void 0 ? void 0 : spec.toSimpleCommonSelector) === null || _a === void 0 ? void 0 : _a.call(spec, elementReference))) || undefined; },
         });

package/dist/ufg/utils/to-generated-selectors.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toGeneratedSelectors = void 0;
-function toGeneratedSelectors({ elementReferences, transformElementReference, }) {
+function toGeneratedSelectors({ elementReferences, logger, transformElementReference, }) {
     var _a, _b, _c;
     const elementReferencesToMark = [
         (_a = elementReferences.target) !== null && _a !== void 0 ? _a : [],
@@ -17,14 +17,39 @@ function toGeneratedSelectors({ elementReferences, transformElementReference, })
         if (generatedSelectors) {
             let offset = 0;
             if (elementReferences.target) {
-                target = (_a = generatedSelectors[offset++].safeSelector) !== null && _a !== void 0 ? _a : undefined;
-                if (!target)
+                const targetOrError = (_a = generatedSelectors[offset++].safeSelector) !== null && _a !== void 0 ? _a : undefined;
+                if (!targetOrError)
                     throw new Error('Target element not found');
+                if (typeof targetOrError !== 'string' && 'error' in targetOrError)
+                    throw new Error(`Target element is stale - please make sure the element is not detached from the DOM tree. ${targetOrError.error}`);
+                target = targetOrError;
             }
             if (elementReferences.scrolling) {
-                scrolling = (_b = generatedSelectors[offset++].safeSelector) !== null && _b !== void 0 ? _b : undefined;
+                const scrollingOrError = (_b = generatedSelectors[offset++].safeSelector) !== null && _b !== void 0 ? _b : undefined;
+                const isError = typeof scrollingOrError === 'object' && 'error' in scrollingOrError;
+                scrolling = isError ? undefined : scrollingOrError;
+                if (isError) {
+                    logger.log('Error in scrolling element:', scrollingOrError);
+                }
+                else if (!scrolling) {
+                    logger.log('Scrolling element not found');
+                }
             }
-            calculate = generatedSelectors.slice(offset);
+            calculate = generatedSelectors.slice(offset).map(generatedSelector => {
+                var _a;
+                const safeSelector = generatedSelector.safeSelector;
+                const isError = safeSelector && typeof safeSelector === 'object' && 'error' in safeSelector;
+                if (isError) {
+                    logger.log('Error in calculate element:', safeSelector);
+                }
+                else if (!safeSelector) {
+                    logger.log('Calculate element not found', (_a = generatedSelector.originalSelector) !== null && _a !== void 0 ? _a : '');
+                }
+                return {
+                    ...generatedSelector,
+                    safeSelector: isError ? null : safeSelector,
+                };
+            });
         }
         else {
             // the entire else statement should be a dead code that was used for NMG, will be removed later
@@ -36,7 +61,7 @@ function toGeneratedSelectors({ elementReferences, transformElementReference, })
                 return { originalSelector: selector, safeSelector: selector };
             });
         }
-        return { target, scrolling, calculate };
+        return { target: target, scrolling, calculate };
     }
 }
 exports.toGeneratedSelectors = toGeneratedSelectors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.24.0",
+  "version": "4.24.2",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -49,8 +49,8 @@
     "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:local": "MOCHA_OMIT_TAGS=sauce run test",
-    "test:sauce": "MOCHA_ONLY_TAGS=sauce run test",
+    "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'",
@@ -74,19 +74,19 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.19.2",
-    "@applitools/dom-capture": "11.5.1",
-    "@applitools/dom-snapshot": "4.11.9",
+    "@applitools/core-base": "1.19.3",
+    "@applitools/dom-capture": "11.5.2",
+    "@applitools/dom-snapshot": "4.11.11",
     "@applitools/driver": "1.20.0",
-    "@applitools/ec-client": "1.9.14",
+    "@applitools/ec-client": "1.9.15",
     "@applitools/logger": "2.0.19",
-    "@applitools/nml-client": "1.8.18",
-    "@applitools/req": "1.7.3",
+    "@applitools/nml-client": "1.8.19",
+    "@applitools/req": "1.7.4",
     "@applitools/screenshoter": "3.10.0",
-    "@applitools/snippets": "2.6.2",
+    "@applitools/snippets": "2.6.3",
     "@applitools/socket": "1.1.19",
     "@applitools/spec-driver-webdriver": "1.1.20",
-    "@applitools/ufg-client": "1.14.0",
+    "@applitools/ufg-client": "1.14.1",
     "@applitools/utils": "1.7.5",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -104,7 +104,7 @@
     "@applitools/spec-driver-selenium": "^1.5.91",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.5.9",
+    "@applitools/tunnel-client": "^1.5.10",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",

package/types/ufg/types.d.ts

@@ -8,7 +8,9 @@ export * from '../automation/types';
 export type DomSnapshot = UFGDomSnapshot & {
     generatedSelectors?: {
         originalSelector: CommonSelector | null;
-        safeSelector: CommonSelector | null;
+        safeSelector: CommonSelector | {
+            error: string;
+        } | null;
     }[];
 };
 export type AndroidSnapshot = UFGAndroidSnapshot;

package/types/ufg/utils/take-dom-snapshot.d.ts

@@ -22,7 +22,9 @@ export type RawDomSnapshot = {
     }[];
     srcAttr: string | null;
     scriptVersion: string;
-    safeSelectors?: (CommonSelector | null)[];
+    safeSelectors?: (CommonSelector | {
+        error: string;
+    } | null)[];
     warnings?: string[];
 };
 export type DomSnapshotSettings<TSpec extends SpecType> = {

package/types/ufg/utils/to-generated-selectors.d.ts

@@ -1,12 +1,14 @@
 import { type SpecType, type ElementReference } from '@applitools/driver';
+import type { Logger } from '@applitools/logger';
 import { type Selector as UFGSelector } from '@applitools/ufg-client';
-export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementReferences, transformElementReference, }: {
+export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementReferences, logger, transformElementReference, }: {
     elementReferences: {
         target?: ElementReference<TSpec>;
         scrolling?: ElementReference<TSpec>;
         calculate?: ElementReference<TSpec>[];
     };
     transformElementReference: (elementReference: ElementReference<TSpec>) => UFGSelector | undefined;
+    logger: Logger;
 }): {
     elementReferencesToMark: (string | TSpec["element"] | TSpec["secondary"]["element"] | TSpec["selector"] | TSpec["secondary"]["selector"] | {
         selector: string | TSpec["selector"] | TSpec["secondary"]["selector"];
@@ -18,7 +20,9 @@ export declare function toGeneratedSelectors<TSpec extends SpecType>({ elementRe
     } | (NonNullable<TSpec["element"]> extends infer T ? T extends NonNullable<TSpec["element"]> ? T extends readonly (infer InnerArr)[] ? InnerArr : T : never : never) | (NonNullable<TSpec["secondary"]["element"]> extends infer T_1 ? T_1 extends NonNullable<TSpec["secondary"]["element"]> ? T_1 extends readonly (infer InnerArr)[] ? InnerArr : T_1 : never : never) | (NonNullable<TSpec["selector"]> extends infer T_2 ? T_2 extends NonNullable<TSpec["selector"]> ? T_2 extends readonly (infer InnerArr)[] ? InnerArr : T_2 : never : never) | (NonNullable<TSpec["secondary"]["selector"]> extends infer T_3 ? T_3 extends NonNullable<TSpec["secondary"]["selector"]> ? T_3 extends readonly (infer InnerArr)[] ? InnerArr : T_3 : never : never))[];
     getGeneratedSelectors: (generatedSelectors?: {
         originalSelector: UFGSelector | null;
-        safeSelector: UFGSelector | null;
+        safeSelector: UFGSelector | {
+            error: string;
+        } | null;
     }[]) => {
         target: UFGSelector | undefined;
         scrolling: UFGSelector | undefined;