@testim/testim-cli 3.288.0 → 3.290.0-beta

package/codim/template.ts/.idea/workspace.xml

@@ -1,57 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RunManager">
-    <configuration default="true" type="js.build_tools.npm">
-      <package-json value="$PROJECT_DIR$/package.json" />
-      <command value="run" />
-      <scripts>
-        <script value="debug-examples" />
-      </scripts>
-      <node-interpreter value="project" />
-      <envs />
-      <method v="2" />
-    </configuration>
-    <configuration name="run examples" type="js.build_tools.npm" nameIsGenerated="true">
-      <package-json value="$PROJECT_DIR$/package.json" />
-      <command value="run" />
-      <scripts>
-        <script value="debug-examples" />
-      </scripts>
-      <node-interpreter value="project" />
-      <envs />
-      <method v="2" />
-    </configuration>
-    <configuration name="run tests" type="js.build_tools.npm" nameIsGenerated="true">
-      <package-json value="$PROJECT_DIR$/package.json" />
-      <command value="run" />
-      <scripts>
-        <script value="debug" />
-      </scripts>
-      <node-interpreter value="project" />
-      <envs />
-      <method v="2" />
-    </configuration>
-    <configuration name="run open file" type="js.build_tools.npm" nameIsGenerated="true">
-      <package-json value="$PROJECT_DIR$/package.json" />
-      <command value="run" />
-      <scripts>
-        <script value="debug-file" />
-      </scripts>
-      <arguments value="$FilePath$" />
-      <node-interpreter value="project" />
-      <envs />
-      <method v="2" />
-    </configuration>
-    <configuration name="run headless" type="js.build_tools.npm" nameIsGenerated="true">
-      <package-json value="$PROJECT_DIR$/package.json" />
-      <command value="run" />
-      <scripts>
-        <script value="headless" />
-      </scripts>
-      <node-interpreter value="project" />
-      <envs />
-      <method v="2" />
-    </configuration>
-
-  </component>
-</project>

package/codim/template.ts/.vscode/launch.json

@@ -1,55 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Run Examples",
-            "runtimeExecutable": "npm",
-            "runtimeArgs": [
-                "run-script",
-                "debug-examples"
-            ],
-            "port": 9229
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Run Tests",
-            "runtimeExecutable": "npm",
-            "outputCapture": "std",
-            "runtimeArgs": [
-                "run-script",
-                "debug"
-            ],
-            "port": 9229
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Run Open File",
-            "runtimeExecutable": "npm",
-            "outputCapture": "std",
-            "runtimeArgs": [
-                "run-script",
-                "debug-file",
-                "${file}"
-            ],
-            "port": 9229
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Run Headless",
-            "runtimeExecutable": "npm",
-            "runtimeArgs": [
-                "run-script",
-                "headless"
-            ],
-            "port": 9229
-        }
-    ]
-}

package/commons/AbortError.js

@@ -1,12 +0,0 @@
-'use strict';
-
-class AbortError extends Error {
-    constructor(message = 'aborted') {
-        super(message);
-        this.name = 'AbortError';
-    }
-}
-
-module.exports = {
-    AbortError,
-};

package/commons/SeleniumPerfStats.js

