@applitools/core 3.10.4 → 3.11.1

package/CHANGELOG.md

@@ -1,5 +1,64 @@
 # Changelog
 
+## [3.11.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.11.0...js/core@3.11.1) (2023-09-21)
+
+
+### Bug Fixes
+
+* add support to shadow dom iframe ([#1925](https://github.com/applitools/eyes.sdk.javascript1/issues/1925)) ([a06b955](https://github.com/applitools/eyes.sdk.javascript1/commit/a06b9555a3b37918fe43a90e92c0a94f765151cc))
+* async cache key - avoid undefined keys and ready promise ([#1929](https://github.com/applitools/eyes.sdk.javascript1/issues/1929)) ([8654f99](https://github.com/applitools/eyes.sdk.javascript1/commit/8654f99d92403f1e59bf8e2f6fbc32ba467e3037))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.4.24
+  #### Bug Fixes
+
+  * add support to shadow dom iframe ([#1925](https://github.com/applitools/eyes.sdk.javascript1/issues/1925)) ([a06b955](https://github.com/applitools/eyes.sdk.javascript1/commit/a06b9555a3b37918fe43a90e92c0a94f765151cc))
+* @applitools/spec-driver-selenium bumped to 1.5.59
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.1
+
+* @applitools/ufg-client bumped to 1.9.1
+  #### Bug Fixes
+
+  * async cache key - avoid undefined keys and ready promise ([#1929](https://github.com/applitools/eyes.sdk.javascript1/issues/1929)) ([8654f99](https://github.com/applitools/eyes.sdk.javascript1/commit/8654f99d92403f1e59bf8e2f6fbc32ba467e3037))
+* @applitools/spec-driver-webdriver bumped to 1.0.45
+
+* @applitools/screenshoter bumped to 3.8.11
+
+* @applitools/nml-client bumped to 1.5.11
+
+* @applitools/ec-client bumped to 1.7.9
+  #### Bug Fixes
+
+  * change expiration time of the tunnel ([c019241](https://github.com/applitools/eyes.sdk.javascript1/commit/c0192411410135b23f3ae47dd62fbef67be66f1a))
+
+
+
+* @applitools/driver bumped to 1.14.1
+
+
+## [3.11.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.10.4...js/core@3.11.0) (2023-09-13)
+
+
+### Features
+
+* change cache to support distributed cache ([#1913](https://github.com/applitools/eyes.sdk.javascript1/issues/1913)) ([32cc257](https://github.com/applitools/eyes.sdk.javascript1/commit/32cc2574500ac512167f4199c456d8b0349954f7))
+
+
+### Bug Fixes
+
+* upgrade dom-capture to get font-family in DOM ([f62cee4](https://github.com/applitools/eyes.sdk.javascript1/commit/f62cee495ba3b301dda04160e4e13c7e380ef40b))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.9.0
+  #### Features
+
+  * change cache to support distributed cache ([#1913](https://github.com/applitools/eyes.sdk.javascript1/issues/1913)) ([32cc257](https://github.com/applitools/eyes.sdk.javascript1/commit/32cc2574500ac512167f4199c456d8b0349954f7))
+
 ## [3.10.4](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.10.3...js/core@3.10.4) (2023-09-12)
 
 

package/dist/core.js

@@ -40,7 +40,7 @@ const close_batch_1 = require("./close-batch");
 const delete_test_1 = require("./delete-test");
 const extract_environment_1 = require("./utils/extract-environment");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, } = {}) {
+function makeCore({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, asyncCache, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
     const environment = (0, extract_environment_1.extractEnvironment)(defaultEnvironment);
     logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment`, environment);
@@ -53,11 +53,21 @@ function makeCore({ spec, clients, concurrency, base: defaultBase, environment:
             getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
             getECClient: (0, get_ec_client_1.makeGetECClient)({ logger }),
             getAccountInfo: (0, get_account_info_1.makeGetAccountInfo)({ core, logger }),
-            makeManager: (0, make_manager_1.makeMakeManager)({ spec, clients, concurrency, core, base: defaultBase, agentId, environment, logger }),
+            makeManager: (0, make_manager_1.makeMakeManager)({
+                spec,
+                clients,
+                concurrency,
+                core,
+                base: defaultBase,
+                agentId,
+                environment,
+                asyncCache,
+                logger,
+            }),
             locate: (0, locate_1.makeLocate)({ spec, core, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
             extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
-            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, concurrency, environment, logger }),
+            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, clients, core, concurrency, environment, asyncCache, logger }),
             closeBatch: (0, close_batch_1.makeCloseBatch)({ core, logger }),
             deleteTest: (0, delete_test_1.makeDeleteTest)({ core, logger }),
         };

package/dist/make-manager.js

@@ -30,7 +30,7 @@ const core_2 = require("./ufg/core");
 const open_eyes_1 = require("./open-eyes");
 const get_manager_results_1 = require("./get-manager-results");
 const utils = __importStar(require("@applitools/utils"));
-function makeMakeManager({ spec, clients, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), core, base, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, }) {
+function makeMakeManager({ spec, clients, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), core, base, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache, }) {
     return async function makeManager({ type = 'classic', settings, logger = mainLogger, } = {}) {
         var _a, _b, _c, _d, _e;
         var _f;
@@ -43,12 +43,12 @@ function makeMakeManager({ spec, clients, concurrency: defaultConcurrency = util
         logger.log('Command "makeManager" is called with settings', settings);
         base !== null && base !== void 0 ? base : (base = (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger }));
         const cores = {
-            ufg: (0, core_2.makeCore)({ spec, base, fetchConcurrency: settings.fetchConcurrency, logger }),
+            ufg: (0, core_2.makeCore)({ spec, base, fetchConcurrency: settings.fetchConcurrency, asyncCache, logger }),
             classic: (0, core_1.makeCore)({ spec, base, logger }),
         };
         const storage = [];
         return {
-            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, clients, batch: settings.batch, spec, core, cores, environment, logger }), async (openEyes, options) => {
+            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, clients, batch: settings.batch, spec, core, cores, environment, asyncCache, logger }), async (openEyes, options) => {
                 const eyes = await openEyes(options);
                 storage.push(eyes);
                 return eyes;

package/dist/open-eyes.js

@@ -34,7 +34,7 @@ const close_1 = require("./close");
 const abort_1 = require("./abort");
 const get_eyes_results_1 = require("./get-eyes-results");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, }) {
+function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, asyncCache, }) {
     return async function openEyes({ type = defaultType, settings, config, target, logger = mainLogger, }) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
         var _v, _w, _x, _y;
@@ -75,7 +75,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, concurrency, bat
             settings: settings,
             target: driver,
             cores: cores !== null && cores !== void 0 ? cores : {
-                ufg: (0, core_2.makeCore)({ spec, clients, base: core.base, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, logger }),
+                ufg: (0, core_2.makeCore)({ spec, clients, base: core.base, concurrency: concurrency !== null && concurrency !== void 0 ? concurrency : 5, asyncCache, logger }),
                 classic: (0, core_1.makeCore)({ spec, clients, base: core.base, logger }),
             },
             logger,

package/dist/ufg/core.js

@@ -35,7 +35,7 @@ const get_nml_client_1 = require("../automation/get-nml-client");
 const get_ufg_client_1 = require("./get-ufg-client");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, base, concurrency, fetchConcurrency, agentId = 'core-ufg', cwd = process.cwd(), logger: defaultLogger, }) {
+function makeCore({ spec, clients, base, concurrency, fetchConcurrency, agentId = 'core-ufg', cwd = process.cwd(), logger: defaultLogger, asyncCache, }) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-ufg' } });
     logger.log(`Core ufg is initialized ${base ? 'with' : 'without'} custom base core`);
     base !== null && base !== void 0 ? base : (base = (0, core_base_1.makeCore)({ concurrency, agentId, cwd, logger }));
@@ -48,7 +48,7 @@ function makeCore({ spec, clients, base, concurrency, fetchConcurrency, agentId
             locate: (0, locate_1.makeLocate)({ spec, core, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ spec, core, logger }),
             extractText: (0, extract_text_1.makeExtractText)({ spec, core, logger }),
-            getUFGClient: (0, get_ufg_client_1.makeGetUFGClient)({ client: clients === null || clients === void 0 ? void 0 : clients.ufg, fetchConcurrency, logger }),
+            getUFGClient: (0, get_ufg_client_1.makeGetUFGClient)({ client: clients === null || clients === void 0 ? void 0 : clients.ufg, fetchConcurrency, asyncCache, logger }),
             getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ client: clients === null || clients === void 0 ? void 0 : clients.nml, logger }),
             openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, core, logger }),
         };

package/dist/ufg/get-ufg-client.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetUFGClient = void 0;
 const ufg_client_1 = require("@applitools/ufg-client");
 const utils = __importStar(require("@applitools/utils"));
-function makeGetUFGClient({ client, fetchConcurrency, logger: mainLogger }) {
+function makeGetUFGClient({ client, fetchConcurrency, logger: mainLogger, asyncCache }) {
     // we are caching by the server config, therefor if the user creates another Runner / manager with the same server config but different
     // fetchConcurrency, it will not take any affect.
     const getUFGClientWithCache = utils.general.cachify(getUFGClient, ([options]) => client ? 'default' : [{ ...options.settings, fetchConcurrency: undefined }]);
@@ -39,7 +39,7 @@ function makeGetUFGClient({ client, fetchConcurrency, logger: mainLogger }) {
             ? utils.general.getEnvValue('TUNNEL_IDS')
             : undefined;
         return (0, ufg_client_1.makeUFGClient)({
-            settings: { ...settings, fetchConcurrency, tunnelIds },
+            settings: { ...settings, fetchConcurrency, tunnelIds, asyncCache },
             logger,
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "3.10.4",
+  "version": "3.11.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -66,18 +66,18 @@
   },
   "dependencies": {
     "@applitools/core-base": "1.6.0",
-    "@applitools/dom-capture": "11.2.2",
+    "@applitools/dom-capture": "11.2.3",
     "@applitools/dom-snapshot": "4.7.11",
-    "@applitools/driver": "1.14.0",
-    "@applitools/ec-client": "1.7.8",
+    "@applitools/driver": "1.14.1",
+    "@applitools/ec-client": "1.7.9",
     "@applitools/logger": "2.0.10",
-    "@applitools/nml-client": "1.5.10",
+    "@applitools/nml-client": "1.5.11",
     "@applitools/req": "1.6.0",
-    "@applitools/screenshoter": "3.8.10",
-    "@applitools/snippets": "2.4.23",
+    "@applitools/screenshoter": "3.8.11",
+    "@applitools/snippets": "2.4.24",
     "@applitools/socket": "1.1.10",
-    "@applitools/spec-driver-webdriver": "1.0.44",
-    "@applitools/ufg-client": "1.8.0",
+    "@applitools/spec-driver-webdriver": "1.0.45",
+    "@applitools/ufg-client": "1.9.1",
     "@applitools/utils": "1.6.0",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
@@ -89,8 +89,8 @@
   },
   "devDependencies": {
     "@applitools/bongo": "^5.6.1",
-    "@applitools/spec-driver-puppeteer": "^1.2.0",
-    "@applitools/spec-driver-selenium": "^1.5.58",
+    "@applitools/spec-driver-puppeteer": "^1.2.1",
+    "@applitools/spec-driver-selenium": "^1.5.59",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
     "@applitools/tunnel-client": "^1.2.2",

package/types/core.d.ts

@@ -1,6 +1,6 @@
 import type { Core } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
-import { type UFGClient } from '@applitools/ufg-client';
+import { type AsyncCache, type UFGClient } from '@applitools/ufg-client';
 import { type NMLClient } from '@applitools/nml-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
@@ -16,6 +16,7 @@ type Options<TSpec extends SpecType> = {
     environment?: Record<string, any>;
     cwd?: string;
     logger?: Logger;
+    asyncCache?: AsyncCache;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId, cwd, logger: defaultLogger, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
+export declare function makeCore<TSpec extends SpecType>({ spec, clients, concurrency, base: defaultBase, environment: defaultEnvironment, agentId, cwd, logger: defaultLogger, asyncCache, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
 export {};

package/types/make-manager.d.ts

@@ -1,6 +1,6 @@
 import type { Core, EyesManager, ManagerSettings } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
-import { type UFGClient } from '@applitools/ufg-client';
+import { type AsyncCache, type UFGClient } from '@applitools/ufg-client';
 import { type NMLClient } from '@applitools/nml-client';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
@@ -17,8 +17,9 @@ type Options<TSpec extends SpecType> = {
     environment?: Record<string, any>;
     cwd?: string;
     logger: Logger;
+    asyncCache?: AsyncCache;
 };
-export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, concurrency: defaultConcurrency, core, base, agentId: defaultAgentId, environment, cwd, logger: mainLogger, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
+export declare function makeMakeManager<TSpec extends SpecType>({ spec, clients, concurrency: defaultConcurrency, core, base, agentId: defaultAgentId, environment, cwd, logger: mainLogger, asyncCache, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
     type?: TType | undefined;
     settings?: ManagerSettings | undefined;
     logger?: Logger | undefined;

package/types/open-eyes.d.ts

@@ -1,5 +1,5 @@
 import type { DriverTarget, Core, TypedCore, Batch, Eyes, Config, OpenSettings } from './types';
-import { type UFGClient } from '@applitools/ufg-client';
+import { type AsyncCache, type UFGClient } from '@applitools/ufg-client';
 import { type NMLClient } from '@applitools/nml-client';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
@@ -18,8 +18,9 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     spec?: SpecDriver<TSpec>;
     environment?: Record<string, any>;
     logger: Logger;
+    asyncCache?: AsyncCache;
 };
-export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
+export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, clients, concurrency, batch, core, cores, spec, environment, logger: mainLogger, asyncCache, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
     type?: TType | undefined;
     settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>> | undefined;
     config?: (Config<TSpec, TDefaultType> & Config<TSpec, TType>) | undefined;

package/types/ufg/core.d.ts

@@ -1,5 +1,5 @@
 import type { Core } from './types';
-import { type UFGClient } from '@applitools/ufg-client';
+import { type AsyncCache, type UFGClient } from '@applitools/ufg-client';
 import { type NMLClient } from '@applitools/nml-client';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
@@ -16,6 +16,7 @@ type Options<TSpec extends SpecType> = {
     agentId?: string;
     cwd?: string;
     logger?: Logger;
+    asyncCache?: AsyncCache;
 };
-export declare function makeCore<TSpec extends SpecType = never>({ spec, clients, base, concurrency, fetchConcurrency, agentId, cwd, logger: defaultLogger, }: Options<TSpec>): Core<TSpec>;
+export declare function makeCore<TSpec extends SpecType = never>({ spec, clients, base, concurrency, fetchConcurrency, agentId, cwd, logger: defaultLogger, asyncCache, }: Options<TSpec>): Core<TSpec>;
 export {};

package/types/ufg/get-ufg-client.d.ts

@@ -1,11 +1,12 @@
 import { type Logger } from '@applitools/logger';
-import { type UFGClient, type UFGClientSettings } from '@applitools/ufg-client';
+import { type AsyncCache, type UFGClient, type UFGClientSettings } from '@applitools/ufg-client';
 type Options = {
     client?: UFGClient;
     fetchConcurrency?: number;
     logger: Logger;
+    asyncCache?: AsyncCache;
 };
-export declare function makeGetUFGClient({ client, fetchConcurrency, logger: mainLogger }: Options): (({ settings, logger }: {
+export declare function makeGetUFGClient({ client, fetchConcurrency, logger: mainLogger, asyncCache }: Options): (({ settings, logger }: {
     settings: UFGClientSettings;
     logger?: Logger | undefined;
 }) => Promise<UFGClient>) & {