@applitools/core 3.7.0 → 3.8.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [3.8.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.8.0...js/core@3.8.1) (2023-08-08)
+
+
+### Bug Fixes
+
+* some fix ([5dc537a](https://github.com/applitools/eyes.sdk.javascript1/commit/5dc537aa5d40933c21f21b8f138f7ff944c064a8))
+
+## [3.8.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.7.0...js/core@3.8.0) (2023-08-08)
+
+
+### Features
+
+* rework log event on opent eyes ([#1842](https://github.com/applitools/eyes.sdk.javascript1/issues/1842)) ([532756b](https://github.com/applitools/eyes.sdk.javascript1/commit/532756b75c1023967c3781316148c890dbcfaac8))
+
 ## [3.7.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/core@3.6.6...js/core@3.7.0) (2023-08-08)
 
 

package/dist/core.js

@@ -38,10 +38,12 @@ const open_eyes_1 = require("./open-eyes");
 const make_manager_1 = require("./make-manager");
 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, concurrency, base: defaultBase, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, } = {}) {
+function makeCore({ spec, concurrency, base: defaultBase, environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), logger: defaultLogger, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' } });
-    logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core`);
+    const environment = (0, extract_environment_1.extractEnvironment)(defaultEnvironment);
+    logger.log(`Core is initialized ${defaultBase ? 'with' : 'without'} custom base core and environment`, environment);
     const base = defaultBase !== null && defaultBase !== void 0 ? defaultBase : (0, core_base_1.makeCore)({ agentId, cwd, logger });
     return utils.general.extend(base, core => {
         return {
@@ -51,11 +53,11 @@ function makeCore({ spec, concurrency, base: defaultBase, agentId = 'core', cwd
             getNMLClient: (0, get_nml_client_1.makeGetNMLClient)({ 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, concurrency, core, base: defaultBase, agentId, logger }),
+            makeManager: (0, make_manager_1.makeMakeManager)({ spec, concurrency, core, base: defaultBase, agentId, environment, 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, core, concurrency, logger }),
+            openEyes: (0, open_eyes_1.makeOpenEyes)({ spec, core, concurrency, environment, 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, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), core, base, agentId: defaultAgentId, cwd = process.cwd(), logger: mainLogger, }) {
+function makeMakeManager({ spec, concurrency: defaultConcurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), core, base, agentId: defaultAgentId, environment, cwd = process.cwd(), logger: mainLogger, }) {
     return async function makeManager({ type = 'classic', settings, logger = mainLogger, } = {}) {
         var _a, _b, _c, _d, _e;
         var _f;
@@ -48,7 +48,7 @@ function makeMakeManager({ spec, concurrency: defaultConcurrency = utils.general
         };
         const storage = [];
         return {
-            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, batch: settings.batch, spec, core, cores, logger }), async (openEyes, options) => {
+            openEyes: utils.general.wrap((0, open_eyes_1.makeOpenEyes)({ type, batch: settings.batch, spec, core, cores, environment, logger }), async (openEyes, options) => {
                 const eyes = await openEyes(options);
                 storage.push(eyes);
                 return eyes;

package/dist/open-eyes.js

@@ -32,12 +32,11 @@ const check_1 = require("./check");
 const check_and_close_1 = require("./check-and-close");
 const close_1 = require("./close");
 const get_eyes_results_1 = require("./get-eyes-results");
-const extract_ci_provider_1 = require("./utils/extract-ci-provider");
 const utils = __importStar(require("@applitools/utils"));
-function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core, cores, spec, logger: mainLogger, }) {
+function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core, cores, spec, environment, logger: mainLogger, }) {
     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, _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;
+        var _u, _v, _w, _x;
         logger = logger.extend(mainLogger, { tags: [`eyes-${type}-${utils.general.shortid()}`] });
         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()}`);
@@ -45,10 +44,10 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
         (_f = settings.apiKey) !== null && _f !== void 0 ? _f : (settings.apiKey = utils.general.getEnvValue('API_KEY'));
         (_g = settings.useDnsCache) !== null && _g !== void 0 ? _g : (settings.useDnsCache = utils.general.getEnvValue('USE_DNS_CACHE', 'boolean'));
         settings.batch = { ...batch, ...settings.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'));
+        (_h = (_u = settings.batch).id) !== null && _h !== void 0 ? _h : (_u.id = (_j = utils.general.getEnvValue('BATCH_ID')) !== null && _j !== void 0 ? _j : `generated-${utils.general.guid()}`);
+        (_k = (_v = settings.batch).name) !== null && _k !== void 0 ? _k : (_v.name = utils.general.getEnvValue('BATCH_NAME'));
+        (_l = (_w = settings.batch).sequenceName) !== null && _l !== void 0 ? _l : (_w.sequenceName = utils.general.getEnvValue('BATCH_SEQUENCE'));
+        (_m = (_x = settings.batch).notifyOnCompletion) !== null && _m !== void 0 ? _m : (_x.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'));
@@ -58,19 +57,13 @@ function makeOpenEyes({ type: defaultType = 'classic', concurrency, batch, core,
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }));
         core.logEvent({
             settings: {
-                eyesServerUrl: settings.eyesServerUrl,
-                apiKey: settings.apiKey,
-                proxy: settings.proxy,
-                agentId: settings.agentId,
-                useDnsCache: settings.useDnsCache,
+                ...settings,
                 level: 'Notice',
                 event: {
-                    type: 'runnerStarted',
-                    testConcurrency: concurrency,
-                    concurrentRendersPerTest: (_w = (_v = (_u = config === null || config === void 0 ? void 0 : config.check) === null || _u === void 0 ? void 0 : _u.renderers) === null || _v === void 0 ? void 0 : _v.length) !== null && _w !== void 0 ? _w : 1,
-                    node: { version: process.version, platform: process.platform, arch: process.arch },
+                    type: 'openEyes',
+                    environment,
+                    concurrency,
                     driverUrl: await (driver === null || driver === void 0 ? void 0 : driver.getDriverUrl()),
-                    extractedCIProvider: (0, extract_ci_provider_1.extractCIProvider)(),
                 },
             },
             logger,

package/dist/universal/core-server.js

@@ -14,7 +14,7 @@ const refer_1 = require("./refer");
 const history_1 = require("./history");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-async function makeCoreServer({ debug = false, shutdownMode = 'lazy', idleTimeout = 900000, // 15min
+async function makeCoreServer({ environment: defaultEnvironment, debug = false, shutdownMode = 'lazy', idleTimeout = 900000, // 15min
 printStdout = false, isProcess = false, ...handlerOptions } = {}) {
     var _a, _b;
     const logDirname = (_a = process.env.APPLITOOLS_LOG_DIR) !== null && _a !== void 0 ? _a : path_1.default.resolve(os_1.default.tmpdir(), `applitools-logs`);
@@ -28,6 +28,7 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
         shutdownMode,
         idleTimeout,
         printStdout,
+        defaultEnvironment,
         ...handlerOptions,
     });
     const { server, port } = await (0, ws_server_1.makeServer)({ ...handlerOptions, debug });
@@ -84,11 +85,17 @@ printStdout = false, isProcess = false, ...handlerOptions } = {}) {
             },
         });
         logger.console.log(`Logs saved in: ${logDirname}`);
-        const corePromise = socket.wait('Core.makeCore', ({ agentId, cwd, spec }) => {
+        const corePromise = socket.wait('Core.makeCore', ({ spec, agentId, environment, cwd }) => {
             return (0, core_1.makeCore)({
-                agentId: `eyes-universal/${require('../../package.json').version}/${agentId}`,
                 spec: spec === 'webdriver' ? spec_driver_webdriver_1.default : (0, spec_driver_1.makeSpec)({ socket, spec }),
+                agentId: `eyes-universal/${require('../../package.json').version}/${agentId}`,
                 cwd,
+                environment: {
+                    ...defaultEnvironment,
+                    ...environment,
+                    versions: { ...defaultEnvironment === null || defaultEnvironment === void 0 ? void 0 : defaultEnvironment.versions, ...environment === null || environment === void 0 ? void 0 : environment.versions },
+                    universal: true,
+                },
                 logger,
             });
         });

package/dist/universal/core.js

@@ -138,15 +138,16 @@ function makeEyes({ socket, core, eyesRef, }) {
     return eyes;
 }
 exports.makeEyes = makeEyes;
-async function makeClientSocket({ agentId, spec, }) {
+async function makeClientSocket({ agentId, environment, spec, }) {
     const { port } = await (0, core_server_1.makeCoreServer)();
     const socket = (0, socket_1.makeSocket)(new ws_1.WebSocket(`ws://localhost:${port}/eyes`), {
         transport: 'ws',
     });
     socket.emit('Core.makeCore', {
+        spec: utils.types.isString(spec) ? spec : Object.keys(spec),
         agentId,
+        environment,
         cwd: process.cwd(),
-        spec: utils.types.isString(spec) ? spec : Object.keys(spec),
     });
     if (!utils.types.isString(spec)) {
         Object.entries(spec).forEach(([name, command]) => {

package/dist/utils/extract-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.extractEnvironment = void 0;
+const os = __importStar(require("os"));
+function extractEnvironment(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.extractEnvironment = extractEnvironment;
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "3.7.0",
+  "version": "3.8.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"

package/types/core.d.ts

@@ -7,8 +7,9 @@ type Options<TSpec extends SpecType> = {
     concurrency?: number;
     base?: BaseCore;
     agentId?: string;
+    environment?: Record<string, any>;
     cwd?: string;
     logger?: Logger;
 };
-export declare function makeCore<TSpec extends SpecType>({ spec, concurrency, base: defaultBase, agentId, cwd, logger: defaultLogger, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
+export declare function makeCore<TSpec extends SpecType>({ spec, concurrency, base: defaultBase, environment: defaultEnvironment, agentId, cwd, logger: defaultLogger, }?: Options<TSpec>): Core<TSpec, 'classic' | 'ufg'>;
 export {};

package/types/make-manager.d.ts

@@ -8,10 +8,11 @@ type Options<TSpec extends SpecType> = {
     core: Core<TSpec>;
     base?: BaseCore;
     agentId?: string;
+    environment?: Record<string, any>;
     cwd?: string;
     logger: Logger;
 };
-export declare function makeMakeManager<TSpec extends SpecType>({ spec, concurrency: defaultConcurrency, core, base, agentId: defaultAgentId, cwd, logger: mainLogger, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
+export declare function makeMakeManager<TSpec extends SpecType>({ spec, concurrency: defaultConcurrency, core, base, agentId: defaultAgentId, environment, cwd, logger: mainLogger, }: 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

@@ -10,9 +10,10 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
         [TKey in 'classic' | 'ufg']: TypedCore<TSpec, TKey>;
     };
     spec?: SpecDriver<TSpec>;
+    environment?: Record<string, any>;
     logger: Logger;
 };
-export declare function makeOpenEyes<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg' = 'classic'>({ type: defaultType, concurrency, batch, core, cores, spec, 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, concurrency, batch, core, cores, spec, environment, logger: mainLogger, }: 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/universal/core-server.d.ts

@@ -1,12 +1,13 @@
 import { type ServerOptions } from './ws-server';
 export type Options = ServerOptions & {
+    environment?: Record<string, any>;
     debug?: boolean;
     shutdownMode?: 'lazy' | 'stdin';
     idleTimeout?: number;
     printStdout?: boolean;
     isProcess?: boolean;
 };
-export declare function makeCoreServer({ debug, shutdownMode, idleTimeout, // 15min
+export declare function makeCoreServer({ environment: defaultEnvironment, debug, shutdownMode, idleTimeout, // 15min
 printStdout, isProcess, ...handlerOptions }?: Options): Promise<{
     port: number;
     close?: () => void;

package/types/universal/core.d.ts

@@ -4,8 +4,9 @@ import type { SpecType, SpecDriver } from '@applitools/driver';
 import { type Socket } from '@applitools/socket';
 import { WebSocket } from 'ws';
 export declare function makeCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'>(options: {
-    agentId: string;
     spec: 'webdriver' | SpecDriver<TSpec>;
+    environment?: Record<string, any>;
+    agentId: string;
 }): Core<TSpec, TType>;
 export declare function makeManager<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ socket, core, managerRef, }: {
     socket: ClientSocket<TSpec, TType>;
@@ -17,7 +18,8 @@ export declare function makeEyes<TSpec extends SpecType, TType extends 'classic'
     core: Core<TSpec, TType>;
     eyesRef: Ref<Eyes<TSpec, TType>>;
 }): Eyes<TSpec, TType>;
-export declare function makeClientSocket<TSpec extends SpecType>({ agentId, spec, }: {
+export declare function makeClientSocket<TSpec extends SpecType>({ agentId, environment, spec, }: {
     agentId: string;
+    environment?: Record<string, any>;
     spec: 'webdriver' | SpecDriver<TSpec>;
 }): Promise<ClientSocket<TSpec, 'classic' | 'ufg'> & Socket<WebSocket>>;

package/types/universal/types.d.ts

@@ -27,9 +27,10 @@ export type ClientSocket<TSpec extends SpecType, TType extends 'classic' | 'ufg'
 export type ServerSocket<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = unknown & Listener<Universalize<UniversalCore<TSpec, TType>, 'Core'>> & Emitter<Universalize<UniversalLogger, 'Logger'>> & Server<Universalize<MainCore.Core<TSpec, TType>, 'Core'>> & Server<Universalize<MainCore.EyesManager<TSpec, TType>, 'EyesManager', 'manager'>> & Server<Universalize<MainCore.Eyes<TSpec, TType>, 'Eyes', 'eyes'>> & Server<Universalize<UniversalDebug<TSpec>, 'Debug'>> & Client<Universalize<UniversalSpecDriver<TSpec>, 'Driver'>>;
 export interface UniversalCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'> {
     makeCore(options: {
+        spec: 'webdriver' | (keyof UniversalSpecDriver<TSpec>)[];
         agentId: string;
+        environment?: Record<string, any>;
         cwd: string;
-        spec: 'webdriver' | (keyof UniversalSpecDriver<TSpec>)[];
     }): Promise<MainCore.Core<TSpec, TType>>;
 }
 export interface UniversalLogger {

package/types/utils/extract-environment.d.ts

@@ -0,0 +1,2 @@
+export declare function extractEnvironment(baseEnvironment?: Record<string, any>): Record<string, any>;
+export declare function extractCIProvider(): string | null;

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

@@ -1,31 +0,0 @@
-"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';
-    return null;
-}
-exports.extractCIProvider = extractCIProvider;

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

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