@applitools/core 4.25.0 → 4.27.0

package/CHANGELOG.md

@@ -1,5 +1,97 @@
 # Changelog
 
+## [4.27.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.26.0...js/core@4.27.0) (2024-12-18)
+
+
+### Features
+
+* check for new ufg balancer - cache result in getAccountInfo instead of makeCoreRequests ([#2692](https://github.com/Applitools-Dev/sdk/issues/2692)) ([e2a9705](https://github.com/Applitools-Dev/sdk/commit/e2a970594ffa6527798c5fac7a72188e30da986d))
+
+
+### Bug Fixes
+
+* support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
+
+
+### Dependencies
+
+* @applitools/utils bumped to 1.7.6
+  #### Bug Fixes
+
+  * support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
+* @applitools/spec-driver-webdriver bumped to 1.1.21
+  #### Bug Fixes
+
+  * support webdriver.io 9 ([baee5ce](https://github.com/Applitools-Dev/sdk/commit/baee5ce96e8220c337b007e3a517b5546ce0fedc))
+
+
+
+* @applitools/logger bumped to 2.0.20
+
+* @applitools/dom-snapshot bumped to 4.11.12
+
+* @applitools/socket bumped to 1.1.20
+
+* @applitools/req bumped to 1.7.5
+
+* @applitools/image bumped to 1.1.15
+
+* @applitools/driver bumped to 1.20.1
+
+* @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.20
+
+* @applitools/tunnel-client bumped to 1.5.11
+
+* @applitools/ufg-client bumped to 1.15.1
+
+* @applitools/core-base bumped to 1.21.0
+  #### Features
+
+  * check for new ufg balancer - cache result in getAccountInfo instead of makeCoreRequests ([#2692](https://github.com/Applitools-Dev/sdk/issues/2692)) ([e2a9705](https://github.com/Applitools-Dev/sdk/commit/e2a970594ffa6527798c5fac7a72188e30da986d))
+  * check for new ufg balancer ([#2683](https://github.com/Applitools-Dev/sdk/issues/2683)) ([60ca9f9](https://github.com/Applitools-Dev/sdk/commit/60ca9f98d37374c918e9c634af46d7f8266b95fc))
+
+
+  #### Bug Fixes
+
+  * move apiKey from query param to request header ([d1d2642](https://github.com/Applitools-Dev/sdk/commit/d1d26424c64d8e03981b1482ca49870a866bc164))
+
+
+
+* @applitools/ec-client bumped to 1.9.17
+
+
+## [4.26.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.25.0...js/core@4.26.0) (2024-12-05)
+
+
+### Features
+
+* deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+
+
+### Bug Fixes
+
+* coded regions dynamic regions with `By` locators ([#2660](https://github.com/Applitools-Dev/sdk/issues/2660)) ([e71b3ae](https://github.com/Applitools-Dev/sdk/commit/e71b3aec7241e61c9ba0d637e6242cedd8f4be7b))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.15.0
+  #### Features
+
+  * deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+* @applitools/core-base bumped to 1.20.0
+  #### Features
+
+  * deterministic output for offline mode ([#2666](https://github.com/Applitools-Dev/sdk/issues/2666)) ([0e158c4](https://github.com/Applitools-Dev/sdk/commit/0e158c4ea62c4681513a952a9e2a681c4618a6bd))
+* @applitools/ec-client bumped to 1.9.16
+
+
 ## [4.25.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.24.2...js/core@4.25.0) (2024-11-29)
 
 

package/dist/autonomous/core.js

@@ -9,6 +9,7 @@ const start_renders_1 = require("./start-renders");
 const get_render_results_1 = require("./get-render-results");
 const create_render_results_1 = require("./create-render-results");
 const open_eyes_1 = require("./open-eyes");
+const open_check_and_close_1 = require("./open-check-and-close");
 function makeAutonomousCore({ spec, clients, base: defaultBase, asyncCache, agentId = 'core-autonomous', logger: defaultLogger, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-autonomous' } });
     const core = (0, core_1.makeCore)({ spec, clients, base: defaultBase, asyncCache, agentId, logger });
@@ -19,7 +20,9 @@ function makeAutonomousCore({ spec, clients, base: defaultBase, asyncCache, agen
         startRenders: (0, start_renders_1.makeStartRenders)({ core, logger }),
         getRenderResults: (0, get_render_results_1.makeGetRenderResults)({ core, logger }),
         createRenderResults: (0, create_render_results_1.makeCreateRenderResults)({ logger }),
+        /** @deprecated */
         openEyes: (0, open_eyes_1.makeOpenEyes)({ core, logger }),
+        openCheckAndClose: (0, open_check_and_close_1.makeOpenCheckAndClose)({ core, logger }),
     };
 }
 exports.makeAutonomousCore = makeAutonomousCore;

package/dist/autonomous/open-check-and-close.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeOpenCheckAndClose = void 0;
+const populate_eyes_server_settings_1 = require("../utils/populate-eyes-server-settings");
+function makeOpenCheckAndClose({ core, logger: defaultLogger }) {
+    return async function openCheckAndClose({ target, openSettings, checkSettings, closeSettings, logger = defaultLogger, }) {
+        (0, populate_eyes_server_settings_1.populateEyesServerSettings)(openSettings);
+        return core.base.openCheckAndClose({
+            target,
+            settings: { ...openSettings, ...checkSettings, ...closeSettings },
+            logger,
+        });
+    };
+}
+exports.makeOpenCheckAndClose = makeOpenCheckAndClose;

package/dist/offline/run-offline-snapshots.js

@@ -40,6 +40,7 @@ async function runOfflineSnapshots(options) {
     var _a, _b;
     if (!options.offlineLocationPath)
         throw new Error('offlineLocationPath is required');
+    const offlineLocationPath = path_1.default.resolve(options.offlineLocationPath);
     const startTime = Date.now();
     const logger = (_a = options.logger) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ format: { label: 'offline-exec' } });
     const eyesServerSettings = { ...(_b = options.config) === null || _b === void 0 ? void 0 : _b.open, ...options };
@@ -48,20 +49,22 @@ async function runOfflineSnapshots(options) {
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
         settings: { ...account.eyesServer, ...account.ufgServer },
     });
-    const executionFolders = (await fs_1.default.promises.readdir(options.offlineLocationPath)).filter(filename => /execution\-\d+/.test(filename));
-    if (executionFolders.length === 1) {
-        logger.console.log(`Running execution ${executionFolders[0]} from folder ${path_1.default.resolve(options.offlineLocationPath)}`);
+    const testFolders = (await fs_1.default.promises.readdir(offlineLocationPath))
+        .filter(filename => filename.startsWith('test-'))
+        .sort();
+    if (testFolders.length === 1) {
+        logger.console.log(`Running single test from folder ${offlineLocationPath}`);
     }
-    else if (executionFolders.length === 0) {
-        logger.console.log('No execution artifacts were found at', options.offlineLocationPath);
+    else if (testFolders.length === 0) {
+        logger.console.log('No test artifacts were found at', offlineLocationPath);
     }
     else {
-        logger.console.log(`Running the following executions from folder ${options.offlineLocationPath} :\n  ${executionFolders.join('\n  ')}`);
+        logger.console.log(`Running ${testFolders.length} tests from folder ${offlineLocationPath}`);
     }
-    if (executionFolders.length === 0) {
-        throw new Error(`Unable to find offline executions in ${options.offlineLocationPath}`);
+    if (testFolders.length === 0) {
+        throw new Error(`Unable to find offline executions in ${offlineLocationPath}`);
     }
-    const allTestResults = (await Promise.all(executionFolders.map(runExecution))).flat();
+    const allTestResults = await runTests(testFolders);
     const { isSuccess, outputStr } = processResults({ testResults: allTestResults, totalTime: Date.now() - startTime });
     if (!isSuccess && options.failOnDiff) {
         throw new Error(outputStr);
@@ -70,30 +73,26 @@ async function runOfflineSnapshots(options) {
         logger.console.log(outputStr);
     }
     return allTestResults;
-    async function runExecution(executionName) {
-        const executionLogger = logger.extend({ tags: [executionName] });
-        const executionPath = path_1.default.resolve(options.offlineLocationPath, executionName);
-        executionLogger.log('handling execution', executionPath);
-        const testFolders = (await fs_1.default.promises.readdir(executionPath)).filter(foldername => foldername.startsWith('test-'));
-        executionLogger.log('running tests', testFolders);
+    async function runTests(testFolders) {
+        logger.log('running tests', testFolders);
         const results = await Promise.all(testFolders.map(async (testFolder) => {
             const testLogger = logger.extend({ tags: [testFolder] });
-            const testPath = path_1.default.resolve(executionPath, testFolder);
+            const testPath = path_1.default.join(offlineLocationPath, testFolder);
             const fileOpenSettings = await fs_1.default.promises
-                .readFile(path_1.default.resolve(testPath, 'settings.json'), 'utf-8')
+                .readFile(path_1.default.join(testPath, 'settings.json'), 'utf-8')
                 .then(JSON.parse);
             const openSettings = (0, merge_configs_1.mergeConfigs)(fileOpenSettings, options.config.open);
             logger.console.log(`Running test: ${openSettings.testName} (${formatEnvironment(openSettings.environment)})`);
-            return runTest(executionPath, testPath, openSettings, testLogger);
+            return runTest(testPath, openSettings, testLogger);
         }));
         const batchIds = [...new Set(results.map(t => t.batchId))];
         const allTestResults = results.map(t => t.results);
-        executionLogger.log('done running all tests', allTestResults);
+        logger.log('done running all tests', allTestResults);
         await core.closeBatch({ settings: batchIds.map(batchId => ({ batchId, ...account.eyesServer })) });
-        executionLogger.log('done execution', executionName);
+        logger.log('done closing batches');
         return allTestResults;
     }
-    async function runTest(executionPath, testPath, openSettings, logger) {
+    async function runTest(testPath, openSettings, logger) {
         const environment = await ufgClient.getActualEnvironment({
             settings: { environment: openSettings.environment.requested },
         });
@@ -111,7 +110,7 @@ async function runOfflineSnapshots(options) {
         const checkFolders = (await fs_1.default.promises.readdir(testPath)).filter(folderpath => folderpath.startsWith('check-'));
         logger.log('running checks for test', testPath, ':', checkFolders);
         const targets = (await Promise.all(checkFolders.map(checkFolder => fs_1.default.promises.readFile(path_1.default.resolve(testPath, checkFolder, 'snapshot.json'), 'utf-8').then(JSON.parse))));
-        await uploadResources(executionPath, targets, logger);
+        await uploadResources(targets, logger);
         // logger.log('resource hashes for test', testFolder, ':', resourceHashes)
         logger.log('uploaded resources for test', testPath);
         await Promise.all(targets.map((target, index) => runCheck(eyes, target, index, logger)));
@@ -121,7 +120,7 @@ async function runOfflineSnapshots(options) {
         logger.log('done running test', logger);
         return { batchId: openSettings.batch.id, results: (await eyes.getResults({ logger }))[0] };
     }
-    async function uploadResources(executionPath, targets, logger) {
+    async function uploadResources(targets, logger) {
         const uploadLogger = logger.extend({ tags: ['upload-resources'] });
         const promises = targets.map(async ({ target }) => {
             let resourcePromises = Object.values(target.resources)
@@ -130,7 +129,7 @@ async function runOfflineSnapshots(options) {
                 const contentfuleResource = {
                     id: '',
                     url: '',
-                    value: await fs_1.default.promises.readFile(path_1.default.resolve(executionPath, 'resources', resource.hash)),
+                    value: await fs_1.default.promises.readFile(path_1.default.join(offlineLocationPath, 'resources', resource.hash)),
                     contentType: resource.contentType,
                     hash: resource,
                 };
@@ -140,7 +139,7 @@ async function runOfflineSnapshots(options) {
                 resource: {
                     id: '',
                     url: '',
-                    value: await fs_1.default.promises.readFile(path_1.default.resolve(executionPath, 'resources', target.snapshot.hash)),
+                    value: await fs_1.default.promises.readFile(path_1.default.join(offlineLocationPath, 'resources', target.snapshot.hash)),
                     contentType: target.snapshot.contentType,
                     hash: target.snapshot,
                 },

package/dist/ufg/utils/to-safe-check-settings.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toSafeCheckSettings = void 0;
 const utils = __importStar(require("@applitools/utils"));
-const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility'];
+const regionTypes = ['ignore', 'layout', 'strict', 'content', 'floating', 'accessibility', 'dynamic'];
 function toSafeCheckSettings({ settings }) {
     const calculate = regionTypes.flatMap(regionType => {
         var _a;

package/dist/universal/core-server.js

@@ -31,7 +31,7 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
         defaultEnvironment,
         ...handlerOptions,
     });
-    const { server, port } = await (0, ws_server_1.makeServer)({ ...handlerOptions, debug });
+    const { server, port } = await (0, ws_server_1.makeServer)({ ...handlerOptions, debug }, baseLogger);
     if (isProcess) {
         // eslint-disable-next-line no-console
         console.log(port.toString()); // NOTE: this is a part of the generic protocol

package/dist/universal/core.js

@@ -99,6 +99,10 @@ function makeCore(options) {
             // TODO
             return null;
         },
+        async openCheckAndClose() {
+            // TODO
+            return null;
+        },
     };
     return core;
 }

package/dist/universal/ws-server.js

@@ -7,7 +7,7 @@ const ws_1 = require("ws");
 const { name, version } = require('../../package.json');
 const TOKEN_HEADER = 'x-eyes-universal-token';
 const TOKEN = `${name}@${version}`;
-async function makeServer(options = {}) {
+async function makeServer(options = {}, logger) {
     const { port = 21077, singleton = true, debug = false, portResolutionMode = 'next', cert, key } = options;
     const secure = Boolean(cert && key);
     const http = secure ? new https_1.Server({ cert, key }) : new http_1.Server();
@@ -27,7 +27,13 @@ async function makeServer(options = {}) {
     return new Promise((resolve, reject) => {
         http.on('listening', () => {
             const ws = new ws_1.Server({ server: http, path: '/eyes', maxPayload: 256 * 1024 * 1024 });
-            ws.on('close', () => http.close());
+            ws.on('close', () => {
+                logger.log('Core universal server is closed');
+                http.close();
+            });
+            ws.on('error', err => {
+                logger.log('Core universal server error', err);
+            });
             resolve({ server: ws, port: http.address().port });
         });
         http.on('error', async (err) => {
@@ -36,7 +42,7 @@ async function makeServer(options = {}) {
                     return resolve({ port });
                 }
                 else {
-                    return resolve(await makeServer({ ...options, port: portResolutionMode === 'next' ? port + 1 : 0 }));
+                    return resolve(await makeServer({ ...options, port: portResolutionMode === 'next' ? port + 1 : 0 }, logger));
                 }
             }
             reject(err);

package/dist/utils/ensure-offline-folder.js

@@ -32,7 +32,7 @@ const path_1 = __importDefault(require("path"));
 const utils = __importStar(require("@applitools/utils"));
 function ensureOfflineFolder() {
     const offlineLocationPath = utils.general.getEnvValue('OFFLINE_LOCATION_PATH')
-        ? path_1.default.resolve(utils.general.getEnvValue('OFFLINE_LOCATION_PATH'), `execution-${Date.now()}`)
+        ? path_1.default.resolve(utils.general.getEnvValue('OFFLINE_LOCATION_PATH'))
         : undefined;
     if (offlineLocationPath) {
         fs_1.default.mkdirSync(offlineLocationPath, { recursive: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.25.0",
+  "version": "4.27.0",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -74,20 +74,20 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.19.3",
+    "@applitools/core-base": "1.21.0",
     "@applitools/dom-capture": "11.5.2",
-    "@applitools/dom-snapshot": "4.11.11",
-    "@applitools/driver": "1.20.0",
-    "@applitools/ec-client": "1.9.15",
-    "@applitools/logger": "2.0.19",
-    "@applitools/nml-client": "1.8.19",
-    "@applitools/req": "1.7.4",
-    "@applitools/screenshoter": "3.10.0",
+    "@applitools/dom-snapshot": "4.11.12",
+    "@applitools/driver": "1.20.1",
+    "@applitools/ec-client": "1.9.17",
+    "@applitools/logger": "2.0.20",
+    "@applitools/nml-client": "1.8.20",
+    "@applitools/req": "1.7.5",
+    "@applitools/screenshoter": "3.10.1",
     "@applitools/snippets": "2.6.3",
-    "@applitools/socket": "1.1.19",
-    "@applitools/spec-driver-webdriver": "1.1.20",
-    "@applitools/ufg-client": "1.14.1",
-    "@applitools/utils": "1.7.5",
+    "@applitools/socket": "1.1.20",
+    "@applitools/spec-driver-webdriver": "1.1.21",
+    "@applitools/ufg-client": "1.15.1",
+    "@applitools/utils": "1.7.6",
     "@types/ws": "8.5.5",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
@@ -100,11 +100,11 @@
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
     "@applitools/sea": "^1.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.4.20",
-    "@applitools/spec-driver-selenium": "^1.5.91",
+    "@applitools/spec-driver-puppeteer": "^1.4.21",
+    "@applitools/spec-driver-selenium": "^1.5.92",
     "@applitools/test-server": "^1.2.2",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.5.10",
+    "@applitools/tunnel-client": "^1.5.11",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/semver": "^7.5.8",

package/types/autonomous/open-check-and-close.d.ts

@@ -0,0 +1,16 @@
+import type { Core as UFGCore } from '../ufg/types';
+import type { OpenSettings } from './types';
+import type { CheckSettings, CloseSettings, Target } from '@applitools/core-base/types';
+import { type Logger } from '@applitools/logger';
+type Options = {
+    core: UFGCore<any>;
+    logger: Logger;
+};
+export declare function makeOpenCheckAndClose({ core, logger: defaultLogger }: Options): ({ target, openSettings, checkSettings, closeSettings, logger, }: {
+    target: Target;
+    openSettings: OpenSettings;
+    checkSettings?: CheckSettings<import("@applitools/utils").Region> | undefined;
+    closeSettings?: CloseSettings | undefined;
+    logger: Logger;
+}) => Promise<void>;
+export {};

package/types/autonomous/types.d.ts

@@ -1,4 +1,4 @@
-import type { Eyes as BaseEyes, ImageTarget as BaseImageTarget, OpenSettings as BaseOpenSettings, CheckSettings as BaseCheckSettings } from '@applitools/core-base/types';
+import type { Eyes as BaseEyes, ImageTarget as BaseImageTarget, OpenSettings as BaseOpenSettings, CheckSettings as BaseCheckSettings, CloseSettings as BaseCloseSettings } from '@applitools/core-base/types';
 import type * as UFGCore from '../ufg/types';
 import { type Logger } from '@applitools/logger';
 import { type SpecType } from '@applitools/driver';
@@ -28,10 +28,18 @@ export interface AutonomousCore<TSpec extends SpecType> {
         rawResults: any[];
         logger?: Logger;
     }): Promise<RenderResult[]>;
+    /** @deprecated */
     openEyes(options: {
         settings: Partial<OpenSettings>;
         logger?: Logger;
     }): Promise<BaseEyes>;
+    openCheckAndClose(options: {
+        target: BaseImageTarget;
+        openSettings: Partial<OpenSettings>;
+        checkSettings?: BaseCheckSettings;
+        closeSettings?: BaseCloseSettings;
+        logger?: Logger;
+    }): Promise<void>;
 }
 export type SnapshotSettings<TSpec extends SpecType> = UFGCore.SnapshotSettings<TSpec> & UFGCore.EyesServerSettings;
 export type RenderTargetWithSettings = {

package/types/universal/ws-server.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { Server as WsServer } from 'ws';
+import { Logger } from '@applitools/logger';
 export type ServerOptions = {
     port?: number;
     singleton?: boolean;
@@ -8,7 +9,7 @@ export type ServerOptions = {
     key?: string | Buffer;
     cert?: string | Buffer;
 };
-export declare function makeServer(options?: ServerOptions): Promise<{
+export declare function makeServer(options: ServerOptions | undefined, logger: Logger): Promise<{
     server?: WsServer;
     port: number;
 }>;