-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement ShadowDOM APIs in the Java bindings
- Loading branch information
Showing
14 changed files
with
676 additions
and
190 deletions.
There are no files selected for viewing
33 changes: 33 additions & 0 deletions
33
java/client/src/org/openqa/selenium/NoSuchShadowRootException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you 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; | ||
|
|
||
| public class NoSuchShadowRootException extends NotFoundException { | ||
|
|
||
| public NoSuchShadowRootException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| public NoSuchShadowRootException(Throwable cause) { | ||
| super(cause); | ||
| } | ||
|
|
||
| public NoSuchShadowRootException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
java/client/src/org/openqa/selenium/remote/ElementLocation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you 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.remote; | ||
|
|
||
| import org.openqa.selenium.By; | ||
| import org.openqa.selenium.InvalidArgumentException; | ||
| import org.openqa.selenium.NoSuchElementException; | ||
| import org.openqa.selenium.SearchContext; | ||
| import org.openqa.selenium.WebElement; | ||
| import org.openqa.selenium.internal.Require; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.function.BiFunction; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| // Very deliberately kept package private. | ||
| class ElementLocation { | ||
|
|
||
| private final Map<Class<? extends By>, ElementFinder> finders = new HashMap<>(); | ||
|
|
||
| public ElementLocation() { | ||
| finders.put(By.cssSelector("a").getClass(), ElementFinder.REMOTE); | ||
| finders.put(By.linkText("a").getClass(), ElementFinder.REMOTE); | ||
| finders.put(By.partialLinkText("a").getClass(), ElementFinder.REMOTE); | ||
| finders.put(By.tagName("a").getClass(), ElementFinder.REMOTE); | ||
| finders.put(By.xpath("//a").getClass(), ElementFinder.REMOTE); | ||
| } | ||
|
|
||
| public WebElement findElement( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
|
|
||
| Require.nonNull("WebDriver", driver); | ||
| Require.nonNull("Context for finding elements", context); | ||
| Require.nonNull("Method for creating remote requests", createPayload); | ||
| Require.nonNull("Locator", locator); | ||
|
|
||
| ElementFinder mechanism = finders.get(locator.getClass()); | ||
| if (mechanism != null) { | ||
| return mechanism.findElement(driver, context, createPayload, locator); | ||
| } | ||
|
|
||
| // We prefer to use the remote version if possible | ||
| if (locator instanceof By.Remotable) { | ||
| try { | ||
| WebElement element = ElementFinder.REMOTE.findElement(driver, context, createPayload, locator); | ||
| finders.put(locator.getClass(), ElementFinder.REMOTE); | ||
| return element; | ||
| } catch (NoSuchElementException e) { | ||
| finders.put(locator.getClass(), ElementFinder.REMOTE); | ||
| throw e; | ||
| } catch (InvalidArgumentException e) { | ||
| // Fall through | ||
| } | ||
| } | ||
|
|
||
| // But if that's not an option, then default to using the locator | ||
| // itself for finding things. | ||
| try { | ||
| WebElement element = ElementFinder.CONTEXT.findElement(driver, context, createPayload, locator); | ||
| finders.put(locator.getClass(), ElementFinder.CONTEXT); | ||
| return element; | ||
| } catch (NoSuchElementException e) { | ||
| finders.put(locator.getClass(), ElementFinder.CONTEXT); | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| public List<WebElement> findElements( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
|
|
||
| Require.nonNull("WebDriver", driver); | ||
| Require.nonNull("Context for finding elements", context); | ||
| Require.nonNull("Method for creating remote requests", createPayload); | ||
| Require.nonNull("Locator", locator); | ||
|
|
||
| ElementFinder finder = finders.get(locator.getClass()); | ||
| if (finder != null) { | ||
| return finder.findElements(driver, context, createPayload, locator); | ||
| } | ||
|
|
||
| // We prefer to use the remote version if possible | ||
| if (locator instanceof By.Remotable) { | ||
| try { | ||
| List<WebElement> element = ElementFinder.REMOTE.findElements(driver, context, createPayload, locator); | ||
| finders.put(locator.getClass(), ElementFinder.REMOTE); | ||
| return element; | ||
| } catch (NoSuchElementException e) { | ||
| finders.put(locator.getClass(), ElementFinder.REMOTE); | ||
| throw e; | ||
| } catch (InvalidArgumentException e) { | ||
| // Fall through | ||
| } | ||
| } | ||
|
|
||
| // But if that's not an option, then default to using the locator | ||
| // itself for finding things. | ||
| List<WebElement> elements = ElementFinder.CONTEXT.findElements(driver, context, createPayload, locator); | ||
|
|
||
| // Only store the finder if we actually completed successfully. | ||
| finders.put(locator.getClass(), ElementFinder.CONTEXT); | ||
| return elements; | ||
| } | ||
|
|
||
| private enum ElementFinder { | ||
| CONTEXT { | ||
| @Override | ||
| WebElement findElement( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
| WebElement element = locator.findElement(context); | ||
| return massage(driver, context, element, locator); | ||
| } | ||
|
|
||
| @Override | ||
| List<WebElement> findElements( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
| List<WebElement> elements = locator.findElements(context); | ||
| return elements.stream() | ||
| .map(e -> massage(driver, context, e, locator)) | ||
| .collect(Collectors.toList()); | ||
| } | ||
| }, | ||
| REMOTE { | ||
| @Override | ||
| WebElement findElement( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
| By.Remotable.Parameters params = ((By.Remotable) locator).getRemoteParameters(); | ||
| CommandPayload commandPayload = createPayload.apply(params.using(), params.value()); | ||
|
|
||
| Response response = driver.execute(commandPayload); | ||
| WebElement element = (WebElement) response.getValue(); | ||
| if (element == null) { | ||
| throw new NoSuchElementException("Unable to find element with locator " + locator); | ||
| } | ||
| return massage(driver, context, element, locator); | ||
| } | ||
|
|
||
| @Override | ||
| List<WebElement> findElements( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator) { | ||
| By.Remotable.Parameters params = ((By.Remotable) locator).getRemoteParameters(); | ||
| CommandPayload commandPayload = createPayload.apply(params.using(), params.value()); | ||
|
|
||
| Response response = driver.execute(commandPayload); | ||
| @SuppressWarnings("unchecked") List<WebElement> elements = (List<WebElement>) response.getValue(); | ||
|
|
||
| if (elements == null) { // see https://github.com/SeleniumHQ/selenium/issues/4555 | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| return elements.stream() | ||
| .map(e -> massage(driver, context, e, locator)) | ||
| .collect(Collectors.toList()); | ||
| } | ||
| } | ||
| ; | ||
|
|
||
| abstract WebElement findElement( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator); | ||
|
|
||
| abstract List<WebElement> findElements( | ||
| RemoteWebDriver driver, | ||
| SearchContext context, | ||
| BiFunction<String, Object, CommandPayload> createPayload, | ||
| By locator); | ||
|
|
||
| protected WebElement massage(RemoteWebDriver driver, SearchContext context, WebElement element, By locator) { | ||
| if (!(element instanceof RemoteWebElement)) { | ||
| return element; | ||
| } | ||
|
|
||
| RemoteWebElement remoteElement = (RemoteWebElement) element; | ||
| if (locator instanceof By.Remotable) { | ||
| By.Remotable.Parameters params = ((By.Remotable) locator).getRemoteParameters(); | ||
| remoteElement.setFoundBy(context, params.using(), String.valueOf(params.value())); | ||
| } | ||
| remoteElement.setFileDetector(driver.getFileDetector()); | ||
| remoteElement.setParent(driver); | ||
|
|
||
| return remoteElement; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
e1d15c4There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have plans to implement the similar API to work with Shadow DOM for JS binding?
e1d15c4There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@StanislavKharchenko yes! We need browser vendors to help implement the work within the browser first