@testim/testim-cli 3.289.0 → 3.290.0

package/agent/routers/standalone-browser/registerRoutes.js

@@ -1,47 +0,0 @@
-// @ts-check
-
-'use strict';
-
-const express = require('express');
-
-module.exports = {
-    standaloneBrowserRoutes,
-};
-
-/**
- * @param {{
-    webdriverApi: import("../../../player/WebdriverioWebDriverApi")
-}} [testimStandaloneBrowser]
- */
-function standaloneBrowserRoutes(testimStandaloneBrowser) {
-    const router = express.Router();
-
-    router.get('/cdp-url', (req, res) => {
-        if (!testimStandaloneBrowser) {
-            res.status(503).send({
-                error: 'Testim standalone browser is not running',
-            });
-
-            return;
-        }
-
-        res.status(200).send({
-            url: testimStandaloneBrowser.webdriverApi.cdpUrl,
-        });
-    });
-
-    router.get('/status', (req, res) => {
-        if (!testimStandaloneBrowser) {
-            res.status(503).send({
-                ok: false,
-            });
-            return;
-        }
-
-        res.status(200).send({
-            ok: true,
-        });
-    });
-
-    return router;
-}

package/agent/server.js

@@ -1,150 +0,0 @@
-'use strict';
-
-const { ArgError } = require('../errors');
-const testimCustomToken = require('../commons/testimCustomToken');
-const lazyRequire = require('../commons/lazyRequire');
-const { prepareChromeDriver } = require('../commons/prepareRunnerAndTestimStartUtils');
-
-module.exports = {
-    init,
-};
-
-/**
- *
- * @param {*} param0
- * @param {{
-    webdriverApi: import("../player/WebdriverioWebDriverApi")
-}} [testimStandaloneBrowser]
-*/
-async function init({
-    agentPort,
-    agentBind,
-    project,
-    token,
-    installPlaygroundPlaywrightDeps,
-    installPlaygroundPuppeteerDeps,
-    installPlaygroundSeleniumDeps,
-}, testimStandaloneBrowser) {
-    await installExternalPackages({
-        installPlaygroundPlaywrightDeps,
-        installPlaygroundPuppeteerDeps,
-        installPlaygroundSeleniumDeps,
-        project,
-    });
-    await initServer({
-        agentPort,
-        agentBind,
-        project,
-        token,
-    }, testimStandaloneBrowser);
-}
-
-/**
- *
- * @param {*} param0
- * @param {{
-        webdriverApi: import("../player/WebdriverioWebDriverApi")
-    }} [testimStandaloneBrowser]
- */
-function initServer({
-    agentPort, agentBind, project, token,
-}, testimStandaloneBrowser) {
-    return new Promise((resolve, reject) => {
-        /**
-         * Init testim auth for making services request.
-         */
-        let initFn = () => { };
-        if (project) {
-            testimCustomToken.init(project, token);
-            initFn = (app) => {
-                app.use((req, res, next) => {
-                    req.project = project;
-                    next();
-                });
-            };
-        }
-
-        const app = require('./routers')(initFn, testimStandaloneBrowser);
-        const http = require('http');
-
-        /**
-         * Create HTTP server.
-         */
-
-        const server = http.createServer(app);
-
-        /**
-         * Listen on provided port, on all network interfaces.
-         */
-        server.listen(agentPort, agentBind);
-
-        // logger.info('Node Version', process.version);
-
-        server.on('error', onError);
-        server.on('listening', onListening);
-
-        /**
-         * Event listener for HTTP server "error" event.
-         */
-
-        function onError(error) {
-            if (error.syscall !== 'listen') {
-                return reject(error);
-            }
-
-            // handle specific listen errors with friendly messages
-            switch (error.code) {
-                case 'EACCES':
-                case 'EPERM':
-                    return reject(new ArgError(`Port ${agentPort} requires elevated privileges`));
-                case 'EADDRINUSE':
-                    return reject(new ArgError(`Port ${agentPort} is already in use, is another Testim instance running?`));
-                default:
-                    return reject(error);
-            }
-        }
-
-        /**
-         * Event listener for HTTP server "listening" event.
-         */
-
-        function onListening() {
-            const { port } = server.address();
-            // eslint-disable-next-line no-console
-            console.log(`Running on port: ${port}`);
-            showStartStopOptions();
-        }
-    });
-}
-
-function installExternalPackages({ installPlaygroundPlaywrightDeps, installPlaygroundPuppeteerDeps, installPlaygroundSeleniumDeps, project }) {
-    const all = [];
-    if (installPlaygroundPlaywrightDeps) {
-        all.push(lazyRequire('playwright'));
-    }
-
-    if (installPlaygroundPuppeteerDeps) {
-        all.push(lazyRequire('puppeteer'));
-    }
-
-    if (installPlaygroundSeleniumDeps) {
-        all.push(lazyRequire('selenium-webdriver'), prepareChromeDriver({ projectId: project }));
-    }
-
-    return Promise.all(all);
-}
-
-
-async function showStartStopOptions() {
-    const prompts = require('prompts');
-    const isMac = process.platform === 'darwin';
-    const sigint = 'Ctrl + C';
-    await prompts({
-        type: 'text',
-        message: `Type the word "stop" or Press ${sigint}.`,
-        validate: x => x.toUpperCase().trim() === 'STOP',
-    });
-    // eslint-disable-next-line no-console
-    console.log('Exiting Testim CLI');
-    process.exit(0);
-}

