This can actually be easily done.
The idea is to get access to the WebDriver
instance and run the JavaScript on it (if it supports it). Then there's a lot of validating, because we need to make sure we only return what we promised.
The ByJavaScript
class itself will look like this:
public class ByJavaScript extends By implements Serializable {
private final String script;
public ByJavaScript(String script) {
checkNotNull(script, "Cannot find elements with a null JavaScript expression.");
this.script = script;
}
@Override
public List<WebElement> findElements(SearchContext context) {
JavascriptExecutor js = getJavascriptExecutorFromSearchContext(context);
// call the JS, inspect and validate response
Object response = js.executeScript(script);
List<WebElement> elements = getElementListFromJsResponse(response);
// filter out the elements that aren't descendants of the context node
if (context instanceof WebElement) {
filterOutElementsWithoutCommonAncestor(elements, (WebElement)context);
}
return elements;
}
private static JavascriptExecutor getJavascriptExecutorFromSearchContext(SearchContext context) {
if (context instanceof JavascriptExecutor) {
// context is most likely the whole WebDriver
return (JavascriptExecutor)context;
}
if (context instanceof WrapsDriver) {
// context is most likely some WebElement
WebDriver driver = ((WrapsDriver)context).getWrappedDriver();
checkState(driver instanceof JavascriptExecutor, "This WebDriver doesn't support JavaScript.");
return (JavascriptExecutor)driver;
}
throw new IllegalStateException("We can't invoke JavaScript from this context.");
}
@SuppressWarnings("unchecked") // cast thoroughly checked
private static List<WebElement> getElementListFromJsResponse(Object response) {
if (response == null) {
// no element found
return Lists.newArrayList();
}
if (response instanceof WebElement) {
// a single element found
return Lists.newArrayList((WebElement)response);
}
if (response instanceof List) {
// found multiple things, check whether every one of them is a WebElement
checkArgument(
Iterables.all((List<?>)response, Predicates.instanceOf(WebElement.class)),
"The JavaScript query returned something that isn't a WebElement.");
return (List<WebElement>)response; // cast is checked as far as we can tell
}
throw new IllegalArgumentException("The JavaScript query returned something that isn't a WebElement.");
}
private static void filterOutElementsWithoutCommonAncestor(List<WebElement> elements, WebElement ancestor) {
for (Iterator<WebElement> iter = elements.iterator(); iter.hasNext(); ) {
WebElement elem = iter.next();
// iterate over ancestors
while (!elem.equals(ancestor) && !elem.getTagName().equals("html")) {
elem = elem.findElement(By.xpath("./.."));
}
if (!elem.equals(ancestor)) {
iter.remove();
}
}
}
@Override
public String toString() {
return "By.javaScript: \"" + script + "\"";
}
}
This code uses the Google Guava library. It is a dependency of Selenium, so you should have it on your classpath. But if there's something you don't understand, look into Guava.
Things to consider:
- Document the whole thing.
- Use better and more helpful exceptions. Consider some custom subclasses of
WebDriverException
. Also add more helpful messages and info.
- Restrict the class' visibility to package. Or embed it into a static factory (as seen in the original
By
class) so that it won't be accessible directly etc.
- Write tests. I have tried the most obvious usages (element can't be found, search from driver, search from some context) and everything seems to be ok, but I didn't test it extensively.
Usage:
WebElement elem = driver.findElement(new ByJavaScript("return document.querySelector('.haha');"));
Now, the original By
class is a static factory that gives out various implementations of itself. Unfortunately, we can't add a new static method to it (without changing its source), so we won't be able to type By.javascript("return something;")
. We have to create our own static factory to get something similar:
public class MyBy {
/**
* Returns a {@code By} which locates elements by the JavaScript expression passed to it.
*
* @param script The JavaScript expression to run and whose result to return
*/
public static By javascript(String script) {
return new ByJavaScript(script);
}
}
Usage:
WebElement elem = driver.findElement(MyBy.javascript("return document.querySelector('.haha');"));