@@ -1,58 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-const { guid, calcPercentile } = require('../utils');
-
-const SELENIUM_PERF_MARKS = {
-    GET_BROWSER: 'GET_BROWSER',
-    GET_HTML: 'GET_HTML',
-    GET_ELEMENT: 'GET_ELEMENT',
-    GET_SCREENSHOT: 'GET_SCREENSHOT',
-};
-
-class SeleniumPerfStats {
-    constructor() {
-        this.marks = _.mapValues(SELENIUM_PERF_MARKS, () => []);
-        this.marks.ALL = [];
-        this.startTimes = {};
-    }
-
-    markStart(mark) {
-        const id = guid();
-        this.startTimes[`${mark}:${id}`] = Date.now();
-        return id;
-    }
-
-    markEnd(id, mark) {
-        const markDuration = Date.now() - this.startTimes[`${mark}:${id}`];
-        delete this.startTimes[`${mark}:${id}`];
-
-        if (!this.marks[mark]) {
-            this.marks.ALL.push(markDuration);
-            return;
-        }
-        this.marks[mark].push(markDuration);
-    }
-
-    getStats() {
-        return {
-            seleniumPerfMarks: this.marks,
-            seleniumStats: _.chain(this.marks).transform(
-                (result, samples, key) => {
-                    if (_.isEmpty(samples)) {
-                        return;
-                    }
-                    result[`${key}_COUNT`] = samples.length;
-                    result[`${key}_P50`] = calcPercentile(samples, 50);
-                    result[`${key}_P95`] = calcPercentile(samples, 95);
-                },
-                {}
-            ).value(),
-        };
-    }
-}
-
-module.exports = {
-    SELENIUM_PERF_MARKS,
-    SeleniumPerfStats,
-};

package/commons/chrome-launcher.js

@@ -1,15 +0,0 @@
-'use strict';
-
-const { exec } = require('child_process');
-
-module.exports.launchChrome = function (url) {
-    const { platform } = process;
-
-    if (platform === 'win32') {
-        exec(`start chrome ${url}`);
-    } else if (platform === 'darwin') {
-        exec(`open -a "Google Chrome" ${url}`);
-    } else if (platform === 'linux') {
-        exec(`google-chrome ${url}`);
-    }
-};

package/commons/chromedriverWrapper.js

@@ -1,70 +0,0 @@
-/* eslint-disable no-console */
-
-const fkill = require('fkill');
-const pRetry = require('p-retry');
-
-const httpRequest = require('./httpRequest');
-const npmWrapper = require('./npmWrapper');
-const { getCliLocation } = require('../utils');
-const { requireWithFallback } = require('./requireWithFallback');
-
-const PACKAGE_NAME = 'chromedriver';
-const DRIVER_PORT = 9515;
-const DRIVER_BASE_URL = `http://localhost:${DRIVER_PORT}/wd/hub`;
-const DEFAULT_DRIVER_ARGS = [
-    // webdriverio expects a wd/hub (selenium-server like server endpoint)
-    '--url-base=/wd/hub',
-    // don't complain about driver version
-    '--disable-build-check',
-    // allow any ip to connect chrome driver
-    '--whitelisted-ips=0.0.0.0',
-    '--log-level=OFF', // instead we could try to log it somehow or at least have a flag to enable this
-];
-
-// [NOTE] This is a "smart installation":
-// By default chromedriver package, when installed, will search for an existing binary in the configured temp directory.
-// If found, and it is the correct version, it will simply copy it to your node_modules directory, and if not it will download the newer version.
-const install = async () => {
-    await npmWrapper.installPackageLocally(getCliLocation(), `${PACKAGE_NAME} --detect_chromedriver_version`);
-};
-
-const start = async () => {
-    // remove --inspect before starting chromedriver
-    process.env.NODE_OPTIONS = '';
-
-    // kill any localhost running chromedriver instance
-    await fkill(`:${DRIVER_PORT}`, { silent: true });
-
-    const chromedriver = requireWithFallback(PACKAGE_NAME);
-    await chromedriver.start(DEFAULT_DRIVER_ARGS, true);
-};
-
-const isReady = async ({ chromeBinaryLocation }) => {
-    // 100 tries, every 30ms
-    await pRetry(async () => {
-        const statusResponse = await httpRequest.get(`${DRIVER_BASE_URL}/status`);
-        if (!statusResponse || !statusResponse.value || !statusResponse.value.ready) {
-            throw new Error('status failed');
-        }
-
-        const chromeOptions = {};
-        if (chromeBinaryLocation) {
-            chromeOptions.binary = chromeBinaryLocation;
-        }
-        const sessionResponse = await httpRequest.post({
-            url: `${DRIVER_BASE_URL}/session`,
-            body: { desiredCapabilities: { browserName: 'chrome', chromeOptions } },
-            headers: { 'Content-Type': 'application/json' },
-        });
-        if (!sessionResponse || sessionResponse.status !== 0 || !sessionResponse.sessionId) {
-            throw new Error('create session failed');
-        }
-        await httpRequest.delete(`${DRIVER_BASE_URL}/session/${sessionResponse.sessionId}`);
-    }, { retries: 100, minTimeout: 30 });
-};
-
-module.exports = {
-    install,
-    start,
-    isReady,
-};

