@applitools/core 3.5.1 → 3.6.1

package/CHANGELOG.md

@@ -2,6 +2,112 @@
 
 ## Unreleased
 
+## [3.6.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.6.0...js/core@3.6.1) (2023-07-13)
+
+
+### Bug Fixes
+
+* replaced NML prefixed appium env vars with APPLITOOLS prefixed ([8905b90](https://github.com/applitools/eyes.sdk.javascript1/commit/8905b90e7c4ec6e310f6e52c03bbcc7acf1ff2ab))
+
+
+### Dependencies
+
+* @applitools/driver bumped from 1.13.0 to 1.13.1
+  #### Bug Fixes
+
+  * replaced NML prefixed appium env vars with APPLITOOLS prefixed ([8905b90](https://github.com/applitools/eyes.sdk.javascript1/commit/8905b90e7c4ec6e310f6e52c03bbcc7acf1ff2ab))
+* @applitools/ec-client bumped from 1.6.2 to 1.7.0
+  #### Features
+
+  * added internal function to prepare environment before running tunnels ([3d19ec3](https://github.com/applitools/eyes.sdk.javascript1/commit/3d19ec3b274702ffdf26b766b7351ec1f4b66a6d))
+
+
+
+* @applitools/tunnel-client bumped from 1.0.2 to 1.1.0
+  #### Features
+
+  * added internal function to prepare environment before running tunnels ([3d19ec3](https://github.com/applitools/eyes.sdk.javascript1/commit/3d19ec3b274702ffdf26b766b7351ec1f4b66a6d))
+
+
+  #### Bug Fixes
+
+  * prevent tunnel binaries from overriding itself ([5609a36](https://github.com/applitools/eyes.sdk.javascript1/commit/5609a36c93622c9b8eeb4b4ab25f95907df8baa4))
+
+
+
+* @applitools/nml-client bumped from 1.5.1 to 1.5.2
+  #### Bug Fixes
+
+  * replaced NML prefixed appium env vars with APPLITOOLS prefixed ([8905b90](https://github.com/applitools/eyes.sdk.javascript1/commit/8905b90e7c4ec6e310f6e52c03bbcc7acf1ff2ab))
+
+
+
+* @applitools/ufg-client bumped from 1.4.0 to 1.4.1
+  #### Bug Fixes
+
+  * fixed an issue when an inability to freeze a gif image caused sdk crush ([dca9ead](https://github.com/applitools/eyes.sdk.javascript1/commit/dca9eadd2bab39d1fc20b99d997879075691f0ee))
+  * fixed issue when sdk crushed due to invalid resource url in ufg mode ([8b44958](https://github.com/applitools/eyes.sdk.javascript1/commit/8b449580a930753dd2735befdcdb4c46e184b2a9))
+* @applitools/spec-driver-webdriver bumped from 1.0.37 to 1.0.38
+
+* @applitools/execution-grid-tunnel bumped to 2.1.8
+
+* @applitools/screenshoter bumped from 3.8.3 to 3.8.4
+
+
+## [3.6.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.5.1...js/core@3.6.0) (2023-07-10)
+
+
+### Features
+
+* ability to skip deserialize dom snapshot ([#1703](https://github.com/applitools/eyes.sdk.javascript1/issues/1703)) ([a461af4](https://github.com/applitools/eyes.sdk.javascript1/commit/a461af4fb72b7cba1ae15a5d20376fd02e7d9003))
+* prevent animated gif images from playing in ufg ([#1721](https://github.com/applitools/eyes.sdk.javascript1/issues/1721)) ([30f39cc](https://github.com/applitools/eyes.sdk.javascript1/commit/30f39cc8ef2cdfa1d85bd7a0037b818db1b52e1b))
+* support custom property per renderer ([#1715](https://github.com/applitools/eyes.sdk.javascript1/issues/1715)) ([8cf6b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/8cf6b1fb0563b2485ca18eebc2efd236c2287db8))
+
+
+### Dependencies
+
+* @applitools/core-base bumped from 1.3.0 to 1.4.0
+  #### Features
+
+  * support custom property per renderer ([#1715](https://github.com/applitools/eyes.sdk.javascript1/issues/1715)) ([8cf6b1f](https://github.com/applitools/eyes.sdk.javascript1/commit/8cf6b1fb0563b2485ca18eebc2efd236c2287db8))
+
+
+
+* @applitools/image bumped from 1.0.36 to 1.1.0
+  #### Features
+
+  * prevent animated gif images from playing in ufg ([#1721](https://github.com/applitools/eyes.sdk.javascript1/issues/1721)) ([30f39cc](https://github.com/applitools/eyes.sdk.javascript1/commit/30f39cc8ef2cdfa1d85bd7a0037b818db1b52e1b))
+* @applitools/ec-client bumped from 1.6.1 to 1.6.2
+  #### Bug Fixes
+
+  * fixed issue that caused creation of unnecessary tunnels ([b38fe37](https://github.com/applitools/eyes.sdk.javascript1/commit/b38fe3754f97c5f312ceffd74406255654466ab7))
+  * start tunnels with proper regional server ([2a34ed8](https://github.com/applitools/eyes.sdk.javascript1/commit/2a34ed8cd72dc9ac54957348cbe8ba9e67032340))
+
+
+
+* @applitools/tunnel-client bumped from 1.0.1 to 1.0.2
+  #### Bug Fixes
+
+  * start tunnels with proper regional server ([2a34ed8](https://github.com/applitools/eyes.sdk.javascript1/commit/2a34ed8cd72dc9ac54957348cbe8ba9e67032340))
+* @applitools/ufg-client bumped from 1.3.0 to 1.4.0
+  #### Features
+
+  * ability to skip deserialize dom snapshot ([#1703](https://github.com/applitools/eyes.sdk.javascript1/issues/1703)) ([a461af4](https://github.com/applitools/eyes.sdk.javascript1/commit/a461af4fb72b7cba1ae15a5d20376fd02e7d9003))
+  * add support for resource fetching through eg tunnel ([3daa4da](https://github.com/applitools/eyes.sdk.javascript1/commit/3daa4da975cbe23ffb33bb3e9f5f76732ead1075))
+  * added new chrome emulation devices - `Galaxy S21`, `Galaxy S21 Ultra`, and `Galaxy S22 Ultra` ([0dac7f7](https://github.com/applitools/eyes.sdk.javascript1/commit/0dac7f7941558a4e9416f70a104b96d125d38fc7))
+  * prevent animated gif images from playing in ufg ([#1721](https://github.com/applitools/eyes.sdk.javascript1/issues/1721)) ([30f39cc](https://github.com/applitools/eyes.sdk.javascript1/commit/30f39cc8ef2cdfa1d85bd7a0037b818db1b52e1b))
+
+
+  #### Bug Fixes
+
+  * add support for resource fetching through eg tunnel ([a0b98e3](https://github.com/applitools/eyes.sdk.javascript1/commit/a0b98e364cf95bf6bed84c1afe3376384d781717))
+  * add support for resource fetching through eg tunnel ([3daa4da](https://github.com/applitools/eyes.sdk.javascript1/commit/3daa4da975cbe23ffb33bb3e9f5f76732ead1075))
+
+
+
+* @applitools/screenshoter bumped from 3.8.2 to 3.8.3
+
+
 ## [3.5.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.5.0...js/core@3.5.1) (2023-07-05)
 
 

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

@@ -50,7 +50,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger:
         });
         const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
         const ufgClient = await eyes.core.getUFGClient({
-            config: { ...eyes.test.ufgServer },
+            config: { ...eyes.test.ufgServer, eyesServerUrl: eyes.test.server.serverUrl, eyesApiKey: eyes.test.server.apiKey },
             concurrency: uniqueRenderers.length || 5,
             logger,
         });
@@ -152,7 +152,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger:
             originalSelector: selector,
             safeSelector: selector,
         })));
-        const promises = uniqueRenderers.map(async (renderer, index) => {
+        const promises = uniqueRenderers.map(async ({ properties, ...renderer }, index) => {
             const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
             if (utils.types.has(renderer, 'name') && renderer.name === 'edge') {
                 const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
@@ -177,7 +177,10 @@ function makeCheckAndClose({ eyes, target: defaultTarget, spec, signal, logger:
                     },
                     logger: rendererLogger,
                 });
-                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, type: snapshotType }, logger });
+                const [baseEyes] = await eyes.getBaseEyes({
+                    settings: { renderer, type: snapshotType, properties },
+                    logger,
+                });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                         rendererLogger.warn('Command "check" was aborted before rendering');

package/dist/ufg/check.js

@@ -50,7 +50,7 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
         });
         const uniqueRenderers = (0, uniquify_renderers_1.uniquifyRenderers)((_a = settings.renderers) !== null && _a !== void 0 ? _a : []);
         const ufgClient = await eyes.core.getUFGClient({
-            config: { ...eyes.test.ufgServer },
+            config: { ...eyes.test.ufgServer, eyesServerUrl: eyes.test.server.serverUrl, eyesApiKey: eyes.test.server.apiKey },
             concurrency: uniqueRenderers.length || 5,
             logger,
         });
@@ -153,7 +153,7 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
             originalSelector: selector,
             safeSelector: selector,
         })));
-        const promises = uniqueRenderers.map(async (renderer, index) => {
+        const promises = uniqueRenderers.map(async ({ properties, ...renderer }, index) => {
             const rendererLogger = logger.extend({ tags: [`renderer-${utils.general.shortid()}`] });
             if (utils.types.has(renderer, 'name') && renderer.name === 'edge') {
                 const message = chalk_1.default.yellow(`The 'edge' option that is being used in your browsers' configuration will soon be deprecated. Please change it to either 'edgelegacy' for the legacy version or to 'edgechromium' for the new Chromium-based version. Please note, when using the built-in BrowserType enum, then the values are BrowserType.EDGE_LEGACY and BrowserType.EDGE_CHROMIUM, respectively.`);
@@ -178,7 +178,10 @@ function makeCheck({ eyes, target: defaultTarget, spec, signal, logger: mainLogg
                     },
                     logger: rendererLogger,
                 });
-                const [baseEyes] = await eyes.getBaseEyes({ settings: { renderer, type: snapshotType }, logger: rendererLogger });
+                const [baseEyes] = await eyes.getBaseEyes({
+                    settings: { renderer, type: snapshotType, properties },
+                    logger: rendererLogger,
+                });
                 try {
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                         rendererLogger.warn('Command "check" was aborted before rendering');

package/dist/ufg/get-base-eyes.js

@@ -32,6 +32,7 @@ function makeGetBaseEyes({ settings: defaultSettings, eyes, base, logger: mainLo
     }
     return getBaseEyesWithCache;
     async function getBaseEyes({ settings, logger = mainLogger, } = {}) {
+        var _a, _b;
         logger = logger.extend(mainLogger);
         logger.log(`Command "getBaseEyes" is called with settings`, settings);
         if (!settings)
@@ -41,8 +42,12 @@ function makeGetBaseEyes({ settings: defaultSettings, eyes, base, logger: mainLo
             logger,
         });
         const environment = await ufgClient.bookRenderer({ settings, logger });
+        let properties;
+        if (defaultSettings.properties || settings.properties) {
+            properties = ((_a = defaultSettings.properties) !== null && _a !== void 0 ? _a : []).concat((_b = settings.properties) !== null && _b !== void 0 ? _b : []);
+        }
         const baseEyes = await eyes.core.base.openEyes({
-            settings: { ...defaultSettings, environment: { ...defaultSettings.environment, ...environment } },
+            settings: { ...defaultSettings, environment: { ...defaultSettings.environment, ...environment }, properties },
             logger,
         });
         return [baseEyes];

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

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractCrossFrames = exports.deserializeDomSnapshot = exports.takeDomSnapshot = void 0;
+exports.extractCrossFrames = exports.takeDomSnapshot = void 0;
 const utils = __importStar(require("@applitools/utils"));
 const { getProcessPagePoll, getPollResult, getProcessPagePollForIE, getPollResultForIE, } = require('@applitools/dom-snapshot');
 async function takeDomSnapshot({ context, settings, logger, }) {
@@ -31,7 +31,7 @@ async function takeDomSnapshot({ context, settings, logger, }) {
     const environment = await driver.getEnvironment();
     const features = await driver.getFeatures();
     const cookies = features.allCookies ? await driver.getCookies().catch(() => []) : [];
-    const snapshot = deserializeDomSnapshot({ snapshot: await takeContextDomSnapshot({ context }) });
+    const snapshot = transformRawDomSnapshot(await takeContextDomSnapshot({ context }));
     snapshot.cookies = cookies;
     return snapshot;
     async function takeContextDomSnapshot({ context }) {
@@ -95,21 +95,19 @@ async function takeDomSnapshot({ context, settings, logger, }) {
     }
 }
 exports.takeDomSnapshot = takeDomSnapshot;
-function deserializeDomSnapshot({ snapshot }) {
+function transformRawDomSnapshot(snapshot) {
     const { blobs, selector: _, crossFrames: __, ...rest } = snapshot;
-    const deserializedSnapshot = {
+    return {
         ...rest,
         resourceContents: blobs.reduce((resourceContents, blob) => {
-            if (blob.value === undefined)
-                return { ...resourceContents, [blob.url]: blob };
-            else
-                return { ...resourceContents, [blob.url]: { ...blob, value: Buffer.from(blob.value, 'base64') } };
+            return {
+                ...resourceContents,
+                [blob.url]: blob,
+            };
         }, {}),
-        frames: snapshot.frames.map(frameSnapshot => deserializeDomSnapshot({ snapshot: frameSnapshot })),
+        frames: snapshot.frames.map(frameSnapshot => transformRawDomSnapshot(frameSnapshot)),
     };
-    return deserializedSnapshot;
 }
-exports.deserializeDomSnapshot = deserializeDomSnapshot;
 function extractCrossFrames({ snapshot, parent = null, logger, }) {
     var _a;
     const crossFrames = [snapshot, ...((_a = snapshot.frames) !== null && _a !== void 0 ? _a : [])].flatMap((snapshot, index) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "3.5.1",
+  "version": "3.6.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -68,19 +68,19 @@
     ]
   },
   "dependencies": {
-    "@applitools/core-base": "1.3.0",
+    "@applitools/core-base": "1.4.0",
     "@applitools/dom-capture": "11.2.2",
     "@applitools/dom-snapshot": "4.7.9",
-    "@applitools/driver": "1.13.0",
-    "@applitools/ec-client": "1.6.1",
+    "@applitools/driver": "1.13.1",
+    "@applitools/ec-client": "1.7.0",
     "@applitools/logger": "2.0.5",
-    "@applitools/nml-client": "1.5.1",
+    "@applitools/nml-client": "1.5.2",
     "@applitools/req": "1.4.0",
-    "@applitools/screenshoter": "3.8.2",
+    "@applitools/screenshoter": "3.8.4",
     "@applitools/snippets": "2.4.21",
     "@applitools/socket": "1.1.5",
-    "@applitools/spec-driver-webdriver": "1.0.37",
-    "@applitools/ufg-client": "1.3.0",
+    "@applitools/spec-driver-webdriver": "1.0.38",
+    "@applitools/ufg-client": "1.4.1",
     "@applitools/utils": "1.5.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -91,13 +91,14 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^4.0.0",
-    "@applitools/sdk-coverage-tests": "^3.0.2",
-    "@applitools/spec-driver-puppeteer": "^1.1.68",
-    "@applitools/spec-driver-selenium": "^1.5.51",
-    "@applitools/spec-driver-webdriverio": "^1.5.6",
+    "@applitools/bongo": "^5.0.4",
+    "@applitools/sdk-coverage-tests": "^3.1.0",
+    "@applitools/spec-driver-puppeteer": "^1.1.69",
+    "@applitools/spec-driver-selenium": "^1.5.52",
+    "@applitools/spec-driver-webdriverio": "^1.5.7",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
+    "@applitools/tunnel-client": "^1.1.0",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/yargs": "^17.0.22",

package/types/ufg/check-and-close.d.ts

@@ -13,7 +13,9 @@ type Options<TSpec extends SpecType> = {
 export declare function makeCheckAndClose<TSpec extends SpecType>({ eyes, target: defaultTarget, spec, signal, logger: mainLogger, }: Options<TSpec>): ({ target, settings, logger, }: {
     target?: Target<TSpec> | undefined;
     settings?: (import("@applitools/core-base").CheckSettings<Region | import("@applitools/driver").ElementReference<TSpec>> & import("./types").ScreenshotSettings<TSpec> & {
-        renderers?: import("@applitools/ufg-client").Renderer[] | undefined;
+        renderers?: (import("@applitools/ufg-client").Renderer & {
+            properties?: import("@applitools/core-base/types").CustomProperty[] | undefined;
+        })[] | undefined;
         hooks?: {
             beforeCaptureScreenshot: string;
         } | undefined;

package/types/ufg/get-base-eyes.d.ts

@@ -1,8 +1,7 @@
-import type { Eyes, OpenSettings } from './types';
+import type { Eyes, GetBaseEyesSettings, OpenSettings } from './types';
 import type { Eyes as BaseEyes } from '@applitools/core-base';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
-import { type RendererSettings } from '@applitools/ufg-client';
 type Options<TSpec extends SpecType> = {
     settings: OpenSettings;
     eyes: Eyes<TSpec>;
@@ -10,7 +9,7 @@ type Options<TSpec extends SpecType> = {
     logger: Logger;
 };
 export declare function makeGetBaseEyes<TSpec extends SpecType>({ settings: defaultSettings, eyes, base, logger: mainLogger, }: Options<TSpec>): (({ settings, logger, }?: {
-    settings?: RendererSettings | undefined;
+    settings?: GetBaseEyesSettings | undefined;
     logger?: Logger | undefined;
 }) => Promise<BaseEyes[]>) & {
     getCachedValues(): Promise<BaseEyes[]>[];

package/types/ufg/types.d.ts

@@ -4,10 +4,13 @@ import type * as AutomationCore from '../automation/types';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 import { type Proxy } from '@applitools/req';
-import { type UFGClient, type UFGRequestsConfig, type Renderer, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot } from '@applitools/ufg-client';
+import { type UFGClient, type UFGRequestsConfig, type Renderer, type DomSnapshot, type AndroidSnapshot, type IOSSnapshot, RendererSettings } from '@applitools/ufg-client';
 export * from '../automation/types';
 export type SnapshotTarget = MaybeArray<DomSnapshot> | MaybeArray<AndroidSnapshot> | MaybeArray<IOSSnapshot>;
 export type Target<TSpec extends SpecType> = SnapshotTarget | AutomationCore.Target<TSpec>;
+export type GetBaseEyesSettings = RendererSettings & {
+    properties?: BaseCore.CustomProperty[];
+};
 export interface Core<TSpec extends SpecType> extends AutomationCore.Core<TSpec> {
     readonly type: 'ufg';
     getUFGClient(options?: {
@@ -26,10 +29,7 @@ export interface Eyes<TSpec extends SpecType> extends AutomationCore.Eyes<TSpec>
     readonly type: 'ufg';
     readonly core: Core<TSpec>;
     getBaseEyes(options?: {
-        settings?: {
-            type: 'web' | 'native';
-            renderer: Renderer;
-        };
+        settings?: GetBaseEyesSettings;
         logger?: Logger;
     }): Promise<BaseCore.Eyes[]>;
     check(options?: {
@@ -48,7 +48,9 @@ export interface Eyes<TSpec extends SpecType> extends AutomationCore.Eyes<TSpec>
     }): Promise<TestResult[]>;
 }
 export type CheckSettings<TSpec extends SpecType> = AutomationCore.CheckSettings<TSpec> & {
-    renderers?: Renderer[];
+    renderers?: (Renderer & {
+        properties?: BaseCore.CustomProperty[];
+    })[];
     hooks?: {
         beforeCaptureScreenshot: string;
     };

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

@@ -1,7 +1,7 @@
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type Context } from '@applitools/driver';
 import { type DomSnapshot } from '@applitools/ufg-client';
-type RawDomSnapshot = {
+export type RawDomSnapshot = {
     url: string;
     selector: string;
     cdt: {
@@ -10,7 +10,7 @@ type RawDomSnapshot = {
             value: string;
         }[];
     }[];
-    crossFrames: {
+    crossFrames?: {
         selector: string;
         index: number;
     }[];
@@ -18,8 +18,10 @@ type RawDomSnapshot = {
     resourceUrls: string[];
     blobs: {
         url: string;
-        value: string;
+        value?: string;
     }[];
+    srcAttr: string | null;
+    scriptVersion: string;
 };
 export type DomSnapshotSettings = {
     disableBrowserFetching?: boolean;
@@ -34,9 +36,6 @@ export declare function takeDomSnapshot<TSpec extends SpecType>({ context, setti
     settings?: DomSnapshotSettings;
     logger: Logger;
 }): Promise<DomSnapshot>;
-export declare function deserializeDomSnapshot({ snapshot }: {
-    snapshot: RawDomSnapshot;
-}): DomSnapshot;
 export declare function extractCrossFrames({ snapshot, parent, logger, }: {
     snapshot: RawDomSnapshot;
     parent?: any;
@@ -46,4 +45,3 @@ export declare function extractCrossFrames({ snapshot, parent, logger, }: {
     reference: any;
     parentSnapshot: RawDomSnapshot;
 }[];
-export {};

package/types/ufg/utils/uniquify-renderers.d.ts

@@ -1,2 +1,2 @@
 import { type Renderer } from '@applitools/ufg-client';
-export declare function uniquifyRenderers(renderers: Renderer[]): Renderer[];
+export declare function uniquifyRenderers<TRenderer extends Renderer>(renderers: TRenderer[]): TRenderer[];