BrowserService.java

/*
 * Copyright 2022 Automate The Planet Ltd.
 * Author: Anton Angelov
 * Licensed under the Apache License, Version 2.0 (the "License");
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package solutions.bellatrix.web.services;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.text.StringEscapeUtils;
import org.junit.jupiter.api.Assertions;
import org.openqa.selenium.*;
import org.openqa.selenium.logging.LogEntry;
import org.openqa.selenium.logging.LogType;
import org.openqa.selenium.remote.http.HttpMethod;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;
import solutions.bellatrix.core.configuration.ConfigurationService;
import solutions.bellatrix.core.utilities.Log;
import solutions.bellatrix.core.utilities.Wait;
import solutions.bellatrix.web.components.Frame;
import solutions.bellatrix.web.configuration.WebSettings;
import solutions.bellatrix.web.infrastructure.ProxyServer;

import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.logging.Level;

public class BrowserService extends WebService {
    public BrowserService() {
        super();
    }

    public JavascriptExecutor getJavascriptExecutor() {
        return (JavascriptExecutor)getWrappedDriver();
    }

    public String getPageSource() {
        return getWrappedDriver().getPageSource();
    }

    public String getUrl() {
        return getWrappedDriver().getCurrentUrl();
    }

    public String getTitle() {
        return getWrappedDriver().getTitle();
    }

    public void back() {
        getWrappedDriver().navigate().back();
    }

    public void setSize(int width, int height) {
        setSize(new Dimension(width, height));
    }

    public void setSize(Dimension dimension) {
        getWrappedDriver().manage().window().setSize(dimension);
    }

    public void maximize() {
        getWrappedDriver().manage().window().maximize();
    }

    public void minimize() {
        getWrappedDriver().manage().window().minimize();
    }

    public void forward() {
        getWrappedDriver().navigate().forward();
    }

    public void refresh() {
        getWrappedDriver().navigate().refresh();
    }

    public void switchToDefault() {
        getWrappedDriver().switchTo().defaultContent();
    }

    public void switchToActive() {
        getWrappedDriver().switchTo().activeElement();
    }

    public void switchToFirstBrowserTab() {
        getWrappedDriver().switchTo().window(getWrappedDriver().getWindowHandles().stream().findFirst().orElse(""));
    }

    public void switchToLastTab() {
        var handles = getWrappedDriver().getWindowHandles();
        getWrappedDriver().switchTo().window(handles.stream().reduce((first, second) -> second).orElse(""));
    }

    public void switchToNewTab() {
        getWrappedDriver().switchTo().newWindow(WindowType.TAB);
    }

    public void switchToTab(Runnable condition) {
        Wait.retry(() -> {
                    var handles = getWrappedDriver().getWindowHandles();
                    boolean shouldThrowException = true;
                    for (var currentHandle : handles) {
                        getWrappedDriver().switchTo().window(currentHandle);
                        try {
                            condition.run();
                            shouldThrowException = false;
                            break;
                        } catch (Exception ex) {
                            // ignore
                        }
                    }

                    if (shouldThrowException) {
                        throw new TimeoutException();
                    }
                },
                5,
                0,
                TimeoutException.class, NotFoundException.class, StaleElementReferenceException.class);
    }

    public void switchToTab(String tabName) {
        getWrappedDriver().switchTo().window(tabName);
    }

    public void switchToFrame(Frame frame) {
        getWrappedDriver().switchTo().frame(frame.findElement());
    }

    public void clearSessionStorage() {
        getJavascriptExecutor().executeScript("sessionStorage.clear()");
    }

    public void removeItemFromLocalStorage(String item) {
        getJavascriptExecutor().executeScript(String.format("window.localStorage.removeItem('%s');", item));
    }

    public void scrollToBottom() {
        getJavascriptExecutor().executeScript("window.scrollTo(0, document.body.scrollHeight)");
    }

    public void scrollToTop() {
        getJavascriptExecutor().executeScript("window.scrollTo(0, 0)");
    }

    public boolean isItemPresentInLocalStorage(String item) {
        return !(getJavascriptExecutor().executeScript(String.format("return window.localStorage.getItem('%s');", item)) == null);
    }

    public String getItemFromLocalStorage(String key) {
        return (String)getJavascriptExecutor().executeScript(String.format("return window.localStorage.getItem('%s');", key));
    }


    public void setItemInLocalStorage(String item, String value) {
        getJavascriptExecutor().executeScript(String.format("window.localStorage.setItem('%s','%s');", item, value));
    }

    public void clearLocalStorage() {
        getJavascriptExecutor().executeScript("localStorage.clear()");
    }

    public List<LogEntry> getBrowserLogs() {
        return getLogsByType(LogType.BROWSER);
    }

    public List<LogEntry> getLogsByType(String type) {
        try {
            return getWrappedDriver().manage().logs().get(type).toJson();
        }

        catch (UnsupportedCommandException ex) {
            // Unsupported browser
            return new ArrayList<>();
        }
    }

    public void assertNoConsoleErrorsLogged() {
        Assertions.assertEquals(new ArrayList<LogEntry>(),
                getSevereLogEntries(),
                "Severe Errors found in console. If they are expected, add them to the whitelist.");
    }

    public void assertConsoleErrorLogged(String errorMessage, Level severity) {
        var errorLogs = getLogsByType(LogType.BROWSER);
        var filteredLog = errorLogs.stream().filter((log) -> log.getMessage().contains(errorMessage)).findFirst();
        Assertions.assertTrue(filteredLog.isPresent(), "Expected message '%s' not found in console. Actual Log: %s".formatted(errorMessage, errorLogs));
        Assertions.assertEquals(severity,
                filteredLog.get().getLevel(),
                "Log severity is not as expected for message '%s'.".formatted(errorMessage));
    }

    public List<LogEntry> getSevereLogEntries() {
        ArrayList<String> whiteList = ConfigurationService.get(WebSettings.class).getConsoleErrorsWhitelist();

        var logs = getBrowserLogs().stream().filter(
                (logEntry ->
                        (logEntry.getLevel() == Level.SEVERE) &&
                                !(whiteList.stream().anyMatch(listEntry -> logEntry.getMessage().contains(listEntry)))
                )).toList();
        return logs;
    }

    public List<String> getRequestEntries(String partialUrl) {
        return (List<String>)getJavascriptExecutor().executeScript(String.format("return window.performance.getEntriesByType('resource').filter(x => x.name.indexOf('%s') >= 0).map(y => y.name);", partialUrl));
    }

    public void waitForAjax() {
        long ajaxTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForAjaxTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        AtomicInteger ajaxConnections = new AtomicInteger();
        try {
            Wait.retry(() -> {
                        var numberOfAjaxConnections = getJavascriptExecutor().executeScript("return !isNaN(window.$openHTTPs) ? window.$openHTTPs : null");
                        if (Objects.nonNull(numberOfAjaxConnections)) {
                            ajaxConnections.set(Integer.parseInt(numberOfAjaxConnections.toString()));
                            if (ajaxConnections.get() > 0) {
                                String message = "Waiting for %s Ajax Connections...".formatted(ajaxConnections);
                                injectInfoNotificationToast(message);
                                Log.info(message);
                                throw new TimeoutException(message);
                            }
                        } else {
                            monkeyPatchXMLHttpRequest();
                        }
                    },
                    Duration.ofSeconds(ajaxTimeout),
                    Duration.ofSeconds(sleepInterval),
                    true,
                    TimeoutException.class);
        }
        catch (Exception e) {
            var message = "Timed out waiting for %s Ajax connections.".formatted(ajaxConnections.get());
            Log.error(message);
            injectErrorNotificationToast(message);
        }
    }

    private void monkeyPatchXMLHttpRequest() {
        var numberOfAjaxConnections = getJavascriptExecutor().executeScript(("return !isNaN(window.$openHTTPs) ? window.$openHTTPs : null"));

        if (Objects.isNull(numberOfAjaxConnections)) {
            var script = "(function() {" +
                            "const oldOpen = XMLHttpRequest.prototype.open;" +
                            "window.$openHTTPs = 0;" +
                            "XMLHttpRequest.prototype.open = function() {" +
                                "window.$openHTTPs++;" +
                                "this.addEventListener('readystatechange', function() {" +
                                    "if(this.readyState == 4) {" +
                                        "window.$openHTTPs--;" +
                                    "}" +
                                "}, false);" +
                                "return oldOpen.call(this, ...arguments);" +
                            "}" +
                        "})();";

            getJavascriptExecutor().executeScript(script);
        }
    }

    public void waitForAjaxRequest(String requestPartialUrl, int additionalTimeoutInSeconds) {
        long ajaxTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForAjaxTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(ajaxTimeout + additionalTimeoutInSeconds), Duration.ofSeconds(sleepInterval));
        webDriverWait.until(d -> {
            String script = String.format("return performance.getEntriesByType('resource').filter(item => item.initiatorType == 'xmlhttprequest' && item.name.toLowerCase().includes('%s'))[0] !== undefined;", requestPartialUrl);
            boolean result = (boolean)getJavascriptExecutor().executeScript(script);
            return result;
        });
    }

    public void waitForAjaxRequest(String requestPartialUrl) {
        waitForAjaxRequest(requestPartialUrl, 0);
    }

    public void waitUntilPageLoadsCompletely() {
        long waitUntilReadyTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitUntilReadyTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitUntilReadyTimeout), Duration.ofSeconds(sleepInterval));
        try {
            webDriverWait.until(webDriver -> ((JavascriptExecutor)webDriver).executeScript("return document.readyState").equals("complete"));
        } catch (ScriptTimeoutException ex) {
            Log.error("Script timeout while loading for page load.");
        }
    }

    public void injectInfoNotificationToast(String message) {
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Information);
    }

    public void injectInfoNotificationToast(String format, Object... args) {
        String message = String.format(format, args);
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Information);
    }

    public void injectSuccessNotificationToast(String message) {
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Success);
    }

    public void injectSuccessNotificationToast(String format, Object... args) {
        String message = String.format(format, args);
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Success);
    }

    public void injectErrorNotificationToast(String message) {
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Error);
    }

    public void injectErrorNotificationToast(String format, Object... args) {
        String message = String.format(format, args);
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Error);
    }

    public void injectWarningNotificationToast(String message) {
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Warning);
    }

    public void injectWarningNotificationToast(String format, Object... args) {
        String message = String.format(format, args);
        var timeout = ConfigurationService.get(WebSettings.class).getNotificationToastTimeout();
        injectNotificationToast(message, timeout, ToastNotificationType.Warning);
    }

    public void injectNotificationToast(String message, long timeoutMillis, ToastNotificationType type) {
        String escapedMessage = StringEscapeUtils.escapeEcmaScript(message);
        Log.info("[" + type.name() + "] " + escapedMessage);
        String executionScript = """
                window.$bellatrixToastContainer = !window.$bellatrixToastContainer ? Object.assign(document.createElement('div'), {id: 'bellatrixToastContainer', style: 'position: fixed; top: 0; height: 100vh; padding-bottom: 20px; display: flex; pointer-events: none; z-index: 2147483646; justify-content: flex-end; flex-direction: column; overflow: hidden;'}) : window.$bellatrixToastContainer;
                let $message = '""" + escapedMessage + """
                ';
                let $timeout = """ + timeoutMillis + """
                ;
                let $type = '""" + type.toString() + """
                ';
                if (!document.querySelector('#bellatrixToastContainer')) document.body.appendChild(window.$bellatrixToastContainer);
                let $bellatrixToast
                switch ($type.toLowerCase()) {
                    case 'warning':
                        $bellatrixToast = Object.assign(document.createElement('div'), {textContent: $message.trim() ? $message : 'message not set', style: 'pointer-events: none; z-index: 2147483647; color: ' + ($message.trim() ? '#2e0f00' : '#2e0f0088') + '; width: fit-content; background-color: #fdefc9; margin: 5px 10px; border-radius: 10px; padding: 15px 10px 15px 52px; background-repeat: no-repeat; background-position: 5px center; font-family: Arial, Helvetica, sans-serif; font-size: 15px; line-height: 15px; box-shadow: 0px 0.6px 0.7px rgba(0, 0, 0, 0.1), 0px 1.3px 1.7px rgba(0, 0, 0, 0.116), 0px 2.3px 3.5px rgba(0, 0, 0, 0.128), 0px 4.2px 7.3px rgba(0, 0, 0, 0.135), 0px 10px 20px rgba(0, 0, 0, 0.13); background-image: url(\\'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><circle cx="11" cy="-1041.36" r="8" transform="matrix(1 0 0-1 0-1030.36)" opacity=".98" fill="%23ffb816"/><path d="m-26.309 18.07c-1.18 0-2.135.968-2.135 2.129v12.82c0 1.176.948 2.129 2.135 2.129 1.183 0 2.135-.968 2.135-2.129v-12.82c0-1.176-.946-2.129-2.135-2.129zm0 21.348c-1.18 0-2.135.954-2.135 2.135 0 1.18.954 2.135 2.135 2.135 1.181 0 2.135-.954 2.135-2.135 0-1.18-.952-2.135-2.135-2.135z" transform="matrix(.30056 0 0 .30056 18.902 1.728)" fill="%23fff" stroke="%23fff"/></svg>\\');'});
                        break;
                    case 'error':
                        $bellatrixToast = Object.assign(document.createElement('div'), {textContent: $message.trim() ? $message : 'message not set', style: 'pointer-events: none; z-index: 2147483647; color: ' + ($message.trim() ? '#2e0004' : '#2e000488') + '; width: fit-content; background-color: #fdc9d2; margin: 5px 10px; border-radius: 10px; padding: 15px 10px 15px 52px; background-repeat: no-repeat; background-position: 5px center; font-family: Arial, Helvetica, sans-serif; font-size: 15px; line-height: 15px; box-shadow: 0px 0.6px 0.7px rgba(0, 0, 0, 0.1), 0px 1.3px 1.7px rgba(0, 0, 0, 0.116), 0px 2.3px 3.5px rgba(0, 0, 0, 0.128), 0px 4.2px 7.3px rgba(0, 0, 0, 0.135), 0px 10px 20px rgba(0, 0, 0, 0.13); background-image: url(\\'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 22 22"><defs><linearGradient gradientUnits="userSpaceOnUse" y2="-2.623" x2="0" y1="986.67"><stop stop-color="%23ffce3b"/><stop offset="1" stop-color="%23ffd762"/></linearGradient><linearGradient id="0" gradientUnits="userSpaceOnUse" y1="986.67" x2="0" y2="-2.623"><stop stop-color="%23ffce3b"/><stop offset="1" stop-color="%23fef4ab"/></linearGradient><linearGradient gradientUnits="userSpaceOnUse" x2="1" x1="0" xlink:href="%230"/></defs><g transform="matrix(2 0 0 2-11-2071.72)"><path transform="translate(7 1037.36)" d="m4 0c-2.216 0-4 1.784-4 4 0 2.216 1.784 4 4 4 2.216 0 4-1.784 4-4 0-2.216-1.784-4-4-4" fill="%23da4453"/><path d="m11.906 1041.46l.99-.99c.063-.062.094-.139.094-.229 0-.09-.031-.166-.094-.229l-.458-.458c-.063-.062-.139-.094-.229-.094-.09 0-.166.031-.229.094l-.99.99-.99-.99c-.063-.062-.139-.094-.229-.094-.09 0-.166.031-.229.094l-.458.458c-.063.063-.094.139-.094.229 0 .09.031.166.094.229l.99.99-.99.99c-.063.062-.094.139-.094.229 0 .09.031.166.094.229l.458.458c.063.063.139.094.229.094.09 0 .166-.031.229-.094l.99-.99.99.99c.063.063.139.094.229.094.09 0 .166-.031.229-.094l.458-.458c.063-.062.094-.139.094-.229 0-.09-.031-.166-.094-.229l-.99-.99" fill="%23fff"/></g></svg>\\');'});
                        break;
                    case 'success':
                        $bellatrixToast = Object.assign(document.createElement('div'), {textContent: $message.trim() ? $message : 'message not set', style: 'pointer-events: none; z-index: 2147483647; color: ' + ($message.trim() ? '#002e0a' : '#002e0a88') + '; width: fit-content; background-color: #c9fdd4; margin: 5px 10px; border-radius: 10px; padding: 15px 10px 15px 52px; background-repeat: no-repeat; background-position: 5px center; font-family: Arial, Helvetica, sans-serif; font-size: 15px; line-height: 15px; box-shadow: 0px 0.6px 0.7px rgba(0, 0, 0, 0.1), 0px 1.3px 1.7px rgba(0, 0, 0, 0.116), 0px 2.3px 3.5px rgba(0, 0, 0, 0.128), 0px 4.2px 7.3px rgba(0, 0, 0, 0.135), 0px 10px 20px rgba(0, 0, 0, 0.13); background-image: url(\\'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 22 22"><g transform="matrix(1.99997 0 0 1.99997-10.994-2071.68)" fill="%23da4453"><rect y="1037.36" x="7" height="8" width="8" fill="%2332c671" rx="4"/><path d="m123.86 12.966l-11.08-11.08c-1.52-1.521-3.368-2.281-5.54-2.281-2.173 0-4.02.76-5.541 2.281l-53.45 53.53-23.953-24.04c-1.521-1.521-3.368-2.281-5.54-2.281-2.173 0-4.02.76-5.541 2.281l-11.08 11.08c-1.521 1.521-2.281 3.368-2.281 5.541 0 2.172.76 4.02 2.281 5.54l29.493 29.493 11.08 11.08c1.52 1.521 3.367 2.281 5.54 2.281 2.172 0 4.02-.761 5.54-2.281l11.08-11.08 58.986-58.986c1.52-1.521 2.281-3.368 2.281-5.541.0001-2.172-.761-4.02-2.281-5.54" fill="%23fff" transform="matrix(.0436 0 0 .0436 8.177 1039.72)" stroke="none" stroke-width="9.512"/></g></svg>\\');'});
                        break;
                    case 'information':
                        $bellatrixToast = Object.assign(document.createElement('div'), {textContent: $message.trim() ? $message : 'message not set', style: 'pointer-events: none; z-index: 2147483647; color: ' + ($message.trim() ? '#00122e' : '#00122e88') + '; width: fit-content; background-color: #c9ecfd; margin: 5px 10px; border-radius: 10px; padding: 15px 10px 15px 52px; background-repeat: no-repeat; background-position: 7.5px center; font-family: Arial, Helvetica, sans-serif; font-size: 15px; line-height: 15px; background-size: 40px; box-shadow: 0px 0.6px 0.7px rgba(0, 0, 0, 0.1), 0px 1.3px 1.7px rgba(0, 0, 0, 0.116), 0px 2.3px 3.5px rgba(0, 0, 0, 0.128), 0px 4.2px 7.3px rgba(0, 0, 0, 0.135), 0px 10px 20px rgba(0, 0, 0, 0.13); background-image: url(\\'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><g transform="matrix(.92857 0 0 .92857-691.94-149.37)"><circle cx="779.63" cy="195.32" r="28" fill="%230c9fdd"/><g fill="%23fff" fill-rule="evenodd" fill-opacity=".855"><path d="m779.62639 179.16433a3.589743 3.589743 0 0 1 3.58975 3.58975 3.589743 3.589743 0 0 1 -3.58975 3.58974 3.589743 3.589743 0 0 1 -3.58974 -3.58974 3.589743 3.589743 0 0 1 3.58974 -3.58975"/><path d="m779.24 189.93h.764c1.278 0 2.314 1.028 2.314 2.307v16.925c0 1.278-1.035 2.307-2.314 2.307h-.764c-1.278 0-2.307-1.028-2.307-2.307v-16.925c0-1.278 1.028-2.307 2.307-2.307"/></g></g></svg>\\');'});
                }
                window.$bellatrixToastContainer.appendChild($bellatrixToast);
                setTimeout($bellatrixToast.remove.bind($bellatrixToast), $timeout);""";
        try {
            ((JavascriptExecutor)getWrappedDriver()).executeScript(executionScript);
        } catch (Exception ex) {
            Log.error("Failed to inject notification toast.");
        }
    }

    public void waitForReactPageLoadsCompletely() {
        long waitUntilReadyTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitUntilReadyTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitUntilReadyTimeout), Duration.ofSeconds(sleepInterval));
        webDriverWait.until(d -> getJavascriptExecutor().executeScript("return document.querySelector('[data-reactroot]') !== null"));
        webDriverWait.until(d -> getJavascriptExecutor().executeScript("return window.performance.timing.loadEventEnd > 0"));
    }

    // TODO Refactor the other methods to reuse this one
    public void waitUntil(Function function) {
        long waitUntilReadyTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitUntilReadyTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitUntilReadyTimeout), Duration.ofSeconds(sleepInterval));
        String message = Thread.currentThread().getStackTrace()[2].getMethodName();
        webDriverWait.withMessage("Timed out while executing method: %s".formatted(message));
        webDriverWait.until(function);
    }

    public void tryWaitUntil(Function function) {
        long waitUntilReadyTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitUntilReadyTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitUntilReadyTimeout), Duration.ofSeconds(sleepInterval));
        try {
            String message = Thread.currentThread().getStackTrace()[2].getMethodName();
            webDriverWait.withMessage("Timed out while executing method: %s".formatted(message));
            webDriverWait.until(function);
        } catch (TimeoutException exception) {
            Log.error(String.format("Timed out waiting for the condition! %s", function.toString()));
        }
    }

    public void waitForJavaScriptAnimations() {
        long waitForJavaScriptAnimationsTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForJavaScriptAnimationsTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitForJavaScriptAnimationsTimeout), Duration.ofSeconds(sleepInterval));
        webDriverWait.until(d -> (boolean)getJavascriptExecutor().executeScript("return jQuery && jQuery(':animated').length === 0"));
    }

    public void waitForPartialUrl(String partialUrl) {
        long waitForPartialUrlTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForPartialUrl();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitForPartialUrlTimeout), Duration.ofSeconds(sleepInterval));
        webDriverWait.until(ExpectedConditions.urlContains(partialUrl));
    }

    public void waitNumberOfWindowsToBe(int numberOfWindows) {
        long waitNumberOfWindowsToBe = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForPartialUrl();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(waitNumberOfWindowsToBe), Duration.ofSeconds(sleepInterval));
        webDriverWait.until(ExpectedConditions.numberOfWindowsToBe(numberOfWindows));
    }

    public void waitForRequest(String partialUrl) {
        String script = String.format("return performance.getEntriesByType('resource').filter(item => item.name.toLowerCase().includes('%s'))[0] !== undefined;", partialUrl);

        try {
            waitUntil(e -> (boolean)getJavascriptExecutor().executeScript(script));
        } catch (TimeoutException exception) {
            throw new TimeoutException(String.format("The expected request with URL '%s' is not loaded!", partialUrl));
        }
    }

    public void tryWaitForResponse(String partialUrl, int additionalTimeoutInSeconds) {
        try {
            if(ProxyServer.get() != null) {
                ProxyServer.waitForResponse(getWrappedDriver(), partialUrl, HttpMethod.GET, 0);
            } else {
                String script = "return performance.getEntriesByType('resource').filter(item => item.name.toLowerCase().includes('" + partialUrl.toLowerCase() + "'))[0] !== undefined;";
                waitUntil(e -> (boolean)getJavascriptExecutor().executeScript(script));
            }
        } catch (Exception exception) {
            Log.error("The expected request with URL '%s' is not loaded!", partialUrl);
        }
    }

    public void tryWaitForResponse(String partialUrl) {
        tryWaitForResponse(partialUrl, 0);
    }

    public void waitForAngular() {
        long angularTimeout = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getWaitForAngularTimeout();
        long sleepInterval = ConfigurationService.get(WebSettings.class).getTimeoutSettings().getSleepInterval();
        var webDriverWait = new WebDriverWait(getWrappedDriver(), Duration.ofSeconds(angularTimeout), Duration.ofSeconds(sleepInterval));

        String isAngular5 = (String)getJavascriptExecutor().executeScript("return getAllAngularRootElements()[0].attributes['ng-version']");
        if (StringUtils.isBlank(isAngular5)) {
            webDriverWait.until(d -> (boolean)getJavascriptExecutor().executeScript("return window.getAllAngularTestabilities().findIndex(x=>!x.isStable()) === -1"));
        } else {
            boolean isAngularDefined = (boolean)getJavascriptExecutor().executeScript("return window.angular === undefined");
            if (!((boolean)isAngularDefined)) {
                boolean isAngularInjectorUnDefined = (boolean)getJavascriptExecutor().executeScript("return angular.element(document).injector() === undefined");
                if (!isAngularInjectorUnDefined) {
                    webDriverWait.until(d -> (boolean)getJavascriptExecutor().executeScript("return angular.element(document).injector().get('$http').pendingRequests.length === 0"));
                }
            }
        }
    }

    public void assertLandedOnPage(String partialUrl) {
        assertLandedOnPage(partialUrl, false);
    }

    public void assertLandedOnPage(String partialUrl, boolean shouldUrlEncode) {
        if (shouldUrlEncode) {
            partialUrl = URLEncoder.encode(partialUrl, StandardCharsets.UTF_8);
        }

        waitUntilPageLoadsCompletely();

        String currentBrowserUrl = getWrappedDriver().getCurrentUrl().toLowerCase();

        Assert.assertTrue(currentBrowserUrl.contains(partialUrl.toLowerCase()),
                "The expected partialUrl: '" + partialUrl + "' was not found in the PageUrl: '" + currentBrowserUrl + "'");
    }

    public void assertNotLandedOnPage(String partialUrl) {
        assertNotLandedOnPage(partialUrl, false);
    }

    public void assertNotLandedOnPage(String partialUrl, boolean shouldUrlEncode) {
        if (shouldUrlEncode) {
            partialUrl = URLEncoder.encode(partialUrl, StandardCharsets.UTF_8);
        }

        String currentBrowserUrl = getWrappedDriver().getCurrentUrl().toString();
        Assert.assertFalse(currentBrowserUrl.contains(partialUrl),
                "The expected partialUrl: '" + partialUrl + "' was found in the PageUrl: '" + currentBrowserUrl + "'");
    }

    public void assertUrl(String fullUrl) {
        String currentBrowserUrl = getWrappedDriver().getCurrentUrl().toString();
        URI actualUri = null;
        URI expectedUri = null;
        try {
            actualUri = new URI(currentBrowserUrl);
            expectedUri = new URI(fullUrl);
        } catch (URISyntaxException e) {
            throw new RuntimeException(e);
        }

        Assert.assertEquals(actualUri.toASCIIString(), expectedUri.toASCIIString(),
                "Expected URL is different than the Actual one.");
    }

    public void assertUrlPath(String urlPath) {
        String currentBrowserUrl = getWrappedDriver().getCurrentUrl().toString();
        URI actualUri = null;
        try {
            actualUri = new URI(currentBrowserUrl);
        } catch (URISyntaxException e) {
            throw new RuntimeException(e);
        }

        Assert.assertEquals(urlPath, actualUri.getPath(),
                "Expected URL path is different than the Actual one.");
    }

    public void assertUrlPathAndQuery(String pathAndQuery) {
        String currentBrowserUrl = getWrappedDriver().getCurrentUrl().toString();
        URI actualUri = null;
        try {
            actualUri = new URI(currentBrowserUrl);
        } catch (URISyntaxException e) {
            throw new RuntimeException(e);
        }

        Assert.assertEquals(pathAndQuery, actualUri.getPath() + "?" + actualUri.getQuery(),
                "Expected URL is different than the Actual one.");
    }

    public String getLastClipboardEntry() {
        JavaScriptService jsService = new JavaScriptService();
        Object lastCopyObject = jsService.execute("return await window.navigator.clipboard.readText();");
        if (lastCopyObject != null) {
            return lastCopyObject.toString();
        } else {
            return "";
        }
    }
}