@applitools/core 1.3.2 → 1.3.4

package/dist/make-manager.js

@@ -31,17 +31,19 @@ const open_eyes_1 = require("./open-eyes");
 const close_manager_1 = require("./close-manager");
 const utils = __importStar(require("@applitools/utils"));
 function makeMakeManager({ spec, core, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), agentId: defaultAgentId, cwd = process.cwd(), logger: defaultLogger, }) {
-    return async function makeManager({ type = 'classic', concurrency = defaultConcurrency, legacyConcurrency, agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId, logger = defaultLogger, } = {}) {
+    return async function makeManager({ type = 'classic', concurrency = defaultConcurrency, legacyConcurrency, batch, agentId = type === 'ufg' ? defaultAgentId === null || defaultAgentId === void 0 ? void 0 : defaultAgentId.replace(/(\/\d)/, '.visualgrid$1') : defaultAgentId, logger = defaultLogger, } = {}) {
+        var _a;
         concurrency !== null && concurrency !== void 0 ? concurrency : (concurrency = utils.types.isInteger(legacyConcurrency) ? legacyConcurrency * 5 : 5);
+        batch !== null && batch !== void 0 ? batch : (batch = {});
+        (_a = batch.id) !== null && _a !== void 0 ? _a : (batch.id = `generated-${utils.general.guid()}`);
         core !== null && core !== void 0 ? core : (core = (0, core_base_1.makeCore)({ agentId, cwd, logger }));
         const cores = {
             ufg: (0, core_2.makeCore)({ spec, core, concurrency, logger }),
             classic: (0, core_1.makeCore)({ spec, core, logger }),
         };
-        const batch = { id: `generated-${utils.general.guid()}` };
         const storage = [];
         // open eyes with result storage
-        const openEyes = utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, spec, core, cores, logger, batch }), async (openEyes, options) => {
+        const openEyes = utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, batch, spec, core, cores, logger }), async (openEyes, options) => {
             const eyes = await openEyes(options);
             const item = { eyes };
             storage.push(item);

package/dist/open-eyes.js

@@ -33,33 +33,30 @@ const locate_text_1 = require("./locate-text");
 const extract_text_1 = require("./extract-text");
 const close_1 = require("./close");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ type: defaultType = 'classic', concurrency, core, cores, spec, logger: defaultLogger, batch, }) {
+const extract_ci_provider_1 = require("./utils/extract-ci-provider");
+function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core, cores, spec, logger: defaultLogger, }) {
     return async function openEyes({ type = defaultType, settings, config, target, logger = defaultLogger, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
-        var _x, _y, _z, _0;
+        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;
         settings = { ...config === null || config === void 0 ? void 0 : config.open, ...settings };
         (_a = settings.userTestId) !== null && _a !== void 0 ? _a : (settings.userTestId = `${settings.testName}--${utils.general.guid()}`);
         (_b = settings.serverUrl) !== null && _b !== void 0 ? _b : (settings.serverUrl = (_c = 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'));
-        settings.batch = {
-            ...settings.batch,
-            properties: [...((_e = batch === null || batch === void 0 ? void 0 : batch.properties) !== null && _e !== void 0 ? _e : []), ...((_g = (_f = settings.batch) === null || _f === void 0 ? void 0 : _f.properties) !== null && _g !== void 0 ? _g : [])],
-            ...batch,
-        };
-        (_h = (_x = settings.batch).id) !== null && _h !== void 0 ? _h : (_x.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
-        (_k = (_y = settings.batch).name) !== null && _k !== void 0 ? _k : (_y.name = utils.general.getEnvValue('BATCH_NAME'));
-        (_l = (_z = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_z.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
-        (_m = (_0 = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_0.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
-        (_o = settings.keepBatchOpen) !== null && _o !== void 0 ? _o : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
-        (_p = settings.branchName) !== null && _p !== void 0 ? _p : (settings.branchName = utils.general.getEnvValue('BRANCH'));
-        (_q = settings.parentBranchName) !== null && _q !== void 0 ? _q : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
-        (_r = settings.baselineBranchName) !== null && _r !== void 0 ? _r : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
-        (_s = settings.ignoreBaseline) !== null && _s !== void 0 ? _s : (settings.ignoreBaseline = false);
-        (_t = settings.compareWithParentBranch) !== null && _t !== void 0 ? _t : (settings.compareWithParentBranch = false);
+        settings.batch = { ...batch, ...settings.batch };
+        (_e = (_v = settings.batch).id) !== null && _e !== void 0 ? _e : (_v.id = (_f = utils.general.getEnvValue('BATCH_ID')) !== null && _f !== void 0 ? _f : `generated-${utils.general.guid()}`);
+        (_g = (_w = settings.batch).name) !== null && _g !== void 0 ? _g : (_w.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_h = (_x = settings.batch).sequenceName) !== null && _h !== void 0 ? _h : (_x.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_j = (_y = settings.batch).notifyOnCompletion) !== null && _j !== void 0 ? _j : (_y.notifyOnCompletion = utils.general.getEnvValue('BATCH_NOTIFY', 'boolean'));
+        (_k = settings.keepBatchOpen) !== null && _k !== void 0 ? _k : (settings.keepBatchOpen = utils.general.getEnvValue('DONT_CLOSE_BATCHES', 'boolean'));
+        (_l = settings.branchName) !== null && _l !== void 0 ? _l : (settings.branchName = utils.general.getEnvValue('BRANCH'));
+        (_m = settings.parentBranchName) !== null && _m !== void 0 ? _m : (settings.parentBranchName = utils.general.getEnvValue('PARENT_BRANCH'));
+        (_o = settings.baselineBranchName) !== null && _o !== void 0 ? _o : (settings.baselineBranchName = utils.general.getEnvValue('BASELINE_BRANCH'));
+        (_p = settings.ignoreBaseline) !== null && _p !== void 0 ? _p : (settings.ignoreBaseline = false);
+        (_q = settings.compareWithParentBranch) !== null && _q !== void 0 ? _q : (settings.compareWithParentBranch = false);
         if (type === 'ufg') {
             const ufgSettings = settings;
             const ufgConfig = config;
-            (_u = ufgSettings.renderConcurrency) !== null && _u !== void 0 ? _u : (ufgSettings.renderConcurrency = (_w = (_v = ufgConfig === null || ufgConfig === void 0 ? void 0 : ufgConfig.check) === null || _v === void 0 ? void 0 : _v.renderers) === null || _w === void 0 ? void 0 : _w.length);
+            (_r = ufgSettings.renderConcurrency) !== null && _r !== void 0 ? _r : (ufgSettings.renderConcurrency = (_t = (_s = ufgConfig === null || ufgConfig === void 0 ? void 0 : ufgConfig.check) === null || _s === void 0 ? void 0 : _s.renderers) === null || _t === void 0 ? void 0 : _t.length);
         }
         core.logEvent({
             settings: {
@@ -73,6 +70,8 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, core, cores,
                     testConcurrency: concurrency,
                     concurrentRendersPerTest: settings.renderConcurrency,
                     node: { version: process.version, platform: process.platform, arch: process.arch },
+                    driverUrl: target && ((_u = spec === null || spec === void 0 ? void 0 : spec.extractHostName) === null || _u === void 0 ? void 0 : _u.call(spec, target)),
+                    extractedCIProvider: (0, extract_ci_provider_1.extractCIProvider)(),
                 },
             },
             logger,

package/dist/utils/extract-ci-provider.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractCIProvider = void 0;
+function extractCIProvider() {
+    if (process.env.TF_BUILD) {
+        return 'Azure';
+    }
+    if (process.env['bamboo.buildKey']) {
+        return 'Bamboo';
+    }
+    if (process.env.BUILDKITE) {
+        return 'Buildkite';
+    }
+    if (process.env.CIRCLECI) {
+        return 'Circle';
+    }
+    if (process.env.CIRRUS_CI) {
+        return 'Cirrus';
+    }
+    if (process.env.CODEBUILD_BUILD_ID) {
+        return 'CodeBuild';
+    }
+    if (process.env.GITHUB_ACTIONS) {
+        return 'GitHub Actions';
+    }
+    if (process.env.GITLAB_CI) {
+        return 'GitLab';
+    }
+    if (process.env.HEROKU_TEST_RUN_ID) {
+        return 'Heroku';
+    }
+    if (process.env.BUILD_ID) {
+        return 'Jenkins';
+    }
+    if (process.env.TEAMCITY_VERSION) {
+        return 'TeamCity';
+    }
+    if (process.env.TRAVIS) {
+        return 'Travis';
+    }
+}
+exports.extractCIProvider = extractCIProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -61,17 +61,17 @@
     }
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.19",
+    "@applitools/core-base": "1.1.22",
     "@applitools/dom-capture": "11.2.0",
     "@applitools/dom-snapshot": "4.7.2",
-    "@applitools/driver": "1.11.14",
-    "@applitools/logger": "1.1.32",
-    "@applitools/nml-client": "1.3.15",
-    "@applitools/req": "1.1.19",
-    "@applitools/screenshoter": "3.7.15",
-    "@applitools/snippets": "2.4.10",
-    "@applitools/ufg-client": "1.1.8",
-    "@applitools/utils": "1.3.18",
+    "@applitools/driver": "1.11.17",
+    "@applitools/logger": "1.1.35",
+    "@applitools/nml-client": "1.3.18",
+    "@applitools/req": "1.1.22",
+    "@applitools/screenshoter": "3.7.17",
+    "@applitools/snippets": "2.4.11",
+    "@applitools/ufg-client": "1.1.10",
+    "@applitools/utils": "1.3.21",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
     "node-fetch": "2.6.7",
@@ -80,11 +80,11 @@
   "devDependencies": {
     "@applitools/bongo": "^2.2.0",
     "@applitools/sdk-fake-eyes-server": "^2.1.3",
-    "@applitools/spec-driver-puppeteer": "^1.1.26",
-    "@applitools/spec-driver-selenium": "^1.5.12",
-    "@applitools/spec-driver-webdriverio": "^1.4.10",
-    "@applitools/test-server": "^1.1.13",
-    "@applitools/test-utils": "^1.5.3",
+    "@applitools/spec-driver-puppeteer": "^1.1.28",
+    "@applitools/spec-driver-selenium": "^1.5.15",
+    "@applitools/spec-driver-webdriverio": "^1.4.13",
+    "@applitools/test-server": "^1.1.15",
+    "@applitools/test-utils": "^1.5.4",
     "@types/mocha": "^9.1.1",
     "@types/node": "12",
     "@types/selenium-webdriver": "^4.1.2",

package/types/make-manager.d.ts

@@ -1,4 +1,4 @@
-import type { EyesManager } from './types';
+import type { Batch, EyesManager } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type SpecDriver } from '@applitools/driver';
@@ -10,11 +10,12 @@ type Options<TDriver, TContext, TElement, TSelector> = {
     cwd?: string;
     logger?: Logger;
 };
-export declare function makeMakeManager<TDriver, TContext, TElement, TSelector>({ spec, core, concurrency: defaultConcurrency, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TType extends "classic" | "ufg" = "classic">({ type, concurrency, legacyConcurrency, agentId, logger, }?: {
+export declare function makeMakeManager<TDriver, TContext, TElement, TSelector>({ spec, core, concurrency: defaultConcurrency, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector>): <TType extends "classic" | "ufg" = "classic">({ type, concurrency, legacyConcurrency, batch, agentId, logger, }?: {
     type?: TType;
     concurrency?: number;
     /** @deprecated */
     legacyConcurrency?: number;
+    batch?: Batch;
     agentId?: string;
     logger?: Logger;
 }) => Promise<EyesManager<TDriver, TContext, TElement, TSelector, TType>>;

package/types/open-eyes.d.ts

@@ -1,19 +1,19 @@
-import type { TypedCore, Eyes, Config, OpenSettings } from './types';
-import type { Core as BaseCore, Batch } from '@applitools/core-base';
+import type { TypedCore, Batch, Eyes, Config, OpenSettings } from './types';
+import type { Core as BaseCore } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type SpecDriver } from '@applitools/driver';
 type Options<TDriver, TContext, TElement, TSelector, TType extends 'classic' | 'ufg'> = {
     type?: TType;
     concurrency?: number;
+    batch?: Batch;
     core: BaseCore;
     cores?: {
         [TKey in 'classic' | 'ufg']: TypedCore<TDriver, TContext, TElement, TSelector, TKey>;
     };
     spec?: SpecDriver<TDriver, TContext, TElement, TSelector>;
     logger?: Logger;
-    batch?: Batch;
 };
-export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, core, cores, spec, logger: defaultLogger, batch, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
+export declare function makeOpenEyes<TDriver, TContext, TElement, TSelector, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, batch, core, cores, spec, logger: defaultLogger, }: Options<TDriver, TContext, TElement, TSelector, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, settings, config, target, logger, }: {
     type?: TType;
     settings?: Partial<OpenSettings<TDefaultType> & OpenSettings<TType>>;
     config?: Config<TElement, TSelector, TDefaultType> & Config<TElement, TSelector, TType>;

package/types/utils/extract-ci-provider.d.ts

@@ -0,0 +1 @@
+export declare function extractCIProvider(): string | null;