@testim/testim-cli 3.289.0 → 3.290.0

package/player/stepActions/inputFileStepAction.js

@@ -1,199 +0,0 @@
-'use strict';
-
-const StepAction = require('./stepAction');
-const inputFileUtils = require('../../inputFileUtils');
-const featureFlagService = require('../../commons/featureFlags');
-const { getLogger } = require('../../commons/logger');
-const { extractElementId, download } = require('../../utils');
-
-const logger = getLogger('input-file-step-action');
-
-class InputFileStepAction extends StepAction {
-    uploadFile(localFileLocation) {
-        return this.driver.uploadFile(localFileLocation);
-    }
-
-    forceInputToBeVisible(target, visibleScriptOptions) {
-        logger.info('workaround - stepaction - move element to visible position');
-
-        const getVisibleElementCode = `
-            var getLocatedElement = ${this.sessionPlayerInit.codeSnippets.getLocatedElementCode};
-            var getVisibleElement = ${inputFileUtils.getVisibleElementScript(visibleScriptOptions)};
-            return getVisibleElement.apply(null, arguments);
-        `;
-
-        return this.driver.executeJS(getVisibleElementCode, target.locatedElement);
-    }
-
-    async safariPreUploadActions(target) {
-        const options = {
-            width: '150px',
-            height: '150px',
-            left: '10px',
-            top: '10px',
-        };
-        try {
-            return await this.forceInputToBeVisible(target, options);
-        } catch (err) {
-            logger.error('failed to set input file in Safari recovery', { err });
-            throw err;
-        }
-    }
-
-    async uploadFilesAndForceVisibility(gridLocalFiles, target) {
-        try {
-            if (this.driver.isSafari()) {
-                await this.safariPreUploadActions(target);
-            }
-            await this.uploadFiles(gridLocalFiles, target);
-        } catch (err) {
-            const edgeErrorEditableMessage = 'The element is not editable';
-            const edgeErrorFocusableMessage = 'The element is not focusable';
-            const safariErrorVisibleMessage = 'An element command could not be completed because the element is not visible on the page.';
-            const elementNotInteractable = 'element not interactable';
-            const elementNotPointerOrKeyboardInteractable = 'element is not pointer- or keyboard interactable';
-            const invalidStateMsg = 'invalid element state: Element is not currently interactable and may not be manipulated';
-            const mustBeVisibleMsg = 'Element must not be hidden, disabled or read-only';
-            const notReachableByKeyboard = 'is not reachable by keyboard';
-            /** @type {string} */
-            const errorMsg = err ? err.message : '';
-            // Workaround move element if element is not visible or disabled
-            if (
-                errorMsg === invalidStateMsg ||
-                errorMsg.startsWith(mustBeVisibleMsg) ||
-                errorMsg.startsWith(edgeErrorEditableMessage) ||
-                errorMsg.startsWith(edgeErrorFocusableMessage) ||
-                errorMsg.startsWith(safariErrorVisibleMessage) ||
-                errorMsg.includes(notReachableByKeyboard) ||
-                errorMsg.includes(elementNotInteractable) ||
-                errorMsg.includes(elementNotPointerOrKeyboardInteractable)
-            ) {
-                await this.forceInputToBeVisible(target);
-                await this.uploadFiles(gridLocalFiles, target);
-                return;
-            }
-
-            logger.error('failed to set input file', { err });
-            throw err;
-        }
-    }
-
-    async uploadFiles(gridLocalFiles, target) {
-        for (const file of gridLocalFiles) {
-            await this.driver.elementIdValue(extractElementId(target.seleniumElement), file);
-        }
-    }
-
-    async performAction() {
-        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 this.sessionPlayerInit.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 (isSafariJsInputCode || isFirefoxJsInputCode) {
-            await this.driver.executeJSWithArray(`
-                const getLocatedElement = ${this.sessionPlayerInit.codeSnippets.getLocatedElementCode};
-                const downloadAndUploadFile = ${downloadAndUpload()};
-                return downloadAndUploadFile.apply(null, arguments);`, [target.locatedElement, fileUrls]);
-            return;
-        }
-
-        const gridLocalFiles = await inputFileUtils.downloadFilesAndUploadToGrid(fileUrls, this.uploadFile.bind(this));
-        await this.uploadFilesAndForceVisibility(gridLocalFiles, target);
-    }
-}
-
-module.exports = InputFileStepAction;
-function downloadAndUpload() {
-    return `async function downloadAndUpload(locatedElement, fileUrls) {
-        const fileIsNative = typeof window.File === 'function' && (window.File.toString().indexOf('native code') > -1);
-        const File = fileIsNative ? window.File : (function obtainSafeGlobals() {
-            const attachTo  = document.body || document.documentElement;
-            if (attachTo) {
-                let tempIFrame;
-                try {
-                    tempIFrame = document.createElement('iframe');
-                    tempIFrame.style.setProperty('display', 'none');
-                    tempIFrame.style.setProperty('pointer-events', 'none');
-                    attachTo.appendChild(tempIFrame);
-                    const { File } = tempIFrame.contentWindow;
-                    return File;
-                } finally {
-                    if (tempIFrame) {
-                        tempIFrame.parentElement.remove(frame);
-                    }
-                }
-            } else {
-                return window.File;
-            }
-        })();
-        const element = getLocatedElement(locatedElement);
-        if(!element) {
-            throw new Error('element not found');
-        }
-
-        function getFileBlob(url) {
-            return new Promise((resolve, reject) => {
-                var xhr = new XMLHttpRequest();
-                xhr.open('GET', url, true);
-                xhr.responseType = 'blob';
-
-                xhr.onload = function() {
-                    if (this.status === 200) {
-                        resolve(this.response);
-                    } else {
-                        reject(new Error('Could not load file, failure status:' + this.status));
-                    }
-                }
-                xhr.onerror = function(e) {
-                    reject(new Error("Error " + e.target.status + " occurred while loading the file."));
-                };
-                xhr.send();
-            });
-
-        }
-
-        const fileList = await Promise.all(fileUrls.map(async ({ url, name }) => {
-            let blob;
-            try {
-                const res = await fetch(url)
-                blob = await res.blob();
-            } catch (err) {
-                blob = await getFileBlob(url); // Sometimes the fetch fails, try using XHR as fallback
-            }
-            return new File([blob], name, { type: blob.type });
-        }));
-
-        const dt = new DataTransfer();
-        for (const file of fileList) {
-            dt.items.add(file);
-        }
-        element.files = dt.files;
-
-        let changeWasFired = false;
-        const changeFiredHandler = (e) => {
-            changeWasFired = true;
-        };
-
-        element.addEventListener("change", changeFiredHandler, true);
-        await Promise.resolve(); // wait microtick
-        element.dispatchEvent(new Event("input", { bubbles: true }));
-        if (!changeWasFired) {
-            element.dispatchEvent(new Event("change", { bubbles: true }));
-        }
-        element.removeEventListener("change", changeFiredHandler, true);
-    }`;
-}

