Merge branch 'trunk' into PEP-484/webdriver-remote-errorhandler

java/client/src/org/openqa/selenium/WrapsDriver.java

@@ -21,6 +21,7 @@
  * This interface indicates that the implementing class knows about the driver that contains it and
  * can export it.
  */
+@FunctionalInterface
 public interface WrapsDriver {
   /**
    * @return The driver that contains this element.

java/client/src/org/openqa/selenium/WrapsElement.java

@@ -20,6 +20,7 @@
 /**
  * Indicates that there is an underlying element that can be used
  */
+@FunctionalInterface
 public interface WrapsElement {
   WebElement getWrappedElement();
 }

java/client/src/org/openqa/selenium/remote/RemoteWebDriver.java

@@ -25,20 +25,26 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.Cookie;
 import org.openqa.selenium.Dimension;
+import org.openqa.selenium.HasCapabilities;
 import org.openqa.selenium.ImmutableCapabilities;
+import org.openqa.selenium.JavascriptExecutor;
 import org.openqa.selenium.MutableCapabilities;
 import org.openqa.selenium.NoSuchFrameException;
 import org.openqa.selenium.NoSuchWindowException;
 import org.openqa.selenium.OutputType;
 import org.openqa.selenium.Pdf;
 import org.openqa.selenium.Platform;
 import org.openqa.selenium.Point;
+import org.openqa.selenium.PrintsPage;
 import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.SessionNotCreatedException;
+import org.openqa.selenium.TakesScreenshot;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.WindowType;
+import org.openqa.selenium.interactions.HasInputDevices;
+import org.openqa.selenium.interactions.Interactive;
 import org.openqa.selenium.interactions.Keyboard;
 import org.openqa.selenium.interactions.Mouse;
 import org.openqa.selenium.interactions.Sequence;
@@ -57,6 +63,7 @@
 import org.openqa.selenium.remote.tracing.Tracer;
 import org.openqa.selenium.remote.tracing.opentelemetry.OpenTelemetryTracer;
 import org.openqa.selenium.virtualauthenticator.Credential;
+import org.openqa.selenium.virtualauthenticator.HasVirtualAuthenticator;
 import org.openqa.selenium.virtualauthenticator.VirtualAuthenticator;
 import org.openqa.selenium.virtualauthenticator.VirtualAuthenticatorOptions;
 
@@ -87,7 +94,14 @@
 import static org.openqa.selenium.remote.CapabilityType.SUPPORTS_JAVASCRIPT;
 
 @Augmentable
-public class RemoteWebDriver implements IsRemoteWebDriver {
+public class RemoteWebDriver implements WebDriver,
+  JavascriptExecutor,
+  HasInputDevices,
+  HasCapabilities,
+  HasVirtualAuthenticator,
+  Interactive,
+  PrintsPage,
+  TakesScreenshot {
 
   // TODO: This static logger should be unified with the per-instance localLogs
   private static final Logger logger = Logger.getLogger(RemoteWebDriver.class.getName());
@@ -218,7 +232,6 @@ public void setFileDetector(FileDetector detector) {
     fileDetector = detector;
   }
 
-  @Override
   public SessionId getSessionId() {
     return sessionId;
   }

java/client/src/org/openqa/selenium/remote/RemoteWebElement.java

@@ -25,11 +25,14 @@
 import org.openqa.selenium.Point;
 import org.openqa.selenium.Rectangle;
 import org.openqa.selenium.SearchContext;
+import org.openqa.selenium.TakesScreenshot;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.WebElement;
+import org.openqa.selenium.WrapsDriver;
 import org.openqa.selenium.WrapsElement;
 import org.openqa.selenium.interactions.Coordinates;
+import org.openqa.selenium.interactions.Locatable;
 import org.openqa.selenium.io.Zip;
 
 import java.io.File;
@@ -42,7 +45,7 @@
 import static org.openqa.selenium.remote.DriverCommand.FIND_CHILD_ELEMENT;
 import static org.openqa.selenium.remote.DriverCommand.FIND_CHILD_ELEMENTS;
 
-public class RemoteWebElement implements IsRemoteWebElement {
+public class RemoteWebElement implements WebElement, Locatable, TakesScreenshot, WrapsDriver  {
 
   private String foundBy;
   protected String id;
@@ -57,7 +60,6 @@ public void setParent(RemoteWebDriver parent) {
     this.parent = parent;
   }
 
-  @Override
   public String getId() {
     return id;
   }

java/client/src/org/openqa/selenium/remote/internal/WebElementToJsonConverter.java

@@ -17,21 +17,19 @@
 
 package org.openqa.selenium.remote.internal;
 
-import static java.util.stream.Collectors.toList;
-
 import com.google.common.collect.ImmutableMap;
-
 import org.openqa.selenium.WrapsElement;
 import org.openqa.selenium.remote.Dialect;
 import org.openqa.selenium.remote.RemoteWebElement;
-import org.openqa.selenium.remote.IsRemoteWebElement;
 
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Function;
 
+import static java.util.stream.Collectors.toList;
+
 /**
  * Converts {@link RemoteWebElement} objects, which may be
  * {@link WrapsElement wrapped}, into their JSON representation as defined by
@@ -53,10 +51,10 @@ public Object apply(Object arg) {
       arg = ((WrapsElement) arg).getWrappedElement();
     }
 
-    if (arg instanceof IsRemoteWebElement) {
+    if (arg instanceof RemoteWebElement) {
       return ImmutableMap.of(
-        Dialect.OSS.getEncodedElementKey(), ((IsRemoteWebElement) arg).getId(),
-        Dialect.W3C.getEncodedElementKey(), ((IsRemoteWebElement) arg).getId());
+        Dialect.OSS.getEncodedElementKey(), ((RemoteWebElement) arg).getId(),
+        Dialect.W3C.getEncodedElementKey(), ((RemoteWebElement) arg).getId());
     }
 
     if (arg.getClass().isArray()) {

java/client/src/org/openqa/selenium/support/decorators/WebDriverDecorator.java

@@ -21,15 +21,19 @@
 import org.openqa.selenium.Beta;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
+import org.openqa.selenium.WrapsDriver;
+import org.openqa.selenium.WrapsElement;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.virtualauthenticator.VirtualAuthenticator;
 
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Proxy;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -230,9 +234,11 @@ public Object call(Decorated<?> target, Method method, Object[] args) throws Thr
 
   public void afterCall(Decorated<?> target, Method method, Object[] args, Object res) {}
 
-  public Object onError(Decorated<?> target, Method method, Object[] args,
-                        InvocationTargetException e) throws Throwable
-  {
+  public Object onError(
+    Decorated<?> target,
+    Method method,
+    Object[] args,
+    InvocationTargetException e) throws Throwable {
     throw e.getTargetException();
   }
 
@@ -275,6 +281,7 @@ private Object decorateResult(Object toDecorate) {
   protected final <Z> Z createProxy(final Decorated<Z> decorated) {
     Set<Class<?>> decoratedInterfaces = extractInterfaces(decorated);
     Set<Class<?>> originalInterfaces = extractInterfaces(decorated.getOriginal());
+    Map<Class<?>, InvocationHandler> derivedInterfaces = deriveAdditionalInterfaces(decorated.getOriginal());
 
     final InvocationHandler handler = (proxy, method, args) -> {
       try {
@@ -288,6 +295,10 @@ protected final <Z> Z createProxy(final Decorated<Z> decorated) {
           decorated.afterCall(method, result, args);
           return result;
         }
+        if (derivedInterfaces.containsKey(method.getDeclaringClass())) {
+          return derivedInterfaces.get(method.getDeclaringClass()).invoke(proxy, method, args);
+        }
+
         return method.invoke(decorated.getOriginal(), args);
       } catch (InvocationTargetException e) {
         return decorated.onError(method, e, args);
@@ -297,6 +308,7 @@ protected final <Z> Z createProxy(final Decorated<Z> decorated) {
     Set<Class<?>> allInterfaces = new HashSet<>();
     allInterfaces.addAll(decoratedInterfaces);
     allInterfaces.addAll(originalInterfaces);
+    allInterfaces.addAll(derivedInterfaces.keySet());
     Class<?>[] allInterfacesArray = allInterfaces.toArray(new Class<?>[0]);
 
     return (Z) Proxy.newProxyInstance(
@@ -329,4 +341,47 @@ private static void extractInterfaces(final Set<Class<?>> collector, final Class
     }
     extractInterfaces(collector, clazz.getSuperclass());
   }
+
+  private Map<Class<?>, InvocationHandler> deriveAdditionalInterfaces(Object object) {
+    Map<Class<?>, InvocationHandler> handlers = new HashMap<>();
+
+    if (object instanceof WebDriver && !(object instanceof WrapsDriver)) {
+      handlers.put(WrapsDriver.class, (proxy, method, args) -> {
+        if ("getWrappedDriver".equals(method.getName())) {
+          return object;
+        }
+        throw new UnsupportedOperationException(method.getName());
+      });
+    }
+
+    if (object instanceof WebElement && !(object instanceof WrapsElement)) {
+      handlers.put(WrapsElement.class, (proxy, method, args) -> {
+        if ("getWrappedElement".equals(method.getName())) {
+          return object;
+        }
+        throw new UnsupportedOperationException(method.getName());
+      });
+    }
+
+    try {
+      Method toJson = object.getClass().getDeclaredMethod("toJson");
+      toJson.setAccessible(true);
+
+      handlers.put(JsonSerializer.class, ((proxy, method, args) -> {
+        if ("toJson".equals(method.getName())) {
+          return toJson.invoke(object);
+        }
+        throw new UnsupportedOperationException(method.getName());
+      }));
+    } catch (NoSuchMethodException e) {
+      // Fine. Just fall through
+    }
+
+    return handlers;
+  }
+
+  @FunctionalInterface
+  interface JsonSerializer {
+    Object toJson();
+  }
 }

java/client/test/org/openqa/selenium/support/decorators/BUILD.bazel

@@ -11,6 +11,7 @@ java_test_suite(
     ),
     deps = [
         "//java/client/src/org/openqa/selenium:core",
+        "//java/client/src/org/openqa/selenium/json",
         "//java/client/src/org/openqa/selenium/remote",
         "//java/client/src/org/openqa/selenium/support/decorators",
         "//java/client/test/org/openqa/selenium/testing:annotations",