@applitools/core 4.56.2 → 4.57.0

package/dist/cli/cli.js

@@ -1,160 +0,0 @@
-#!/usr/bin/env node
-"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 });
-/* eslint no-console: off */
-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 yargs_1 = __importDefault(require("yargs"));
-const utils = __importStar(require("@applitools/utils"));
-const fs_1 = __importDefault(require("fs"));
-void yargs_1.default
-    .example([
-    ['eyes universal', 'Run Eyes Universal server on default port (21077)'],
-    ['eyes universal --fork', 'Run Eyes Universal server in a forked process'],
-    ['eyes universal --port 8080', 'Run Eyes Universal server on port 8080'],
-    ['eyes universal --no-singleton', 'Run Eyes Universal server on a non-singleton mode'],
-    ['eyes universal --shutdown-mode stdin', 'Run Eyes Universal server which will close once stdin stream will end'],
-    ['eyes check-network', ''],
-])
-    .version(JSON.parse(fs_1.default.readFileSync(require.resolve('../../package.json'), 'utf-8')).version)
-    .command({
-    command: 'universal',
-    builder: yargs => yargs.options({
-        port: {
-            description: 'run server on a specific port.',
-            type: 'number',
-            default: 21077,
-        },
-        singleton: {
-            description: 'runs server on a singleton mode. It will prevent the server to start in case the same server is already started.',
-            type: 'boolean',
-            default: true,
-        },
-        fork: {
-            description: 'runs server in a forked process.',
-            type: 'boolean',
-            default: false,
-        },
-        debug: {
-            description: 'runs server in a debug mode.',
-            type: 'boolean',
-            default: false,
-        },
-        'port-resolution-mode': {
-            describe: 'preferred algorithm to solve port collisions.\n"lazy" mode will not try find free port.\n"random" mode will run on a random port.\n"next" mode will run on next free port after the given one.',
-            alias: 'port-resolution',
-            type: 'string',
-            default: 'next',
-        },
-        'shutdown-mode': {
-            describe: 'preferred algorithm to automatically kill the process.\n"lazy" mode will end the process once the idle timeout ran out after the last client is disconnected from the server.\n"stdin" mode will end the process once its stdin stream got to its end.',
-            alias: 'shutdown',
-            type: 'string',
-            default: 'lazy',
-        },
-        'idle-timeout': {
-            description: 'time in minutes for server to stay responsible in case of idle.',
-            type: 'number',
-            default: 15,
-            coerce: value => value * 60 * 1000,
-        },
-        cert: {
-            description: 'path to the certificate file.',
-            alias: 'cert-path',
-            type: 'string',
-            implies: 'key',
-        },
-        key: {
-            description: 'path to the key file.',
-            alias: 'key-path',
-            type: 'string',
-            implies: 'cert',
-        },
-        config: {
-            description: 'json string to use instead of cli arguments',
-            type: 'string',
-            coerce: JSON.parse,
-        },
-        maskLog: {
-            description: 'mask sensitive information in the log',
-            type: 'boolean',
-            default: false,
-        },
-    }),
-    handler: async (args) => {
-        if (args.fork) {
-            const { port } = await (0, core_server_process_1.makeCoreServerProcess)({ ...args, fork: false, isProcess: true });
-            // eslint-disable-next-line no-console
-            console.log(port); // NOTE: this is a part of the generic protocol
-        }
-        else {
-            void (0, core_server_1.makeCoreServer)({ ...args, ...args.config, isProcess: true });
-        }
-    },
-})
-    .command({
-    command: 'logs [input]',
-    builder: yargs => yargs.options({
-        input: {
-            description: 'log input to process',
-            type: 'string',
-        },
-        structure: {
-            description: 'group logs by tag names',
-            type: 'boolean',
-        },
-        analyze: {
-            description: 'group logs by tag names',
-            type: 'boolean',
-        },
-    }),
-    handler: async (args) => {
-        var _a;
-        const input = (_a = args.input) !== null && _a !== void 0 ? _a : (await utils.streams.toBuffer(process.stdin)).toString('utf8');
-        const logs = (0, logs_1.parseLogs)(input);
-        if (args.analyze) {
-            console.log(JSON.stringify((0, logs_1.analyzeLogs)((0, logs_1.structureLogs)(logs)), null, 2));
-        }
-        else if (args.structure) {
-            console.log(JSON.stringify((0, logs_1.structureLogs)(logs), null, 2));
-        }
-        else {
-            console.log(JSON.stringify(logs, null, 2));
-        }
-    },
-})
-    .command({
-    command: 'check-network',
-    handler: async () => {
-        await (0, check_network_1.checkNetwork)();
-    },
-})
-    .wrap(yargs_1.default.terminalWidth()).argv;

