@testim/testim-cli 3.254.0 → 3.255.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testim/testim-cli",
-  "version": "3.254.0",
+  "version": "3.255.0",
   "description": "Command line interface for running Testing on your CI",
   "author": "Oren Rubin",
   "contributors": [{
@@ -83,6 +83,7 @@
     "npm": "8.19.2",
     "object-hash": "3.0.0",
     "ora": "5.4.1",
+    "p-limit": "4.0.0",
     "p-retry": "4.6.2",
     "pako": "1.0.11",
     "portfinder": "1.0.28",
@@ -111,8 +112,8 @@
     "testim": "cli.js"
   },
   "scripts": {
-    "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": "yarn test:pattern './src/**/*.test.js'",
+    "test:pattern": "IS_UNIT_TEST=1 ../../node_modules/mocha/bin/_mocha --timeout 2000 --exit --recursive --exclude ./src/codim/template.js/tests/examples/**/*.test.js --watch-files 'src'",
     "test:cov": "nyc --reporter=lcov --reporter=text yarn test",
     "upload-bundle-s3": "ts-node-transpile-only scripts/upload.js",
     "prepare-version": "rm -rf ./deploy && mkdir -p deploy && gulp prepare-version-on-prem",

package/player/services/tabService.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 'use strict';
 
 const sessionPlayer = require('../../commons/getSessionPlayerRequire');
@@ -36,8 +38,20 @@ const logger = require('../../commons/logger').getLogger('tab-service');
  *     from: any;
  *     isMain: any;
  *     openerStepId: any;
+ *     openerOriginalStepId?: any;
+ *     isClosed?: boolean;
+ *     currentUrl?: any;
+ *     lastUpdatedUrl?: any;
  * }} TabInfo
  */