package/commons/config.js

@@ -1,39 +0,0 @@
-'use strict';
-
-let SERVICES_HOST = process.env.SERVICES_HOST || 'https://services.testim.io';
-const canonicalBlobURL = 'https://testimstatic.blob.core.windows.net';
-const canonicalEdgeUrl = 'https://tstresultfiles.azureedge.net';
-if (process.env.GATEWAY_URL) {
-    process.env.CORALOGIX_URL = `${process.env.GATEWAY_URL}/testim/coralogix/api/v1/logs`;
-    process.env.SERVICES_HOST = `${process.env.GATEWAY_URL}/testim/services`;
-    // set the services for the extension
-    process.env.EXTENSION_SERVICES_HOST = process.env.TUNNEL_GATEWAY ? process.env.SERVICES_HOST : SERVICES_HOST;
-    SERVICES_HOST = process.env.SERVICES_HOST;
-}
-
-module.exports = {
-    DISABLE_AGENT_ORIGIN_CHECK: parseInt(process.env.DISABLE_AGENT_ORIGIN_CHECK || '0'),
-    DISABLE_DEBUGGER_INFINITE_TIMEOUT: parseInt(process.env.DISABLE_DEBUGGER_INFINITE_TIMEOUT || '0'),
-    OVERRIDE_TIMEOUTS: parseInt(process.env.OVERRIDE_TIMEOUTS || '0'),
-    EDITOR_URL: process.env.EDITOR_URL,
-    WEBSOCKET_HOST: process.env.WEBSOCKET_HOST || `${SERVICES_HOST}/ws`,
-    SERVICES_HOST,
-    LOGGER_CONSOLE: parseInt(process.env.LOGGER_CONSOLE || '0'),
-    LOGGER_DEBUG: parseInt(process.env.LOGGER_DEBUG || '0'),
-    WEBDRIVER_DEBUG: parseInt(process.env.WEBDRIVER_DEBUG || '0'),
-    IS_ON_PREM: parseInt(process.env.IS_ON_PREM || '0'),
-    REQUESTS_QUEUE_SIZE: process.env.REQUESTS_QUEUE_SIZE ? parseInt(process.env.REQUESTS_QUEUE_SIZE) : undefined,
-    DEBUG_MODE: parseInt(process.env.DEBUG_MODE || '0'),
-    TESTIM_CONCURRENT_WORKER_COUNT: process.env.TESTIM_CONCURRENT_WORKER_COUNT ? parseInt(process.env.TESTIM_CONCURRENT_WORKER_COUNT) : null,
-    ROLLOUT_KEY: process.env.ROLLOUT_KEY || '5b5560729601aa6484276518',
-    DF_ENABLE_VIDEO: parseInt(process.env.DF_ENABLE_VIDEO || '0'),
-    START_WORKER_DELAY_MS: parseInt(process.env.START_WORKER_DELAY_MS || 1500),
-    APPIUM_VERSION: process.env.APPIUM_VERSION || '1.10.1',
-
-    GATEWAY_URL: process.env.GATEWAY_URL,
-    EXTENSION_SERVICES_HOST: process.env.EXTENSION_SERVICES_HOST || SERVICES_HOST,
-    BLOB_URL: process.env.GATEWAY_URL ? `${process.env.GATEWAY_URL}/testim/blob` : canonicalBlobURL,
-    EDGE_URL: process.env.GATEWAY_URL ? `${process.env.GATEWAY_URL}/testim/edge` : canonicalEdgeUrl,
-    CANONICAL_BLOB_URL: canonicalBlobURL,
-    CANONICAL_EDGE_URL: canonicalEdgeUrl,
-};

