@testim/testim-cli 3.289.0 → 3.290.0

package/player/utils/eyeSdkService.js

@@ -1,250 +0,0 @@
-/**
- * @typedef {import('@applitools/types').SpecDriver} SpecDriver
- * @typedef {import('@applitools/types').Core} Core
- */
-
-const _ = require('lodash');
-const { makeSDK } = require('@applitools/eyes-sdk-core');
-const { W3C_ELEMENT_ID } = require('../constants');
-const { getSessionPlayer } = require('../../commons/getSessionPlayerRequire');
-
-let packageJson;
-// There is a difference in the folder structure in prod vs. dev
-try {
-    // PRODUCTION
-    // eslint-disable-next-line import/no-unresolved
-    packageJson = require('../../package.json');
-} catch (e) {
-    //pass
-}
-if (!packageJson) {
-    try {
-        // in dev, they are one level up
-        packageJson = require('../../../package.json');
-    } catch (e) {
-        //pass
-    }
-}
-
-const LEGACY_ELEMENT_ID = 'ELEMENT';
-
-function extractElementId(element) {
-    if (_.has(element, 'elementId')) {
-        return element.elementId;
-    }
-    if (_.has(element, W3C_ELEMENT_ID)) {
-        return element[W3C_ELEMENT_ID];
-    }
-    if (_.has(element, LEGACY_ELEMENT_ID)) {
-        return element[LEGACY_ELEMENT_ID];
-    }
-    return undefined;
-}
-
-/**
- * Applitools Spec Driver for webdriverIO 4.
- * @see https://github.com/applitools/eyes.sdk.javascript1/blob/master/packages/eyes-webdriverio-4/src/spec-driver.ts
- * @implements {SpecDriver}
- */
-class EyesSpec {
-    // #region UTILITY
-    isDriver(driver) {
-        return Boolean(driver?.getPrototype && driver.desiredCapabilities && driver.requestHandler);
-    }
-
-    isElement(element) {
-        if (!element) {
-            return false;
-        }
-        const elementToCheck = element.value || element;
-        return Boolean(elementToCheck[W3C_ELEMENT_ID] || elementToCheck[LEGACY_ELEMENT_ID]);
-    }
-
-    isSelector(selector) {
-        return typeof selector === 'string';
-    }
-
-    transformDriver(driver) {
-        return new Proxy(driver, {
-            get: (target, key) => {
-                if (key === 'then') {
-                    return undefined;
-                }
-                return Reflect.get(target, key);
-            },
-        });
-    }
-
-    transformElement(element) {
-        const elementId = extractElementId(element.value || element);
-        return { [W3C_ELEMENT_ID]: elementId, [LEGACY_ELEMENT_ID]: elementId };
-    }
-
-    transformSelector(selector) {
-        if (!_.has(selector, 'selector')) {
-            return selector;
-        }
-        if (!_.has(selector, 'type')) {
-            return selector.selector;
-        }
-        if (selector.type === 'css') {
-            return `css selector:${selector.selector}`;
-        }
-        return `${selector.type}:${selector.selector}`;
-    }
-
-    extractSelector(element) {
-        return _.has(element, 'selector') ? element.selector : undefined;
-    }
-
-    isStaleElementError(error, selector) {
-        if (!error) {
-            return false;
-        }
-        const errOrResult = error.originalError || error;
-        return errOrResult instanceof Error ?
-            errOrResult.seleniumStack && errOrResult.seleniumStack.type === 'StaleElementReference' :
-            errOrResult.value && errOrResult.selector && errOrResult.selector === selector;
-    }
-
-    isEqualElements(_browser, element1, element2) {
-        if (!element1 || !element2) {
-            return false;
-        }
-        const elementId1 = extractElementId(element1);
-        const elementId2 = extractElementId(element2);
-        return elementId1 === elementId2;
-    }
-    // #endregion
-
-    // #region COMMANDS
-    async executeScript(driver, script, arg) {
-        const { value } = await driver.execute(script, arg);
-        return value;
-    }
-
-    async mainContext(driver) {
-        await driver.frame(null);
-        return driver;
-    }
-
-    async parentContext(driver) {
-        await driver.frameParent();
-        return driver;
-    }
-
-    async childContext(driver, element) {
-        await driver.frame(element);
-        return driver;
-    }
-
-    async findElement(driver, selector, parent) {
-        const { value } = parent ? await driver.elementIdElement(extractElementId(parent), selector) : await driver.element(selector);
-        return value;
-    }
-
-    async findElements(driver, selector, parent) {
-        const { value } = parent ? await driver.elementIdElements(extractElementId(parent), selector) : await driver.elements(selector);
-        return value;
-    }
-
-    async getWindowSize(driver) {
-        const { value: size } = await driver.windowHandleSize();
-        return { width: size.width, height: size.height };
-    }
-
-    async setWindowSize(driver, size) {
-        await driver.windowHandlePosition({ x: 0, y: 0 });
-        await driver.windowHandleSize(size);
-    }
-
-    async getDriverInfo(driver) {
-        const desiredCapabilities = driver.desiredCapabilities;
-
-        return {
-            sessionId: driver.requestHandler.sessionID || driver.sessionId,
-            isMobile: driver.isMobile,
-            isNative: driver.isMobile && !desiredCapabilities.browserName,
-            deviceName: desiredCapabilities.deviceName,
-            platformName: desiredCapabilities.platformName || desiredCapabilities.platform,
-            platformVersion: desiredCapabilities.platformVersion,
-            browserName: desiredCapabilities.browserName ?? desiredCapabilities.name,
-            browserVersion: desiredCapabilities.browserVersion ?? desiredCapabilities.version,
-            pixelRatio: desiredCapabilities.pixelRatio,
-        };
-    }
-
-    async getTitle(driver) {
-        return driver.getTitle();
-    }
-
-    async getUrl(driver) {
-        return driver.getUrl();
-    }
-
-    async visit(driver, url) {
-        await driver.url(url);
-    }
-
-    async takeScreenshot(driver) {
-        return driver.saveScreenshot();
-    }
-
-    async click(driver, element) {
-        if (this.isSelector(element)) {
-            element = await this.findElement(driver, element);
-        }
-        await driver.elementIdClick(extractElementId(element));
-    }
-
-    async hover(driver, element, offset) {
-        if (this.isSelector(element)) {
-            element = await this.findElement(driver, element);
-        }
-        await driver.moveTo(extractElementId(element), offset?.x, offset?.y);
-    }
-
-    async type(driver, element, keys) {
-        if (this.isSelector(element)) {
-            element = await this.findElement(driver, element);
-        } else {
-            driver.elementIdValue(extractElementId(element), keys);
-        }
-    }
-
-    async scrollIntoView(driver, element, align = false) {
-        if (this.isSelector(element)) {
-            element = await this.findElement(driver, element);
-        }
-        await driver.execute('arguments[0].scrollIntoView(arguments[1])', element, align);
-    }
-
-    async waitUntilDisplayed(driver, selector, timeout) {
-        await driver.waitForVisible(selector, timeout);
-    }
-    // #endregion
-}
-
-class EyeSdkService {
-    constructor() {
-        const { EyeSdkBuilder } = getSessionPlayer();
-        const sdkVersion = packageJson ? packageJson.dependencies['@applitools/eyes-sdk-core'] : 'N/A';
-
-        /** @type {Core} */
-        this.sdk = makeSDK({
-            name: 'Testim.io',
-            version: `4.0.0/eyes-sdk-core/${sdkVersion}`,
-            spec: new EyesSpec(),
-        });
-        /** @type {typeof EyeSdkBuilder['handleApplitoolsSdkResult']} */
-        this.handleApplitoolsSdkResult = EyeSdkBuilder.handleApplitoolsSdkResult;
-    }
-    async getManager(useVisualGrid, concurrency, batchId, applitoolsIntegrationData) {
-        const { EyeSdkBuilder } = getSessionPlayer();
-        const manager = await this.sdk.makeManager({ type: useVisualGrid ? 'vg' : 'classic', concurrency });
-        EyeSdkBuilder.rememberCreatedBatch(batchId, applitoolsIntegrationData);
-        return manager;
-    }
-}
-
-exports.eyeSdkService = new EyeSdkService();

