@applitools/core 3.11.5 → 3.11.7

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [3.11.7](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.11.6...js/core@3.11.7) (2023-10-04)
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.9.4
+  #### Bug Fixes
+
+  * async cache should wait for upload ([#1961](https://github.com/applitools/eyes.sdk.javascript1/issues/1961)) ([53c7204](https://github.com/applitools/eyes.sdk.javascript1/commit/53c72046738d5589fc53c16822f9b2efd142357c))
+
+## [3.11.6](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.11.5...js/core@3.11.6) (2023-10-02)
+
+
+### Bug Fixes
+
+* move lazyload option to take-dom-snapshots ([#1947](https://github.com/applitools/eyes.sdk.javascript1/issues/1947)) ([1833613](https://github.com/applitools/eyes.sdk.javascript1/commit/18336131048733d6d31d31ea4fa959c299320bfe))
+
 ## [3.11.5](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.11.4...js/core@3.11.5) (2023-09-29)
 
 

package/dist/automation/utils/wait-for-lazy-load.js

@@ -3,20 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForLazyLoad = void 0;
 const { lazyLoad } = require('@applitools/snippets');
 async function waitForLazyLoad({ context, settings, logger, }) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b;
     logger.log('lazy loading the page before capturing a screenshot');
+    const { scrollLength = 300, waitingTime = 2000, maxAmountToScroll = 15000, } = typeof settings === 'boolean' ? {} : settings;
     await context.executePoll(lazyLoad, {
         main: [
             await context.getScrollingElement(),
             {
-                scrollLength: (_a = settings.scrollLength) !== null && _a !== void 0 ? _a : 300,
-                waitingTime: (_b = settings.waitingTime) !== null && _b !== void 0 ? _b : 2000,
-                maxAmountToScroll: (_c = settings.maxAmountToScroll) !== null && _c !== void 0 ? _c : 15000,
+                scrollLength: scrollLength,
+                waitingTime: waitingTime,
+                maxAmountToScroll: maxAmountToScroll,
             },
         ],
         poll: [],
         executionTimeout: 5 * 60 * 1000,
-        pollTimeout: (_e = (_d = settings.pollTimeout) !== null && _d !== void 0 ? _d : settings.waitingTime) !== null && _e !== void 0 ? _e : 2000,
+        pollTimeout: (_b = (_a = settings.pollTimeout) !== null && _a !== void 0 ? _a : settings.waitingTime) !== null && _b !== void 0 ? _b : 2000,
     });
 }
 exports.waitForLazyLoad = waitForLazyLoad;

package/dist/ufg/check-and-close.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheckAndClose = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
-const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const uniquify_renderers_1 = require("../automation/utils/uniquify-renderers");
 const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
@@ -79,23 +78,13 @@ function makeCheckAndClose({ eyes, target: defaultTarget, renderers: defaultRend
                         layoutBreakpoints: settings.layoutBreakpoints,
                         renderers: uniqueRenderers,
                         skipResources: ufgClient.getCachedResourceUrls(),
+                        lazyLoad: settings.lazyLoad,
                         calculateRegionsOptions: {
                             elementReferencesToCalculate,
                             elementReferenceToTarget,
                             scrollRootElement: settings.scrollRootElement,
                         },
                     },
-                    hooks: {
-                        async beforeSnapshots() {
-                            if (settings.lazyLoad && environment.isWeb) {
-                                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-                                    context: driver.currentContext,
-                                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-                                    logger,
-                                });
-                            }
-                        },
-                    },
                     provides: {
                         getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
                         getIOSDevices: ufgClient.getIOSDevices,

package/dist/ufg/check.js

@@ -29,7 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCheck = void 0;
 const driver_1 = require("@applitools/driver");
 const take_dom_snapshots_1 = require("./utils/take-dom-snapshots");
-const wait_for_lazy_load_1 = require("../automation/utils/wait-for-lazy-load");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const uniquify_renderers_1 = require("../automation/utils/uniquify-renderers");
 const extract_renderer_key_1 = require("../automation/utils/extract-renderer-key");
@@ -79,23 +78,13 @@ function makeCheck({ eyes, target: defaultTarget, renderers: defaultRenderers =
                         layoutBreakpoints: settings.layoutBreakpoints,
                         renderers: uniqueRenderers,
                         skipResources: ufgClient.getCachedResourceUrls(),
+                        lazyLoad: settings.lazyLoad,
                         calculateRegionsOptions: {
                             elementReferencesToCalculate,
                             elementReferenceToTarget,
                             scrollRootElement: settings.scrollRootElement,
                         },
                     },
-                    hooks: {
-                        async beforeSnapshots() {
-                            if (settings.lazyLoad && environment.isWeb) {
-                                await (0, wait_for_lazy_load_1.waitForLazyLoad)({
-                                    context: driver.currentContext,
-                                    settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
-                                    logger,
-                                });
-                            }
-                        },
-                    },
                     provides: {
                         getChromeEmulationDevices: ufgClient.getChromeEmulationDevices,
                         getIOSDevices: ufgClient.getIOSDevices,

package/dist/ufg/utils/take-dom-snapshots.js

@@ -34,9 +34,10 @@ const take_dom_snapshot_1 = require("./take-dom-snapshot");
 const utils = __importStar(require("@applitools/utils"));
 const chalk_1 = __importDefault(require("chalk"));
 const calculate_regions_1 = require("./calculate-regions");
+const wait_for_lazy_load_1 = require("../../automation/utils/wait-for-lazy-load");
 __exportStar(require("./take-dom-snapshot"), exports);
 async function takeDomSnapshots({ driver, settings, hooks, provides, logger, }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f, _g;
     const currentContext = driver.currentContext;
     let calculateRegionsResults = {};
     const waitBeforeCapture = async () => {
@@ -47,8 +48,14 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
             await utils.general.sleep(settings.waitBeforeCapture);
         }
     };
-    await ((_a = hooks === null || hooks === void 0 ? void 0 : hooks.beforeSnapshots) === null || _a === void 0 ? void 0 : _a.call(hooks));
-    if (!((_b = settings.layoutBreakpoints) === null || _b === void 0 ? void 0 : _b.reload) && settings.calculateRegionsOptions) {
+    if (settings.lazyLoad) {
+        await (0, wait_for_lazy_load_1.waitForLazyLoad)({
+            context: driver.currentContext,
+            settings: settings.lazyLoad !== true ? settings.lazyLoad : {},
+            logger,
+        });
+    }
+    if (!((_a = settings.layoutBreakpoints) === null || _a === void 0 ? void 0 : _a.reload) && settings.calculateRegionsOptions) {
         calculateRegionsResults = await (0, calculate_regions_1.calculateRegions)({
             ...settings.calculateRegionsOptions,
             driver,
@@ -56,13 +63,13 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
     }
     if (!settings.layoutBreakpoints) {
         logger.log(`taking single dom snapshot`);
-        await ((_c = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _c === void 0 ? void 0 : _c.call(hooks));
+        await ((_b = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _b === void 0 ? void 0 : _b.call(hooks));
         await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
-        await ((_d = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _d === void 0 ? void 0 : _d.call(calculateRegionsResults));
+        await ((_c = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _c === void 0 ? void 0 : _c.call(calculateRegionsResults));
         return Array(settings.renderers.length).fill({ snapshot, ...calculateRegionsResults });
     }
-    const isStrictBreakpoints = utils.types.isArray((_e = settings.layoutBreakpoints) === null || _e === void 0 ? void 0 : _e.breakpoints);
+    const isStrictBreakpoints = utils.types.isArray((_d = settings.layoutBreakpoints) === null || _d === void 0 ? void 0 : _d.breakpoints);
     const requiredWidths = await settings.renderers.reduce(async (prev, renderer, index) => {
         const { name, width } = (await extractRendererInfo({ renderer }));
         const requiredWidths = await prev;
@@ -90,7 +97,7 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
     const snapshotsResults = Array(settings.renderers.length);
     if (requiredWidths.has(viewportSize.width)) {
         logger.log(`taking dom snapshot for existing width ${viewportSize.width}`);
-        await ((_f = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _f === void 0 ? void 0 : _f.call(hooks));
+        await ((_e = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _e === void 0 ? void 0 : _e.call(hooks));
         await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         requiredWidths.get(viewportSize.width).forEach(({ index }) => {
@@ -128,7 +135,7 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
                 logger.log(message);
             }
         }
-        await ((_g = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _g === void 0 ? void 0 : _g.call(hooks));
+        await ((_f = hooks === null || hooks === void 0 ? void 0 : hooks.beforeEachSnapshot) === null || _f === void 0 ? void 0 : _f.call(hooks));
         await waitBeforeCapture();
         const snapshot = await (0, take_dom_snapshot_1.takeDomSnapshot)({ context: currentContext, settings, logger });
         browsersInfo.forEach(({ index }) => {
@@ -141,7 +148,7 @@ async function takeDomSnapshots({ driver, settings, hooks, provides, logger, })
         await waitBeforeCapture();
     }
     else {
-        (_h = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _h === void 0 ? void 0 : _h.call(calculateRegionsResults);
+        (_g = calculateRegionsResults === null || calculateRegionsResults === void 0 ? void 0 : calculateRegionsResults.cleanupGeneratedSelectors) === null || _g === void 0 ? void 0 : _g.call(calculateRegionsResults);
     }
     return snapshotsResults;
     function calculateBreakpoint({ breakpoints, value }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "3.11.5",
+  "version": "3.11.7",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -77,7 +77,7 @@
     "@applitools/snippets": "2.4.24",
     "@applitools/socket": "1.1.11",
     "@applitools/spec-driver-webdriver": "1.0.47",
-    "@applitools/ufg-client": "1.9.3",
+    "@applitools/ufg-client": "1.9.4",
     "@applitools/utils": "1.6.1",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",

package/types/automation/types.d.ts

@@ -118,6 +118,11 @@ export type EyesStorage = Map<string, {
 export interface GetBaseEyesSettings {
     renderer: Renderer;
 }
+export type LazyLoadOptions = {
+    scrollLength?: number;
+    waitingTime?: number;
+    maxAmountToScroll?: number;
+};
 export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.ImageSettings<Region | ElementReference<TSpec>> {
     webview?: boolean | string;
     frames?: (ContextReference<TSpec> | {
@@ -136,11 +141,7 @@ export interface ScreenshotSettings<TSpec extends SpecType> extends BaseCore.Ima
     };
     waitBeforeCapture?: number;
     waitBetweenStitches?: number;
-    lazyLoad?: boolean | {
-        scrollLength?: number;
-        waitingTime?: number;
-        maxAmountToScroll?: number;
-    };
+    lazyLoad?: boolean | LazyLoadOptions;
     sendDom?: boolean;
 }
 export type LocateSettings<TLocator extends string, TSpec extends SpecType> = BaseCore.LocateSettings<TLocator, Region | ElementReference<TSpec>> & ScreenshotSettings<TSpec>;

package/types/automation/utils/wait-for-lazy-load.d.ts

@@ -1,14 +1,11 @@
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type Context } from '@applitools/driver';
-export type LazyLoadSettings = {
-    scrollLength?: number;
-    waitingTime?: number;
-    maxAmountToScroll?: number;
-    executionTimeout?: number;
-    pollTimeout?: number;
-};
+import { type LazyLoadOptions } from '../types';
 export declare function waitForLazyLoad<TSpec extends SpecType>({ context, settings, logger, }: {
     context: Context<TSpec>;
-    settings: LazyLoadSettings;
+    settings: LazyLoadOptions & {
+        pollTimeout?: number;
+        waitingTime?: number;
+    };
     logger: Logger;
 }): Promise<void>;

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

@@ -5,6 +5,7 @@ import { type DomSnapshot, type Renderer } from '@applitools/ufg-client';
 import { type DomSnapshotSettings } from './take-dom-snapshot';
 import { type CalculateRegionsOptions } from './calculate-regions';
 import { SnapshotResult } from '../types';
+import { type LazyLoadOptions } from '../types';
 export * from './take-dom-snapshot';
 export type DomSnapshotsSettings = DomSnapshotSettings & {
     renderers: Renderer[];
@@ -14,12 +15,12 @@ export type DomSnapshotsSettings = DomSnapshotSettings & {
         reload?: boolean;
     };
     calculateRegionsOptions?: CalculateRegionsOptions;
+    lazyLoad?: boolean | LazyLoadOptions;
 };
 export declare function takeDomSnapshots<TSpec extends SpecType>({ driver, settings, hooks, provides, logger, }: {
     driver: Driver<TSpec>;
     settings: DomSnapshotsSettings;
     hooks?: {
-        beforeSnapshots?(): void | Promise<void>;
         beforeEachSnapshot?(): void | Promise<void>;
     };
     provides?: {