@testim/testim-cli 3.241.0 → 3.242.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.241.0",
+  "version": "3.242.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -47,8 +47,8 @@
     "multer": "1.4.4"
   },
   "dependencies": {
-    "@applitools/eyes-sdk-core": "13.2.0",
-    "@applitools/visual-grid-client": "15.11.0",
+    "@applitools/eyes-sdk-core": "13.6.23",
+    "@applitools/visual-grid-client": "15.12.34",
     "@testim/coralogix-logger": "1.1.27-beta.1",
     "@testim/webdriverio": "0.0.5",
     "abort-controller": "3.0.0",

package/player/services/playbackTimeoutCalculator.js

@@ -1,12 +1,11 @@
-"use strict";
-var COMMUNICATION_BUFFER_TIME = 1000;
+'use strict';
+
 const _ = require('lodash');
-const logger = require('../../commons/logger').getLogger('playback-timeout-calculator');
 
-let warnedAboutDebugger = false;
+const COMMUNICATION_BUFFER_TIME = 1000;
+const UI_VERIFICATION_STEPS = ['simple-ui-verification', 'wait-for-simple-ui-verification'];
 
 class PlaybackTimeoutCalculator {
-
     constructor(isDebuggerConnected) {
         this.resetStepVariables();
         this.resetRetryVariables();
@@ -18,13 +17,13 @@ class PlaybackTimeoutCalculator {
         this.totalStepTime = totalStepTime || 0;
         this.totalStepTimesReport = [];
         this.currentRetryTimesReport = {};
-        var now = Date.now();
+        const now = Date.now();
         this.currentRetryStart = now;
         this.lastUpdateTime = now;
     }
 
     resetRetryVariables() {
-        var now = Date.now();
+        const now = Date.now();
         this.currentRetryStart = now;
         this.lastUpdateTime = now;
         this.totalStepTimesReport.push(this.currentRetryTimesReport);
@@ -32,7 +31,7 @@ class PlaybackTimeoutCalculator {
     }
 
     initStepRun(stepPlayback) {
-        var getRetryTimeoutSuggestions = (totalStepTime) => {
+        const getRetryTimeoutSuggestions = (totalStepTime) => {
             const timeToPlayStep = this.getTotalStepTimeLeftToPlay(stepPlayback, totalStepTime);
             const MINIMAL_RETRY_TIME = 5000;
             if (timeToPlayStep <= MINIMAL_RETRY_TIME) {
@@ -42,7 +41,7 @@ class PlaybackTimeoutCalculator {
         };
         stepPlayback.setStartTimestamp();
         const totalStepTime = this.getTotalStepRunTime(stepPlayback);
-        var currentRetryTimes = ["simple-ui-verification", "wait-for-simple-ui-verification", "custom-validation"].includes(stepPlayback.stepType) ? [totalStepTime] : getRetryTimeoutSuggestions(totalStepTime);
+        const currentRetryTimes = [...UI_VERIFICATION_STEPS, 'custom-validation'].includes(stepPlayback.stepType) ? [totalStepTime] : getRetryTimeoutSuggestions(totalStepTime);
         this.resetStepVariables(totalStepTime, currentRetryTimes);
         stepPlayback.context.data.maxTotalStepTime = totalStepTime;
     }
@@ -57,9 +56,12 @@ class PlaybackTimeoutCalculator {
     }
 
     getTotalStepRunTime(stepPlayback) {
-        return (stepPlayback.step.useStepTimeout && stepPlayback.step.stepTimeout) ?
-            stepPlayback.step.stepTimeout :
-            stepPlayback.context.config.stepTimeout;
+        const HALF_HOUR_IN_MS = 30 * 60 * 1000;
+        let fallbackTimeout = stepPlayback.context.config.stepTimeout;
+        if (UI_VERIFICATION_STEPS.includes(stepPlayback.stepType)) {
+            fallbackTimeout = stepPlayback.context.config.applitoolsStepTimeout || HALF_HOUR_IN_MS;
+        }
+        return (stepPlayback.step.useStepTimeout && stepPlayback.step.stepTimeout) ? stepPlayback.step.stepTimeout : fallbackTimeout;
     }
     getTotalStepTimeLeftToPlay(stepPlayback, totalStepTime = this.totalStepTime) {
         const playTimeSoFar = Date.now() - stepPlayback.startTimestamp;
@@ -71,7 +73,7 @@ class PlaybackTimeoutCalculator {
             this.getTotalStepTimeLeftToPlay(stepPlayback);
     }
     getTotalCurrentRetryTimeLeft(stepPlayback) {
-        var totalRetryTime = Date.now() - this.currentRetryStart;
+        const totalRetryTime = Date.now() - this.currentRetryStart;
         return this.getCurrentRetryTime(stepPlayback) - totalRetryTime + COMMUNICATION_BUFFER_TIME;
     }
     getTabTimeout(stepPlayback) {
@@ -97,7 +99,6 @@ class PlaybackTimeoutCalculator {
         }
 
         return (stepPlayback.step.events.length * timePerEvent) + buffer;
-
     }
 
     getActionTimeout(stepPlayback) {
@@ -108,10 +109,10 @@ class PlaybackTimeoutCalculator {
         const actionType = stepPlayback.step.type;
         const MIN_ACTION_PLAYBACK_TIME = 30000;
 
-        var actionTime;
-        if (actionType === "sleep") {
+        let actionTime;
+        if (actionType === 'sleep') {
             actionTime = stepPlayback.step.durationMS + SLEEP_ERROR_MARGIN_MS;
-        } else if (actionType === "android-scroll") {
+        } else if (actionType === 'android-scroll') {
             actionTime = Math.max(this.calcAndroidScrollTimeout(stepPlayback), MIN_ACTION_PLAYBACK_TIME);
         } else {
             actionTime = Math.max(this.getTotalStepTimeLeftToPlay(stepPlayback), MIN_ACTION_PLAYBACK_TIME);
@@ -120,34 +121,34 @@ class PlaybackTimeoutCalculator {
     }
 
     setStepPhaseTime(phase) {
-        var now = Date.now();
-        var totalTime = now - this.lastUpdateTime;
+        const now = Date.now();
+        const totalTime = now - this.lastUpdateTime;
         this.lastUpdateTime = now;
         this.currentRetryTimesReport[phase] = totalTime;
     }
 
     reportGetTabTime() {
-        this.setStepPhaseTime("tab");
+        this.setStepPhaseTime('tab');
     }
 
     reportGetFrameTime() {
-        this.setStepPhaseTime("frame");
+        this.setStepPhaseTime('frame');
     }
 
     reportCalcConditionTime() {
-        this.setStepPhaseTime("condition");
+        this.setStepPhaseTime('condition');
     }
 
     reportPreLocateActionsTime() {
-        this.setStepPhaseTime("pre-locate");
+        this.setStepPhaseTime('pre-locate');
     }
 
     reportFindElementsTime() {
-        this.setStepPhaseTime("locate");
+        this.setStepPhaseTime('locate');
     }
 
     reportStepActionTime() {
-        this.setStepPhaseTime("action");
+        this.setStepPhaseTime('action');
     }
 }
 

package/processHandler.js

@@ -2,18 +2,18 @@
 
 'use strict';
 
+const Promise = require('bluebird');
 const logger = require('./commons/logger').getLogger('process-handler');
 
 const exitHooks = [];
-const Promise = require('bluebird');
 
-module.exports = function (onExit) {
+module.exports = function (onExit, _process = process) {
     async function cleanup(err) {
         // give cleanup and socket reports a chance to run
         await Promise.all(exitHooks.map(x => x())).timeout(10000).catch(() => {});
         onExit(err);
     }
-    process.on('uncaughtException', async (err) => {
+    _process.on('uncaughtException', async (err) => {
         logger.error('Caught exception', { err });
         console.log('Uncaught exception');
         if (err.message) {
@@ -25,7 +25,7 @@ module.exports = function (onExit) {
         await cleanup(err);
     });
 
-    process.on('unhandledRejection', (reason) => {
+    _process.on('unhandledRejection', (reason) => {
         // rollout manages promises incorrectly and generates unhandled rejections from within their code
         logger.fatal('Caught unhandled promise rejection', reason);
         //TODO(benji) - this is a pretty shitty way to detect this error since rollout can change their API endpoint
@@ -37,11 +37,11 @@ module.exports = function (onExit) {
         throw reason;
     });
 
-    process.on('rejectionHandled', () => {
+    _process.on('rejectionHandled', () => {
         logger.error('Caught rejection handled');
     });
 
-    process.once('SIGTERM', () => {
+    _process.once('SIGTERM', () => {
         const msg = 'Runner aborted - SIGTERM event';
         const err = new Error(msg);
         logger.error(msg);
@@ -49,7 +49,7 @@ module.exports = function (onExit) {
         throw err;
     });
 
-    process.once('SIGINT', () => {
+    _process.once('SIGINT', () => {
         const msg = 'Runner aborted - SIGINT event';
         const err = new Error(msg);
         logger.error(msg);
@@ -58,12 +58,15 @@ module.exports = function (onExit) {
     });
 
     // One time self-call is expected :(
-    process.once('exit', (e) => {
+    _process.once('exit', (e) => {
         onExit(e);
     });
 };
 
-
 module.exports.registerExitHook = function (hook) {
     exitHooks.push(hook);
 };
+
+module.exports.reset = function () {
+    exitHooks.splice(0, exitHooks.length);
+};

package/processHandler.test.js

@@ -0,0 +1,56 @@
+
+const { delay } = require('bluebird');
+const EventEmitter = require('events');
+const { expect, sinon } = require('../test/utils/testUtils');
+const processHandler = require('./processHandler');
+
+
+class Process extends EventEmitter {
+    constructor() {
+        super();
+        this.stdout = new EventEmitter();
+        this.stderr = new EventEmitter();
+    }
+}
+
+describe('testimTunnel', () => {
+    let process;
+    let onExitMock;
+
+    beforeEach(() => {
+        process = new Process();
+        onExitMock = sinon.spy();
+        processHandler(onExitMock, process);
+    });
+
+    afterEach(async () => {
+        await delay(10);
+        expect(onExitMock).to.have.been.calledOnce;
+        processHandler.reset();
+    });
+
+
+    it('should register a SIGTERM handler', (done) => {
+        processHandler.registerExitHook(done);
+        expect(() => process.emit('SIGTERM')).to.throw('Runner aborted - SIGTERM event');
+    });
+    it('should register a SIGINT handler', (done) => {
+        processHandler.registerExitHook(done);
+        expect(() => process.emit('SIGINT')).to.throw('Runner aborted - SIGINT event');
+    });
+    it('should register a unhandledRejection handler', () => {
+        expect(() => process.emit('unhandledRejection', new Error('reason'))).to.throw('reason');
+        onExitMock();
+    });
+    it('should register a uncaughtException handler', (done) => {
+        processHandler.registerExitHook(done);
+        expect(() => process.emit('uncaughtException', new Error())).not.to.throw();
+    });
+    it('should do nothing on rejectionHandled', () => {
+        expect(() => process.emit('rejectionHandled')).not.to.throw();
+        onExitMock();
+    });
+    it('should register a exit handler', () => {
+        expect(() => process.emit('exit')).not.to.throw();
+    });
+});