@testim/testim-cli 3.253.0 → 3.254.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.253.0",
+  "version": "3.254.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -32,7 +32,7 @@
   },
   "lazyDependencies": {
     "ngrok": "3.4.0",
-    "webpack": "4.43.0",
+    "webpack": "5.74.0",
     "playwright": "0.12.1",
     "puppeteer": "2.1.1",
     "selenium-webdriver": "3.6.0",
@@ -71,23 +71,23 @@
     "https-proxy-agent": "5.0.0",
     "istanbul-lib-report": "3.0.0",
     "istanbul-reports": "3.0.2",
-    "jimp": "0.16.1",
+    "jimp": "0.16.2",
     "jsdom": "19.0.0",
     "jsonwebtoken": "8.5.1",
     "lodash": "4.17.21",
     "memory-fs": "0.5.0",
     "memorystream": "0.3.1",
     "mkdirp": "1.0.4",
-    "moment": "2.25.3",
+    "moment": "2.29.4",
     "ms": "2.1.2",
-    "npm": "8.3.0",
+    "npm": "8.19.2",
     "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",
-    "prompts": "2.3.2",
+    "prompts": "2.4.2",
     "proxy-agent": "5.0.0",
     "rox-node": "4.9.18",
     "semver": "7.3.2",

package/player/appiumTestPlayer.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const webdriverio = require('webdriverio');
-const TabService = require('./services/tabService');
+const TabService = require('./services/tabServiceMock');
 const PortSelector = require('./services/portSelector');
 const windowCreationListener = require('./services/windowCreationListener');
 const frameLocatorFactory = require('./services/mobileFrameLocatorMock');

package/player/chromeLauncherTestPlayer.js

@@ -3,7 +3,6 @@
 const launcher = require('chrome-launcher');
 const desiredCapabilitiesBuilder = require('../commons/testimDesiredCapabilitiesBuilder');
 const utils = require('../utils');
-const httpRequest = require('../commons/httpRequest');
 const { registerExitHook } = require('../processHandler');
 const CDPTestRunner = require('../cdpTestRunner');
 

package/player/services/tabServiceMock.js

@@ -0,0 +1,166 @@
+'use strict';
+
+/**
+ * @typedef {{
+ *     attachDebugger(): Promise<any>,
+ *     detachDebugger(): Promise<any>,
+ *     onDebuggerDetached(): {},
+ *     tabId: string,
+ *     domUtils: { getDOM(): Promise<any> },
+ *     windowUtils: WindowUtils,
+ *     imageCaptureUtils: ImageCaptureUtils
+ * }} TabUtil
+ * */
+/**
+ * @typedef {{
+ *     infoId: any;
+ *     url: any;
+ *     title: any;
+ *     favIconUrl: any;
+ *     order: any;
+ *     from: any;
+ *     isMain: any;
+ *     openerStepId: any;
+ * }} TabInfo
+ */
+
+class TabService {
+    /** @param {import('../webdriver')} driver */
+    constructor(driver) {
+        this.driver = driver;
+        /** @type {Record<string, TabUtil>} */
+        this._utils = {};
+        /** @type {Record<string, { tabCount: number; tabInfos: Record<string, TabInfo> }>} */
+        this.sessionTabs = {};
+        /** @type {Record<string, string>} */
+        this.pendingTabs = {};
+        /** @type {Record<string, Set<any>>} */
+        this.addedTabs = {};
+    }
+
+    on() {}
+
+    tabCount(sessionId) {
+    }
+
+    getAllOpenTabIds(sessionId) {
+    }
+
+    /**
+     * Get last tab info for pixel validation
+     *
+     * @returns last tab info
+     */
+    getActiveTabInfo(sessionId) {
+    }
+
+    getAllTabIds(sessionId) {
+    }
+
+    isSessionTab(sessionId, tabId) {
+    }
+
+    createSesion(sessionId) {
+    }
+
+    setAddFrameHandlerCallBack(addFrameHandlerCb) {
+    }
+
+    getAllTabInfoStrings(sessionId) {
+    }
+
+    getAllTabInfos(sessionId) {
+    }
+
+    addNewTab(sessionId, tabId, openerStepId, options = {}) {
+    }
+
+    addOpenerStepId(sessionId, tabId, openerStepId) {
+    }
+    addOpenerStep(sessionId, tabId, openerStep) {
+    }
+
+    fixMissingMainTab(sessionId) {
+    }
+
+    buildTabInfo(sessionId, tabId, order, openerStepId, options = {}) {
+    }
+
+    addTab(sessionId, id, order, openerStepId, options = {}) {
+    }
+
+    getTabUtilsByTabIdAndSessionId(sessionId, tabId) {
+    }
+
+    getTabUtilsByTabId(tabId) {
+    }
+
+    getTabInfo(sessionId, id) {
+    }
+
+    getTabUtils(sessionId, tabInfo) {
+    }
+
+    exactUrlMatch(first, second, allUrls) {
+    }
+
+    singleExactMatchForParts(first, second, allUrls, combinePartsFunction) {
+    }
+
+    isSameTab(sessionId, first, second) {
+    }
+
+    getMainTabInfo(sessionId) {
+    }
+
+    getMainTabUtils(sessionId) {
+    }
+
+    removeTabInfo(sessionId, tabId) {
+    }
+
+    getMainTabId(sessionId) {
+    }
+
+    isMainTabExists(sessionId) {
+    }
+
+    clearAllTabs(sessionId) {
+    }
+
+    clearNonMainTabs(sessionId) {
+    }
+
+    switchTab(tabId, sessionId, { forceSwitch } = { forceSwitch: false }) {
+    }
+
+    getTabDetails(tabId, sessionId, options = {}) {
+    }
+
+    getUnregisteredTabId(sessionId) {
+    }
+
+    waitForTabToOpen(sessionId) {
+    }
+
+    tryToAddTab(sessionId, openerStepId) {
+
+    }
+
+    addNewPopup(id, openerStepId) {
+    }
+
+    waitToPendingTabs(id, openerStepId) {
+    }
+
+    isMainTabIncognito() {
+    }
+
+    isInvalidStepVersion(step) {
+    }
+
+    getTabIdByTabInfo(sessionId, step) {
+    }
+}
+
+module.exports = TabService;

package/player/stepActions/navigationStepAction.js

@@ -1,15 +1,14 @@
-"use strict";
+'use strict';
 
 const StepAction = require('./stepAction');
-const url = require('url');
+const requiredUrl = require('url');
 const Promise = require('bluebird');
 
 class NavigationStepAction extends StepAction {
-
     updateBaseUrl(location) {
-        let orgUrl = url.parse(location);
-        const baseLocation = url.parse(this.context.recordedBaseUrl);
-        const newBaseLocation = url.parse(this.context.baseUrl);
+        const orgUrl = requiredUrl.parse(location);
+        const baseLocation = requiredUrl.parse(this.context.recordedBaseUrl);
+        const newBaseLocation = requiredUrl.parse(this.context.baseUrl);
         if (orgUrl.host === baseLocation.host && baseLocation.host !== newBaseLocation.host) {
             orgUrl.host = newBaseLocation.host;
         }
@@ -18,12 +17,14 @@ class NavigationStepAction extends StepAction {
 
     performAction() {
         const url = this.context.data.testimNavigationStepDestination || this.context.data.url;
-
+        // Opens a new tab and switches to new tab
+        if (this.step.openInNewTab) {
+            return this.driver.client.newWindow(url).then(() => {});
+        }
         return this.updateBaseUrl(url)
-            .then(url => this.driver.url(url))
-            .then(() => Promise.resolve());
+            .then(updatedUrl => this.driver.url(updatedUrl))
+            .then(() => {});
     }
-
 }
 
 module.exports = NavigationStepAction;

package/player/stepActions/sleepStepAction.js

@@ -1,12 +1,11 @@
-"use strict";
+'use strict';
 
 const StepAction = require('./stepAction');
-const Promise = require("bluebird");
+const { delay } = require('../../utils');
 
 class SleepStepAction extends StepAction {
-
-    performAction() {
-        return Promise.delay(this.step.durationMS).then(() => Promise.resolve());
+    async performAction() {
+        await delay(this.step.durationMS);
     }
 }
 

package/player/stepActions/textStepAction.js

@@ -6,12 +6,10 @@ const Promise = require('bluebird');
 const { codeSnippets } = require('../../commons/getSessionPlayerRequire');
 const dispatchFocus = require('./scripts/focusElement');
 const sessionPlayer = require('../../commons/getSessionPlayerRequire');
-const { extractElementId } = require('../../utils');
-const util = require('util');
+const { extractElementId, delay } = require('../../utils');
 
 const constants = sessionPlayer.commonConstants.stepResult;
-const setTextDraftJs = codeSnippets && codeSnippets.setTextDraftJs;
-const delay = util.promisify(setTimeout);
+const setTextDraftJs = codeSnippets?.setTextDraftJs;
 class TextStepAction extends StepAction {
     setValueNative() {
         const context = this.context;
@@ -61,12 +59,7 @@ class TextStepAction extends StepAction {
         const eventParam = this.driver.isEdge() ? JSON.stringify(eventMessage) : eventMessage;
 
         return this.driver.executeCodeAsync(setTextCode, timeout, eventParam)
-            .then(result => {
-                if (result.value && result.value.success) {
-                    return Promise.resolve({ success: true });
-                }
-                return Promise.resolve({ success: false });
-            });
+            .then(result => ({ success: Boolean(result.value?.success) }));
     }
 
     async setTextDelayed() {
@@ -86,7 +79,7 @@ class TextStepAction extends StepAction {
         const context = this.context;
         const target = this.getTarget();
 
-        if (target && target.seleniumElement) {
+        if (target?.seleniumElement) {
             if (!this.step.delayBetweenChars) {
                 keys.push(Array.from(context.stepText));
                 return this.driver.elementIdValue(extractElementId(target.seleniumElement), keys);

package/player/utils/windowUtils.js

@@ -2,6 +2,7 @@
 
 const Promise = require('bluebird');
 const pRetry = require('p-retry');
+const { delay } = require('../../utils');
 const { PageNotAvailableError } = require('../../errors');
 const logger = require('../../commons/logger').getLogger('window-utils');
 
@@ -72,7 +73,7 @@ class WindowUtils {
                 const shouldRetryNavigation = err.seleniumStack && err.message.includes('method IWebBrowser2::Navigate2() failed');
                 if (shouldRetryNavigation && retries > 0) {
                     logger.warn('selenium navigation failed. retrying to navigate', { err });
-                    await Promise.delay(1500);
+                    await delay(1500);
                     return navigate(retries - 1);
                 }
                 throw err;
@@ -80,13 +81,13 @@ class WindowUtils {
             return undefined;
         }
 
-        return Promise.race([navigate(), Promise.delay(NAVIGATION_MAX_TIME)]);
+        return Promise.race([navigate(), delay(NAVIGATION_MAX_TIME)]);
     }
 
     reloadTab(timeoutMSec = 15000) {
         return Promise.race([
             this.driver.reloadTab(),
-            Promise.delay(timeoutMSec),
+            delay(timeoutMSec),
         ]);
     }
 

package/player/webdriver.js

@@ -93,7 +93,7 @@ class WebDriver extends WebDriverApi {
             this.cdpUrl = await getCdpAddress(initResult);
             perf.log('after getCdpAddress in webdriver.js init');
             logger.info(`init new session testName: ${testName}`, { sessionId: this.getSessionId(), testResultId });
-            await Promise.delay(driverDelay);
+            await utils.delay(driverDelay);
             await focus();
             perf.log('after focus and delay in webdriver.js init');
         } catch (err) {

package/processHandler.js

@@ -2,7 +2,7 @@
 
 'use strict';
 
-const Promise = require('bluebird');
+const { promiseTimeout, promiseMap } = require('./utils');
 const logger = require('./commons/logger').getLogger('process-handler');
 
 const exitHooks = [];
@@ -10,7 +10,7 @@ const exitHooks = [];
 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(() => {});
+        await promiseTimeout(promiseMap(exitHooks, hook => hook()), 10000).catch(() => null);
         onExit(err);
     }
     _process.on('uncaughtException', async (err) => {
@@ -29,7 +29,7 @@ module.exports = function (onExit, _process = process) {
         // 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
-        if (reason && reason.message && reason.message.includes('ENOTFOUND x-api.rollout.io')) {
+        if (reason?.message?.includes('ENOTFOUND x-api.rollout.io')) {
             // this is not a fatal error - we recover from this in feature-flags service
             return;
         }

package/processHandler.test.js

@@ -1,5 +1,5 @@
 
-const { delay } = require('bluebird');
+const { delay } = require('./utils');
 const EventEmitter = require('events');
 const { expect, sinon } = require('../test/utils/testUtils');
 const processHandler = require('./processHandler');

package/reports/consoleReporter.js

@@ -2,7 +2,7 @@
 const chalk = require('chalk');
 const _ = require('lodash');
 
-const utils = require('../utils.js');
+const utils = require('../utils');
 const constants = require('../commons/constants');
 const featureAvailabilityService = require('../commons/featureAvailabilityService');
 const { getAbortedTests, getFailedTests, getPassedTests, getFailureEvaluatingCount, getSkippedCount } = require('./reporterUtils');
@@ -120,7 +120,8 @@ class ConsoleReporter {
         if (isCodeMode) {
             console.log(`Run test plan, Project: ${this.options.project} (Execution ID: ${executionId}):`);
         } else {
-            console.log(`Run${this.buildTestPlanName(isAnonymous, testPlanName)} test plan with ${configString}, Project: ${this.options.project}, Branch: ${this.branchToUse} (${executionId})`);
+            const sfdcCredentialLog = this.options.sfdcCredential ? ` SfdcCredential: ${this.options.sfdcCredential}` : '';
+            console.log(`Run${this.buildTestPlanName(isAnonymous, testPlanName)} test plan with ${configString}, Project: ${this.options.project}, Branch: ${this.branchToUse}${sfdcCredentialLog} (${executionId})`);
         }
         this.printWorkerDivider();
 

package/reports/junitReporter.js

@@ -5,11 +5,10 @@
 const xml2js = require('xml2js');
 const Promise = require('bluebird');
 const fs = Promise.promisifyAll(require('fs'));
-const utils = require('../utils.js');
+const utils = require('../utils');
 const {
     isAbortedTest, isSkippedTest, getFailedTests, isFailedTest, getFailureEvaluatingCount, getSkippedCount, getAbortedTests,
 } = require('./reporterUtils');
-const featureFlags = require('../commons/featureFlags.js');
 const featureAvailabilityService = require('../commons/featureAvailabilityService');
 
 class JunitReporter {

package/runOptions.js

@@ -183,12 +183,12 @@ program
     .option('-h, --headless [headless]', 'run in headless mode')
     .option('-m, --mode [runner-mode]', 'use extension or selenium mode (extension/selenium/appium)')
     .option('--branch [branch]', 'branch name', null)
-    .option('--base-url [base-url]', 'change al test base-url to a specified url')
+    .option('--base-url [base-url]', 'change base-url to a specified url for all tests in current execution')
     .option('--token [token]', 'identification token to testim')
     .option('--is-regression-baseline-run', 'save doms and run results as regression baseline data')
-    .option('--parallel [number-of-tests]', 'number of tests to run on parallel')
-    .option('--before-parallel [number-of-tests]', 'number of tests to run on parallel in the before phase of a test plan')
-    .option('--after-parallel [number-of-tests]', 'number of tests to run on parallel in the after phase of a test plan')
+    .option('--parallel [number-of-tests]', 'number of tests to run in parallel')
+    .option('--before-parallel [number-of-tests]', 'number of tests to run in parallel during the before phase of a test plan')
+    .option('--after-parallel [number-of-tests]', 'number of tests to run in parallel during the after phase of a test plan')
     .option('--canary [canary-mode]', 'enable canary mode', false)
     .option('--test-plan [test-plan-name]', 'test plan to run', collect, [])
     .option('--test-plan-id [test-plan-id]', 'test plan to run', collect, [])
@@ -203,7 +203,7 @@ program
     .option('--proxy-for-grid [proxy-for-grid]', 'used together with --proxy to also router grid traffic through a proxy')
     .option('--result-label [result-label]', 'result label', collect, [])
     .option('-oen --override-execution-name [execution-name]', 'override the default execution name', '')
-    .option('--retries [max_num_of_retries]', 'number of retires failure test defaults to not retrying', 0)
+    .option('--retries [max_num_of_retries]', 'number of retries on test failure, defaults to 0 (no retries)', 0)
     .option('--set-retention [retention-in-days]', 'set the number of days for results retention')
     .option('--user [user-id]', 'user ID for local Testim-CLI')
     .option('--pass-zero-tests', 'don\'t fail the run if no tests were found')
@@ -347,7 +347,7 @@ program
     .option('--use-prefeched-data [location]', 'use prefetched data from local cache file, and force using only cached data')
     .option('--save-rca-locally [path]', 'save root cause analysis assets locally')
 
-    .option('--exit-code-ignore-failing-tests', 'dont return non zero exit code when tests fail. non zero exit code will mean a real error occurred')
+    .option('--exit-code-ignore-failing-tests', 'return exit code of zero when tests fail. non zero exit code will mean a real error occurred')
 
     .option('--intersect-with-label [label]', 'Out of the execution\'s test list, run only those tests that have the specified label', collect, [])
     .option('--intersect-with-suite [suiteName]', 'Out of the execution\'s test list, run only those tests that are included in the specified suite (by suite name)', collect, [])

package/runner.js

@@ -118,6 +118,14 @@ function setBranch(options, branchInfoFromServer) {
     }
 }
 
+async function setSfdcCredential(options) {
+    const { projectData: { projectId } } = options;
+    const branch = branchService.getCurrentBranch();
+    if (_.get(options, 'company.activePlan.premiumFeatures.ttaForSalesforce')) {
+        options.sfdcCredential = await servicesApi.loadSfdcCredential({ projectId, branch });
+    }
+}
+
 function setCompany(options, company) {
     const { onprem, id, storageBaseUrl, storageType, name, activePlan = {} } = company;
     if (onprem) {
@@ -194,6 +202,10 @@ async function setMockNetworkRules(options) {
     }
 }
 
+/**
+ * @param {Awaited<ReturnType<typeof import('./runOptions')['process']>>} options
+ * @param {string=} customExtensionLocalLocation
+ */
 async function runRunner(options, customExtensionLocalLocation) {
     perf.log('in runner.js runRunner');
 
@@ -265,6 +277,7 @@ async function init(options) {
     setBranch(options, branchName);
     setAllGrids(options, allGrids);
     setAuthData(options, authData);
+    await setSfdcCredential(options);
 
     if (!(options.lightweightMode && options.lightweightMode.disableLabs)) {
         await labFeaturesService.loadLabFeatures(projectById.id, companyByProjectId.activePlan);