@applitools/core 2.5.2 → 2.5.3-legacy

package/dist/utils/extract-current-commit.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractLatestCommitInfo = exports.cacheKey = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const fs_1 = __importDefault(require("fs"));
+const logger_1 = require("@applitools/logger");
+exports.cacheKey = 'extract-current-commit';
+exports.extractLatestCommitInfo = utils.general.cachify(extractCommitInfo, () => exports.cacheKey);
+async function extractGithubPullRequestLastCommitSha() {
+    var _a, _b, _c;
+    if (((_a = process.env.GITHUB_EVENT_NAME) === null || _a === void 0 ? void 0 : _a.startsWith('pull_request')) && process.env.GITHUB_EVENT_PATH) {
+        const event = await fs_1.default.promises.readFile(process.env.GITHUB_EVENT_PATH, 'utf-8').then(JSON.parse);
+        return (_c = (_b = event === null || event === void 0 ? void 0 : event.pull_request) === null || _b === void 0 ? void 0 : _b.head) === null || _c === void 0 ? void 0 : _c.sha;
+    }
+}
+async function extractCommitInfo({ execOptions, logger = (0, logger_1.makeLogger)(), }) {
+    let result;
+    try {
+        const githubPullRequestLastCommitSha = await extractGithubPullRequestLastCommitSha();
+        await executeWithLog(`git fetch origin --depth=2`);
+        result = await executeWithLog(`git log ${githubPullRequestLastCommitSha !== null && githubPullRequestLastCommitSha !== void 0 ? githubPullRequestLastCommitSha : ''} -1 --format="%aI %H"`, {
+            execOptions,
+            logger,
+        });
+        if (result.stderr) {
+            logger.log(`Error during extracting commit information from git`, result.stderr);
+        }
+        else {
+            const [timestamp, sha] = result.stdout.trim().split(' ');
+            return { timestamp, sha };
+        }
+    }
+    catch (err) {
+        logger.log(`Error during parsing commit hash from git`, err, result === null || result === void 0 ? void 0 : result.stdout);
+    }
+}
+async function executeWithLog(command, { execOptions, logger = (0, logger_1.makeLogger)() } = {
+    execOptions: {},
+    logger: (0, logger_1.makeLogger)(),
+}) {
+    logger.log(`executing command: ${command}`);
+    const result = await utils.process.execute(command, execOptions);
+    if (result.stderr && result.code)
+        logger.log(`exit code: ${result.code}, stderr: ${result.stderr}`);
+    return result;
+}

package/dist/utils/extract-git-info.js

