@wdio/image-comparison-core/dist/commands/checkWebElement.js

Image comparison core module for @wdio/visual-service - WebdriverIO visual testing framework

import { executeImageCompare } from '../methods/images.js';
import saveWebElement from './saveWebElement.js';
import { methodCompareOptions } from '../helpers/options.js';
import { extractCommonCheckVariables, buildBaseExecuteCompareOptions } from '../helpers/utils.js';
/**
 * Compare  an image of the element
 */
export default async function checkWebElement({ browserInstance, instanceData, folders, element, tag, checkElementOptions, testContext, isNativeContext = false, }) {
    // 1. Extract common variables
    const commonCheckVariables = extractCommonCheckVariables({ folders, instanceData, wicOptions: checkElementOptions.wic });
    const { disableBlinkingCursor, disableCSSAnimation, enableLayoutTesting, enableLegacyScreenshotMethod, hideScrollBars, resizeDimensions, hideElements = [], removeElements = [], waitForFontsLoaded = false, } = checkElementOptions.method;
    // 2. Take the actual element screenshot and retrieve the needed data
    const saveElementOptions = {
        wic: checkElementOptions.wic,
        method: {
            disableBlinkingCursor,
            disableCSSAnimation,
            enableLayoutTesting,
            enableLegacyScreenshotMethod,
            hideScrollBars,
            resizeDimensions,
            hideElements,
            removeElements,
            waitForFontsLoaded,
        },
    };
    const { devicePixelRatio, fileName } = await saveWebElement({
        browserInstance,
        instanceData,
        folders,
        element,
        tag,
        saveElementOptions,
    });
    // 3. Determine the options
    const compareOptions = methodCompareOptions(checkElementOptions.method);
    const executeCompareOptions = buildBaseExecuteCompareOptions({
        commonCheckVariables,
        wicCompareOptions: checkElementOptions.wic.compareOptions,
        methodCompareOptions: compareOptions,
        devicePixelRatio,
        fileName,
        isElementScreenshot: true,
    });
    // 4. Now execute the compare and return the data
    return executeImageCompare({
        isViewPortScreenshot: true,
        isNativeContext,
        options: executeCompareOptions,
        testContext,
    });
}