package/cdpTestRunner.js

@@ -1,86 +0,0 @@
-const WebSocket = require('ws');
-const { promiseFromCallback } = require('./utils');
-
-class CDPTestRunner {
-    constructor() {
-        this._cdpUrl = null;
-        this._cdpCallbacks = new Map();
-    }
-
-    async initSession(cdpUrl, timeout = 500) {
-        await this.stopSession();
-        this._cdpUrl = cdpUrl;
-        await this.initCDPWebsocket(timeout);
-    }
-
-    async initCDPWebsocket(timeout = 500) {
-        if (this._cdpWs) {
-            return this._cdpWs;
-        }
-        const websocket = new WebSocket(this._cdpUrl, { timeout });
-
-        const openPromise = promiseFromCallback((cb) => {
-            websocket.once('open', cb);
-        });
-
-        const errorPromise = promiseFromCallback((cb) => {
-            websocket.once('error', cb);
-        }).catch(() => {
-            websocket.close();
-            websocket.removeAllListeners();
-        });
-
-        websocket.on('message', (message) => this.onCDPMessage(message));
-
-        this._cdpWs = Promise.race([openPromise, errorPromise]).then(() => websocket);
-        return this._cdpWs;
-    }
-
-    onCDPMessage(message) {
-        const object = JSON.parse(message);
-        const callback = this._cdpCallbacks.get(object.id);
-        if (!callback) {
-            return;
-        }
-        this._cdpCallbacks.delete(object.id);
-        if (object.error) {
-            callback.reject(new Error(object.error));
-        } else if (object.result.exceptionDetails?.exception) {
-            callback.reject(new Error(object.result.exceptionDetails.exception.description));
-        } else {
-            callback.resolve(object.result);
-        }
-    }
-
-    async stopSession() {
-        const websocket = this._cdpWs;
-        this._cdpUrl = null;
-        this._cdpWs = null;
-        this._cdpCallbacks.clear();
-        if (websocket) {
-            try {
-                return await websocket.close();
-            } catch (e) {
-                return undefined;
-            }
-        }
-        return undefined;
-    }
-
-    async cdpCommand(method, params, sessionId) {
-        const websocket = await this.initCDPWebsocket();
-        this._lastWsId = this._lastWsId || 0;
-        const id = this._lastWsId++;
-        const result = new Promise((resolve, reject) => {
-            this._cdpCallbacks.set(id, { resolve, reject });
-        });
-        const msg = { method, params, id };
-        if (sessionId) {
-            Object.assign(msg, { sessionId });
-        }
-        websocket.send(JSON.stringify(msg));
-        return result;
-    }
-}
-
-module.exports = CDPTestRunner;

package/chromiumInstaller.js