@@ -0,0 +1,168 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isISODate = exports.extractBranchingTimestamp = exports.extractBuildIdFromCI = exports.extractGitRepo = exports.extractGitBranch = exports.extractLatestCommitInfo = exports.cacheKey = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("@applitools/logger");
+exports.cacheKey = 'default';
+exports.extractLatestCommitInfo = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)(), }) {
+    let result;
+    try {
+        const githubPullRequestLastCommitSha = await extractGithubPullRequestLastCommitSha();
+        result = await executeWithLog(`git log ${githubPullRequestLastCommitSha !== null && githubPullRequestLastCommitSha !== void 0 ? githubPullRequestLastCommitSha : ''} -1 --format="%aI %H"`, {
+            execOptions,
+            logger,
+        });
+        if (result.stderr) {
+            logger.log(`Error during extracting commit information from git`, result.stderr);
+        }
+        else {
+            const [timestamp, sha] = result.stdout.trim().split(' ');
+            if (isISODate(timestamp)) {
+                return { sha, timestamp };
+            }
+            else {
+                logger.log(`latestCommitInfo.timestamp is an invalid ISO date string: ${timestamp}`);
+            }
+        }
+    }
+    catch (err) {
+        logger.log(`Error during parsing commit hash from git`, err, result === null || result === void 0 ? void 0 : result.stdout);
+    }
+    async function extractGithubPullRequestLastCommitSha() {
+        var _a, _b, _c;
+        if (((_a = process.env.GITHUB_EVENT_NAME) === null || _a === void 0 ? void 0 : _a.startsWith('pull_request')) && process.env.GITHUB_EVENT_PATH) {
+            await executeWithLog(`git fetch origin --depth=2`, { execOptions, logger });
+            const event = await fs_1.default.promises.readFile(process.env.GITHUB_EVENT_PATH, 'utf-8').then(JSON.parse);
+            return (_c = (_b = event === null || event === void 0 ? void 0 : event.pull_request) === null || _b === void 0 ? void 0 : _b.head) === null || _c === void 0 ? void 0 : _c.sha;
+        }
+    }
+}, () => exports.cacheKey);
+exports.extractGitBranch = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    if (process.env.GITHUB_HEAD_REF) {
+        return process.env.GITHUB_HEAD_REF;
+    }
+    if (process.env.GITHUB_REF) {
+        return process.env.GITHUB_REF.split('/')[2]; // refs/heads/<branch_name>
+    }
+    const result = await executeWithLog('git branch --show-current', { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting current branch from git`, result.stderr);
+    }
+    else {
+        const branch = result.stdout.trim();
+        logger.log(`Extracted current git branch: "${branch}"`);
+        return branch;
+    }
+}, () => exports.cacheKey);
+exports.extractGitRepo = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    const remotes = await extractRemotes();
+    logger.log(`Extracted remotes from git: ${remotes}`);
+    const remote = remotes.includes('origin') ? 'origin' : remotes[0];
+    const result = await executeWithLog(`git remote get-url ${remote}`, { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting remote url from git`, result.stderr);
+        return {};
+    }
+    else {
+        const remoteUrl = result.stdout.trim();
+        logger.log(`Extracted url for git remote ${remote}: ${remoteUrl}`);
+        return extractRepoFromRemoteUrl(remoteUrl);
+    }
+    async function extractRemotes() {
+        const result = await executeWithLog('git remote show', { execOptions, logger });
+        if (result.stderr) {
+            logger.log(`Error during extracting remotes from git`, result.stderr);
+            return [];
+        }
+        else {
+            return result.stdout.trim().split(/\s+/);
+        }
+    }
+    function extractRepoFromRemoteUrl(remoteUrl) {
+        try {
+            const url = new URL(remoteUrl);
+            return { name: path_1.default.basename(url.pathname, '.git'), owner: path_1.default.dirname(url.pathname).replace(/^\//, '') };
+        }
+        catch (err) {
+            return { name: path_1.default.basename(remoteUrl, '.git'), owner: path_1.default.dirname(remoteUrl).replace(/^[^:]+:/, '') };
+        }
+    }
+}, () => exports.cacheKey);
+async function extractBuildIdFromCI() {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    return ((_k = (_j = (_h = (_g = (_f = (_e = (_d = (_c = (_b = (_a = process.env.GITHUB_RUN_ID) !== null && _a !== void 0 ? _a : process.env.CI_JOB_ID) !== null && _b !== void 0 ? _b : process.env.CIRCLE_BUILD_NUM) !== null && _c !== void 0 ? _c : process.env.BUILD_BUILDID) !== null && _d !== void 0 ? _d : process.env.BITBUCKET_BUILD_NUMBER) !== null && _e !== void 0 ? _e : process.env.CODEBUILD_BUILD_ID) !== null && _f !== void 0 ? _f : process.env.BUILD_ID) !== null && _g !== void 0 ? _g : process.env.BUILD_NUMBER) !== null && _h !== void 0 ? _h : process.env.TRAVIS_BUILD_ID) !== null && _j !== void 0 ? _j : process.env.BUILDKITE_BUILD_ID) !== null && _k !== void 0 ? _k : process.env.BAMBOO // TODO: Bamboo
+    );
+}
+exports.extractBuildIdFromCI = extractBuildIdFromCI;
+exports.extractBranchingTimestamp = utils.general.cachify(async function ({ branchName, parentBranchName, execOptions, logger = (0, logger_1.makeLogger)(), }) {
+    var _a;
+    logger = logger.extend({ tags: [`extract-branching-timestamp-${utils.general.shortid()}`] });
+    const command = `HASH=$(git merge-base ${branchName} ${parentBranchName}) && git show -q --format=%aI $HASH`;
+    let result = await executeWithLog(command, { execOptions, logger });
+    // both parent and current branches could be missing, that's why we have to iterate the missing branches check check twice
+    for (let i = 0; i < 2; i++) {
+        if (result.stderr) {
+            const [, missingBranch] = (_a = result.stderr.match(/Not a valid object name ([^\s]+)/)) !== null && _a !== void 0 ? _a : [];
+            if (missingBranch) {
+                result = await executeWithLog(`git fetch origin ${missingBranch}:${missingBranch} && ${command}`, {
+                    execOptions,
+                    logger,
+                });
+            }
+        }
+    }
+    if (!result.stdout) {
+        result = await executeWithLog(`git fetch origin --unshallow && ${command}`, { execOptions, logger });
+    }
+    const timestamp = result.stdout.replace(/\s/g, '');
+    if (isISODate(timestamp)) {
+        logger.log('git branching timestamp successfully extracted', timestamp);
+        return timestamp;
+    }
+    else {
+        logger.log(`Error during extracting merge timestamp: git branching timestamp is an invalid ISO date string: ${timestamp}. stderr: ${result.stderr}, stdout: ${result.stdout}`);
+    }
+}, () => exports.cacheKey);
+async function executeWithLog(command, { execOptions, logger = (0, logger_1.makeLogger)() } = {
+    execOptions: {},
+    logger: (0, logger_1.makeLogger)(),
+}) {
+    logger.log(`executing command: ${command}`);
+    const result = await utils.process.execute(command, execOptions);
+    if (result.stderr && result.code) {
+        logger.log(`exit code: ${result.code}, stderr: ${result.stderr}`);
+    }
+    return result;
+}
+function isISODate(str) {
+    return /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\+\d{2}:\d{2})?/.test(str);
+}
+exports.isISODate = isISODate;

