com.shaft.gui.browser.internal.JavaScriptWaitManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of SHAFT_ENGINE Show documentation
SHAFT is a unified test automation engine. Powered by best-in-class frameworks, SHAFT provides a wizard-like syntax to drive your automation efficiently, maximize your ROI, and minimize your learning curve. Stop reinventing the wheel. Upgrade now!
There is a newer version: 8.2.20240402
Show newest version
package com.shaft.gui.browser.internal;

import com.shaft.driver.SHAFT;
import com.shaft.driver.internal.DriverFactoryHelper;
import com.shaft.tools.internal.support.JavaScriptHelper;
import com.shaft.tools.io.internal.ReportManagerHelper;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.NoSuchSessionException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.support.ui.ExpectedCondition;
import org.openqa.selenium.support.ui.WebDriverWait;

import java.time.Duration;
import java.util.Objects;

public class JavaScriptWaitManager {
    private static int WAIT_DURATION_INTEGER;
    private static final String TARGET_DOCUMENT_READY_STATE = "complete";
    private static final ThreadLocal jsWaitDriver = new ThreadLocal<>();
    private static final int delayBetweenPolls = 20; // milliseconds
    private static JavascriptExecutor jsExec;

    private JavaScriptWaitManager() {
        throw new IllegalStateException("Utility class");
    }

    private static void setDriver(WebDriver driver) {
        jsWaitDriver.set(driver);
        jsExec = (JavascriptExecutor) jsWaitDriver.get();
        WAIT_DURATION_INTEGER = SHAFT.Properties.timeouts.lazyLoadingTimeout();
    }

    /**
     * Waits for jQuery, Angular, and/or Javascript if present on the current page.
     */
    public static void waitForLazyLoading() {
        setDriver(DriverFactoryHelper.getDriver().get());
        if (SHAFT.Properties.timeouts.waitForLazyLoading()
                && !DriverFactoryHelper.isMobileNativeExecution()) {
            try {
                waitForJQueryLoadIfDefined();
                waitForAngularIfDefined();
                waitForJSLoadIfDefined();
            } catch (NoSuchSessionException | NullPointerException e) {
                // do nothing
            } catch (WebDriverException e) {
                if (!e.getMessage().contains("jQuery is not defined")) {
                    ReportManagerHelper.logDiscrete(e);
                }
                // else do nothing
            } catch (Exception e) {
                ReportManagerHelper.logDiscrete(e);
            }
        }
    }

    private static void waitForJQueryLoadIfDefined() {
        Boolean jQueryDefined = (Boolean) jsExec.executeScript("return typeof jQuery != 'undefined'");
        if (Boolean.TRUE.equals(jQueryDefined)) {
            ExpectedCondition jQueryLoad = null;
            try {
                // Wait for jQuery to load
                jQueryLoad = driver -> ((Long) ((JavascriptExecutor) jsWaitDriver.get())
                        .executeScript("return jQuery.active") == 0);
            } catch (NullPointerException e) {
                // do nothing
            }
            // Get JQuery is Ready
            boolean jqueryReady = (Boolean) jsExec.executeScript("return jQuery.active==0");

            if (!jqueryReady) {
                // Wait JQuery until it is Ready!
                int tryCounter = 0;
                while ((!jqueryReady) && (tryCounter < 5)) {
                    try {
                        // Wait for jQuery to load
                        (new WebDriverWait(jsWaitDriver.get(), Duration.ofSeconds(WAIT_DURATION_INTEGER))).until(jQueryLoad);
                    } catch (NullPointerException e) {
                        // do nothing
                    }
                    sleep();
                    tryCounter++;
                    jqueryReady = (Boolean) jsExec.executeScript("return jQuery.active == 0");
                }
            }
        }
    }

    private static void waitForAngularLoad() {
        JavascriptExecutor jsExec = (JavascriptExecutor) jsWaitDriver.get();

        String angularReadyScript = "return angular.element(document).injector().get('$http').pendingRequests.length === 0";

        // Wait for ANGULAR to load
        ExpectedCondition angularLoad = driver -> Boolean
                .valueOf(((JavascriptExecutor) Objects.requireNonNull(driver)).executeScript(angularReadyScript).toString());

        // Get Angular is Ready
        boolean angularReady = Boolean.parseBoolean(jsExec.executeScript(angularReadyScript).toString());

        if (!angularReady) {
            // Wait ANGULAR until it is Ready!
            int tryCounter = 0;
            while ((!angularReady) && (tryCounter < 5)) {
                // Wait for Angular to load
                (new WebDriverWait(jsWaitDriver.get(), Duration.ofSeconds(WAIT_DURATION_INTEGER))).until(angularLoad);
//                ExpectedCondition finalAngularLoad = angularLoad;
//                (new WebDriverWait(jsWaitDriver.get(), WAIT_DURATION)).until(waitDriver-> finalAngularLoad);
                // More Wait for stability (Optional)
                sleep();
                tryCounter++;
                angularReady = Boolean.parseBoolean(jsExec.executeScript(angularReadyScript).toString());
            }
        }
    }

    private static void waitForJSLoadIfDefined() {
        JavascriptExecutor jsExec = (JavascriptExecutor) jsWaitDriver.get();

        // Wait for Javascript to load
        ExpectedCondition jsLoad = driver -> ((JavascriptExecutor) jsWaitDriver.get())
                .executeScript(JavaScriptHelper.DOCUMENT_READYSTATE.getValue()).toString().trim()
                .equalsIgnoreCase(TARGET_DOCUMENT_READY_STATE);

        // Get JS is Ready
        boolean jsReady = jsExec.executeScript(JavaScriptHelper.DOCUMENT_READYSTATE.getValue()).toString().trim()
                .equalsIgnoreCase(TARGET_DOCUMENT_READY_STATE);

        // Wait Javascript until it is Ready!
        if (!jsReady) {
            // Wait JS until it is Ready!
            int tryCounter = 0;
            while ((!jsReady) && (tryCounter < 5)) {
                // Wait for Javascript to load
                try {
                    (new WebDriverWait(jsWaitDriver.get(), Duration.ofSeconds(WAIT_DURATION_INTEGER))).until(jsLoad);
                } catch (org.openqa.selenium.TimeoutException e) {
                    //do nothing
                    //TODO: confirm that this fixed the timeout issue on the grid
                }
                // More Wait for stability (Optional)
                sleep();
                tryCounter++;
                jsReady = jsExec.executeScript(JavaScriptHelper.DOCUMENT_READYSTATE.getValue()).toString().trim()
                        .equalsIgnoreCase(TARGET_DOCUMENT_READY_STATE);
            }
        }
    }

    private static void waitForAngularIfDefined() {
        try {
            Boolean angularDefined = !((Boolean) jsExec.executeScript("return window.angular === undefined"));
            if (Boolean.TRUE.equals(angularDefined)) {
                Boolean angularInjectorDefined = !((Boolean) jsExec
                        .executeScript("return angular.element(document).injector() === undefined"));

                if (Boolean.TRUE.equals(angularInjectorDefined)) {
                    waitForAngularLoad();
                }
            }
        } catch (WebDriverException e) {
            // do nothing
        }
    }

    private static void sleep() {
        try {
            Thread.sleep(JavaScriptWaitManager.delayBetweenPolls);
        } catch (Exception e) {
            ReportManagerHelper.logDiscrete(e);
            // InterruptedException
        }
    }
}