package/dist/universal/core-server-process.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeCoreServerProcess = void 0;
-const child_process_1 = require("child_process");
-const path_1 = __importDefault(require("path"));
-function makeCoreServerProcess(options) {
-    return new Promise((resolve, reject) => {
-        const server = (0, child_process_1.fork)(path_1.default.resolve(__dirname, '../../dist/cli/cli.js'), ['universal', `--config=${JSON.stringify(options)}`], {
-            stdio: [options.shutdownMode === 'stdin' ? 'inherit' : 'ignore', 'ignore', 'ignore', 'ipc'],
-            ...options.forkOptions,
-        });
-        const timeout = setTimeout(() => {
-            reject(new Error(`Server didn't respond for 10s after being started`));
-            server.kill();
-        }, 60000);
-        server.on('error', reject);
-        server.once('message', ({ name, payload }) => {
-            var _a;
-            if (name === 'port') {
-                resolve({ port: payload.port, close: () => server.kill() });
-                clearTimeout(timeout);
-                (_a = server.channel) === null || _a === void 0 ? void 0 : _a.unref();
-            }
-        });
-        server.unref();
-    });
-}
-exports.makeCoreServerProcess = makeCoreServerProcess;

package/dist/universal/core-server.js

@@ -1,216 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeCoreServer = void 0;
-const socket_1 = require("@applitools/socket");
-const spec_driver_webdriver_1 = __importDefault(require("@applitools/spec-driver-webdriver"));
-const spec_driver_1 = require("./spec-driver");
-const ws_server_1 = require("./ws-server");
-const logger_1 = require("@applitools/logger");
-const core_1 = require("../core");
-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({ environment: defaultEnvironment, agentIdPrefix = `eyes-universal/${require('../../package.json').version}`, debug = false, shutdownMode = 'lazy', idleTimeout = 900000, // 15min
-printStdout = false, isProcess = false, maskLog = false, logger = undefined, ...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`);
-    const baseLogger = logger !== null && logger !== void 0 ? logger : (0, logger_1.makeLogger)({
-        handler: { type: 'rolling file', name: 'universal', dirname: logDirname },
-        level: 'info',
-        format: { label: 'core-universal', colors: false },
-        maskLog,
-    });
-    baseLogger.log('Core universal is going to be initialized with options', {
-        debug,
-        shutdownMode,
-        idleTimeout,
-        printStdout,
-        defaultEnvironment,
-        ...handlerOptions,
-    });
-    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
-        (_b = process.send) === null || _b === void 0 ? void 0 : _b.call(process, { name: 'port', payload: { port } }); // NOTE: this is a part of the js specific protocol
-    }
-    if (!server) {
-        baseLogger.console.log(`You are trying to spawn a duplicated server, use the server on port ${port} instead`);
-        return { port };
-    }
-    if (!printStdout)
-        process.stdout.write = () => true; // NOTE: prevent any write to stdout
-    baseLogger.log('Core universal is started on port', port);
-    let idle;
-    let serverClosed = false;
-    if (shutdownMode === 'stdin') {
-        process.stdin.resume();
-        process.stdin.on('end', () => {
-            server.close();
-        });
-    }
-    else if (shutdownMode === 'lazy') {
-        if (idleTimeout) {
-            idle = setTimeout(() => server.close(), idleTimeout);
-        }
-    }
-    server.on('close', () => {
-        clearTimeout(idle);
-        serverClosed = true;
-    });
-    server.on('connection', async (client) => {
-        const refer = (0, refer_1.makeRefer)();
-        const socket = (0, socket_1.makeSocket)(client, {
-            transport: 'ws',
-            logger: baseLogger,
-        });
-        const getHistory = debug ? (0, history_1.withHistory)(socket) : () => null;
-        if (shutdownMode === 'lazy' && idleTimeout) {
-            clearTimeout(idle);
-            socket.on('close', () => {
-                if (server.clients.size > 0 || serverClosed)
-                    return;
-                idle = setTimeout(() => server.close(), idleTimeout);
-            });
-        }
-        const logger = baseLogger.extend({
-            console: {
-                log: (message) => socket.emit('Logger.log', { level: 'info', message }),
-                warn: (message) => socket.emit('Logger.log', { level: 'warn', message }),
-                error: (message) => socket.emit('Logger.log', { level: 'error', message }),
-                fatal: (message) => socket.emit('Logger.log', { level: 'fatal', message }),
-            },
-            maskLog,
-        });
-        logger.console.log(`Logs saved in: ${logDirname}`);
-        const corePromise = socket.wait('Core.makeCore', ({ spec, agentId, environment, cwd }) => {
-            return (0, core_1.makeCore)({
-                spec: spec === 'webdriver' ? spec_driver_webdriver_1.default : (0, spec_driver_1.makeSpec)({ socket, spec }),
-                agentId: `${agentIdPrefix}/${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,
-                maskLog,
-            });
-        });
-        socket.command('Core.getAccountInfo', async (options) => {
-            const core = await corePromise;
-            return core.getAccountInfo(options);
-        });
-        socket.command('Core.getViewportSize', async (options) => {
-            var _a;
-            const core = await corePromise;
-            return (_a = core.getViewportSize) === null || _a === void 0 ? void 0 : _a.call(core, options);
-        });
-        socket.command('Core.setViewportSize', async (options) => {
-            var _a;
-            const core = await corePromise;
-            return (_a = core.setViewportSize) === null || _a === void 0 ? void 0 : _a.call(core, options);
-        });
-        socket.command('Core.closeBatch', async (options) => {
-            const core = await corePromise;
-            return core.closeBatch(options);
-        });
-        socket.command('Core.deleteTest', async (options) => {
-            const core = await corePromise;
-            return core.deleteTest(options);
-        });
-        socket.command('Core.logEvent', async ({ settings }) => {
-            const core = await corePromise;
-            return core.logEvent({ settings });
-        });
-        socket.command('Core.locate', async (options) => {
-            const core = await corePromise;
-            return core.locate(options);
-        });
-        socket.command('Core.locateText', async (options) => {
-            const core = await corePromise;
-            return core.locateText(options);
-        });
-        socket.command('Core.extractText', async (options) => {
-            const core = await corePromise;
-            return core.extractText(options);
-        });
-        socket.command('Core.getECClient', async (options) => {
-            const core = await corePromise;
-            const client = await core.getECClient(options);
-            return { url: client.url };
-        });
-        socket.command('Core.makeManager', async (options) => {
-            var _a;
-            const core = await corePromise;
-            if ((_a = options.settings) === null || _a === void 0 ? void 0 : _a.agentId) {
-                options.settings.agentId = `${agentIdPrefix}/${options.settings.agentId}`;
-            }
-            return refer.ref(await core.makeManager(options));
-        });
-        socket.command('EyesManager.openEyes', async ({ manager, ...options }) => {
-            var _a;
-            const eyes = await ((_a = refer.deref(manager)) === null || _a === void 0 ? void 0 : _a.openEyes(options));
-            const eyesRef = refer.ref(eyes, manager);
-            return eyesRef;
-        });
-        socket.command('EyesManager.getResults', async ({ manager, ...options }) => {
-            var _a;
-            return (_a = refer.deref(manager)) === null || _a === void 0 ? void 0 : _a.getResults(options);
-        });
-        socket.command('Eyes.check', async ({ eyes, ...options }) => {
-            var _a;
-            return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.check(options);
-        });
-        socket.command('Eyes.checkAndClose', async ({ eyes, ...options }) => {
-            var _a;
-            return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.checkAndClose(options);
-        });
-        socket.command('Eyes.close', async ({ eyes, ...options }) => {
-            var _a;
-            return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.close(options);
-        });
-        socket.command('Eyes.abort', async ({ eyes, ...options }) => {
-            var _a;
-            return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.abort(options);
-        });
-        socket.command('Eyes.getResults', async ({ eyes, ...options }) => {
-            var _a;
-            return (_a = refer.deref(eyes)) === null || _a === void 0 ? void 0 : _a.getResults(options);
-        });
-        socket.command('Debug.getHistory', async () => {
-            return {
-                ...getHistory(),
-                initialArgs: {
-                    environment: defaultEnvironment,
-                    agentIdPrefix,
-                    debug,
-                    shutdownMode,
-                    idleTimeout,
-                    printStdout,
-                    isProcess,
-                    maskLog,
-                    ...handlerOptions,
-                },
-            };
-        });
-    });
-    process.on('unhandledRejection', error => {
-        baseLogger.error('Unhandled promise rejection', error);
-        /* eslint-disable-next-line no-console */
-        console.error('Unhandled promise rejection', error);
-    });
-    process.on('uncaughtException', error => {
-        baseLogger.error('Uncaught error terminating the process', error);
-        /* eslint-disable-next-line no-console */
-        console.error('Uncaught error terminating the process', error);
-        process.exit(1);
-    });
-    return { port, close: () => server.close() };
-}
-exports.makeCoreServer = makeCoreServer;