@@ -1,91 +0,0 @@
-const path = require('path');
-const os = require('os');
-const fs = require('fs-extra');
-const { ArgError } = require('./errors');
-const { downloadAndSave, unzipFile, TESTIM_BROWSER_DIR } = require('./utils');
-const ora = require('ora');
-
-
-const CHROMIUM_VERSION = '1000968'; // '973306' = 101.0.4899.0  '1000968' = 103.0.5046.0;
-const DOWNLOAD_CHROME_FOLDER = path.join(TESTIM_BROWSER_DIR, `chrome-${CHROMIUM_VERSION}`);
-
-function getCurrentPlatform() {
-    const osType = os.type().toLowerCase();
-    if (osType === 'darwin') {
-        return os.arch() === 'arm' ? 'mac_arm' : 'mac';
-    }
-    if (osType === 'windows_nt') {
-        return os.arch() === 'x64' ? 'win64' : 'win32';
-    }
-    return 'linux';
-}
-
-async function downloadAndInstallChromium() {
-    /** Inspired by puppeteer's implementation https://github.com/puppeteer/puppeteer/blob/main/src/node/BrowserFetcher.ts#L45 */
-    const platform = getCurrentPlatform();
-
-    // example download url: https://storage.googleapis.com/chromium-browser-snapshots/Mac/1000968/chrome-mac.zip
-    const storageBaseUrl = 'https://storage.googleapis.com/chromium-browser-snapshots';
-    const platformFolder = {
-        linux: 'Linux_x64',
-        mac: 'Mac',
-        mac_arm: 'Mac_Arm', // eslint-disable-line camelcase
-        win32: 'Win',
-        win64: 'Win_x64',
-    };
-    if (!(platform in platformFolder)) {
-        throw new ArgError(`Unsupported platform: ${platform}`);
-    }
-    // Windows archive name changed at r591479.
-    const winArchiveName = parseInt(CHROMIUM_VERSION, 10) > 591479 ? 'chrome-win' : 'chrome-win32';
-    const platformArchiveName = {
-        linux: 'chrome-linux',
-        mac: 'chrome-mac',
-        mac_arm: 'chrome-mac', // eslint-disable-line camelcase
-        win32: winArchiveName,
-        win64: winArchiveName,
-    };
-    const binaryPaths = {
-        linux: 'chrome',
-        mac: 'Chromium.app/Contents/MacOS/Chromium',
-        mac_arm: 'Chromium.app/Contents/MacOS/Chromium', // eslint-disable-line camelcase
-        win32: 'chrome.exe',
-        win64: 'chrome.exe',
-    };
-    const downloadUrl = `${storageBaseUrl}/${platformFolder[platform]}/${CHROMIUM_VERSION}/${platformArchiveName[platform]}.zip`;
-    const downloadArchivePath = path.join(DOWNLOAD_CHROME_FOLDER, platformArchiveName[platform]);
-    const downloadedZipFile = `${downloadArchivePath}.zip`;
-    const binaryPath = path.join(downloadArchivePath, binaryPaths[platform]);
-
-    if (await fs.pathExists(binaryPath)) {
-        return binaryPath;
-    }
-    if (!(await fs.pathExists(downloadedZipFile))) {
-        const downloadSpinner = ora('Downloading Chromium').start();
-        try {
-            await fs.mkdirp(DOWNLOAD_CHROME_FOLDER);
-            await downloadAndSave(downloadUrl, downloadedZipFile);
-            // todo - We can add a failover here if the download fails if we host the file too
-        } catch (e) {
-            const errorMessage = `Failed to download Chromium: ${e.message}`;
-            downloadSpinner.fail(errorMessage);
-            throw new Error(errorMessage);
-        }
-        downloadSpinner.succeed();
-    }
-    const extractSpinner = ora('Extracting Chromium').start();
-    try {
-        await unzipFile(downloadedZipFile, DOWNLOAD_CHROME_FOLDER);
-    } catch (e) {
-        const errorMessage = `Failed to extract Chromium: ${e.message}`;
-        extractSpinner.fail(errorMessage);
-        throw new Error(errorMessage);
-    }
-    extractSpinner.succeed();
-    return binaryPath;
-}
-
-module.exports = {
-    CHROMIUM_VERSION,
-    downloadAndInstallChromium,
-};