package/dist/utils/extract-start-info.js

@@ -0,0 +1,100 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractBuildIdFromCI = exports.extractGitRepo = exports.extractGitBranch = exports.cacheKey = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("@applitools/logger");
+exports.cacheKey = 'default';
+exports.extractGitBranch = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    if (process.env.GITHUB_HEAD_REF) {
+        return process.env.GITHUB_HEAD_REF;
+    }
+    if (process.env.GITHUB_REF) {
+        return process.env.GITHUB_REF.split('/')[2]; // refs/heads/<branch_name>
+    }
+    const result = await executeWithLog('git branch --show-current', { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting current branch from git`, result.stderr);
+    }
+    else {
+        const branch = result.stdout.trim();
+        logger.log(`Extracted current git branch: "${branch}"`);
+        return branch;
+    }
+}, () => exports.cacheKey);
+exports.extractGitRepo = utils.general.cachify(async function ({ execOptions, logger = (0, logger_1.makeLogger)() }) {
+    const remotes = await extractRemotes();
+    logger.log(`Extracted remotes from git: ${remotes}`);
+    const remote = remotes.includes('origin') ? 'origin' : remotes[0];
+    const result = await executeWithLog(`git remote get-url ${remote}`, { execOptions, logger });
+    if (result.stderr) {
+        logger.log(`Error during extracting remote url from git`, result.stderr);
+        return {};
+    }
+    else {
+        const remoteUrl = result.stdout.trim();
+        logger.log(`Extracted url for git remote ${remote}: ${remoteUrl}`);
+        return extractRepoFromRemoteUrl(remoteUrl);
+    }
+    async function extractRemotes() {
+        const result = await executeWithLog('git remote show', { execOptions, logger });
+        if (result.stderr) {
+            logger.log(`Error during extracting remotes from git`, result.stderr);
+            return [];
+        }
+        else {
+            return result.stdout.trim().split(/\s+/);
+        }
+    }
+    function extractRepoFromRemoteUrl(remoteUrl) {
+        try {
+            const url = new URL(remoteUrl);
+            return { name: path_1.default.basename(url.pathname, '.git'), owner: path_1.default.dirname(url.pathname).replace(/^\//, '') };
+        }
+        catch (err) {
+            return { name: path_1.default.basename(remoteUrl, '.git'), owner: path_1.default.dirname(remoteUrl).replace(/^[^:]+:/, '') };
+        }
+    }
+}, () => exports.cacheKey);
+async function extractBuildIdFromCI() {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    return ((_k = (_j = (_h = (_g = (_f = (_e = (_d = (_c = (_b = (_a = process.env.GITHUB_RUN_ID) !== null && _a !== void 0 ? _a : process.env.CI_JOB_ID) !== null && _b !== void 0 ? _b : process.env.CIRCLE_BUILD_NUM) !== null && _c !== void 0 ? _c : process.env.BUILD_BUILDID) !== null && _d !== void 0 ? _d : process.env.BITBUCKET_BUILD_NUMBER) !== null && _e !== void 0 ? _e : process.env.CODEBUILD_BUILD_ID) !== null && _f !== void 0 ? _f : process.env.BUILD_ID) !== null && _g !== void 0 ? _g : process.env.BUILD_NUMBER) !== null && _h !== void 0 ? _h : process.env.TRAVIS_BUILD_ID) !== null && _j !== void 0 ? _j : process.env.BUILDKITE_BUILD_ID) !== null && _k !== void 0 ? _k : process.env.BAMBOO // TODO: Bamboo
+    );
+}
+exports.extractBuildIdFromCI = extractBuildIdFromCI;
+async function executeWithLog(command, { execOptions, logger = (0, logger_1.makeLogger)() } = {
+    execOptions: {},
+    logger: (0, logger_1.makeLogger)(),
+}) {
+    logger.log(`executing command: ${command}`);
+    const result = await utils.process.execute(command, execOptions);
+    if (result.stderr && result.code)
+        logger.log(`exit code: ${result.code}, stderr: ${result.stderr}`);
+    return result;
+}

package/dist/utils/extract-test-environment.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractCIProvider = exports.extractTestEnvironment = void 0;
+const os = __importStar(require("os"));
+function extractTestEnvironment(baseEnvironment) {
+    return {
+        ...baseEnvironment,
+        versions: {
+            ...baseEnvironment === null || baseEnvironment === void 0 ? void 0 : baseEnvironment.versions,
+            core: require('../../package.json').version,
+            node: process.version,
+        },
+        platform: `${os.type()}@${os.release()}`,
+        arch: os.arch(),
+        ram: os.totalmem(),
+        ci: extractCIProvider(),
+    };
+}
+exports.extractTestEnvironment = extractTestEnvironment;
+function extractCIProvider() {
+    if (process.env.TF_BUILD)
+        return 'Azure';
+    else if (process.env['bamboo.buildKey'])
+        return 'Bamboo';
+    else if (process.env.BUILDKITE)
+        return 'Buildkite';
+    else if (process.env.CIRCLECI)
+        return 'Circle';
+    else if (process.env.CIRRUS_CI)
+        return 'Cirrus';
+    else if (process.env.CODEBUILD_BUILD_ID)
+        return 'CodeBuild';
+    else if (process.env.GITHUB_ACTIONS)
+        return 'GitHub Actions';
+    else if (process.env.GITLAB_CI)
+        return 'GitLab';
+    else if (process.env.HEROKU_TEST_RUN_ID)
+        return 'Heroku';
+    else if (process.env.BUILD_ID)
+        return 'Jenkins';
+    else if (process.env.TEAMCITY_VERSION)
+        return 'TeamCity';
+    else if (process.env.TRAVIS)
+        return 'Travis';
+    return null;
+}
+exports.extractCIProvider = extractCIProvider;

package/dist/utils/memory-usage-logging.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startMemoryUsageLogging = void 0;
+const utils = __importStar(require("@applitools/utils"));
+function startMemoryUsageLogging({ timeout = 30000, logger }) {
+    var _a;
+    logger = logger.extend({ tags: [`mem-usage-${utils.general.shortid()}`] });
+    const interval = setInterval(() => logger.log(formatMemoryUsage(process.memoryUsage())), (_a = utils.general.getEnvValue('MEMORY_LOG_TIMEOUT', 'number')) !== null && _a !== void 0 ? _a : timeout);
+    interval.unref();
+    return { stop };
+    function stop() {
+        clearInterval(interval);
+    }
+}
+exports.startMemoryUsageLogging = startMemoryUsageLogging;
+function formatMemoryUsage(usage) {
+    return `Memory usage: ${Object.entries(usage)
+        .map(([key, value]) => `${key}: ${toMB(value)}MB`)
+        .join(', ')}`;
+}
+function toMB(size) {
+    return Math.round((size / 1024 / 1024) * 100) / 100;
+}

package/dist/utils/populate-eyes-server-settings.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.populateEyesServerSettings = void 0;
+const utils = __importStar(require("@applitools/utils"));
+function populateEyesServerSettings(settings) {
+    var _a, _b, _c, _d, _e, _f;
+    (_a = settings.eyesServerUrl) !== null && _a !== void 0 ? _a : (settings.eyesServerUrl = (_c = (_b = utils.general.getEnvValue('EYES_SERVER_URL')) !== null && _b !== void 0 ? _b : utils.general.getEnvValue('SERVER_URL')) !== null && _c !== void 0 ? _c : 'https://eyesapi.applitools.com');
+    (_d = settings.apiKey) !== null && _d !== void 0 ? _d : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
+    (_e = settings.proxy) !== null && _e !== void 0 ? _e : (settings.proxy = utils.general.getEnvValue('PROXY_URL') ? { url: utils.general.getEnvValue('PROXY_URL') } : undefined);
+    (_f = settings.useDnsCache) !== null && _f !== void 0 ? _f : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
+    return {
+        eyesServerUrl: settings.eyesServerUrl,
+        apiKey: settings.apiKey,
+        proxy: settings.proxy,
+        useDnsCache: settings.useDnsCache,
+    };
+}
+exports.populateEyesServerSettings = populateEyesServerSettings;

package/dist/utils/validate-sdk-version.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractLatestRubyPackageVersion = exports.extractLatestPythonPackageVersion = exports.extractLatestDotNetPackageVersion = exports.extractLatestJavaPackageVersion = exports.extractLatestJsPackageVersion = exports.validateSdkVersion = void 0;
+const req_1 = require("@applitools/req");
+const lt_1 = __importDefault(require("semver/functions/lt"));
+const chalk_1 = __importDefault(require("chalk"));
+const utils = __importStar(require("@applitools/utils"));
+const lang = __importStar(require("../lang"));
+const extractors = {
+    js: utils.general.cachify(extractLatestJsPackageVersion),
+    java: utils.general.cachify(extractLatestJavaPackageVersion),
+    dotnet: utils.general.cachify(extractLatestDotNetPackageVersion),
+    python: utils.general.cachify(extractLatestPythonPackageVersion),
+    ruby: utils.general.cachify(extractLatestRubyPackageVersion),
+};
+async function validateSdkVersion(sdk, { logger }) {
+    try {
+        if (!sdk.latestVersion) {
+            logger.log(`Extracting latest version of ${sdk.lang}/${sdk.name}`);
+            sdk.latestVersion = await extractors[sdk.lang](sdk.name);
+        }
+        logger.log(`Latest version of ${sdk.lang}/${sdk.name} is ${sdk.latestVersion}`);
+        if ((0, lt_1.default)(sdk.currentVersion, sdk.latestVersion)) {
+            const message = lang.outdatedSdkVersionWarning(sdk);
+            logger.console.warn(chalk_1.default.yellow(message));
+            logger.warn(message);
+        }
+    }
+    catch (error) {
+        logger.error(`Failed to extract latest version of ${sdk.lang}/${sdk.name} due to the error: `, error);
+    }
+}
+exports.validateSdkVersion = validateSdkVersion;
+async function extractLatestJsPackageVersion(name) {
+    const response = await (0, req_1.req)(`https://registry.npmjs.org/${name}/latest`);
+    const info = await response.json();
+    return info.version;
+}
+exports.extractLatestJsPackageVersion = extractLatestJsPackageVersion;
+async function extractLatestJavaPackageVersion(name) {
+    const response = await (0, req_1.req)(`https://search.maven.org/solrsearch/select?q=a:${name}&wt=json`);
+    const info = await response.json();
+    return info.response.docs[0].latestVersion;
+}
+exports.extractLatestJavaPackageVersion = extractLatestJavaPackageVersion;
+async function extractLatestDotNetPackageVersion(name) {
+    const response = await (0, req_1.req)(`https://api.nuget.org/v3-flatcontainer/${name.toLowerCase()}/index.json`);
+    const info = await response.json();
+    return info.versions[info.versions.length - 1];
+}
+exports.extractLatestDotNetPackageVersion = extractLatestDotNetPackageVersion;
+async function extractLatestPythonPackageVersion(name) {
+    const response = await (0, req_1.req)(`https://pypi.org/pypi/${name}/json`);
+    const info = await response.json();
+    return info.info.version;
+}
+exports.extractLatestPythonPackageVersion = extractLatestPythonPackageVersion;
+async function extractLatestRubyPackageVersion(name) {
+    const response = await (0, req_1.req)(`https://rubygems.org/api/v1/gems/${name}.json`);
+    const info = await response.json();
+    return info.version;
+}
+exports.extractLatestRubyPackageVersion = extractLatestRubyPackageVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "2.5.2",
+  "version": "2.5.3-legacy",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -87,14 +87,14 @@
     "@applitools/snippets": "2.4.19",
     "@applitools/socket": "1.0.10",
     "@applitools/spec-driver-webdriver": "1.0.24",
-    "@applitools/ufg-client": "1.2.9",
+    "@applitools/ufg-client": "1.2.10",
     "@applitools/utils": "1.3.32",
     "@types/ws": "8.5.4",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
     "node-fetch": "2.6.7",
     "webdriver": "7.30.0",
-    "ws": "8.12.0",
+    "ws": "8.17.1",
     "yargs": "17.6.2"
   },
   "devDependencies": {

package/types/abort.d.ts

@@ -0,0 +1,13 @@
+import type { Eyes, AbortSettings, Environment } from './types';
+import { type SpecType } from '@applitools/driver';
+import { type Logger } from '@applitools/logger';
+type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
+    eyes: Eyes<TSpec, TType>;
+    environments?: Environment[];
+    logger: Logger;
+};
+export declare function makeAbort<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
+    settings?: AbortSettings<TType> | undefined;
+    logger?: Logger | undefined;
+}) => Promise<void>;
+export {};

