@testim/testim-cli 3.285.0 → 3.287.0

package/agent/routers/cliJsCode/service.js

@@ -2,18 +2,20 @@
 
 'use strict';
 
-const path = require('path');
+const fs = require('fs');
 const os = require('os');
-const dataUriToBuffer = require('data-uri-to-buffer');
-const { spawn: threadSpawn, config } = require('threads');
+const path = require('path');
 const fse = require('fs-extra');
-const fs = require('fs');
+const dataUriToBuffer = require('data-uri-to-buffer');
 const utils = require('../../../utils');
-const logger = require('../../../commons/logger').getLogger('cli-service');
-const { getS3Artifact } = require('../../../commons/testimServicesApi');
 const npmWrapper = require('../../../commons/npmWrapper');
 const featureFlags = require('../../../commons/featureFlags');
+const { spawn: threadSpawn, config } = require('threads');
 const { TimeoutError } = require('../../../errors');
+const { getLogger } = require('../../../commons/logger');
+const { getS3Artifact } = require('../../../commons/testimServicesApi');
+
+const logger = getLogger('cli-service');
 
 /** @type {import('worker_threads') | false} */
 let workerThreads;
@@ -270,16 +272,17 @@ function runCode(transactionId, incomingParams, context, code, packageLocalLocat
         .finally(() => thread?.kill());
 }
 