+/**
+ * @typedef {{
+ *     tabCount: number;
+ *     tabInfos: Record<string, TabInfo>;
+ *     lastActiveTabInfo?: any;
+ *     currentTab?: any;
+ * }} SessionTab
+ */
 
 class TabService {
     /** @param {import('../webdriver')} driver */
@@ -45,7 +59,7 @@ class TabService {
         this.driver = driver;
         /** @type {Record<string, TabUtil>} */
         this._utils = {};
-        /** @type {Record<string, { tabCount: number; tabInfos: Record<string, TabInfo> }>} */
+        /** @type {Record<string, SessionTab>} */
         this.sessionTabs = {};
         /** @type {Record<string, string>} */
         this.pendingTabs = {};

package/player/stepActions/locateStepAction.js

@@ -33,6 +33,7 @@ function createUtils(driver) {
             return Promise.resolve([frameHandler.frameOffset || {}]);
         }
 
+        /** @type {typeof import('clickim/src/background/stepActions/locateStepAction').LocateStepAction['htmlStringToDom']} */
         static htmlStringToDom(htmlString, url, nonBodyElements, bodyTagName, setDomTimeout = true) {
             const virtualConsole = new VirtualConsole();
             const jsdom = new JSDOM(htmlString, {
@@ -74,6 +75,7 @@ function createUtils(driver) {
             return true;
         }
 
+        /** @type {typeof import('clickim/src/background/stepActions/locateStepAction').LocateStepAction['isVisible']} */
         static isVisible(target, targetElement, rect, locateStep, frameHandler, allOffsets, dom) {
             const skipVisibilityCheck =
                 featureFlags.flags.disableEdgeVisibilityChecks.isEnabled() && driver.isEdge();

package/player/utils/imageCaptureUtils.js

@@ -1,7 +1,10 @@
+// @ts-check
+
 'use strict';
 
-const Promise = require('bluebird');
+const _ = require('lodash');
 const Jimp = require('jimp');
+const utils = require('../../utils');
 
 const logger = require('../../commons/logger').getLogger('image-capture-utils');
 
@@ -13,22 +16,27 @@ class RectIsOutsideOfImageError extends Error {
     }
 }
 
+/**
+ * @param {never} tabId
+ * @param {import('./windowUtils')} windowUtils
+ * @param {import('./screenshotUtils')} screenshotUtils
+ * */
 const ImageCaptureUtils = function (tabId, windowUtils, screenshotUtils) {
     this.windowUtils = windowUtils;
     this.screenshotUtils = screenshotUtils;
 };
 
-function cropImageFromImageData(imageData, imageInfo) {
-    const image = imageInfo.image || imageInfo;
+async function cropImageFromImageData(imageData, imageInfo) {
+    const _image = imageInfo.image || imageInfo;
     const pixelRatio = imageInfo.devicePixelRatio;
 
-    if (!image) {
-        return Promise.reject(new Error('Failed to get image'));
+    if (!_image) {
+        throw new Error('Failed to get image');
     }
 
-    const imageRegExMatch = image.match(/^data\:[^;]*\;base64,(.*)$/);
+    const imageRegExMatch = _image.match(/^data\:[^;]*\;base64,(.*)$/);
     if (!imageRegExMatch) {
-        return Promise.reject(new Error('Image is not in base64 format'));
+        throw new Error('Image is not in base64 format');
     }
 
     // chromeCropImage2
@@ -39,102 +47,67 @@ function cropImageFromImageData(imageData, imageInfo) {
 
     // elementImage
     if (!imageData.elementRect) {
-        const { image, ...rest } = imageData;
-        logger.warn('missing elementRect', { ...rest });
-        return Promise.resolve({});
+        logger.warn('missing elementRect', _.omit(imageData, 'image'));
+        return {};
     }
 
     const { elementRect } = imageData;
-    return new Promise((resolve, reject) => {
-        Jimp.read(Buffer.from(imageRegExMatch[1], 'base64'), (err, image) => {
-            if (err) {
-                return reject(err);
-            }
-            try {
-                let x = elementRect.left * pixelRatio + offset.left * pixelRatio;
-                let y = elementRect.top * pixelRatio + offset.top * pixelRatio;
-                let width = elementRect.width * pixelRatio;
-                let height = elementRect.height * pixelRatio;
-
-                if (x < 0) {
-                    width += x;
-                    width = width < 0 ? 0 : width;
-                    x = 0;
-                }
+    const image = await Jimp.read(Buffer.from(imageRegExMatch[1], 'base64'));
+    let x = elementRect.left * pixelRatio + offset.left * pixelRatio;
+    let y = elementRect.top * pixelRatio + offset.top * pixelRatio;
+    let width = elementRect.width * pixelRatio;
+    let height = elementRect.height * pixelRatio;
+
+    if (x < 0) {
+        width += x;
+        width = width < 0 ? 0 : width;
+        x = 0;
+    }
 
-                if (y < 0) {
-                    height += y;
-                    height = height < 0 ? 0 : height;
-                    y = 0;
-                }
+    if (y < 0) {
+        height += y;
+        height = height < 0 ? 0 : height;
+        y = 0;
+    }
 
-                const imageWidth = image.bitmap.width;
-                const imageHeight = image.bitmap.height;
-                if ((x + width) > imageWidth) {
-                    width = imageWidth - x;
-                }
+    const imageWidth = image.bitmap.width;
+    const imageHeight = image.bitmap.height;
+    if ((x + width) > imageWidth) {
+        width = imageWidth - x;
+    }
 
-                if ((y + height) > imageHeight) {
-                    height = imageHeight - y;
-                }
+    if ((y + height) > imageHeight) {
+        height = imageHeight - y;
+    }
 
-                if (height <= 0 || width <= 0) {
-                    reject(new RectIsOutsideOfImageError('height or width is equal or lower than zero'));
-                    return undefined;
-                }
+    if (height <= 0 || width <= 0) {
+        throw new RectIsOutsideOfImageError('height or width is equal or lower than zero');
+    }
 
-                const cImage = image.crop(x, y, width, height);
-                cImage.getBase64(Jimp.MIME_PNG, (err, base64) => {
-                    if (err) {
-                        return reject(err);
-                    }
-                    resolve({
-                        elementImage: base64,
-                    });
-                    return undefined;
-                });
-                return undefined;
-            } catch (err) {
-                return reject(err);
-            }
-        });
-    });
+    const cImage = image.crop(x, y, width, height);
+    const base64 = await cImage.getBase64Async(Jimp.MIME_PNG);
+    return { elementImage: base64 };
 }
 
-
-function chromeStitchImage(fullSize, parts) {
-    return new Promise((resolve, reject) => {
-        new Jimp(fullSize.width, fullSize.height, ((err, fullImage) => {
-            if (err) {
-                reject(err);
-                return undefined;
-            }
-            return Promise.each(parts, part => new Promise((resolve, reject) => {
-                const imageRegExMatch = part.image.match(/^data\:[^;]*\;base64,(.*)$/);
-                Jimp.read(Buffer.from(imageRegExMatch[1], 'base64'), (err, partImage) => {
-                    if (err) {
-                        return reject(err);
-                    }
-                    fullImage.composite(partImage, part.position.left, part.position.top, (err, image) => {
-                        if (err) {
-                            return reject(err);
-                        }
-                        resolve(image);
-                        return undefined;
-                    });
-                    return undefined;
-                });
-            })).then(() => {
-                fullImage.getBase64(Jimp.MIME_PNG, (err, base64) => {
-                    if (err) {
-                        return reject(err);
-                    }
-                    resolve(base64);
-                    return undefined;
-                });
+async function chromeStitchImage(fullSize, parts) {
+    const fullImage = await Jimp.read(fullSize.width, fullSize.height);
+
+    for (const part of parts) {
+        const imageRegExMatch = part.image.match(/^data\:[^;]*\;base64,(.*)$/);
+        const partImage = await Jimp.read(Buffer.from(imageRegExMatch[1], 'base64'));
+        // From the code or types doesn't seem like `fullImage.composite` has an async Promise API
+        await new Promise((resolve, reject) => {
+            fullImage.composite(partImage, part.position.left, part.position.top, (err) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                resolve();
             });
-        }));
-    });
+        });
+    }
+    const base64 = await fullImage.getBase64Async(Jimp.MIME_PNG);
+    return base64;
 }
 
 function stitchImage(fullSize, parts) {
@@ -194,10 +167,8 @@ ImageCaptureUtils.prototype = {
         return this.screenshotUtils.takeScreenshot(format)
             .then((imageInfo) => cropImageFromImageData(areas, imageInfo).then((result) => {
                 result.screenImage = imageInfo.image;
-                result.absoluteScreenHighlight = getElementAbsoluteRectangle(
-                    areas.elementRect,
-                    imageInfo.devicePixelRatio);
-                return Promise.resolve(result);
+                result.absoluteScreenHighlight = getElementAbsoluteRectangle(areas.elementRect, imageInfo.devicePixelRatio);
+                return result;
             }));
     },
 
@@ -211,10 +182,8 @@ ImageCaptureUtils.prototype = {
             .then((imageInfo) => {
                 const result = {};
                 result.screenImage = imageInfo.image;
-                result.absoluteScreenHighlight = getElementAbsoluteRectangle(
-                    areas.elementRect,
-                    imageInfo.devicePixelRatio);
-                return Promise.resolve(result);
+                result.absoluteScreenHighlight = getElementAbsoluteRectangle(areas.elementRect, imageInfo.devicePixelRatio);
+                return result;
             }).then(uploadAllDataUrls);
     },
 
@@ -226,14 +195,12 @@ ImageCaptureUtils.prototype = {
         return this.screenshotUtils.getCurrentDevicePixelRatio();
     },
 
-    takeStitchedDataUrl(useImprovedScreenshotStitching) {
+    async takeStitchedDataUrl(useImprovedScreenshotStitching) {
         const windowUtil = this.windowUtils;
         const getCurrentScrollPosition = windowUtil.getCurrentScrollPosition.bind(windowUtil);
 
         const that = this;
-        const stabilize = () => new Promise(resolve => {
-            setTimeout(resolve, 250);
-        });
+        const stabilize = () => utils.delay(250);
         const usingImprovedStitching = Boolean(useImprovedScreenshotStitching);
         const scroll = usingImprovedStitching ?
             (pos) => windowUtil.scrollToPositionWithoutAnimation.bind(windowUtil)(pos) :
@@ -243,12 +210,7 @@ ImageCaptureUtils.prototype = {
             return scroll(position)
                 .then(stabilize)
                 .then(() => that.screenshotUtils.takeScreenshot())
-                .then(imageInfo => {
-                    const imageData = {
-                        elementRect: crop,
-                    };
-                    return cropImageFromImageData(imageData, imageInfo);
-                })
+                .then(imageInfo => cropImageFromImageData({ elementRect: crop }, imageInfo))
                 .then(cropResult => ({
                     position: { left: position.x + crop.left, top: position.y + crop.top },
                     size: { width: crop.width, height: crop.height },
@@ -256,13 +218,13 @@ ImageCaptureUtils.prototype = {
                 }));
         }
 
-        function takeAllParts(positionsData) {
-            const takeAllPartsPromises = positionsData.reduce(function (allParts, nextPos) {
-                const lastPart = allParts[allParts.length - 1];
-                allParts.push(lastPart.then(createPart.bind(this, nextPos.scrollPos, nextPos.cropData)));
-                return allParts;
-            }, [Promise.resolve()]);
-            return Promise.all(takeAllPartsPromises);
+        async function takeAllParts(positionsData) {
+            const allParts = [];
+            for (const nextPos of positionsData) {
+                const part = await createPart(nextPos.scrollPos, nextPos.cropData);
+                allParts.push(part);
+            }
+            return allParts;
         }
 
         function getPartsPositions(fullPageSize, viewPortSize) {
@@ -294,12 +256,11 @@ ImageCaptureUtils.prototype = {
             const positions = getPartsPositions(fullPageSize, viewPortSize);
             const parts = await takeAllParts(positions);
             await windowUtil.scrollToPosition(originalPosition);
-            parts.shift();
             return stitchImage(fullPageSize, parts);
         }
 
-        return Promise.all([windowUtil.getFullPageSize(), windowUtil.getViewportSize()])
-            .then(([fullPageSize, viewPortSize]) => createStitchImage(fullPageSize, viewPortSize));
+        const [fullPageSize, viewPortSize] = await Promise.all([windowUtil.getFullPageSize(), windowUtil.getViewportSize()]);
+        return await createStitchImage(fullPageSize, viewPortSize);
     },
 };
 

package/player/webdriver.js

@@ -1,9 +1,9 @@
-/* eslint-disable no-var */
+/* eslint-disable arrow-body-style, no-shadow, @typescript-eslint/prefer-optional-chain, comma-spacing, no-empty, padded-blocks, semi, indent, unicorn/no-useless-promise-resolve-reject, default-param-last, comma-dangle, semi-style, consistent-return, radix, prefer-template, prefer-const, object-shorthand, no-trailing-spaces, operator-linebreak, no-else-return, unicorn/prefer-includes, prefer-arrow-callback, max-len, no-var */
 
 'use strict';
 
+const _ = require('lodash');
 const logger = require('../commons/logger').getLogger('webdriver');
-const Promise = require('bluebird');
 const parser = require('ua-parser-js');
 const desiredCapabilitiesBuilder = require('../commons/testimDesiredCapabilitiesBuilder');
 const { SeleniumError, SeleniumCrashError, IeError } = require('../errors');
@@ -13,7 +13,7 @@ const doubleClick = require('./stepActions/scripts/doubleClick');
 const dispatchFocus = require('./stepActions/scripts/focusElement');
 const { isOldProtocol } = require('./webDriverUtils');
 const featureFlags = require('../commons/featureFlags');
-const _ = require('lodash');
+const { W3C_ELEMENT_ID } = require('./constants');
 
 const [LEFT, RIGHT] = [0, 2];
 const { extractElementId, getCdpAddressForHost } = utils;
@@ -202,7 +202,8 @@ class WebDriver extends WebDriverApi {
     switchToLocatedFrame(locatedElement) {
         return this.getElement(locatedElement)
             .then(async el => {
-                await this.switchToFrame(el.value);
+                const elementId = extractElementId(el.value);
+                await this.switchToFrame({ ELEMENT: elementId, [W3C_ELEMENT_ID]: elementId });
                 return el;
             });
     }
@@ -213,7 +214,7 @@ class WebDriver extends WebDriverApi {
 
     switchToTopFrame() {
         return this.frame().catch(err => {
-            if (err.message && err.message.includes('ECONNREFUSED')) {
+            if (err.message?.includes('ECONNREFUSED')) {
                 throw new SeleniumCrashError();
             }
             throw err;
@@ -221,11 +222,11 @@ class WebDriver extends WebDriverApi {
     }
 
     /**
-     * @returns {Promise<{ value: HTMLElement }>}
+     * @returns {Promise<{ value: HTMLElement | { [W3C_ELEMENT_ID]: string } | { ELEMENT: string } }>}
     */
     getElement(locatedElement) {
         const perfId = this.seleniumPerfStats.markStart(SELENIUM_PERF_MARKS.GET_ELEMENT);
-        if (typeof locatedElement === 'string' || typeof locatedElement === 'number') { // support testimId in the meanwhile for backwards compatability
+        if (typeof locatedElement === 'string' || typeof locatedElement === 'number') { // support testimId in the meanwhile for backwards compatibility
             return this.getElementBySelector(`[testim_dom_element_id='${locatedElement}']`)
                 .finally(() => this.seleniumPerfStats.markEnd(perfId, SELENIUM_PERF_MARKS.GET_ELEMENT));
         }
@@ -452,10 +453,10 @@ class WebDriver extends WebDriverApi {
                     throw testimInternalError;
                 }
                 return this.executeJS('return navigator.userAgent;')
-                    .catch(() => Promise.reject(testimInternalError))
+                    .catch(() => { throw testimInternalError; })
                     .then(ua => {
                         const error = this.isUsingUnsupportedCompabilityMode(ua.value) ? this.getIeError('Can’t run test in IE compatibility mode') : testimInternalError;
-                        return Promise.reject(error);
+                        throw error;
                     });
             });
     }
@@ -586,7 +587,7 @@ class WebDriver extends WebDriverApi {
                 userAgent: rawUserAgent,
                 browserVersion: parse.browser.version
             };
-            return Promise.resolve(this.browserAndOS);
+            return this.browserAndOS;
         });
     }
 
@@ -690,7 +691,7 @@ class WebDriver extends WebDriverApi {
                     this.unsupportedActions.move = true;
                     return this.rightClickWithActionsAPI(element, offsets);
                 }
-                return Promise.reject(err);
+                throw err;
             });
     }
 
@@ -704,7 +705,7 @@ class WebDriver extends WebDriverApi {
                     this.unsupportedActions.move = true;
                     return this.leftClickWithActionsAPI(element, offsets);
                 }
-                return Promise.reject(err);
+                throw err;
             });
     }
 
@@ -826,7 +827,7 @@ class WebDriver extends WebDriverApi {
                             this.unsupportedActions.move = true;
                             return this.dragWithActionsAPI(seleniumElement, xDiff, yDiff, midXRelative, midYRelative);
                         }
-                        return Promise.reject(err);
+                        throw err;
                     });
             });
     }
@@ -857,15 +858,17 @@ class WebDriver extends WebDriverApi {
         }, [{ x: Math.round(startLeft), y: Math.round(startTop) }]);
     }
 
-    dragAndDropWithGeneratedMoves(sourceSeleniumElement, destinationSeleniumElement, rectsAndOffsets) {
+    async dragAndDropWithGeneratedMoves(sourceSeleniumElement, destinationSeleniumElement, rectsAndOffsets) {
         const { fromRect, fromX, fromY, toRect, toX, toY } = rectsAndOffsets;
         const moveSequence = this.getMoveRelativeSequence(fromRect.left + fromX, fromRect.top + fromY, toRect.left + toX, toRect.top + toY);
 
-        return this.moveTo(extractElementId(sourceSeleniumElement), Math.round(fromX), Math.round(fromY))
-            .then(() => this.buttonDown())
-            .then(() => Promise.each(moveSequence, movePosition => this.moveTo(null, movePosition.x, movePosition.y)))
-            .then(() => this.moveTo(extractElementId(destinationSeleniumElement), Math.round(toX), Math.round(toY)))
-            .then(() => this.buttonUp());
+        await this.moveTo(extractElementId(sourceSeleniumElement), Math.round(fromX), Math.round(fromY));
+        await this.buttonDown();
+        for (const movePosition of moveSequence) {
+            await this.moveTo(null, movePosition.x, movePosition.y);
+        }
+        await this.moveTo(extractElementId(destinationSeleniumElement), Math.round(toX), Math.round(toY));
+        return await this.buttonUp();
     }
 
     dragAndDropWithActionsAPIWithGeneratedMoves(rectsAndOffsets) {
@@ -900,7 +903,7 @@ class WebDriver extends WebDriverApi {
                         this.unsupportedActions.move = true;
                         return this.dragAndDropWithActionsAPIWithGeneratedMoves(rectsAndOffsets);
                     }
-                    return Promise.reject(err);
+                    throw err;
                 });
         }
         if (this.unsupportedActions.move) {
@@ -912,7 +915,7 @@ class WebDriver extends WebDriverApi {
                     this.unsupportedActions.move = true;
                     return this.dragAndDropWithActionsAPI(rectsAndOffsets);
                 }
-                return Promise.reject(err);
+                throw err;
             });
     }
 
