Selenium wait until document is ready

Question

Can anyone let me how can I make selenium wait until the time the page loads completely  I want something generic  I know I can configure WebDriverWait and call something like  find  to make it wait but I don t go that far  I just need to test that the page loads successfully and move on to next page to test   I found something in  net but couldn t make it work in java      IWait lt IWebDriver gt  wait   new OpenQA Selenium Support UI WebDriverWait driver  TimeSpan FromSeconds 30 00    wait Until driver1   gt    IJavaScriptExecutor driver  ExecuteScript  return document readyState   Equals  complete       Any thoughts anyone

User · Answer

This is a working Java version of the example you gave :

void waitForLoad(WebDriver driver) {
    new WebDriverWait(driver, 30).until((ExpectedCondition<Boolean>) wd ->
            ((JavascriptExecutor) wd).executeScript("return document.readyState").equals("complete"));
}

Example For c#:

public static void WaitForLoad(IWebDriver driver, int timeoutSec = 15)
{
    IJavaScriptExecutor js = (IJavaScriptExecutor)driver;
    WebDriverWait wait = new WebDriverWait(driver, new TimeSpan(0, 0, timeoutSec));
    wait.Until(wd => js.ExecuteScript("return document.readyState").ToString() == "complete");
}

Example for PHP:

final public function waitUntilDomReadyState(RemoteWebDriver $webDriver): void
{
    $webDriver->wait()->until(function () {
        return $webDriver->executeScript('return document.readyState') === 'complete';
    });
}

User · Answer

normaly when selenium open a new page from a click or submit or get methods  it will wait untell the page is loaded but the probleme is when the page have a xhr call  ajax  he will never wait of the xhr to be loaded  so creating a new methode to monitor a xhr and wait for them it will be the good    public boolean waitForJSandJQueryToLoad         WebDriverWait wait   new WebDriverWait webDriver  30          wait for jQuery to load     ExpectedCondition lt Boolean gt  jQueryLoad   new ExpectedCondition lt Boolean gt             Override       public Boolean apply WebDriver driver            try               Long r    Long   JavascriptExecutor driver  executeScript  return   active                return r    0            catch  Exception e                LOG info  no jquery present                return true                                   wait for Javascript to load     ExpectedCondition lt Boolean gt  jsLoad   new ExpectedCondition lt Boolean gt             Override       public Boolean apply WebDriver driver            return   JavascriptExecutor driver  executeScript  return document readyState            toString   equals  complete                      return wait until jQueryLoad   amp  amp  wait until jsLoad       if   active    0 so the is no active xhrs call  that work only with jQuery   for javascript ajax call you have to create a variable in your project and simulate it

User · Answer

For C  NUnit  you need to convert WebDriver to JSExecuter and then execute the script to check if document ready state is complete or not  Check below code for reference     public static void WaitForLoad IWebDriver driver                IJavaScriptExecutor js    IJavaScriptExecutor driver          int timeoutSec   15          WebDriverWait wait   new WebDriverWait driver  new TimeSpan 0  0  timeoutSec            wait Until wd   gt  js ExecuteScript  return document readyState   ToString       complete            This will wait until the condition is satisfied or timeout

User · Answer

In Java it will like below  -    private static boolean isloadComplete WebDriver driver                return   JavascriptExecutor  driver  executeScript  return document readyState   equals  loaded                        JavascriptExecutor  driver  executeScript  return document readyState   equals  complete

User · Answer

Are you using Angular  If you are it is possible that the webdriver doesn t recognize that the async calls have finished   I recommend looking at Paul Hammants ngWebDriver  The method waitForAngularRequestsToFinish   could come in handy

User · Answer

WebDriverWait wait   new WebDriverWait dr  30   wait until ExpectedConditions jsReturnsValue  return document readyState    complete

User · Answer

Ben Dryer s answer didn t compile on my machine   The method until Predicate lt WebDriver gt   is ambiguous for the type WebDriverWait      Working Java 8 version   Predicate lt WebDriver gt  pageLoaded   wd - gt    JavascriptExecutor  wd  executeScript           return document readyState   equals  complete    new FluentWait lt WebDriver gt  driver  until pageLoaded     Java 7 version    Predicate lt WebDriver gt  pageLoaded   new Predicate lt WebDriver gt                Override         public boolean apply WebDriver input                return   JavascriptExecutor  input  executeScript  return document readyState   equals  complete                  new FluentWait lt WebDriver gt  driver  until pageLoaded