package/dist/universal/history.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withHistory = void 0;
-//TODO Design a better history tracker
-function withHistory(socket) {
-    const history = {
-        managers: new Map(),
-        eyes: new Map(),
-        startedAt: new Date().toISOString(),
-        unknownEvents: [],
-    };
-    const originalCommand = socket.command;
-    socket.command = function command(name, fn) {
-        return originalCommand(name, async (payload) => {
-            let result, error;
-            try {
-                result = await fn(payload);
-                return result;
-            }
-            catch (err) {
-                error = err;
-                throw error;
-            }
-            finally {
-                if (name === 'Core.makeManager') {
-                    const managerRef = result;
-                    history.managers.set(extractRefId(managerRef), { ...payload, manager: result, eyes: [] });
-                }
-                else if (name.startsWith('EyesManager.')) {
-                    const managerRef = payload.manager;
-                    const managerHistory = history.managers.get(extractRefId(managerRef));
-                    if (managerHistory) {
-                        if (name === 'EyesManager.openEyes') {
-                            if (error) {
-                                managerHistory.eyes.push({ ...payload, error });
-                            }
-                            else {
-                                const eyesRef = result;
-                                managerHistory.eyes.push(eyesRef);
-                                history.eyes.set(extractRefId(eyesRef), { ...payload, eyes: eyesRef, commands: [] });
-                            }
-                        }
-                    }
-                }
-                else if (name.startsWith('Eyes.')) {
-                    const eyesRef = payload.eyes;
-                    const eyesHistory = history.eyes.get(extractRefId(eyesRef));
-                    if (eyesHistory) {
-                        if (name === 'Eyes.check') {
-                            const command = { name, ...payload };
-                            if (error)
-                                command.error = error;
-                            else
-                                command.result = result;
-                            eyesHistory.commands.push(command);
-                        }
-                        else if (name === 'Eyes.close') {
-                            eyesHistory.closed = true;
-                        }
-                        else if (name === 'Eyes.abort') {
-                            eyesHistory.aborted = true;
-                        }
-                        else if (name === 'Eyes.getResults') {
-                            eyesHistory.result = error !== null && error !== void 0 ? error : result;
-                        }
-                    }
-                }
-                else {
-                    history.unknownEvents.push({ name, payload });
-                }
-            }
-        });
-    };
-    return function getHistory() {
-        return {
-            managers: Array.from(history.managers.values(), managerMeta => ({
-                ...managerMeta,
-                eyes: managerMeta.eyes.map(eyesRefOrError => {
-                    return eyesRefOrError instanceof Error ? eyesRefOrError : history.eyes.get(extractRefId(eyesRefOrError));
-                }),
-            })),
-            startedAt: history.startedAt,
-            requestedAt: new Date().toISOString(),
-        };
-    };
-    function extractRefId(ref) {
-        return ref['applitools-ref-id'];
-    }
-}
-exports.withHistory = withHistory;