package/player/utils/imageCaptureUtils.js

@@ -1,267 +0,0 @@
-// @ts-check
-
-'use strict';
-
-const _ = require('lodash');
-const Jimp = require('jimp');
-const utils = require('../../utils');
-
-const logger = require('../../commons/logger').getLogger('image-capture-utils');
-
-class RectIsOutsideOfImageError extends Error {
-    constructor(message) {
-        super(message);
-        this.rectIsOutsideOfImageError = true;
-        Object.setPrototypeOf(this, RectIsOutsideOfImageError.prototype);
-    }
-}
-
-async function cropImageFromImageData(imageData, imageInfo) {
-    const _image = imageInfo.image || imageInfo;
-    const pixelRatio = imageInfo.devicePixelRatio;
-
-    if (!_image) {
-        throw new Error('Failed to get image');
-    }
-
-    const imageRegExMatch = _image.match(/^data\:[^;]*\;base64,(.*)$/);
-    if (!imageRegExMatch) {
-        throw new Error('Image is not in base64 format');
-    }
-
-    // chromeCropImage2
-    const offset = imageData.offset || { top: 0, left: 0 };
-
-    offset.top *= pixelRatio;
-    offset.left *= pixelRatio;
-
-    // elementImage
-    if (!imageData.elementRect) {
-        logger.warn('missing elementRect', _.omit(imageData, 'image'));
-        return {};
-    }
-
-    const { elementRect } = imageData;
-    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;
-    }
-
-    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 (height <= 0 || width <= 0) {
-        throw new RectIsOutsideOfImageError('height or width is equal or lower than zero');
-    }
-
-    const cImage = image.crop(x, y, width, height);
-    const base64 = await cImage.getBase64Async(Jimp.MIME_PNG);
-    return { elementImage: base64 };
-}
-
-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) {
-    return chromeStitchImage(fullSize, parts);
-}
-
-// ???????????
-function uploadDataUrl() {
-    return Promise.resolve();
-}
-
-function uploadAllDataUrls(imagesObject) {
-    function isImageUrl(key) {
-        return (typeof imagesObject[key] === 'string') && imagesObject[key].startsWith('data');
-    }
-
-    function updateKey(key) {
-        return uploadDataUrl(imagesObject[key]).then((imageUrl) => ({ key, url: imageUrl }));
-    }
-
-    return Promise.all(Object.keys(imagesObject).filter(isImageUrl).map(updateKey))
-        .then((keyUrlList) => keyUrlList.reduce((obj, current) => {
-            obj[current.key] = current.url;
-            return obj;
-        }, imagesObject));
-}
-
-function getElementAbsoluteRectangle(elementRect, pixelRatio) {
-    pixelRatio = pixelRatio || 1;
-    elementRect = elementRect || {
-        left: 0, top: 0, width: 0, height: 0,
-    };
-    return {
-        left: pixelRatio * Math.round(elementRect.left),
-        top: pixelRatio * Math.round(elementRect.top),
-        width: pixelRatio * Math.round(elementRect.width),
-        height: pixelRatio * Math.round(elementRect.height),
-        pixelRatio,
-    };
-}
-
-class ImageCaptureUtils {
-    /**
-     * @param {unknown} _unusedId
-     * @param {import('./windowUtils')} windowUtils
-     * @param {import('./screenshotUtils')} screenshotUtils
-     * */
-    constructor(_unusedId, windowUtils, screenshotUtils) {
-        this.windowUtils = windowUtils;
-        this.screenshotUtils = screenshotUtils;
-    }
-
-    async takeViewPortImage() {
-        const imageInfo = await this.screenshotUtils.takeScreenshot();
-        return ((typeof imageInfo === 'string') ? imageInfo : imageInfo.image);
-    }
-
-    takeImageForComparison() {
-        return this.takeViewPortImage();
-    }
-
-    async takeAreaDataUrl(areas, format) {
-        // Future changes in clickim will pass parameters to this function as a single object
-        if (areas.areas) {
-            areas = areas.areas;
-        }
-
-        const imageInfo = await this.screenshotUtils.takeScreenshot(format);
-        const result = await cropImageFromImageData(areas, imageInfo);
-        result.screenImage = imageInfo.image;
-        result.absoluteScreenHighlight = getElementAbsoluteRectangle(areas.elementRect, imageInfo.devicePixelRatio);
-        return result;
-    }
-
-    async takeArea(areas) {
-        // Future changes in clickim will pass parameters to this function as a single object
-        if (areas.areas) {
-            areas = areas.areas;
-        }
-
-        const imageInfo = await this.screenshotUtils.takeScreenshot();
-        return uploadAllDataUrls({
-            screenImage: imageInfo.image,
-            absoluteScreenHighlight: getElementAbsoluteRectangle(areas.elementRect, imageInfo.devicePixelRatio),
-        });
-    }
-
-    forcePixelRatio(forceRatio) {
-        return this.screenshotUtils.forcePixelRatio(forceRatio);
-    }
-
-    getCurrentDevicePixelRatio() {
-        return this.screenshotUtils.getCurrentDevicePixelRatio();
-    }
-
-    async takeStitchedDataUrl(useImprovedScreenshotStitching) {
-        const { windowUtils, screenshotUtils } = this;
-
-        const stabilize = () => utils.delay(250);
-        const usingImprovedStitching = Boolean(useImprovedScreenshotStitching);
-
-        async function createPart(position, crop) {
-            if (usingImprovedStitching) {
-                await windowUtils.scrollToPositionWithoutAnimation(position);
-            } else {
-                await windowUtils.scrollToPosition(position);
-            }
-            await stabilize();
-            const imageInfo = await screenshotUtils.takeScreenshot();
-            const cropResult = await cropImageFromImageData({ elementRect: crop }, imageInfo);
-            return ({
-                position: { left: position.x + crop.left, top: position.y + crop.top },
-                size: { width: crop.width, height: crop.height },
-                image: cropResult.elementImage,
-            });
-        }
-
-        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) {
-            const FPW = Math.max(fullPageSize.width, viewPortSize.width);
-            const VPW = viewPortSize.width;
-            const FPH = Math.max(fullPageSize.height, viewPortSize.height);
-            const VPH = viewPortSize.height;
-            const Ws = Array.from({ length: Math.ceil(FPW / VPW) }, (__, i) => ({
-                scrollX: Math.min(i * VPW, FPW - VPW),
-                cropX: i * VPW - Math.min(i * VPW, FPW - VPW),
-                cropW: VPW - (i * VPW - Math.min(i * VPW, FPW - VPW)),
-            }));
-            const Hs = Array.from({ length: Math.ceil(FPH / VPH) }, (__, i) => ({
-                scrollY: Math.min(i * VPH, FPH - VPH),
-                cropY: i * VPH - Math.min(i * VPH, FPH - VPH),
-                cropH: VPH - (i * VPH - Math.min(i * VPH, FPH - VPH)),
-            }));
-            return Ws.flatMap(w => Hs.map(h => ({
-                scrollPos: { x: w.scrollX, y: h.scrollY },
-                cropData: {
-                    top: h.cropY,
-                    left: w.cropX,
-                    width: w.cropW,
-                    height: h.cropH,
-                },
-            }))
-            );
-        }
-
-        async function createStitchImage(fullPageSize, viewPortSize) {
-            const originalPosition = await windowUtils.getCurrentScrollPosition();
-            const positions = getPartsPositions(fullPageSize, viewPortSize);
-            const parts = await takeAllParts(positions);
-            await windowUtils.scrollToPosition(originalPosition);
-            return stitchImage(fullPageSize, parts);
-        }
-
-        const [fullPageSize, viewPortSize] = await Promise.all([windowUtils.getFullPageSize(), windowUtils.getViewportSize()]);
-        return await createStitchImage(fullPageSize, viewPortSize);
-    }
-}
-
-module.exports = ImageCaptureUtils;