User · Answer

Have a look at tapestry web-framework  You can download source code there   The idea is to signalize that page is ready by html attribute of body  You can use this idea ignore complicated sue cases    lt html gt   lt head gt   lt  head gt   lt body data-page-initialized  false  gt       lt p gt Write you page here lt  p gt        lt script gt        document  ready function                document body  attr  data-page-initialized    true                 lt  script gt     lt  body gt   lt  html gt    And then create extension of Selenium webdriver  according to tapestry framework   public static void WaitForPageToLoad this IWebDriver driver  int timeout   15000          wait a bit for the page to start loading     Thread Sleep 100             In a limited number of cases  a  page  is an container error page or raw HTML content        that does not include the body element and data-page-initialized element  In those cases         there will never be page initialization in the Tapestry sense and we return immediately      if   driver ElementIsDisplayed   html body  data-page-initialized                                   return             Stopwatch stopwatch   Stopwatch StartNew         int sleepTime   20       while true                if  driver ElementIsDisplayed   html body  data-page-initialized  true                            return                     if  stopwatch ElapsedMilliseconds  gt  30000                        throw new Exception  Page did not finish initializing after 30 seconds                        Thread Sleep sleepTime           sleepTime    2     geometric row of sleep time                     Use extension ElementIsDisplayed written by Alister Scott   public static bool ElementIsDisplayed this IWebDriver driver  string xpath        try               return driver FindElement By XPath xpath   Displayed            catch NoSuchElementException                return false            And finally create test   driver Url   this GetAbsoluteUrl   Account Login                driver WaitForPageToLoad

User · Answer

You can have the thread sleep till the page is reloaded  This is not the best solution  because you need to have an estimate of how long does the page take to load   driver get homeUrl    Thread sleep 5000   driver findElement By xpath  Your Xpath here    sendKeys userName   driver findElement By xpath  Your Xpath here    sendKeys passWord   driver findElement By xpath  Your Xpath here    click

User · Answer

I tried this code and it works for me  I call this function every time I move to another page  public static void waitForPageToBeReady          JavascriptExecutor js    JavascriptExecutor driver         This loop will rotate for 100 times to check If page Is ready after every 1 second        You can replace your if you wants to Increase or decrease wait time      for  int i 0  i lt 400  i                   try                        Thread sleep 1000            catch  InterruptedException e                To check page ready state           if  js executeScript  return document readyState   toString   equals  complete                           break

User · Answer

Here s something similar  in Ruby   wait   Selenium  WebDriver  Wait new  timeout   gt  10  wait until    driver execute script  return document readyState   eql   complete

User · Answer

Like Rubanov wrote for C   i write it for Java  and it is       public void waitForPageLoaded         ExpectedCondition lt Boolean gt  expectation   new             ExpectedCondition lt Boolean gt                      public Boolean apply WebDriver driver                        return    JavascriptExecutor  driver  executeScript  return document readyState   toString   equals  complete   amp  amp   Boolean   JavascriptExecutor driver  executeScript  return jQuery active    0                                           try           Thread sleep 100           WebDriverWait waitForLoad   new WebDriverWait driver  30           waitForLoad until expectation         catch  Throwable error            Assert fail  Timeout waiting for Page Load Request to complete

User · Answer

The following code should probably work   WebDriverWait wait   new WebDriverWait driver  10   wait until ExpectedConditions presenceOfAllElementsLocated By xpath

User · Answer

Try this code     driver manage   timeouts   pageLoadTimeout 10  TimeUnit SECONDS     The above code will wait up to 10 seconds for page loading  If the page loading exceeds the time it will throw the TimeoutException   You catch the exception and do your needs  I am not sure whether it quits the page loading after the exception thrown  i didn t try this code yet  Want to just try it   This is an implicit wait  If you set this once it will have the scope until the Web Driver instance destroy   See the documentation for WebDriver Timeouts for more info

User · Answer

