Make it more convenient to wait on something while reloading the page

[ldaley]

I think it would be useful to have a waitFor like construct that refreshes the browser before each try. I think it would be the same in all other regards.

It should support nested use such as:

refreshWaitFor {
  waitFor(1) {
    // some condition
  } 
}

Based on my, somewhat hazy, understanding of how waitFor is implemented, that support for nesting would come for free.

[erdi]

To confirm that I understand what you're after, refreshWaitFor()'s implementation should be along these lines (this is obviously simplified):

public <T> T refreshWaitFor(Closure<T> block) {
    waitFor {
        browser.driver.navigate.refresh()
        block.call()
    }
}

while keeping the implicit assertions feature on the block passed to it. Is that right?

The method should only be available on Page and not on Module because modules have bases which will become stale as soon as the refresh happens.

[ldaley]

Yeah, that's basically it.

I think this method should probably on be on Browser, as Pages can have cached elements that are going to go stale. However, it's conceivable that the user is going to go on and make use of the page after doing this, so it might be beneficial to get a freshly loaded page out of it.

So perhaps…

<T extends Page> T refreshWaitFor(Class<T> pageType, Closure<?> block) {
  browser.driver.navigate.refresh()
  def page = at(pageType)
  block.call()
  page
}

Page refreshWaitFor(Closure<?> block) {
  def pageType = browser.page.class
  browser.driver.navigate.refresh()
  def page = at(pageType)
  block.call()
  page
}

[erdi]

I decided against passing pages to refreshWaitFor() for it to handle navigating to them because there are 4 signatures of Browser.to() and 4 signatures of waitFor() and combining them in a meaningful way proved tricky. I went with my initial idea, hopefully it still makes things easier for you @ldaley and @timyates.