package/cli/isCiRun.js

@@ -1,10 +0,0 @@
-"use strict";
-
-// copied from https://github.com/watson/ci-info/blob/master/index.js
-module.exports.isCi = !!(
-    process.env.CI || // Travis CI, CircleCI, Cirrus CI, Gitlab CI, Appveyor, CodeShip, dsari
-    process.env.CONTINUOUS_INTEGRATION || // Travis CI, Cirrus CI
-    process.env.BUILD_NUMBER || // Jenkins, TeamCity
-    process.env.RUN_ID || // TaskCluster, dsari
-    false
-);

package/cli/onExit.js

@@ -1,65 +0,0 @@
-'use strict';
-
-const constants = require('../commons/constants');
-const { requireWithFallback } = require('../commons/requireWithFallback');
-const { isCi } = require('./isCiRun');
-const { writeStackTrace } = require('./writeStackTrace');
-const logger = require('../commons/logger').getLogger('process-handler');
-
-let exitCodeIgnoreFailingTests = false;
-
-function getExitCode(result) {
-    if (result instanceof Error) {
-        return 1;
-    }
-
-    if (exitCodeIgnoreFailingTests) {
-        return 0;
-    }
-
-    result = result || {};
-    const hasFailedTests = Object.values(result).some(
-        ({ runnerStatus, success, testStatus, status }) => {
-            if (
-                [runnerStatus, status].includes(constants.runnerTestStatus.SKIPPED) ||
-                ([runnerStatus, status].includes(constants.runnerTestStatus.FAILED) &&
-                    testStatus === constants.testStatus.EVALUATING)
-            ) {
-                return false;
-            }
-            return success !== true;
-        }
-    );
-
-    return hasFailedTests ? 1 : 0;
-}
-
-function closeChromeDriverIfRunning() {
-    try {
-        const chromedriver = requireWithFallback('chromedriver');
-        chromedriver.stop();
-    // eslint-disable-next-line no-empty
-    } catch (err) { }
-}
-
-module.exports.ignoreFailingTestsInExitCode = function () {
-    exitCodeIgnoreFailingTests = true;
-};
-
-
-module.exports.onExit = async function onExit(exitValue) {
-    if (exitValue?.stack) {
-        if (!isCi) {
-            writeStackTrace(exitValue);
-        } else {
-            // eslint-disable-next-line no-console
-            console.error(exitValue, exitValue.stack);
-        }
-    }
-
-    closeChromeDriverIfRunning();
-
-    await logger.waitForFlush();
-
-    process.exit(getExitCode(exitValue));
-};

package/cli/writeStackTrace.js

@@ -1,27 +0,0 @@
-/* eslint-disable no-console */
-
-const os = require('os');
-const path = require('path');
-const chalk = require('chalk');
-const fse = require('fs-extra');
-
-module.exports.writeStackTrace = function writeStackTrace(err) {
-    if (err?.message?.includes('SIGINT')) {
-        return; // no need to generate a log file for a sigint.
-    }
-    try {
-        const homedir = os.homedir();
-
-        fse.ensureDirSync(path.resolve(homedir, '.testim_logs'));
-        const logFileName = path.resolve(homedir, '.testim_logs', `${new Date().toISOString().replace(/:|\./g, '_')}.log`);
-        console.log('Oops :( The test runner has encountered an unexpected error. A complete log of this run can be found in:');
-        console.log(`\t${logFileName}`);
-
-        if (err?.message?.includes('Unable to compile TypeScript') && err.stack.includes('runner/src') && process.argv.some(x => x.includes('player-require-path'))) {
-            console.log(chalk.red('Looks like you got a TypeScript compile error champ - but it\'s not a very good one because we use TypeScript in transpile-only mode'));
-            console.log(chalk.red('change require(\'ts-node/register/transpile-only\'); to require(\'ts-node/register\'); for better errors'));
-        }
-
-        fse.writeFileSync(logFileName, `${err}\n${err.stack}\n\n${JSON.stringify(err, Object.getOwnPropertyNames(err), 2)}`);
-    } catch { /* noop */ }
-};