Your suggested solution only waits for DOM readyState to signal complete  But Selenium by default tries to wait for those  and a little bit more  on page loads via the driver get   and element click   methods  They are already blocking  they wait for the page to fully load and those should be working ok   Problem  obviously  are redirects via AJAX requests and running scripts - those can t be caught by Selenium  it doesn t wait for them to finish  Also  you can t reliably catch them via readyState - it waits for a bit  which can be useful  but it will signal complete long before all the AJAX content is downloaded   There is no general solution that would work everywhere and for everyone  that s why it s hard and everyone uses something a little bit different   The general rule is to rely on WebDriver to do his part  then use implicit waits  then use explicit waits for elements you want to assert on the page  but there s a lot more techniques that can be done  You should pick the one  or a combination of several of them  that works best in your case  on your tested page   See my two answers regarding this for more information    How I can check whether page is loaded completely or not in web driver Selenium Webdriver   Wait for complex page with javascript to load

User · Answer

I Checked page load complete  work in Selenium 3 14 0      public static void UntilPageLoadComplete IWebDriver driver  long timeoutInSeconds                Until driver   d    gt                        Boolean isPageLoaded    Boolean   IJavaScriptExecutor driver  ExecuteScript  return document readyState   Equals  complete                if   isPageLoaded  Console WriteLine  Document is loading                return isPageLoaded             timeoutInSeconds              public static void Until IWebDriver driver  Func lt IWebDriver  Boolean gt  waitCondition  long timeoutInSeconds                WebDriverWait webDriverWait   new WebDriverWait driver  TimeSpan FromSeconds timeoutInSeconds            webDriverWait Timeout   TimeSpan FromSeconds timeoutInSeconds           try                       webDriverWait Until waitCondition                     catch  Exception e                        Console WriteLine e

User · Answer

I had a similar problem  I needed to wait until my document was ready but also until all Ajax calls had finished  The second condition proved to be difficult to detect  In the end I checked for active Ajax calls and it worked   Javascript   return  document readyState     complete   amp  amp  jQuery active    0    Full C  method   private void WaitUntilDocumentIsReady TimeSpan timeout        var javaScriptExecutor   WebDriver as IJavaScriptExecutor      var wait   new WebDriverWait WebDriver  timeout                       Check if document is ready     Func lt IWebDriver  bool gt  readyCondition   webDriver   gt  javaScriptExecutor          ExecuteScript  return  document readyState     complete   amp  amp  jQuery active    0         wait Until readyCondition

User · Answer

Here s my attempt at a completely generic solution  in Python   First  a generic  wait  function  use a WebDriverWait if you like  I find them ugly    def wait for condition function       start time   time time       while time time    lt  start time   3          if condition function                return True         else              time sleep 0 1      raise Exception  Timeout waiting for     format condition function   name       Next  the solution relies on the fact that selenium records an  internal  id-number for all elements on a page  including the top-level  lt html gt  element   When a page refreshes or loads  it gets a new html element with a new ID   So  assuming you want to click on a link with text  my link  for example   old page   browser find element by tag name  html    browser find element by link text  my link   click    def page has loaded        new page   browser find element by tag name  html       return new page id    old page id  wait for page has loaded    For more Pythonic  reusable  generic helper  you can make a context manager   from contextlib import contextmanager   contextmanager def wait for page load browser       old page   browser find element by tag name  html        yield      def page has loaded            new page   browser find element by tag name  html           return new page id    old page id      wait for page has loaded    And then you can use it on pretty much any selenium interaction   with wait for page load browser       browser find element by link text  my link   click     I reckon that s bulletproof   What do you think     More info in a blog post about it here

User · Answer

If you have a slow page or network connection  chances are that none of the above will work  I have tried them all and the only thing that worked for me is to wait for the last visible element on that page  Take for example the Bing webpage  They have placed a CAMERA icon  search by image button  next to the main search button that is visible only after the complete page has loaded  If everyone did that  then all we have to do is use an explicit wait like in the examples above

User · Answer

public void waitForPageToLoad        new WebDriverWait driver  DEFAULT WAIT TIME   until new ExpectedCondition lt Boolean gt            public Boolean apply WebDriver d            return    org openqa selenium JavascriptExecutor  driver  executeScript  return document readyState   equals  complete                      Here DEFAULT WAIT TIME is a integer correspond to wait time in seconds

User · Answer