package/types/automation/abort.d.ts

@@ -0,0 +1,16 @@
+import type { Eyes, AbortSettings, Environment } from './types';
+import { type Logger } from '@applitools/logger';
+import { type AbortController } from 'abort-controller';
+import { type Driver, type SpecType } from '@applitools/driver';
+type Options<TSpec extends SpecType> = {
+    eyes: Eyes<TSpec>;
+    driver?: Driver<TSpec>;
+    controller: AbortController;
+    environments?: Environment[];
+    logger: Logger;
+};
+export declare function makeAbort<TSpec extends SpecType>({ eyes, driver, controller, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
+    settings?: AbortSettings | undefined;
+    logger?: Logger | undefined;
+}) => Promise<void>;
+export {};

package/types/automation/close.d.ts

@@ -0,0 +1,14 @@
+import type { Eyes, CloseSettings, Environment } from '../ufg/types';
+import { type Logger } from '@applitools/logger';
+import { type Driver, type SpecType } from '@applitools/driver';
+type Options<TSpec extends SpecType> = {
+    eyes: Eyes<TSpec>;
+    driver?: Driver<TSpec>;
+    environments?: Environment[];
+    logger: Logger;
+};
+export declare function makeClose<TSpec extends SpecType>({ eyes, driver, environments: defaultEnvironments, logger: mainLogger, }: Options<TSpec>): ({ settings, logger, }?: {
+    settings?: CloseSettings | undefined;
+    logger?: Logger | undefined;
+}) => Promise<void>;
+export {};