package/commons/constants.js

@@ -1,67 +0,0 @@
-'use strict';
-
-module.exports = {
-    timeoutMessages: {
-        GET_BROWSER_TIMEOUT_MSG: 'get-browser-timeout',
-        TEST_START_TIMEOUT_MSG: 'test-start-timeout',
-        TEST_COMPLETE_TIMEOUT_MSG: 'test-complete-timeout',
-    },
-    testRunStatus: {
-        COMPLETED: 'completed',
-        RUNNING: 'running',
-    },
-    runnerTestStatus: {
-        PASSED: 'PASSED',
-        FAILED: 'FAILED',
-        ABORTED: 'ABORTED',
-        SKIPPED: 'SKIPPED',
-        QUEUED: 'QUEUED',
-    },
-    testStatus: {
-        DRAFT: 'draft',
-        EVALUATING: 'evaluating',
-        ACTIVE: 'active',
-        QUARANTINE: 'quarantine',
-    },
-    gridMessages: {
-        NOT_FOUND: 'The specified grid is not available',
-        UNKNOWN: "Test couldn't get browser - unknown error",
-    },
-    mobileWeb: {
-        MOBILE_WEB_REMOTE_RUN_HEADER_SPACING: 50,
-    },
-    test: {
-        HIDDEN_PARAM: 'TST_HIDDEN_PARAM',
-    },
-    socketEventTypes: {
-        TEST_RESULT_CREATED: 'test-result-created',
-        TEST_RESULT_UPDATED: 'test-result-updated',
-        REMOTE_STEP_SAVED: 'remote-step-saved',
-    },
-    CLI_MODE: {
-        EXTENSION: 'extension',
-        SELENIUM: 'selenium',
-        APPIUM: 'appium',
-    },
-    sessionType: {
-        CODELESS: 'codeless',
-        CODEFUL: 'codeful',
-    },
-    gridTypes: {
-        TESTIM_ENTERPRISE: 'testimEnterprise',
-        TESTIM: 'testim',
-        LAMBDATEST: 'testimLambdaTest',
-        DEVICE_FARM: 'testimDF',
-        HYBRID: 'testimHybrid',
-        BROWSERSTACK: 'browserstack',
-        SAUCELABS: 'saucelabs',
-        TESTIM_HEADSPIN: 'testimHeadspin',
-    },
-    stepResult: {
-        SETUP_TIMEOUT: 'setup-timeout',
-        NETWORK_ERROR: 'network-error',
-        GRID_ERROR: 'grid-error',
-        SELENIUM_ERROR: 'selenium-error',
-        BROWSER_CLOSED: 'browser-closed',
-    },
-};

package/commons/detectDebugger.js

@@ -1,19 +0,0 @@
-'use strict';
-
-const { DISABLE_DEBUGGER_INFINITE_TIMEOUT } = require('./config');
-
-module.exports.isDebuggerConnected = () => {
-    try {
-        if (DISABLE_DEBUGGER_INFINITE_TIMEOUT) {
-            return false;
-        }
-        const inspector = require('inspector');
-        //https://github.com/GoogleChrome/puppeteer/blob/14fb3e38db7c97fc3ea76c65e6f219b0ddb3b54f/utils/testrunner/TestRunner.js#L279
-        if (inspector.url()) {
-            return true;
-        }
-    } catch (e) {
-        /* empty */
-    }
-    return false;
-};

