@applitools/core 4.18.2 → 4.20.0

package/CHANGELOG.md

@@ -1,5 +1,74 @@
 # Changelog
 
+## [4.20.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.19.0...js/core@4.20.0) (2024-09-30)
+
+
+### Features
+
+* offline execution ([#2528](https://github.com/Applitools-Dev/sdk/issues/2528)) ([e6c3b9e](https://github.com/Applitools-Dev/sdk/commit/e6c3b9e3315203027551da3bfdecf90490edd029))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.13.0
+  #### Features
+
+  * offline execution ([#2528](https://github.com/Applitools-Dev/sdk/issues/2528)) ([e6c3b9e](https://github.com/Applitools-Dev/sdk/commit/e6c3b9e3315203027551da3bfdecf90490edd029))
+* @applitools/core-base bumped to 1.17.0
+  #### Features
+
+  * offline execution ([#2528](https://github.com/Applitools-Dev/sdk/issues/2528)) ([e6c3b9e](https://github.com/Applitools-Dev/sdk/commit/e6c3b9e3315203027551da3bfdecf90490edd029))
+* @applitools/ec-client bumped to 1.9.6
+
+
+## [4.19.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.18.2...js/core@4.19.0) (2024-09-16)
+
+
+### Features
+
+* allow passing arguments to dom-capture from core ([#2531](https://github.com/Applitools-Dev/sdk/issues/2531)) ([9cfc9a5](https://github.com/Applitools-Dev/sdk/commit/9cfc9a5b5d6650afd1e7daf2714d6779a7dc2724))
+
+
+### Bug Fixes
+
+* stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+
+
+### Dependencies
+
+* @applitools/snippets bumped to 2.5.0
+  #### Features
+
+  * add playwright fixture ([#2412](https://github.com/Applitools-Dev/sdk/issues/2412)) ([0632e93](https://github.com/Applitools-Dev/sdk/commit/0632e93dd7f53029a8c5f4230d22a05abf5fefd4))
+
+
+  #### Bug Fixes
+
+  * stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+* @applitools/dom-capture bumped to 11.5.0
+  #### Features
+
+  * ability to capture element properties ([#2525](https://github.com/Applitools-Dev/sdk/issues/2525)) ([ab35e1d](https://github.com/Applitools-Dev/sdk/commit/ab35e1dc929ba4bd82e99081527b277c8090f1e0))
+* @applitools/driver bumped to 1.19.1
+  #### Bug Fixes
+
+  * stale layout breakpoints elements ([#2479](https://github.com/Applitools-Dev/sdk/issues/2479)) ([f5e4b5a](https://github.com/Applitools-Dev/sdk/commit/f5e4b5ac8077b8c4b7ba67a38c4e58050a55ce75))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.13
+
+* @applitools/spec-driver-selenium bumped to 1.5.84
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.13
+
+* @applitools/screenshoter bumped to 3.8.37
+
+* @applitools/nml-client bumped to 1.8.11
+
+* @applitools/ec-client bumped to 1.9.5
+
+
 ## [4.18.2](https://github.com/Applitools-Dev/sdk/compare/js/core@4.18.1...js/core@4.18.2) (2024-09-10)
 
 

package/dist/autonomous/core.js

@@ -14,7 +14,7 @@ function makeAutonomousCore({ spec, clients, base: defaultBase, asyncCache, agen
     const core = (0, core_1.makeCore)({ spec, clients, base: defaultBase, asyncCache, agentId, cwd, logger });
     return {
         type: 'autonomous',
-        takeSnapshots: spec && (0, take_snapshots_1.makeTakeSnapshots)({ core, logger }),
+        takeSnapshots: spec && (0, take_snapshots_1.makeTakeSnapshots)({ core, spec, logger }),
         createRenderTarget: (0, create_render_target_1.makeCreateRenderTarget)({ core, logger }),
         startRenders: (0, start_renders_1.makeStartRenders)({ core, logger }),
         getRenderResults: (0, get_render_results_1.makeGetRenderResults)({ core, logger }),

package/dist/autonomous/create-render-target.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeCreateRenderTarget = void 0;
+const create_render_target_from_snapshot_1 = require("../ufg/create-render-target-from-snapshot");
 function makeCreateRenderTarget({ core, logger: defaultLogger }) {
     return async function createRenderTarget({ snapshot, logger = defaultLogger, }) {
         const ufgClient = await core.getUFGClient({
@@ -11,21 +12,7 @@ function makeCreateRenderTarget({ core, logger: defaultLogger }) {
             },
             logger,
         });
-        const target = await ufgClient.createRenderTarget({
-            snapshot: snapshot.target,
-            settings: {
-                environment: snapshot.environment,
-                cookies: snapshot.target.cookies,
-                headers: {
-                    Referer: snapshot.url,
-                    'User-Agent': snapshot.userAgent,
-                    ...snapshot.settings.headers,
-                },
-                proxy: snapshot.account.eyesServer.proxy,
-                autProxy: snapshot.settings.autProxy,
-            },
-            logger,
-        });
+        const target = await (0, create_render_target_from_snapshot_1.createRenderTargetFromSnapshot)({ ufgClient, snapshot, logger });
         return { ...snapshot, target };
     };
 }

package/dist/autonomous/take-snapshots.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeTakeSnapshots = void 0;
+const driver_1 = require("@applitools/driver");
 const populate_eyes_server_settings_1 = require("../utils/populate-eyes-server-settings");
-function makeTakeSnapshots({ core, logger: defaultLogger }) {
+const uniquify_environments_1 = require("../automation/utils/uniquify-environments");
+function makeTakeSnapshots({ core, spec, logger: defaultLogger }) {
     return async function takeSnapshots({ target, settings, logger = defaultLogger, }) {
         (0, populate_eyes_server_settings_1.populateEyesServerSettings)(settings);
         const account = await core.base.getAccountInfo({ settings: settings, logger });
-        return core.takeSnapshots({ target, settings, account, logger });
+        settings.environments = (0, uniquify_environments_1.uniquifyEnvironments)(settings.environments);
+        const driver = await (0, driver_1.makeDriver)({ spec, driver: target, logger });
+        return core.takeSnapshots({ driver, settings, account, logger });
     };
 }
 exports.makeTakeSnapshots = makeTakeSnapshots;

package/dist/classic/core.js

@@ -34,10 +34,10 @@ const extract_text_1 = require("../automation/extract-text");
 const get_nml_client_1 = require("../automation/get-nml-client");
 const open_eyes_1 = require("./open-eyes");
 const utils = __importStar(require("@applitools/utils"));
-function makeCore({ spec, clients, base: defaultBase, concurrency, agentId = 'core-classic', cwd = process.cwd(), logger: defaultLogger, }) {
+function makeCore({ spec, clients, base: defaultBase, concurrency, agentId = 'core-classic', cwd = process.cwd(), logger: defaultLogger, offlineLocationPath, }) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core-classic' } });
     logger.log(`Core classic is initialized ${defaultBase ? 'with' : 'without'} custom base core`);
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger });
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
     return utils.general.extend(base, core => {
         return {
             type: 'classic',

package/dist/classic/utils/take-dom-capture.js

@@ -11,6 +11,7 @@ async function takeDomCapture({ driver, settings, logger, }) {
     const arg = {
         chunkByteLength: (_a = settings === null || settings === void 0 ? void 0 : settings.chunkByteLength) !== null && _a !== void 0 ? _a : (Number(process.env.APPLITOOLS_SCRIPT_RESULT_MAX_BYTE_LENGTH) ||
             (environment.isIOS ? 100000 : 250 * 1024 * 1024)),
+        ...settings === null || settings === void 0 ? void 0 : settings.domCaptureArgs,
     };
     const scripts = {
         main: features.canExecuteOnlyFunctionScripts

package/dist/cli/cli.js

@@ -32,6 +32,7 @@ const core_server_1 = require("../universal/core-server");
 const core_server_process_1 = require("../universal/core-server-process");
 const logs_1 = require("../troubleshoot/logs");
 const check_network_1 = require("../troubleshoot/check-network");
+const run_offline_snapshots_1 = require("../run-offline-snapshots");
 const yargs_1 = __importDefault(require("yargs"));
 const utils = __importStar(require("@applitools/utils"));
 const fs_1 = __importDefault(require("fs"));
@@ -151,5 +152,24 @@ yargs_1.default
     handler: async () => {
         await (0, check_network_1.checkNetwork)();
     },
+})
+    .command({
+    command: 'run-offline-snapshots',
+    builder: yargs => yargs
+        .options({
+        offlineLocationPath: {
+            description: 'path to offline snapshots folder',
+            type: 'string',
+        },
+    })
+        .fail((_msg, err, _yargs) => {
+        if (err) {
+            console.error(err.message);
+            process.exit(1);
+        }
+    }),
+    handler: async (args) => {
+        await (0, run_offline_snapshots_1.runOfflineSnapshots)(args);
+    },
 })
     .wrap(yargs_1.default.terminalWidth()).argv;

package/dist/core.js

@@ -41,6 +41,7 @@ const make_manager_1 = require("./make-manager");
 const close_batch_1 = require("./close-batch");
 const delete_test_1 = require("./delete-test");
 const extract_test_environment_1 = require("./utils/extract-test-environment");
+const ensure_offline_folder_1 = require("./utils/ensure-offline-folder");
 const validate_sdk_version_1 = require("./utils/validate-sdk-version");
 const memory_usage_logging_1 = require("./utils/memory-usage-logging");
 const utils = __importStar(require("@applitools/utils"));
@@ -51,10 +52,11 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
     logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment `, environment);
     if (environment.sdk)
         (0, validate_sdk_version_1.validateSdkVersion)(environment.sdk, { logger });
-    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger });
+    const offlineLocationPath = (0, ensure_offline_folder_1.ensureOfflineFolder)();
+    const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, concurrency, cwd, logger, offlineLocationPath });
     const cores = {
-        ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger }),
-        classic: (0, core_1.makeCore)({ spec, clients, base, logger }),
+        ufg: (0, core_2.makeCore)({ spec, clients, base, asyncCache, logger, offlineLocationPath }),
+        classic: (0, core_1.makeCore)({ spec, clients, base, logger, offlineLocationPath }),
     };
     return utils.general.extend(base, core => {
         return {
@@ -76,6 +78,7 @@ function makeCore({ spec, clients, base: defaultBase, concurrency = utils.genera
                 environment,
                 asyncCache,
                 logger,
+                offlineLocationPath,
             }),
             locate: (0, locate_1.makeLocate)({ spec, core, logger }),
             locateText: (0, locate_text_1.makeLocateText)({ spec, 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, core, base: defaultBase, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache, }) {
+function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, asyncCache, offlineLocationPath, }) {
     return async function makeManager({ type = 'classic', settings, logger = mainLogger, } = {}) {
         var _a, _b, _c, _d, _e, _f, _g;
         var _h, _j;
@@ -42,9 +42,10 @@ function makeMakeManager({ spec, clients, core, base: defaultBase, agentId: defa
         (_f = (_j = settings.batch).buildId) !== null && _f !== void 0 ? _f : (_j.buildId = utils.general.getEnvValue('BATCH_BUILD_ID'));
         (_g = settings.agentId) !== null && _g !== void 0 ? _g : (settings.agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId);
         logger.log('Command "makeManager" is called with settings', settings);
-        const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger });
+        const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId: settings.agentId, concurrency: settings.concurrency, cwd, logger, offlineLocationPath });
+        const fetchConcurrency = settings.fetchConcurrency;
         const cores = {
-            ufg: (0, core_2.makeCore)({ spec, clients, base, fetchConcurrency: settings.fetchConcurrency, asyncCache, logger }),
+            ufg: (0, core_2.makeCore)({ spec, clients, base, fetchConcurrency, asyncCache, logger, offlineLocationPath }),
             classic: (0, core_1.makeCore)({ spec, clients, base, logger }),
         };
         const storage = [];

package/dist/open-eyes.js

@@ -35,6 +35,7 @@ const abort_1 = require("./abort");
 const get_eyes_results_1 = require("./get-eyes-results");
 const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-settings");
 const utils = __importStar(require("@applitools/utils"));
+const core_base_1 = require("@applitools/core-base");
 function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDuplicateTests, 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;
@@ -98,7 +99,9 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
             },
             logger,
         });
-        const eyes = await getTypedEyes({ logger });
+        const eyes = await getTypedEyes({ logger }).catch(error => {
+            throw refineMissingApiKeyException(error, environment === null || environment === void 0 ? void 0 : environment.sdk);
+        });
         return utils.general.extend(eyes, eyes => {
             var _a, _b;
             return ({
@@ -113,6 +116,63 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
     };
 }
 exports.makeOpenEyes = makeOpenEyes;
+function refineMissingApiKeyException(error, sdk) {
+    var _a;
+    if (!sdk || typeof sdk !== 'object')
+        return error;
+    try {
+        if (error instanceof core_base_1.MissingApiKeyError) {
+            const apiKeyTutorials = {
+                python: {
+                    'eyes-selenium': 'api-ref/sdk-api/selenium/python/#API',
+                    'eyes-playwright': 'api-ref/sdk-api/playwright/python/#API',
+                    'eyes-robotframework': 'api-ref/sdk-api/robot/#API',
+                    'eyes-images': undefined,
+                },
+                ruby: {
+                    eyes_images: 'api-ref/sdk-api/selenium/ruby/#API',
+                    eyes_appium: undefined,
+                    eyes_selenium: undefined,
+                    eyes_universal: undefined,
+                    eyes_capybara: undefined,
+                    eyes_calabash: undefined,
+                },
+                java: {
+                    java_appium: undefined,
+                    java_selenium: 'api-ref/sdk-api/selenium/java/#API',
+                    java_playwright: 'api-ref/sdk-api/playwright/java/#API',
+                    java_images: undefined,
+                },
+                dotnet: {
+                    'eyes-selenium': 'api-ref/sdk-api/selenium/csharp/#API',
+                    'eyes-playwright': 'api-ref/sdk-api/playwright/csharp/#API',
+                    'eyes-appium': undefined,
+                    'eyes-appium2': undefined,
+                    'eyes-images': undefined,
+                },
+                js: {
+                    'eyes-images': undefined,
+                    'eyes-webdriverio': 'api-ref/sdk-api/wdio/#API',
+                    'eyes-selenium': 'api-ref/sdk-api/selenium/javascript/#API',
+                    'eyes-playwright': 'api-ref/sdk-api/playwright/javascript/#API',
+                    'eyes-puppeteer': 'api-ref/sdk-api/puppeteer/javascript/#API',
+                    'eyes-storybook': 'api-ref/sdk-api/storybook/#API',
+                    'eyes-cypress': 'api-ref/sdk-api/cypress/#API',
+                },
+            };
+            const { lang, name } = sdk !== null && sdk !== void 0 ? sdk : {};
+            const path = (_a = apiKeyTutorials[lang]) === null || _a === void 0 ? void 0 : _a[name];
+            if (path) {
+                error.message = error.message.replace('Default.html#cshid=api', path);
+            }
+        }
+    }
+    catch {
+        // if it fails, no harm done. The error message is fine without this refinement
+        return error;
+    }
+    return error;
+}
 function getLatestCommitInfoFromEnvVars(logger) {
     const timestamp = utils.general.getEnvValue('GIT_LATEST_COMMIT_TIMESTAMP');
     const sha = utils.general.getEnvValue('GIT_LATEST_COMMIT_SHA');