@@ -934,7 +937,7 @@ class WebDriver extends WebDriverApi {
                     this.unsupportedActions.move = true;
                     return this.doubleClickFallback(element, eventData, offsets);
                 }
-                return Promise.reject(err);
+                throw err;
             });
     }
 

package/reports/junitReporter.js

@@ -3,8 +3,7 @@
 'use strict';
 
 const xml2js = require('xml2js');
-const Promise = require('bluebird');
-const fs = Promise.promisifyAll(require('fs'));
+const fsPromises = require('fs/promises');
 const utils = require('../utils');
 const {
     isAbortedTest, isSkippedTest, getFailedTests, isFailedTest, getFailureEvaluatingCount, getSkippedCount, getAbortedTests,
@@ -34,7 +33,7 @@ class JunitReporter {
             return undefined;
         }
         try {
-            await fs.writeFileAsync(reportFile, reportText);
+            await fsPromises.writeFile(reportFile, reportText);
             console.log('JUnit XML file saved to', reportFile);
             return testResults;
         } catch (err) {
@@ -55,7 +54,7 @@ function getPrintName(testResult) {
 }
 
 async function report(editorUrl, testPlanResults, projectId, branch, classname, options) {
-    function createTestCaseObject(testResult, projectId) {
+    function createTestCaseObject(testResult) {
         const testResultUrl = utils.getTestUrl(editorUrl, projectId, testResult.testId, testResult.resultId, branch);
         const testResultObject = {
             $: {
@@ -102,7 +101,7 @@ async function report(editorUrl, testPlanResults, projectId, branch, classname,
         }
         return {
             $: testSuiteAttributes,
-            testcase: Object.keys(testResults).map(resultId => createTestCaseObject(testResults[resultId], projectId)),
+            testcase: Object.keys(testResults).map(resultId => createTestCaseObject(testResults[resultId])),
         };
     }
 
@@ -130,9 +129,9 @@ async function report(editorUrl, testPlanResults, projectId, branch, classname,
     try {
         const builder = new xml2js.Builder();
         const jUnitXmlReporter = builder.buildObject(testResultObject);
-        return Promise.resolve(jUnitXmlReporter);
+        return jUnitXmlReporter;
     } catch (err) {
-        return Promise.resolve(createErrorjUnitReporter(err));
+        return createErrorjUnitReporter(err);
     }
 }