package/dist/universal/refer.js

@@ -1,67 +0,0 @@
-"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.makeRefer = void 0;
-const utils = __importStar(require("@applitools/utils"));
-const REF_ID = 'applitools-ref-id';
-function makeRefer() {
-    const store = new Map();
-    const relation = new Map();
-    return { isRef, ref, deref, destroy };
-    function isRef(ref) {
-        return Boolean(ref[REF_ID]);
-    }
-    function ref(value, parentRef) {
-        const ref = utils.general.guid();
-        store.set(ref, value);
-        if (parentRef) {
-            let childRefs = relation.get(parentRef[REF_ID]);
-            if (!childRefs) {
-                childRefs = new Set();
-                relation.set(parentRef[REF_ID], childRefs);
-            }
-            childRefs.add({ [REF_ID]: ref });
-        }
-        return { [REF_ID]: ref };
-    }
-    function deref(ref) {
-        if (isRef(ref)) {
-            return store.get(ref[REF_ID]);
-        }
-        else {
-            return ref;
-        }
-    }
-    function destroy(ref) {
-        if (!isRef(ref))
-            return;
-        const childRefs = relation.get(ref[REF_ID]);
-        if (childRefs) {
-            childRefs.forEach(childRef => destroy(childRef));
-        }
-        store.delete(ref[REF_ID]);
-    }
-}
-exports.makeRefer = makeRefer;