package/commons/featureAvailabilityService.js

@@ -1,26 +0,0 @@
-'use strict';
-
-const { gridTypes } = require('./constants');
-
-class FeatureAvailabilityService {
-    constructor() {
-        /**
-         * @type {'free'|'trial'|'pro'}
-         */
-        this._planType = 'free';
-    }
-
-    setPlanType(planType) {
-        this._planType = planType;
-    }
-
-    get isTestStatusEnabled() {
-        return ['pro', 'trial'].includes(this._planType);
-    }
-
-    shouldShowFreeGridRunWarning(gridType) {
-        return this._planType !== 'pro' && gridType === gridTypes.DEVICE_FARM;
-    }
-}
-
-module.exports = new FeatureAvailabilityService();

package/commons/featureFlags.js

@@ -1,132 +0,0 @@
-'use strict';
-
-const Rox = require('rox-node');
-const { getLogger } = require('./logger');
-const { promiseTimeout } = require('../utils');
-const { ROLLOUT_KEY, IS_ON_PREM, GATEWAY_URL } = require('./config');
-
-const logger = getLogger('FeatureFlagsService');
-
-// IS_UNIT_TEST = disable rollout if code run in unit test mode to ignore mocha process stuck on running
-const USE_FEATURE_FLAGS = !IS_ON_PREM && !process.env.IS_UNIT_TEST && !GATEWAY_URL;
-
-const FORCE_FETCH_TIMEOUT_MS = 20000; // rollout sometimes takes up to 15 seconds to load
-const SEC_IN_DAY = 60 * 60 * 24;
-
-/** @type {['labs', 'disabled', 'enabled'] as const} */
-const LAB_FEATURE_FLAG_VALUES = ['labs', 'disabled', 'enabled'];
-
-class LabFeatureFlag extends Rox.Variant {
-    constructor(initialValue = 'disabled') {
-        super(initialValue, LAB_FEATURE_FLAG_VALUES);
-    }
-
-    /** @returns {(typeof LAB_FEATURE_FLAG_VALUES)[number]} */
-    getValue() {
-        const value = super.getValue();
-        if (!LAB_FEATURE_FLAG_VALUES.includes(value)) {
-            logger.warn('unexpected value for lab feature flag. Falling back to value "labs"', { featureFlagName: this.name, value });
-            return 'labs';
-        }
-
-        return value;
-    }
-}
-
-class FeatureFlagsService {
-    constructor() {
-        this.flags = {
-            useNewWSCLI: new Rox.Flag(),
-            useSafariWebdriverVisibilityChecks: new Rox.Flag(),
-            useClickimVisibilityChecks: new Rox.Flag(),
-            runGetElementCodeInAut: new Rox.Flag(),
-            enableFrameSwitchOptimization: new Rox.Flag(),
-            maximumJsResultSize: new Rox.Configuration(2000 * 1024),
-            skipFileInputClicks: new Rox.Flag(),
-            errorMessageOnBadNetwork: new Rox.Flag(true),
-            warnOnBadNetwork: new Rox.Flag(false),
-            overrideAzureStorageUrl: new Rox.Flag(),
-            useJsInputCodeInSafari: new Rox.Flag(),
-            useJsInputCodeInFirefox: new Rox.Flag(),
-            autoSaveDownloadFileFireFox: new Rox.Flag(true),
-            safariSelectOptionDispatchEventOnSelectElement: new Rox.Flag(true),
-            experimentalPreCodeCompilation: new Rox.Flag(true),
-            /** Enables using top level await inside custom actions */
-            experimentalAsyncCustomCode: new Rox.Flag(),
-            useSameBrowserForMultiTests: new LabFeatureFlag('labs'),
-            highSpeedMode: new LabFeatureFlag(),
-            usePortedHtml5DragDrop: new Rox.Flag(),
-            testNamesToBeforeSuiteHook: new Rox.Flag(),
-            addCustomCapabilities: new Rox.Variant('{}'),
-            enableWorkerThreadsCliCodeExecution: new Rox.Flag(true),
-            LTNetworkCapabilities: new Rox.Flag(),
-            downloadToBase64: new Rox.Flag(),
-            dec2022eolBrowsers: new Rox.Flag(),
-            publicGridURL: new Rox.Configuration('public-grid.testim.io'),
-        };
-        Rox.register('default', this.flags);
-    }
-
-    /** @param {string} projectId */
-    setProjectId(projectId) {
-        Rox.setCustomStringProperty('projectId', projectId);
-    }
-
-    /** @param {string} projectType */
-    setProjectType(projectType) {
-        Rox.setCustomStringProperty('projectType', projectType);
-    }
-
-    /** @param {string} productType */
-    setCompanyProductType(productType) {
-        Rox.setCustomStringProperty('productType', productType);
-    }
-
-    /** @param {string} companyId */
-    setCompanyId(companyId) {
-        Rox.setCustomStringProperty('companyId', companyId);
-    }
-
-    /** @param {string} planType */
-    setPlanType(planType) {
-        Rox.setCustomStringProperty('planType', planType);
-    }
-
-    /** @param {boolean} isPOC */
-    setIsPOC(isPOC) {
-        Rox.setCustomBooleanProperty('isPOC', isPOC);
-    }
-
-    /** @param {boolean} isStartUp */
-    setIsStartUp(isStartUp) {
-        Rox.setCustomBooleanProperty('isStartUp', isStartUp);
-    }
-
-    /** @param {string} mode */
-    setRunnerMode(mode) {
-        Rox.setCustomStringProperty('runnerMode', mode);
-    }
-
-    async fetch() {
-        if (!USE_FEATURE_FLAGS) {
-            return undefined;
-        }
-        /** @type {Rox.RoxSetupOptions} */
-        const opts = {
-            fetchIntervalInSec: SEC_IN_DAY, // we don't actually want to refresh feature flags in the CLI,
-            disableNetworkFetch: false,
-        };
-
-
-        if (global.ProxyAgent) {
-            const agent = new global.ProxyAgent(global.proxyUri);
-            opts.httpsAgent = agent;
-            opts.httpAgent = agent;
-        }
-
-        return promiseTimeout(Rox.setup(ROLLOUT_KEY, opts), FORCE_FETCH_TIMEOUT_MS)
-            .catch(err => logger.error('failed to get feature flag status', err));
-    }
-}
-
-module.exports = new FeatureFlagsService();

