@testim/testim-cli 3.207.0 → 3.213.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.207.0",
+  "version": "3.213.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -60,8 +60,6 @@
     "bluebird": "3.7.2",
     "bluebird-retry": "0.11.0",
     "body-parser": "1.19.0",
-    "winston": "3.3.3",
-    "winston-transport": "4.4.0",
     "chalk": "4.1.0",
     "chrome-launcher": "0.13.4",
     "combine-source-map": "0.8.0",
@@ -89,7 +87,6 @@
     "moment": "2.25.3",
     "ms": "2.1.2",
     "npm": "6.14.11",
-    "npm-registry-client": "8.6.0",
     "object-hash": "2.0.3",
     "ora": "4.0.4",
     "pako": "1.0.11",
@@ -107,6 +104,8 @@
     "threads": "0.12.0",
     "ua-parser-js": "0.7.28",
     "validate-npm-package-name": "3.0.0",
+    "winston": "3.3.3",
+    "winston-transport": "4.4.0",
     "ws": "8.2.3",
     "xml2js": "0.4.23",
     "yaml": "1.10.0"
@@ -116,7 +115,6 @@
     "testim": "cli.js"
   },
   "scripts": {
-    "postpublish": "scripts/publish-docker.js",
     "test": "IS_UNIT_TEST=1 ./node_modules/mocha/bin/_mocha --timeout 2000  --reporter spec --exit --recursive \"./src/**/*.test.js\" --exclude ./src/codim/template.js/tests/examples/**/*.test.js",
     "test:watch": "IS_UNIT_TEST=1 ./node_modules/mocha/bin/_mocha --timeout 2000 --exit --recursive \"./src/**/*.test.js\"  --exclude ./src/codim/template.js/tests/examples/**/*.test.js --watch",
     "test:cov": "nyc --reporter=lcov --reporter=text yarn test",

package/player/seleniumTestPlayer.js

@@ -4,7 +4,6 @@ const TabService = require('./services/tabService');
 const PortSelector = require('./services/portSelector');
 const windowCreationListener = require('./services/windowCreationListener');
 const CookieUtils = require('./utils/cookieUtils');
-const downloadsApiUtils = require('./utils/downloadsApiUtils');
 const FrameLocator = require('./services/frameLocator');
 const Promise = require('bluebird');
 const { isDebuggerConnected } = require('../commons/detectDebugger');
@@ -46,11 +45,21 @@ class SeleniumTestPlayer {
 
         this.tabService.createSesion(id);
 
-        this.sessionPlayer = new player(id, this.tabService, CookieUtils(this.driver),
-            windowCreationListener, FrameLocator(this.driver), PortSelector,
-            null, downloadsApiUtils, stepActionUtils,
-            this.stepActionFactory, this.playbackTimeoutCalculator, testResultService.getSocket(),
-            automationMode);
+        this.sessionPlayer = new player(
+            id,
+            this.tabService,
+            CookieUtils(this.driver),
+            windowCreationListener,
+            FrameLocator(this.driver),
+            PortSelector,
+            null,
+            null /* Not in use, placeholder for the order of arguments */,
+            stepActionUtils,
+            this.stepActionFactory,
+            this.playbackTimeoutCalculator,
+            testResultService.getSocket(),
+            automationMode,
+        );
 
         if (this.sessionPlayer.setShouldMonitorPerformance) {
             this.sessionPlayer.setShouldMonitorPerformance(shouldMonitorPerformance);

package/player/services/tabService.js

@@ -350,14 +350,16 @@ class TabService {
                     mainTabPromise = this.driver.executeJS('return window.__isMainTestimTab').get('value');
                 }
 
-                return Promise.props({ title: this.driver.getTitle(), url: this.driver.getUrl(), isMainTab: mainTabPromise })
-                    .catch(err => {
+                return Promise.all([this.driver.getTitle(), this.driver.getUrl(), mainTabPromise]).then(
+                    ([title, url, isMainTab]) => ({ title, url, isMainTab }),
+                    err => {
                         logger.error('failed to get url or title', { err });
                         return {
                             title: '',
                             url: '',
                         };
-                    });
+                    },
+                );
             })
             .catch(err => {
                 logger.error('failed to switch to tab', { tabId, err });

package/player/stepActions/inputFileStepAction.js

@@ -34,7 +34,10 @@ class InputFileStepAction extends StepAction {
             top: '10px',
         };
         return this.forceInputToBeVisible(target, options)
-            .tapCatch(err => logger.error('failed to set input file in Safari recovery', { err }));
+            .catch(err => {
+                logger.error('failed to set input file in Safari recovery', { err });
+                throw err;
+            });
     }
 
     uploadFilesAndForceVisibility(gridLocalFiles, target) {

package/player/stepActions/pixelValidationStepAction.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const _ = require('lodash');
 const StepAction = require('./stepAction');
 const { eyeSdkService } = require('../utils/eyeSdkService');
 const logger = require('../../commons/logger').getLogger('pixel-validation-step-action');
@@ -9,6 +10,7 @@ class PixelValidationStepAction extends StepAction {
     async performAction() {
         const { shouldUseVisualGrid, applitoolsSdkConfig: config, testResultId } = this.context;
         this.runContext = this.context.getRunContext(undefined);
+        const finalParams = (this.runContext.incomingParams && this.runContext.incomingParams.final) || {};
         const batchId = (config.batch && config.batch.id) || testResultId;
         const eyeManager = await eyeSdkService.getManager(shouldUseVisualGrid, this.context.config.applitoolsConcurrency || 5, batchId, this.runContext.applitoolsIntegrationData);
         const targetElementData = this.getTarget() || {};
@@ -16,7 +18,12 @@ class PixelValidationStepAction extends StepAction {
         try {
             const openedEye = await eyeManager.openEyes({ driver: this.driver.client, config });
             const region = (this.step.action === 'element' && targetElementData.seleniumElement) || undefined;
-            await openedEye.check({ settings: { region, fully: this.step.action === 'stitched' } });
+            const settings = { region, fully: this.step.action === 'stitched' };
+            if (finalParams.applitoolsStepSettings && _.isPlainObject(finalParams.applitoolsStepSettings)) {
+                Object.assign(settings, finalParams.applitoolsStepSettings);
+                logger.info('Applitools SDK step executed with applitoolsStepSettings parameter', { applitoolsStepSettings: finalParams.applitoolsStepSettings });
+            }
+            await openedEye.check({ settings });
             const eyesResults = await openedEye.close();
 
             result = { isApplitoolsSdkResult: true, success: true, eyesResults };

package/player/utils/imageCaptureUtils.js

@@ -290,7 +290,7 @@ ImageCaptureUtils.prototype = {
         }
 
         return Promise.all([windowUtil.getFullPageSize(), windowUtil.getViewportSize()])
-            .spread((fullPageSize, viewPortSize) => createStitchImage(fullPageSize, viewPortSize));
+            .then(([fullPageSize, viewPortSize]) => createStitchImage(fullPageSize, viewPortSize));
     },
 };
 

package/player/utils/screenshotUtils.js

@@ -1,10 +1,10 @@
-"use strict";
+'use strict';
 
 const Promise = require('bluebird');
 const utils = require('../../utils');
 
 class ScreenshotUtils {
-    constructor(tabId, driver, options = { takeScreenshots: true}){
+    constructor(tabId, driver, options = { takeScreenshots: true }) {
         this.tabId = tabId;
         this.driver = driver;
         this.options = options;
@@ -30,12 +30,12 @@ class ScreenshotUtils {
         const devicePixelRatioPromise = this.currentDevicePixelRatio ? Promise.resolve(this.currentDevicePixelRatio) : this.getDevicePixelRatio();
         const getScreenshot = () => Promise.all([devicePixelRatioPromise, this.driver.takeScreenshot()]);
         return utils.runWithRetries(getScreenshot, MAX_RETRY_COUNT, SCREENSHOT_RETRY_DELAY)
-            .spread((devicePixelRatio, image) => {
+            .then(([devicePixelRatio, image]) => {
                 const base64 = image ? image.value : '';
-                const dataUrl = "data:image/png;base64," + this.base64AddPadding(base64.replace(/[\r\n]/g, ''));
+                const dataUrl = `data:image/png;base64,${this.base64AddPadding(base64.replace(/[\r\n]/g, ''))}`;
                 return {
                     image: dataUrl,
-                    devicePixelRatio: devicePixelRatio
+                    devicePixelRatio,
                 };
             });
     }
@@ -52,7 +52,7 @@ class ScreenshotUtils {
         return this.driver.executeJS(devicePixelRatioJS).then(result => Promise.resolve(result.value));
     }
 
-    forcePixelRatio(forceRatio = 1){
+    forcePixelRatio(forceRatio = 1) {
         this.currentDevicePixelRatio = forceRatio;
         return Promise.resolve();
     }

package/player/utils/stepActionUtils.js

@@ -74,8 +74,8 @@ class StepActionUtils {
         return this.cookieUtils.set(cookieObject).then(cookie => [cookie]);
     }
 
-    getNextDynamicParent(frameHandler, parentId, contextMatchThreshold, nextParentId, firstChildValues) {
-        const code = `return ${codeSnippets.getNextDynamicParent(parentId, firstChildValues, contextMatchThreshold, nextParentId)}`;
+    getNextDynamicParent(frameHandler, dynamicParentOptions) {
+        const code = `return ${codeSnippets.getNextDynamicParent(dynamicParentOptions)}`;
         return this.driver.executeJS(code).then(res => res.value);
     }
 }

package/runOptions.js

@@ -287,6 +287,8 @@ program
     .option('--tunnel [tunnel]', 'enable tunnel')
     .option('--tunnel-port [tunnel-port]', 'tunnel port address')
     .option('--tunnel-host-header [tunnel-host-header]', 'tunnel host header')
+    .option('--tunnel-region [tunnel-region]', 'ngrok tunnel region')
+    .option('--tunnel-diagnostics', 'collect ngrok tunnel diagnostics')
     .option('--tunnel-use-http-address [tunnel-use-http-address]', 'use http:// address instead of https://', false)
     .option('--external-lambdatest-tunnel-id [tunnel-id]', 'use existing lambdatest tunnel id')
     .option('--external-lambdatest-use-wss', 'use wss instead of ssh for LT', false)
@@ -527,14 +529,9 @@ module.exports = {
             return Promise.reject(new ArgError('missing --tunnel parameter'));
         }
 
-        if (!program.tunnel && program.tunnelPort) {
+        if (!program.tunnel && [program.tunnelPort, program.tunnelHostHeader, program.tunnelRegion, program.tunnelDiagnostics].some(Boolean)) {
             return Promise.reject(new ArgError('missing --tunnel parameter'));
         }
-
-        if (!program.tunnel && program.tunnelHostHeader) {
-            return Promise.reject(new ArgError('missing --tunnel parameter'));
-        }
-
         if (program.chromeExtraPrefs) {
             try {
                 chromeExtraPrefs = require(path.join(process.cwd(), program.chromeExtraPrefs));
@@ -1089,6 +1086,8 @@ module.exports = {
             tunnel: program.tunnel,
             tunnelPort: program.tunnelPort,
             tunnelHostHeader: program.tunnelHostHeader,
+            tunnelRegion: program.tunnelRegion,
+            tunnelDiagnostics: program.tunnelDiagnostics,
             tunnelUseHttpAddress: program.tunnelUseHttpAddress,
             externalLambdatestTunnelId: program.externalLambdatestTunnelId,
             externalLambdatestUseWss: program.externalLambdatestUseWss || false,

package/runners/ParallelWorkerManager.js

@@ -63,6 +63,7 @@ class ParallelWorkerManager {
             const source = options.source || 'cli';
             const user = options.user;
             const companyPlan = options.company && options.company.planType;
+            const isStartUp = options.company && options.company.isStartUp;
             const projectName = options.projectData && options.projectData.name;
             const lightweightMode = options.lightweightMode;
             const sessionType = utils.getSessionType(options);
@@ -82,6 +83,7 @@ class ParallelWorkerManager {
                     source,
                     user,
                     lightweightMode,
+                    isStartUp,
                 });
                 return testStatus.testStartAndReport(wid, executionId, resultId, isRerun, testRetryKey);
             };
@@ -146,6 +148,7 @@ class ParallelWorkerManager {
                     user,
                     lightweightMode,
                     logger,
+                    isStartUp,
                 });
                 if (stopOnError && !testResult.success) {
                     reject(new StopRunOnError());

package/services/analyticsService.js

@@ -31,7 +31,7 @@ function setLightweightAnalytics(properties, lightweightMode) {
 }
 
 function analyticsTestStart({
-    executionId, projectId, testId, resultId, companyId, companyName, projectName, companyPlan, sessionType, source, user, lightweightMode,
+    executionId, projectId, testId, resultId, companyId, companyName, projectName, companyPlan, sessionType, source, user, lightweightMode, isStartUp,
 }) {
     const properties = setLightweightAnalytics({
         executionId,
@@ -44,13 +44,14 @@ function analyticsTestStart({
         companyPlan,
         sessionType,
         source: calcSource(source, user),
+        isStartUp,
     }, lightweightMode);
     analytics.trackWithCIUser('test-run-ci', properties);
 }
 
 function analyticsTestEnd({
     executionId, projectId, testId, resultId, result, companyId, companyName, projectName, companyPlan, sessionType, source, user, lightweightMode,
-    logger,
+    logger, isStartUp,
 }) {
     try {
         const properties = setLightweightAnalytics({
@@ -65,6 +66,7 @@ function analyticsTestEnd({
             sessionType,
             mockNetworkEnabled: result.wasMockNetworkActivated,
             source: calcSource(source, user),
+            isStartUp,
         }, lightweightMode);
 
         if (result.success) {

package/testRunHandler.js

@@ -18,6 +18,8 @@ const { SeleniumPerfStats } = require('./commons/SeleniumPerfStats');
 const { preloadTests } = require('./commons/preloadTests');
 
 const RETRIES_ON_TIMEOUT = 3;
+const MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE = 50 * 1000; // max size, in characters, of stringified run data sent over URL params. Chosen arbitrarily, this value should be changed according to data.
+const canSendRunDataOverUrl = (runData) => JSON.stringify(runData).length < MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE;
 
 const TestRun = function (executionId, executionName, test, options, branchToUse, testRunStatus) {
     this._executionId = executionId;
@@ -175,7 +177,13 @@ TestRun.prototype.getRunRequestParams = async function () {
 
     if (this._options.lightweightMode && this._options.lightweightMode.general) {
         runRequestParams.company = this._options.company;
-        runRequestParams.runData = this.getRunData();
+        const runData = this.getRunData();
+        runRequestParams.lightweightMode.isRunDataSentInUrl = canSendRunDataOverUrl(runData);
+        if (runRequestParams.lightweightMode.isRunDataSentInUrl) {
+            runRequestParams.runData = runData;
+        } else {
+            logger.warn(`Run data is too big to be sent as a URL param (lightweight mode). Run data size: ${JSON.stringify(runData).length} (limit: ${MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE} characters)`);
+        }
         runRequestParams.isLocalRun = Boolean(this._options.useLocalChromeDriver || this._options.useChromeLauncher);
     }
 
@@ -240,7 +248,7 @@ TestRun.prototype.clearTestResult = function () {
     const mustClearPreviousStepResults = !this.isAllowReportTestResultRetries() && (this._timeoutRetryCount > 1 || this._retryCount > 1);
 
     if (this._options.lightweightMode && this._options.lightweightMode.disableResults &&
-        !mustClearPreviousStepResults) {
+            !mustClearPreviousStepResults && canSendRunDataOverUrl(runData)) {
         return Promise.resolve();
     }
 

package/workers/BaseWorker.js

@@ -8,7 +8,7 @@ const { timeoutMessages, testRunStatus, stepResult, runnerTestStatus } = require
 const logger = require('../commons/logger').getLogger('base-worker');
 const testResultService = require('../commons/socket/testResultService');
 const remoteStepService = require('../commons/socket/remoteStepService');
-const { isNetworkHealthy } = require('../commons/httpRequest');
+const { isNetworkHealthy, didNetworkConnectivityTestFail } = require('../commons/httpRequest');
 const testimServicesApi = require('../commons/testimServicesApi');
 const gridService = require('../services/gridService');
 const LambdatestService = require('../services/lambdatestService');
@@ -264,13 +264,14 @@ class BaseWorker {
                 return undefined;
             }
         };
+        const getNetworkErrorMessage = () => 'Due to network connectivity issues, Testim CLI has been unable to connect to the grid.\n' +
+                                             `Please make sure the CLI has stable access to the internet. ${didNetworkConnectivityTestFail() ? '(Internal: network connectivity test failed)' : ''}`;
 
-        const buildError = (err) => {
-            if (!isNetworkHealthy() && featureFlags.flags.errorMessageOnBadNetwork.isEnabled()) {
+        const buildError = (err, wasNetworkHealthy) => {
+            if (!wasNetworkHealthy && featureFlags.flags.errorMessageOnBadNetwork.isEnabled()) {
                 return {
                     errorType: NETWORK_ERROR,
-                    reason: 'Due to network connectivity issues, Testim CLI has been unable to connect to the grid.' +
-                        'Please make sure the CLI has stable access to the internet.',
+                    reason: getNetworkErrorMessage(),
                 };
             }
 
@@ -324,17 +325,16 @@ class BaseWorker {
         };
 
         const onRunError = async (err, testRunHandler) => {
-            if (!isNetworkHealthy() && featureFlags.flags.warnOnBadNetwork.isEnabled()) {
+            const wasNetworkHealthy = await isNetworkHealthy();
+            if (!wasNetworkHealthy && featureFlags.flags.warnOnBadNetwork.isEnabled()) {
                 // intentional, we want to log to stderr:
                 // eslint-disable-next-line no-console
-                console.warn('Due to network connectivity issues, Testim CLI has been unable to connect to the grid.');
-                // eslint-disable-next-line no-console
-                console.warn('Please make sure the CLI has stable access to the internet.');
+                console.warn(getNetworkErrorMessage());
             }
             logger.warn('error on run', { err });
 
             const projectId = this.userData && this.userData.projectId;
-            const { errorType, reason } = buildError(err);
+            const { errorType, reason } = buildError(err, wasNetworkHealthy);
             testimServicesApi.updateTestResult(projectId, this.testResultId, this.testId, {
                 status: testRunStatus.COMPLETED,
                 success: false,

package/workers/WorkerExtension.js

@@ -87,7 +87,10 @@ class WorkerExtension extends BaseWorker {
                 .then(url => {
                     reporter.onWaitToTestStart(this.id);
                     return Promise.all([
-                        driver.url(url).tap(() => { startStausDetails.driverUrlFinished = true; }).tapCatch(err => logger.error('error from driver.url', { err, testResultId, executionId, testId })),
+                        driver.url(url).tap(() => { startStausDetails.driverUrlFinished = true; }).catch(err => {
+                            logger.error('error from driver.url', { err, testResultId, executionId, testId, url, urlLength: url.length });
+                            throw err;
+                        }),
                         testRunHandler.onStarted(TEST_START_TIMEOUT_MS).tap(() => { startStausDetails.testRunHandlerStartedFinished = true; }),
                     ])
                         .timeout(TEST_START_TIMEOUT_MS, timeoutMessages.TEST_START_TIMEOUT_MSG)
@@ -110,7 +113,7 @@ class WorkerExtension extends BaseWorker {
                         .tap(testResult => {
                             driver.unregisterToClosedBrowser(onBrowserClosed);
                             if (this.lambdatestService.isLambdatestRun()) {
-                                return driver.executeJS(`lambda-status=${!testResult.success ? 'failed' : 'passed'}`).catch(() => {});
+                                return driver.executeJS(`lambda-status=${!testResult.success ? 'failed' : 'passed'}`).catch(() => { });
                             }
                             return undefined;
                         })

package/workers/workerUtils.js

@@ -40,7 +40,10 @@ module.exports.getBrowserWithRetries = ({ getBrowserOnce, testPlayerFactory, rel
         return getBrowserOnce(player)
             .then((getBrowserRes) => player || getBrowserRes)
             .timeout(singleGetBrowserDuration, timeoutMessages.GET_BROWSER_TIMEOUT_MSG)
-            .tapCatch(() => reporter.onGetBrowserFailure(workerId, projectId, ++failedAttempts))
+            .catch(err => {
+                reporter.onGetBrowserFailure(workerId, projectId, ++failedAttempts);
+                throw err;
+            })
             .tap(() => reporter.onGetBrowserSuccess(workerId, projectId))
             .catch(err => waitUntilBrowserTimeout(err, startTime, singleGetBrowserDuration, projectId, workerId, player, releaseSlotOnTestFinished));
     }, maxGetBrowserAttempts).catch(err => {

package/player/utils/downloadsApiUtils.js

@@ -1,13 +0,0 @@
-"use strict";
-
-const Promise = require('bluebird');
-
-// Only for extension mode
-class DownloadsApiUtils {
-
-    removeAndErase() {
-        return Promise.resolve();
-    }
-}
-
-module.exports = new DownloadsApiUtils();