package/player/utils/screenshotUtils.js

@@ -1,68 +0,0 @@
-// @ts-check
-
-'use strict';
-
-const pRetry = require('p-retry');
-
-class ScreenshotUtils {
-    /**
-     * @param {any} tabId
-     * @param {import('../webdriver')} driver
-     */
-    constructor(tabId, driver, options = { takeScreenshots: true }) {
-        this.tabId = tabId;
-        this.driver = driver;
-        this.options = options;
-    }
-
-    base64AddPadding(str) {
-        return str + Array(((4 - (str.length % 4)) % 4) + 1).join('=');
-    }
-
-    shouldTakeScreenshots() {
-        if (typeof this.options.takeScreenshots !== 'boolean') {
-            return true;
-        }
-        return this.options.takeScreenshots;
-    }
-
-    async takeScreenshot() {
-        if (!this.shouldTakeScreenshots()) {
-            return { devicePixelRatio: 1, image: '' };
-        }
-        const MAX_RETRY_COUNT = 3;
-        const SCREENSHOT_RETRY_DELAY = 2000;
-        const devicePixelRatioPromise = this.currentDevicePixelRatio ? Promise.resolve(this.currentDevicePixelRatio) : this.getDevicePixelRatio();
-        const getScreenshot = () => Promise.all([devicePixelRatioPromise, this.driver.takeScreenshot()]);
-        const [devicePixelRatio, image] = await pRetry(getScreenshot, { retries: MAX_RETRY_COUNT, minTimeout: SCREENSHOT_RETRY_DELAY });
-        const base64 = image ? image.value : '';
-        const dataUrl = `data:image/png;base64,${this.base64AddPadding(base64.replace(/[\r\n]/g, ''))}`;
-        return {
-            image: dataUrl,
-            devicePixelRatio,
-        };
-    }
-
-    getDevicePixelRatio() {
-        function devicePixelRatioJS() {
-            try {
-                return window.devicePixelRatio;
-            } catch (err) {
-                return 1;
-            }
-        }
-
-        return this.driver.executeJS(devicePixelRatioJS).then(result => result.value);
-    }
-
-    forcePixelRatio(forceRatio = 1) {
-        this.currentDevicePixelRatio = forceRatio;
-        return Promise.resolve();
-    }
-
-    getCurrentDevicePixelRatio() {
-        return this.currentDevicePixelRatio;
-    }
-}
-
-module.exports = ScreenshotUtils;