package/player/stepActions/jsCodeStepAction.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const BaseJsStepAction = require('./baseJsStepAction');
-
-class JsCodeStepAction extends BaseJsStepAction {
-    isFailedResult(resultValue) {
-        return resultValue === false;
-    }
-}
-
-module.exports = JsCodeStepAction;

package/player/stepActions/jsConditionStepAction.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const BaseJsStepAction = require('./baseJsStepAction');
-
-class JsConditionStepAction extends BaseJsStepAction {
-    isFailedResult(resultValue) {
-        return !resultValue;
-    }
-}
-
-module.exports = JsConditionStepAction;

package/player/stepActions/locateStepAction.js

@@ -1,159 +0,0 @@
-// @ts-check
-
-'use strict';
-
-const StepAction = require('./stepAction');
-const featureFlags = require('../../commons/featureFlags');
-const { JSDOM, VirtualConsole } = require('jsdom');
-const { getLogger } = require('../../commons/logger');
-const { getSessionPlayer } = require('../../commons/getSessionPlayerRequire');
-
-
-const logger = getLogger('locate-step-action');
-const DEFAULT_VISIBILITY_RESULT = { opacity: 1, clientRects: {} };
-
-/**
- * @param {import('../webdriver')} driver
-*/
-function createUtils(driver) {
-    return {
-        getFrameIdByTestimFrameId() { },
-
-        async setElementResultDataOnContext(target) {
-            const seleniumResponse = await driver.getElement(target.locatedElement);
-            target.seleniumElement = seleniumResponse.value;
-        },
-
-        getElementRectangle(target) {
-            return driver.getElementRect(target);
-        },
-
-        getOffsets(frameHandler) {
-            return Promise.resolve([frameHandler.frameOffset || {}]);
-        },
-
-        /** @type {typeof import('clickim/src/background/stepActions/locateStepAction').LocateStepAction['htmlStringToDom']} */
-        htmlStringToDom(htmlString, url, nonBodyElements, bodyTagName, setDomTimeout = true) {
-            const virtualConsole = new VirtualConsole();
-            const jsdom = new JSDOM(htmlString, {
-                virtualConsole,
-            });
-
-            const { window } = jsdom;
-            if (setDomTimeout) {
-                // memory leak fix.
-                // this used to be nexttick, but it was too soon.
-
-                setTimeout(() => {
-                    window.close();
-                }, 1000 * 60);
-            }
-            return Object.assign(window.document, { TESTIM_URL: url });
-        },
-
-        shouldUseNativeVisibilityCheck(locateStep, driver, visibilityUtils, positionUtils) {
-            if (locateStep.opacity === 0) {
-                return false;
-            }
-            if (locateStep.isShadowed) {
-                return false;
-            }
-            if ((visibilityUtils === undefined) || (positionUtils === undefined)) {
-                return true;
-            }
-            if (featureFlags.flags.useClickimVisibilityChecks.isEnabled()) {
-                return false;
-            }
-            if (driver.isSafari()) {
-                return featureFlags.flags.useSafariWebdriverVisibilityChecks.isEnabled();
-            }
-            return true;
-        },
-
-        /** @type {typeof import('clickim/src/background/stepActions/locateStepAction').LocateStepAction['isVisible']} */
-        async isVisible(target, targetElement, rect, locateStep, frameHandler, allOffsets, dom) {
-            const { locatorBuilderUtils, codeSnippets, visibilityUtils, positionUtils } = getSessionPlayer();
-            const useNativeVisibilityCheck = this.shouldUseNativeVisibilityCheck(locateStep, driver, visibilityUtils, positionUtils);
-            if (useNativeVisibilityCheck) {
-                return driver.isVisible(target.seleniumElement);
-            }
-
-            if (!target.seleniumElement) {
-                return { visible: false, invisibleReason: 'element not found' };
-            }
-
-            // this is here for the side effects.
-            try {
-                await driver.isVisible(target.seleniumElement);
-            } catch {
-                /* ignored */
-            }
-            if (!targetElement || locatorBuilderUtils.isEmptyResult(targetElement)) {
-                return { visible: false, invisibleReason: 'element not found' };
-            }
-            const middlePosition = positionUtils.calculateElementMiddlePoint(rect);
-            const points = [middlePosition, positionUtils.calculateClickPoint(locateStep.clickOffset, rect)].filter(Boolean);
-            const code = codeSnippets.getVisibilityCode.getCompoundVisibilityInfoCode(target.locatedElement, points, false, locateStep);
-            let response;
-            try {
-                response = await driver.execute(`return ${code}`);
-            } catch (err) {
-                logger.error('failed to execute getVisibilityCode', { err });
-                throw err;
-            }
-            const { value } = response || {};
-            const elementVisibilityInfo = value.elementVisibilityInfo || DEFAULT_VISIBILITY_RESULT;
-            const [middleElementFromPoint, clickElementFromPoint] = value.elementsFromPointResults || [null, null];
-            return visibilityUtils.checkElementVisibility(elementVisibilityInfo, locateStep, clickElementFromPoint, middleElementFromPoint, dom, targetElement);
-        },
-
-        scrollToElement(frameHandler, locatedElement) {
-            const { codeSnippets } = getSessionPlayer();
-            const code = codeSnippets.scrollToElement;
-            return driver.execute(code(locatedElement));
-        },
-    };
-}
-
-class LocateStepAction extends StepAction {
-    execute() {
-        return this.driver.getHTML(this.step);
-    }
-
-    static getUtils(driver) {
-        return Object.assign(createUtils(driver), { useLocatedElement: true });
-    }
-
-    static getFrameIdByTestimFrameId(...args) {
-        logger.warn('Unplanned access to getFrameIdByTestimFrameId()');
-        throw new Error('Use .getUtils() instead');
-    }
-
-    static setElementResultDataOnContext(...args) {
-        logger.warn('Unplanned access to setElementResultDataOnContext()');
-        throw new Error('Use .getUtils() instead');
-    }
-
-    static getElementRectangle(...args) {
-        logger.warn('Unplanned access to getElementRectangle()');
-        throw new Error('Use .getUtils() instead');
-    }
-
-    static getOffsets(...args) {
-        logger.warn('Unplanned access to getOffsets()');
-        throw new Error('Use .getUtils() instead');
-    }
-
-    static htmlStringToDom(...args) {
-        logger.warn('Unplanned access to htmlStringToDom()');
-        throw new Error('Use .getUtils() instead');
-    }
-
-    static isVisible(...args) {
-        logger.warn('Unplanned access to isVisible()');
-        throw new Error('Use .getUtils() instead');
-    }
-}
-
-module.exports = LocateStepAction;
-