-function requireOrImportMethod(path) {
+/** @param {string} _path */
+function requireOrImportMethod(_path) {
     try {
-        return { sync: true, lib: require(path) };
+        return { sync: true, lib: require(_path) };
     } catch (err) {
         if (err.code === 'ERR_REQUIRE_ESM') {
             const pathModule = require('path');
 
             const lib = fs.promises.readFile(`${path}${pathModule.sep}package.json`).then(file => {
                 const packageJson = JSON.parse(file);
-                const fullPath = pathModule.join(path, packageJson.main || `${pathModule.sep}index.js`);
+                const fullPath = pathModule.join(_path, packageJson.main || `${pathModule.sep}index.js`);
                 return import(fullPath);
             });
 
@@ -563,6 +566,7 @@ function runCodeWithWorkerThread(
         .finally(() => thread?.terminate());
 }
 
+/** @param {string} installFolder */
 async function removeFolder(installFolder) {
     try {
         await fse.remove(installFolder);
@@ -571,10 +575,24 @@ async function removeFolder(installFolder) {
     }
 }
 
+/**
+ * @param {string} stepResultId
+ * @param {string} testResultId
+ * @param {string} stepId
+ * @param {number} retryIndex
+ */
 function getTransactionId(stepResultId, testResultId, stepId, retryIndex) {
     return `${testResultId}_${stepId}_${stepResultId}_${retryIndex}`;
 }
 
+/**
+ * @param {string} stepId
+ * @param {string} testResultId
+ * @param {number} retryIndex
+ * @param {{ packageName: string; packageVersion: string }[]} packageData
+ * @param {string} stepResultId
+ * @param {number} timeout
+ */
 function installPackage(stepId, testResultId, retryIndex, packageData, stepResultId, timeout) {
     const transactionId = getTransactionId(stepResultId, testResultId, stepId, retryIndex);
     return runNpmInstall(transactionId, packageData, timeout).then(({ data }) => data);
@@ -622,6 +640,11 @@ function runCodeWithPackages(code, stepId, incomingParams, context, testResultId
     }).then(res => Object.assign({}, res, { nodeVersion: process.version }));
 }
 
+/**
+ * @param {string} transactionId
+ * @param {{ packageName: string; packageVersion: string }[]} packageData
+ * @param {number} timeout
+ */
 async function runNpmInstall(transactionId, packageData, timeout) {
     const packages = packageData.map(data => `${data.packageName}@${data.packageVersion}`);
     const localPackageInstallFolder = getLocalPackageInstallFolder();

package/agent/routers/codim/service.js

@@ -150,19 +150,22 @@ async function compileFunctionsLibrary({ fileSystem, bypassWebpack } = {}, optio
         const Module = require('module');
         // attempt to require without webpack compile - useful for puppeteer/selenium hybrid
         const originalRequire = Module.prototype.require;
-        Module.prototype.require = function requireThatOverridesSessionPlayer(id) {
+        Module.prototype.require = function requireThatOverridesTestimTDK(id) {
             if (id === 'testim') {
                 return bypassWebpack.testim;
             }
             // eslint-disable-next-line prefer-rest-params
             return originalRequire.apply(this, arguments);
         };
-        // delete references to the old __testim from previous invocations
-        delete require.cache[require.resolve(functionsFile)];
-        const functions = require(functionsFile);
-        // asynchronous required not supported - is this fine?
-        Module.prototype.require = originalRequire;
-        return functions;
+        try {
+            // delete references to the old __testim from previous invocations
+            delete require.cache[require.resolve(functionsFile)];
+            const functions = require(functionsFile); // eslint-disable-line import/no-dynamic-require
+            // asynchronous require not supported - is this fine?
+            return functions;
+        } finally {
+            Module.prototype.require = originalRequire;
+        }
     }
     const functionsAsAWebpackModule = await buildCodeTests([functionsFile], {
         output: {

package/cli/writeStackTrace.js

@@ -1,26 +1,27 @@
+/* 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 && err.message && err.message.includes('SIGINT')) {
+    if (err?.message?.includes('SIGINT')) {
         return; // no need to generate a log file for a sigint.
     }
     try {
-        const homedir = require('os-homedir')();
-        const fse = require('fs-extra');
-        const path = require('path');
+        const homedir = os.homedir();
 
         fse.ensureDirSync(path.resolve(homedir, '.testim_logs'));
-        const logfilename = path.resolve(homedir, '.testim_logs', new Date().toISOString().replace(/:|\./g, '_') + '.log');
+        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}`);
+        console.log(`\t${logFileName}`);
 
-        if (err && err.message && err.message.includes('Unable to compile TypeScript') && err.stack.includes('runner/src')
-            && process.argv.some(x => x.includes('player-require-path'))) {
-                const chalk = require('chalk');
+        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`));
+            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 (err) { }
-}
+        fse.writeFileSync(logFileName, `${err}\n${err.stack}\n\n${JSON.stringify(err, Object.getOwnPropertyNames(err), 2)}`);
+    } catch { /* noop */ }
+};

package/cli.js

@@ -4,26 +4,23 @@
 'use strict';
 
 require('./polyfills');
-const options = require('./runOptions');
+const semver = require('semver');
 const EventEmitter = require('events');
-const logger = require('./commons/logger').getLogger('cli-entry');
-const { onExit, ignoreFailingTestsInExitCode } = require('./cli/onExit');
+const utils = require('./utils');
 const testRunner = require('./runner');
+const options = require('./runOptions');
+const agentMode = require('./cliAgentMode');
+const perf = require('./commons/performance-logger');
 const prepareRunner = require('./commons/prepareRunner');
+const prepareRunnerAndTestimStartUtils = require('./commons/prepareRunnerAndTestimStartUtils');
+const { getLogger } = require('./commons/logger');
 const { CLI_MODE } = require('./commons/constants');
+const { registerProcessForCleanup } = require('./processHandler');
+const { NoArgsError, SeleniumError, ArgError } = require('./errors');
+const { onExit, ignoreFailingTestsInExitCode } = require('./cli/onExit');
 const { updateRemoteRunFailure } = require('./commons/testimServicesApi');
-const prepareRunnerAndTestimStartUtils = require('./commons/prepareRunnerAndTestimStartUtils');
 
-const {
-    NoArgsError,
-    SeleniumError,
-    ArgError,
-} = require('./errors');
-
-const utils = require('./utils');
-const semver = require('semver');
-const perf = require('./commons/performance-logger');
-const agentMode = require('./cliAgentMode');
+const logger = getLogger('cli-entry');
 
 try {
     require('./fixLocalBuild');
@@ -56,7 +53,7 @@ async function checkNodeVersion() {
 async function main() {
     console.log('Starting Testim.io CLI');
     perf.log('Starting Testim.io CLI');
-    require('./processHandler')(onExit);
+    registerProcessForCleanup(onExit);
 
     checkNodeVersion().catch(err => {
         console.log('Argument Error:', err.message);

package/commons/featureFlags.js

@@ -62,6 +62,7 @@ class FeatureFlagsService {
             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);
     }

package/commons/getSessionPlayerRequire.js

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

package/commons/httpRequestCounters.js

@@ -62,13 +62,13 @@ module.exports.makeCounters = () => {
      * @template T, TArgs
      * @param {(...args: TArgs[]) => T} fn
      * @param {string=} name
-     * @return {(...args: TArgs[]) => Promise<Awaited<T>>}
+     * @return {(...args: TArgs[]) => Promise<T>}
      */
     function wrapWithMonitoring(fn, name = fn.name) {
         return async function (...args) {
             update(counters.call, name);
             try {
-                const result = await fn.call(this, ...args);
+                const result = await fn.call(null, ...args);
                 update(counters.success, name);
                 return result;
             } catch (e) {

package/commons/initializeUserWithAuth.js

@@ -15,7 +15,7 @@ function preloadSlowRequires(mode) {
         }
         // heuristic to pay the cost of loading the sessionPlayer here while we are waiting for the backend
         try {
-            require('./getSessionPlayerRequire');
+            require('./getSessionPlayerRequire').getSessionPlayer();
             // jsdom for the same reason, we don't require workerSelenium here since it actually takes longer to load
             // then it takes for the backend to return 🤯
             require('jsdom');

package/commons/testimDesiredCapabilitiesBuilder.js

@@ -529,7 +529,11 @@ function buildSeleniumOptions(browserOptions, testName, testRunConfig, gridInfo,
          * One level targeting (either grid provider, host, browser name or browser version): { "devicefarm": { selenium_version: '3.141.59' } }
          * Two level targeting: { "internet explorer": { "11": { selenium_version: '3.141.59' } } }
          */
-        const hostToProvider = { 'hub.lambdatest.com': 'lambdatest', 'public-grid.testim.io': 'testim', 'testgrid-devicefarm.us-west-2.amazonaws.com': 'devicefarm' };
+        const hostToProvider = {
+            'hub.lambdatest.com': 'lambdatest',
+            [featureFlags.flags.publicGridURL.getValue()]: 'testim',
+            'testgrid-devicefarm.us-west-2.amazonaws.com': 'devicefarm',
+        };
         const byGrid = (capabilities) => capabilities[gridInfo.provider] || capabilities[opts.host] || capabilities[hostToProvider[opts.host]];
         const getTargetingGroup = capabilities =>
             byGrid(capabilities) ||
@@ -576,6 +580,7 @@ function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp, o
         hostname: gridInfo.host,
         port: gridInfo.port,
         path: `/v0/${gridInfo.accessToken}/wd/hub`,
+        logLevel: options.appiumLogLevel,
         // connectionRetryTimeout: 900000, -- not used for now
     };
     //TODO: check if more caps should be defined as default