package/player/utils/stepActionUtils.js

@@ -1,90 +0,0 @@
-const CookieUtils = require('./cookieUtils');
-const { getSessionPlayer } = require('../../commons/getSessionPlayerRequire');
-
-class StepActionUtils {
-    /** @param {import('../webdriver')} driver */
-    constructor(driver, cookieUtils) {
-        this.driver = driver;
-        this._abortedSteps = [];
-        this.cookieUtils = cookieUtils || new CookieUtils(this.driver);
-    }
-
-    /** @private */
-    get sessionPlayerInit() {
-        return getSessionPlayer();
-    }
-
-    getTimeStamp() {
-        return Date.now();
-    }
-
-    getTestimId(element) {
-        if (!element) {
-            return undefined;
-        }
-        const { locatorBuilderUtils } = this.sessionPlayerInit;
-        const testimIDFieldName = locatorBuilderUtils.TESTIM_ID_FIELD_NAME;
-        return locatorBuilderUtils.isEmptyResult(element) ? locatorBuilderUtils.EMPTY_RESULT_ID : element.getAttribute(testimIDFieldName);
-    }
-
-    resetAbort() {
-        this._abortedSteps = [];
-    }
-
-    abort(result) {
-        this._abortedSteps.push(result);
-    }
-
-    get abortedSteps() {
-        return this._abortedSteps;
-    }
-
-    restoreNativeAlerts() {}
-
-    executeOverloadNativeAlertsInFrame() {}
-
-    getClickOffset(clickOffset, rect) {
-        const { utils } = this.sessionPlayerInit;
-        if (clickOffset && utils.isWithinBounds(0, rect.width, clickOffset.x) && utils.isWithinBounds(0, rect.height, clickOffset.y)) {
-            return {
-                xOffset: clickOffset.x,
-                yOffset: clickOffset.y,
-            };
-        }
-        return {
-            xOffset: rect.width / 2,
-            yOffset: rect.height / 2,
-        };
-    }
-
-    executeInAut(context, code) {
-        return this.driver.executeJS(code).then(r => r.value);
-    }
-
-    extractTargetText(target) {
-        return this.driver.getTargetText(target);
-    }
-
-    extractText(locatedElement) {
-        return this.driver.getElementTextJS(locatedElement);
-    }
-
-    /** @type {import('clickim/src/background/stepActions/stepActionUtils').StepActionUtils['markDynamicParent']} */
-    async markDynamicParent(target, id, frameHandler) {
-        return this.driver.markDynamicParent(target, id, frameHandler);
-    }
-
-    getCookie(name) {
-        return this.cookieUtils.get({ name }).then(cookie => (cookie ? [cookie] : []));
-    }
-    setCookie(cookieObject, frameHandler) {
-        return this.cookieUtils.set(cookieObject).then(cookie => [cookie]);
-    }
-
-    getNextDynamicParent(frameHandler, dynamicParentOptions) {
-        const code = `return ${this.sessionPlayerInit.codeSnippets.getNextDynamicParent(dynamicParentOptions)}`;
-        return this.driver.executeJS(code).then(res => res.value);
-    }
-}
-
-module.exports = StepActionUtils;