public boolean waitForElement String zoneName  String element  int index  int timeout            WebDriverWait wait   new WebDriverWait appiumDriver  timeout 1000           wait until ExpectedConditions visibilityOfElementLocated By xpath element             return true

User · Answer

For initial page load I have noticed that  Maximizing  the browser window practically waits until page load is completed  including sources   Replace   AppDriver Navigate   GoToUrl url     With   public void OpenURL IWebDriver AppDriver  string Url                                try                                       AppDriver Navigate   GoToUrl Url                       AppDriver Manage   Window Maximize                        AppDriver SwitchTo   ActiveElement                                      catch  Exception e                                        Console WriteLine  ERR   0    1    e TargetSite  e Message                       throw                                    than use   OpenURL myDriver  myUrl     This will load the page  wait until completed  maximize and focus on it  I don t know why its like this but it works   If you want to wait for page load after click on next or any other page navigation trigger other then  Navigate     Ben Dyer s answer  in this thread  will do the work

User · Answer

For the people who need to wait for a specific element to show up   used c    public static void WaitForElement IWebDriver driver  By element        WebDriverWait wait   new WebDriverWait driver  TimeSpan FromSeconds 20        wait Until ExpectedConditions ElementIsVisible element        Then if you want to wait for example if an class  error-message  exists in the DOM you simply do   WaitForElement driver  By ClassName  error-message       For id  it will then be   WaitForElement driver  By Id  yourid

User · Answer

The wait for the document ready event is not the entire fix to this problem  because this code is still in a race condition  Sometimes this code is fired before the click event is processed so this directly returns  since the browser hasn t started loading the new page yet    After some searching I found a post on Obay the testing goat  which has a solution for this problem  The c  code for that solution is something like this    IWebElement page   null        public void WaitForPageLoad          if  page    null               var waitForCurrentPageToStale   new WebDriverWait driver  TimeSpan FromSeconds 10           waitForCurrentPageToStale Until ExpectedConditions StalenessOf page               var waitForDocumentReady   new WebDriverWait driver  TimeSpan FromSeconds 10        waitForDocumentReady Until  wdriver    gt   driver as IJavaScriptExecutor  ExecuteScript  return document readyState   Equals  complete          page   driver FindElement By TagName  html             I fire this method directly after the driver navigate gotourl  so that it gets a reference of the page as soon as possible  Have fun with it

User · Answer

In Nodejs you can get it via promises     If you write this code  you can be sure that the page is fully loaded when you get to the then     driver get  www sidanmor com   then     gt           here the page is fully loaded           do your stuff       catch console log bind console      If you write this code  you will navigate  and selenium will wait 3 seconds     driver get  www sidanmor com    driver sleep 3000      you can t be sure that the page is fully loaded       do your stuff    hope it will be OK      From Selenium documentation   this get  url     Thenable  Schedules a command to navigate to the given URL   Returns a promise that will be resolved when the document has finished loading   Selenium Documentation  Nodejs

User · Answer

I executed a javascript code to check if the document is ready  Saved me a lot of time debugging selenium tests for sites that has client side rendering   public static boolean waitUntilDOMIsReady WebDriver driver    def maxSeconds   DEFAULT WAIT SECONDS   10 for  count in 1  maxSeconds        Thread sleep 100      def ready   isDOMReady driver       if  ready            break               public static boolean isDOMReady WebDriver driver       return driver executeScript  return document readyState

User · Answer

You can write some logic to handle this  I have write a method that will return the WebElement and this method will be called three times or you can increase the time and add a null check for WebElement Here is an example  public static void main String   args            WebDriver driver   new FirefoxDriver            driver get  https   www crowdanalytix com  home            WebElement webElement   getWebElement driver   homekkkkkkkkkkkk            int i   1          while  webElement    null  amp  amp  i  lt  4                webElement   getWebElement driver   homessssssssssss                System out println  calling                i                      System out println webElement getTagName             System out println  End            driver close               public static WebElement getWebElement WebDriver driver  String id            WebElement myDynamicElement   null          try               myDynamicElement    new WebDriverWait driver  10                        until ExpectedConditions presenceOfElementLocated By                              id id                 return myDynamicElement            catch  TimeoutException ex                return null

[selenium] Selenium wait until document is ready

Examples related to selenium

Examples related to load

Examples related to document

Examples related to wait