org.openqa.selenium.internal.seleniumemulation.WaitForPageToLoad Maven / Gradle / Ivy
/*
Copyright 2007-2009 WebDriver committers
Copyright 2007-2009 Google Inc.
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 org.openqa.selenium.internal.seleniumemulation;
import com.google.common.base.Throwables;
import com.thoughtworks.selenium.Wait;
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebDriver;
import java.util.logging.Logger;
public class WaitForPageToLoad extends SeleneseCommand {
Logger log = Logger.getLogger(WaitForPageToLoad.class.getName());
private int timeToWait = 250;
/**
* Overrides the default time to wait (in milliseconds) after a page has finished loading.
*
* @param timeToWait the time to wait, in milliseconds, after the page has finished loading
*/
public void setTimeToWait(int timeToWait) {
this.timeToWait = timeToWait;
}
@Override
protected Void handleSeleneseCommand(final WebDriver driver, String timeout, String ignored) {
// Wait until things look like they've been stable for "timeToWait"
if (!(driver instanceof JavascriptExecutor)) {
// Assume that we Do The Right Thing
return null;
}
long timeoutInMillis = Long.parseLong(timeout);
// Micro sleep before we continue in case an async click needs processing.
pause();
Object result = ((JavascriptExecutor) driver).executeScript(
"return !!document['readyState'];");
log.fine("Does browser support readyState: " + result);
Wait wait = (result != null && (Boolean) result) ?
getReadyStateUsingWait(driver) : getLengthCheckingWait(driver);
wait.wait(String.format("Failed to load page within %s ms", timeout), timeoutInMillis);
pause();
return null;
}
private void pause() {
try {
Thread.sleep(timeToWait);
} catch (InterruptedException e) {
throw Throwables.propagate(e);
}
}
private Wait getReadyStateUsingWait(final WebDriver driver) {
return new Wait() {
public boolean until() {
try {
Object result = ((JavascriptExecutor) driver).executeScript(
"return 'complete' == document.readyState;");
if (result != null && result instanceof Boolean && (Boolean) result) {
return true;
}
} catch (Exception e) {
// Possible page reload. Fine
}
return false;
}
};
}
public Wait getLengthCheckingWait(final WebDriver driver) {
return new Wait() {
private int length;
private long seenAt;
@Override
public boolean until() {
// Page length needs to be stable for a second
try {
int currentLength = driver.findElement(By.tagName("body")).getText().length();
if (seenAt == 0) {
seenAt = System.currentTimeMillis();
length = currentLength;
return false;
}
if (currentLength != length) {
seenAt = System.currentTimeMillis();
length = currentLength;
return false;
}
return System.currentTimeMillis() - seenAt > 1000;
} catch (NoSuchElementException ignored) {}
catch (NullPointerException ignored) {}
return false;
}
};
}
}