package/commons/getSessionPlayerRequire.js

@@ -1,28 +0,0 @@
-'use strict';
-
-const { join, resolve } = require('path');
-
-/** @type {{ playerPath: string | undefined }} */ module.exports.options = { playerPath: undefined };
-
-/** @type {import('clickim/src/background/sessionPlayerInit').SessionPlayerInit | undefined} */ let sessionPlayerInit;
-
-module.exports.getSessionPlayer = () => {
-    if (sessionPlayerInit) {
-        return sessionPlayerInit;
-    }
-    const perf = require('./performance-logger');
-
-    perf.log('getSessionPlayerRequire start');
-    const { getSessionPlayerFolder } = require('./prepareRunnerAndTestimStartUtils');
-
-    const testimAppDataFolder = getSessionPlayerFolder();
-    const { options } = module.exports;
-    const path = options.playerPath ? resolve(options.playerPath, 'src/background/sessionPlayerInit.ts') : join(testimAppDataFolder, 'sessionPlayer.js');
-
-    /** @type {import('clickim/src/background/sessionPlayerInit').SessionPlayerInit} */
-    const sessionPlayer = require(path); // eslint-disable-line import/no-dynamic-require
-
-    perf.log('getSessionPlayerRequire end');
-    sessionPlayerInit = sessionPlayer;
-    return sessionPlayer;
-};