@testim/testim-cli 3.244.0 → 3.245.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.244.0",
+  "version": "3.245.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -57,7 +57,6 @@
     "appium-dom-utils": "1.0.6",
     "archiver": "5.3.0",
     "bluebird": "3.7.2",
-    "bluebird-retry": "0.11.0",
     "body-parser": "1.19.1",
     "chalk": "4.1.2",
     "chrome-launcher": "0.15.0",
@@ -87,6 +86,7 @@
     "npm": "8.3.0",
     "object-hash": "3.0.0",
     "ora": "5.4.1",
+    "p-retry": "4.6.2",
     "pako": "1.0.11",
     "portfinder": "1.0.28",
     "promise-queue": "2.2.5",

package/player/stepActions/RefreshStepAction.js

@@ -6,10 +6,8 @@ require('bluebird');
 class RefreshStepAction extends StepAction {
     execute() {
         return this.driver.reloadTab()
-            .return({ success: true })
-            .catch(error => {
-                return { success: false, reason: error.message };
-            });
+            .then(() => ({ success: true }))
+            .catch(error => ({ success: false, reason: error.message }));
     }
 }
 

package/player/stepActions/inputFileStepAction.js

@@ -86,18 +86,22 @@ class InputFileStepAction extends StepAction {
         const target = this.context.data[this.step.targetId || 'targetId'];
         const overrideAzureStorageUrl = featureFlagService.flags.overrideAzureStorageUrl.isEnabled();
         const useJsInputCodeInSafari = featureFlagService.flags.useJsInputCodeInSafari.isEnabled();
+        const useJsInputCodeInFirefox = featureFlagService.flags.useJsInputCodeInFirefox.isEnabled();
         const downloadToBase64 = featureFlagService.flags.downloadToBase64.isEnabled();
 
         let fileUrls = await utils.addTokenToFileUrl(this.context.project.id, this.step.fileUrls, this.stepActionUtils.testimServicesApi, overrideAzureStorageUrl, logger);
 
+
+        const isSafariJsInputCode = this.driver.isSafari() && (useJsInputCodeInSafari || fileUrls.length > 1);
+        const isFirefoxJsInputCode = this.driver.isFirefox() && (useJsInputCodeInFirefox || fileUrls.length > 1);
+
         if (downloadToBase64) {
             fileUrls = await Promise.all(fileUrls.map(async ({ name, url }) => {
                 const res = await download(url);
                 return { name, url: `data:${res.type};base64,${Buffer.from(res.body).toString('base64')}` };
             }));
         }
-
-        if (this.driver.isSafari() && (useJsInputCodeInSafari || fileUrls.length > 1)) {
+        if (isSafariJsInputCode || isFirefoxJsInputCode) {
             await this.driver.executeJSWithArray(`
                 const getLocatedElement = ${codeSnippets.getLocatedElementCode};
                 const downloadAndUploadFile = ${downloadAndUpload()};

package/player/utils/screenshotUtils.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const Promise = require('bluebird');
-const utils = require('../../utils');
+const pRetry = require('p-retry');
 
 class ScreenshotUtils {
     constructor(tabId, driver, options = { takeScreenshots: true }) {
@@ -29,7 +29,7 @@ class ScreenshotUtils {
         const SCREENSHOT_RETRY_DELAY = 2000;
         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)
+        return pRetry(getScreenshot, { retries: MAX_RETRY_COUNT, minTimeout: SCREENSHOT_RETRY_DELAY })
             .then(([devicePixelRatio, image]) => {
                 const base64 = image ? image.value : '';
                 const dataUrl = `data:image/png;base64,${this.base64AddPadding(base64.replace(/[\r\n]/g, ''))}`;

package/player/utils/windowUtils.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const Promise = require('bluebird');
-const utils = require('../../utils');
+const pRetry = require('p-retry');
 const { PageNotAvailableError } = require('../../errors');
 const logger = require('../../commons/logger').getLogger('window-utils');
 
@@ -152,12 +152,12 @@ WindowUtils.prototype.quit = function () {
 };
 
 WindowUtils.prototype.getOsAndBrowser = function () {
-    return utils.runWithRetries(() => this.driver.getBrowserAndOS())
+    return pRetry(() => this.driver.getBrowserAndOS(), { retries: 3 })
         .then(osAndBrowser => ({ uaBrowserName: osAndBrowser.browser, uaOs: osAndBrowser.os, userAgent: osAndBrowser.userAgent, browserVersion: osAndBrowser.browserVersion }));
 };
 
 WindowUtils.prototype.getUserAgentInfo = function () {
-    return utils.runWithRetries(() => this.driver.getUserAgentInfo());
+    return pRetry(() => this.driver.getUserAgentInfo(), { retries: 3 });
 };
 
 module.exports = WindowUtils;

package/services/lambdatestService.js

@@ -1,6 +1,6 @@
 const os = require('os');
 const childProcess = require('child_process');
-const Promise = require('bluebird');
+const pRetry = require('p-retry');
 const fse = require('fs-extra');
 const portfinder = require('portfinder');
 const ms = require('ms');
@@ -154,7 +154,7 @@ class LambdatestService {
 
         // verify that LT tunnel strated successfully
         try {
-            const ltInfo = await utils.runWithRetries(() => httpRequest.get(`http://127.0.0.1:${infoAPIPort}/api/v1.0/info`, {}, {}, undefined, { skipProxy: true }), 30, 2000);
+            const ltInfo = await pRetry(() => httpRequest.get(`http://127.0.0.1:${infoAPIPort}/api/v1.0/info`, {}, {}, undefined, { skipProxy: true }), { retries: 30, minTimeout: 2000 });
             logger.info('LT tunnel info', ltInfo);
         } catch (err) {
             logger.error('Failed to start LT tunnel', { err, stdoutResult, stderrResult });

package/services/lambdatestService.test.js

@@ -4,6 +4,7 @@ const httpRequest = require('../commons/httpRequest');
 const LambdatestService = require('./lambdatestService');
 const utils = require('../utils');
 const fse = require('fs-extra');
+const { AbortError } = require('p-retry');
 const os = require('os');
 const childProcess = require('child_process');
 const EventEmitter = require('events');
@@ -312,7 +313,7 @@ describe('LambdatestService', () => {
             sinon.assert.calledOnce(httpGetStub);
         });
         it('should throw when tunnel did not start', async () => {
-            sandbox.stub(utils, 'runWithRetries').rejects(new Error('tunnel did not start'));
+            httpGetStub.rejects(new AbortError('tunnel did not start'));
             await expect(LambdatestService.connectTunnel({ ...credentials })).to.be.rejectedWith(Error, 'tunnel did not start');
             processMock.stdout.emit('data', '');
             processMock.stderr.emit('data', '');

package/testRunHandler.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const pRetry = require('p-retry');
 const _ = require('lodash');
 const testimCustomToken = require('./commons/testimCustomToken');
 const remoteStepService = require('./commons/socket/remoteStepService');
@@ -312,12 +313,12 @@ class TestRun {
             const { sessionId: extensionSessionId } = extensionSession || {};
             perf.log('before Runtime.evaluate');
 
-            await utils.runWithRetries(async () => {
+            await pRetry(async () => {
                 const { result } = await cdpTestRunner.cdpCommand('Runtime.evaluate', { expression: 'typeof runTestimTest !== \'undefined\'', returnByValue: true }, extensionSessionId);
                 if (!result.value) {
                     throw new Error('runTestimTest not available on global scope');
                 }
-            }, 100, 30);
+            }, { retries: 100, minTimeout: 30 });
 
             perf.log('after wait for runTestimTest function');
             const { result } = await cdpTestRunner.cdpCommand(

package/testRunStatus.js

@@ -442,7 +442,8 @@ RunStatus.prototype.executionStart = function (executionId, projectId, startTime
                     logger.error('Failed to start suite', { err });
                     // eslint-disable-next-line no-console
                     console.error('Failed to start test run. Please contact support@testim.io');
-                }).return({ beforeTests, tests, afterTests });
+                })
+                .then(() => ({ beforeTests, tests, afterTests }));
         });
 };
 

package/utils.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const moment = require('moment');
-const retry = require('bluebird-retry');
+const pRetry = require('p-retry');
 const _ = require('lodash');
 const Promise = require('bluebird');
 const fs = Promise.promisifyAll(require('fs'));
@@ -96,17 +96,6 @@ function getDurationSec(ms) {
     return moment.duration(ms).asSeconds();
 }
 
-function runWithRetries(task, times, interval, predicate) {
-    times = times || 3;
-    interval = interval || 3000;
-
-    const opt = { max_tries: times, interval, throw_original: true };
-    if (predicate) {
-        opt.predicate = predicate;
-    }
-    return retry(task, opt);
-}
-
 function getRunnerVersion() {
     try {
         const pack = require(`${__dirname}/package.json`);
@@ -243,7 +232,7 @@ function isURL(path) {
 }
 
 const DOWNLOAD_RETRY = 3;
-const download = async (url) => runWithRetries(() => httpRequest.download(url), DOWNLOAD_RETRY);
+const download = async (url) => pRetry(() => httpRequest.download(url), { retries: DOWNLOAD_RETRY });
 
 const downloadAndSave = async (url, saveToLocation) => {
     const res = await download(url);
@@ -311,6 +300,16 @@ function getPlanType(plan) {
     return 'free';
 }
 
+/**
+ * @param time {number} in ms
+ * @returns {Promise}
+ */
+ function delay(time) {
+    return new Promise(((resolve) => {
+        setTimeout(resolve, time);
+    }));
+}
+
 const calcPercentile = (arr, percentile) => {
     if (arr.length === 0) return 0;
     if (typeof percentile !== 'number') throw new TypeError('p must be a number');
@@ -362,7 +361,6 @@ module.exports = {
     getTestUrl,
     getDuration,
     getDurationSec,
-    runWithRetries,
     getRunnerVersion,
     getEnginesVersion,
     getEnginesVersionAsync,
@@ -391,4 +389,5 @@ module.exports = {
     isQuarantineAndNotRemoteRun,
     groupTestsByRetries,
     getPlanType,
+    delay,
 };

package/workers/BaseWorker.js

@@ -2,6 +2,7 @@
 
 const Bluebird = require('bluebird');
 const moment = require('moment');
+const pRetry = require('p-retry');
 const ms = require('ms');
 
 const { timeoutMessages, testRunStatus, stepResult, runnerTestStatus } = require('../commons/constants');
@@ -116,7 +117,8 @@ class BaseWorker {
         try {
             perf.log('before getSlotOnce retries');
             let failedGetSlotAttempts = 0;
-            let gridInfo = await utils.runWithRetries(async () => {
+
+            let gridInfo = await pRetry(async () => {
                 const startTime = Date.now();
                 try {
                     return await Bluebird.resolve(this.getSlotOnce(testRunHandler))
@@ -124,10 +126,10 @@ class BaseWorker {
                 } catch (error) {
                     logger.error('error getting grid slot', { error, testId: this.testId, testResultId: this.testResultId, executionId: this.executionId });
                     failedGetSlotAttempts++;
-                    await Bluebird.delay(this.options.getBrowserTimeout - (Date.now() - startTime));
+                    await utils.delay(this.options.getBrowserTimeout - (Date.now() - startTime));
                     throw error;
                 }
-            }, this.options.getBrowserRetries);
+            }, { retries: this.options.getBrowserRetries - 1, minTimeout: 0 });
             perf.log('after getSlotOnce retries');
 
             perf.log('before getBrowserOnce retries');
@@ -136,7 +138,7 @@ class BaseWorker {
                 throw new Error('No free browser slots in desired grid');
             }
             let failedGetBrowserAttempts = 0;
-            testPlayer = await utils.runWithRetries(async () => {
+            testPlayer = await pRetry(async () => {
                 const startTime = Date.now();
                 const player = this.initPlayer(testRunHandler);
                 try {
@@ -162,11 +164,11 @@ class BaseWorker {
                     player.onDone();
 
                     if (!(error instanceof PageNotAvailableError)) {
-                        await Bluebird.delay(this.options.getBrowserTimeout - (Date.now() - startTime));
+                        await utils.delay(this.options.getBrowserTimeout - (Date.now() - startTime));
                     }
                     throw error;
                 }
-            }, getBrowserRetriesNumber, undefined, (err) => !(err instanceof PageNotAvailableError));
+            }, { retries: getBrowserRetriesNumber - 1, minTimeout: 0 });
             perf.log('after getBrowserOnce retries');
         } catch (err) {
             await releasePlayer(this.id, this.releaseSlotOnTestFinished, projectId, testPlayer);
@@ -235,7 +237,7 @@ class BaseWorker {
                 testResult.testRetryKey = testRetryKey;
                 await this.onTestCompleted(this.id, this.testId, testResult, sessionId, shouldRerun);
                 if (this.executionQueue.hasMoreTests() && !(this.options.lightweightMode && this.options.lightweightMode.general)) {
-                    await Bluebird.delay(DELAY_BETWEEN_TESTS);
+                    await utils.delay(DELAY_BETWEEN_TESTS);
                 }
                 await this.runTestCleanup();
                 if (shouldRerun) {

package/workers/BaseWorker.test.js

@@ -3,10 +3,9 @@ const proxyquire = require('proxyquire');
 const { expect, sinon } = require('../../test/utils/testUtils');
 const gridService = require('../services/gridService');
 const reporter = require('../reports/reporter');
-const Bluebird = require('bluebird');
 const { PageNotAvailableError, GridError, GetBrowserError } = require('../errors');
 const servicesApi = require('../commons/testimServicesApi');
-const { releasePlayer } = require('./workerUtils');
+const utils = require('../utils');
 
 
 describe('BaseWorker', () => {
@@ -41,7 +40,7 @@ describe('BaseWorker', () => {
         getGridSlotStub = sinon.stub(gridService, 'getGridSlot').resolves({});
 
 
-        sandbox.stub(Bluebird, 'delay').returns(Promise.resolve());
+        sandbox.stub(utils, 'delay').returns(Promise.resolve());
         sandbox.stub(reporter);
     });
 
@@ -57,7 +56,7 @@ describe('BaseWorker', () => {
             it('should get grid slot from server', async () => {
                 await worker.getTestPlayer(testRunHandlerMock);
                 sinon.assert.calledOnce(getGridSlotStub);
-                sinon.assert.notCalled(Bluebird.delay);
+                sinon.assert.notCalled(utils.delay);
             });
             it('should retry getting slot until it succeeds', async () => {
                 getGridSlotStub.onFirstCall().rejects();
@@ -65,7 +64,7 @@ describe('BaseWorker', () => {
 
                 await worker.getTestPlayer(testRunHandlerMock);
                 sinon.assert.calledTwice(getGridSlotStub);
-                sinon.assert.calledTwice(Bluebird.delay);
+                sinon.assert.calledOnce(utils.delay);
             });
             it('should not proceed to getting browser if all retries used for getting a slot', async () => {
                 getGridSlotStub.resolves({});
@@ -74,7 +73,7 @@ describe('BaseWorker', () => {
                 sinon.assert.calledOnce(getGridSlotStub);
                 sinon.assert.notCalled(worker.getBrowserOnce);
                 sinon.assert.notCalled(worker.initPlayer);
-                sinon.assert.notCalled(Bluebird.delay);
+                sinon.assert.notCalled(utils.delay);
             });
         });
 
@@ -84,7 +83,7 @@ describe('BaseWorker', () => {
                 sinon.assert.calledOnce(getGridSlotStub);
                 sinon.assert.calledOnce(worker.getBrowserOnce);
                 sinon.assert.calledOnce(worker.initPlayer);
-                sinon.assert.notCalled(Bluebird.delay);
+                sinon.assert.notCalled(utils.delay);
             });
             it('should retry getting browser until it succeeds', async () => {
                 worker.getBrowserOnce.onFirstCall().rejects();
@@ -95,16 +94,16 @@ describe('BaseWorker', () => {
                 sinon.assert.calledTwice(worker.getBrowserOnce);
                 sinon.assert.calledTwice(worker.initPlayer);
                 sinon.assert.calledOnce(testPlayerMock.onDone);
-                sinon.assert.calledTwice(Bluebird.delay);
+                sinon.assert.calledOnce(utils.delay);
             });
             it('should not retry if page is not available', async () => {
                 worker.getBrowserOnce.throws(() => new PageNotAvailableError());
 
-                await expect(worker.getTestPlayer(testRunHandlerMock)).to.eventually.be.rejectedWith(PageNotAvailableError);
+                await expect(worker.getTestPlayer(testRunHandlerMock)).to.eventually.be.rejectedWith(Error);
                 sinon.assert.calledOnce(getGridSlotStub);
                 sinon.assert.calledOnce(worker.getBrowserOnce);
                 sinon.assert.calledOnce(testPlayerMock.onDone);
-                sinon.assert.notCalled(Bluebird.delay);
+                sinon.assert.notCalled(utils.delay);
             });
             it('should handle get grid error', async () => {
                 worker.getBrowserOnce.throws(() => new GridError());
@@ -153,8 +152,8 @@ describe('BaseWorker', () => {
                 getHybridGridProviderStub.onFirstCall().resolves({ provider: 'loacker', connectionDetails: { host: 'localhost', external: { user: 'user', key: 'password' } } });
                 getHybridGridProviderStub.onSecondCall().resolves({ provider: 'nitzan', connectionDetails: { host: 'google.com', port: 443 } });
                 getHybridGridProviderStub.onThirdCall().resolves({ provider: 'a', connectionDetails: { host: 'google.com', port: 4444 } });
-                worker.getBrowserOnce.onFirstCall().rejects();
-                worker.getBrowserOnce.onSecondCall().rejects();
+                worker.getBrowserOnce.onFirstCall().rejects(new Error());
+                worker.getBrowserOnce.onSecondCall().rejects(new Error());
                 worker.getBrowserOnce.onThirdCall().resolves({});
 
                 await worker.getTestPlayer(testRunHandlerMock);