@testim/testim-cli 3.243.0 → 3.246.0

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'));
@@ -10,6 +10,10 @@ const { sessionType, testStatus: testStatusConst } = require('./commons/constant
 const path = require('path');
 const httpRequest = require('./commons/httpRequest');
 const decompress = require('decompress');
+const os = require('os');
+
+const HOMEDIR = os.homedir();
+const TESTIM_BROWSER_DIR = path.join(HOMEDIR, '.testim-browser-profile');
 
 const OSS = [
     { osName: 'Linux', bs: { os: 'LINUX' }, sl: { platform: 'Linux' } },
@@ -71,20 +75,16 @@ function getRunConfigByBrowserName(browser, saucelabs, browserstack) {
     return _.merge(selectedBrowser, selectedOS);
 }
 
-function handleAngularURIComponent(part) {
-    return part.replace(/(~|\/)/g, m => ({ '~': '~~', '/': '~2F' }[m]));
-}
-
 function getTestUrl(editorUrl, projectId, testId, resultId, branch) {
     let testUrl = '';
-    branch = branch ? handleAngularURIComponent(branch) : 'master';
+    branch = branch ? encodeURIComponent(branch) : 'master';
     if (projectId && testId) {
         testUrl = `${editorUrl}/#/project/${projectId}/branch/${branch}/test/${testId}`;
         if (resultId) {
             testUrl += `?result-id=${resultId}`;
         }
     }
-    return encodeURI(testUrl);
+    return testUrl;
 }
 
 function isPromise(obj) {
@@ -100,17 +100,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`);
@@ -198,7 +187,7 @@ function extractElementId(element) {
 }
 
 function isURL(path) {
-    const legacyPattern = new RegExp('^(https?:\\/\\/)', 'i');
+    const legacyPattern = /^(https?:\/\/)/i;
 
     // https://gist.github.com/dperini/729294 (validator.js based on).
     const pattern = new RegExp(
@@ -247,7 +236,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);
@@ -315,6 +304,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');
@@ -361,12 +360,45 @@ function groupTestsByRetries(testResults = []) { // NOTE: This duplicates a func
         .value();
 }
 
+async function getCdpAddressForHost(browserInstanceHost, timeout) {
+    try {
+        /**
+            Example response:
+            {
+                "Browser": "Chrome/81.0.4044.138",
+                "Protocol-Version": "1.3",
+                "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36",
+                "V8-Version": "8.1.307.32",
+                "WebKit-Version": "537.36 (@8c6c7ba89cc9453625af54f11fd83179e23450fa)",
+                "webSocketDebuggerUrl": "ws://localhost:58938/devtools/browser/d4290379-ec08-4d03-a41a-ab9d9d4c36ac"
+            }
+        */
+        const debuggerAddress = await httpRequest.get(`http://${browserInstanceHost}/json/version`, undefined, undefined, timeout);
+        return debuggerAddress.webSocketDebuggerUrl;
+    } catch (e) {
+        throw new Error('unable to connect to devtools server');
+    }
+}
+
+function getArgsOnRemoteRunFailure() {
+    const { argv: args } = process;
+    if (!args.includes('--remoteRunId')) {
+        return undefined;
+    }
+    return {
+        remoteRunId: args[args.indexOf('--remoteRunId') + 1],
+        projectId: args[args.indexOf('--project') + 1],
+        token: args[args.indexOf('--token') + 1],
+    };
+}
+
+
 module.exports = {
+    TESTIM_BROWSER_DIR,
     removePropertyFromObject,
     getTestUrl,
     getDuration,
     getDurationSec,
-    runWithRetries,
     getRunnerVersion,
     getEnginesVersion,
     getEnginesVersionAsync,
@@ -395,4 +427,7 @@ module.exports = {
     isQuarantineAndNotRemoteRun,
     groupTestsByRetries,
     getPlanType,
+    delay,
+    getCdpAddressForHost,
+    getArgsOnRemoteRunFailure,
 };

package/utils.test.js

@@ -32,11 +32,37 @@ describe('utils', () => {
             expect(utils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'normal-branch-name'))
                 .to.equal('http://localhost:8080/#/project/project/branch/normal-branch-name/test/test?result-id=result');
             expect(utils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'branch/with/slashes'))
-                .to.equal('http://localhost:8080/#/project/project/branch/branch~2Fwith~2Fslashes/test/test?result-id=result');
+                .to.equal('http://localhost:8080/#/project/project/branch/branch%2Fwith%2Fslashes/test/test?result-id=result');
             expect(utils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'branch with spaces'))
                 .to.equal('http://localhost:8080/#/project/project/branch/branch%20with%20spaces/test/test?result-id=result');
             expect(utils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'encoded%20branch'))
                 .to.equal('http://localhost:8080/#/project/project/branch/encoded%2520branch/test/test?result-id=result');
         });
     });
+
+    describe('getArgsOnRemoteRunFailure', () => {
+        let originalArgv;
+
+        beforeEach(() => {
+            originalArgv = process.argv;
+        });
+
+        afterEach(() => {
+            process.argv = originalArgv;
+        });
+
+        it('should return undefined if no remote run is current', () => {
+            process.argv = ['node', 'file.js', '--token', 'token', '--project', 'project-id'];
+            expect(utils.getArgsOnRemoteRunFailure()).to.be.undefined;
+        });
+
+        it('should return details if remote run is current', () => {
+            process.argv = ['node', 'file.js', '--token', 'token', '--project', 'project-id', '--remoteRunId', 'remote-run-id'];
+            expect(utils.getArgsOnRemoteRunFailure()).to.eql({
+                remoteRunId: 'remote-run-id',
+                projectId: 'project-id',
+                token: 'token',
+            });
+        });
+    });
 });

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);