Loadable Components In Selenium: Make Your Test Robust For Slow Loading Web Pages

Nishant Kashyap - Jan 5 '23 - - Dev Community

Being in automation testing for the last 10 years I have faced a lot of problems. Recently I was working on a selenium automation project and in that project everything was going fine until I faced a most common but difficult problem. How to make sure that my selenium automation testing work fine even for slow loading web pages. A quick google and browsing through forums highlighted that this is a problem that testers are facing for many past years. If you too have faced it then yes, this article is there to help you from my personal experience.

Let’s take a look, at which are the most wanted test automation tools in 2023 that have climbed the top of the ladder so far?

Well, this problem is majorly observed in the case when the web application uses a javascript heavy framework.

The component that’s gonna help us in page loading is an extended version of PageObject pattern called Loadable component.In the selenium library, Loadable Component class helps the automation test engineers to make sure that the page or its component is loaded successfully. This hack should greatly reduce the efforts that you put in debugging your test cases.

Check this out: Appium Tutorial: A Detailed Guide To Appium Automation Testing

On a side note, to make your life of testing easy and fuss-free while debugging, you can try the LT Debug Chrome extension.

To start with, we would first have to make sure that all the PageObject classes extends the abstract LoadableComponent class and in turn provide implementation for the following two methods:

  • protected abstract void load()

  • protected abstract void isLoaded() throws java.lang.Error

Code to ensure whether the page or component inside the page is completely loaded in given in isLoaded(). If the page is not completely loaded, java.lang.Error is thrown

Fallback or mitigation code is given load(), if isLoaded() fails to load the complete page successfully.

Check this out: A Complete End to End Testing Tutorial: Comprehensive Guide With Examples and Best Practices

Let’s take an example on how it works :

Suppose, we have a LoginPage with username, password and submit button.

    import org.openqa.selenium.WebDriver;
    import org.openqa.selenium.WebElement;
    import org.openqa.selenium.support.CacheLookup;
    import org.openqa.selenium.support.FindBy;
    import org.openqa.selenium.support.PageFactory;

    public class LoginPage {

    private WebDriver driver;

    @FindBy(id = "login_username")
    private WebElement usernameInputBox;

    @FindBy(id = "login_password")
    private WebElement passwordInputBox;

    @FindBy(id = "login_submit")
    private WebElement loginButton;

    public AdminLoginPageUsingLoadableComponent(WebDriver driver){
    this.driver = driver;
    PageFactory.initElements(driver, this);
    }

    public NextPage login(String loginUsername, String loginPassword){
    usernameInputBox.sendKeys(loginUsername");
    passwordInputBox.sendKeys(loginPassword");
    loginButton.click();

    return PageFactory.initElements(driver, NextPage.class);
    }

    }

Enter fullscreen mode Exit fullscreen mode

Now, the above PageObject can be transformed using LoadableCompenent like below.

   import org.junit.Assert;
    import org.openqa.selenium.WebDriver;
    import org.openqa.selenium.WebElement;
    import org.openqa.selenium.support.CacheLookup;
    import org.openqa.selenium.support.FindBy;
    import org.openqa.selenium.support.PageFactory;
    import org.openqa.selenium.support.ui.LoadableComponent;

    public class LoginPageUsingLoadableComponent extends LoadableCompenent {

    private WebDriver driver;

    @FindBy(id = "login_username")
    private WebElement usernameInputBox;

    @FindBy(id = "login_password")
    private WebElement passwordInputBox;

    @FindBy(id = "login_submit")
    private WebElement loginButton;

    public LoginPageUsingLoadableComponent(WebDriver driver){
    this.driver = driver;
    PageFactory.initElements(driver, this);
    }

    public NextPage login(String loginUsername, String loginPassword){
    usernameInputBox.sendKeys(loginUsername");
    passwordInputBox.sendKeys(loginPassword");
    loginButton.click();

    return PageFactory.initElements(driver, NextPage.class);
    }

    @Override
    protected void load() {
    driver.get("http://www.example.com/login");
    }

    @Override
    protected void isLoaded() throws Error {
    Assert.assertTrue(driver.getCurrentUrl().contains("login"));
    }

    }

    LoginPageUsingLoadableComponent loginPage = new LoginPageUsingLoadableComponent(driver).get();
Enter fullscreen mode Exit fullscreen mode

The get() method from the LoadableComponent class will ensure sure the page or the component is loaded by invoking the isLoaded() method. If the assertion fails there, load() method is called, followed by isLoaded().

Check this out: A Complete End to End (E2E) Testing Tutorial: Comprehensive Guide With Examples and Best Practices

Hope this article helps in stabilizing UI tests !!!

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .