#875 FIX

Author: TikhomirovSergey

src/main/java/io/appium/java_client/remote/AppiumCommandExecutor.java

@@ -18,25 +18,44 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Throwables.throwIfUnchecked;
+import static java.lang.String.format;
+import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.util.Optional.ofNullable;
+import static org.openqa.selenium.remote.DriverCommand.NEW_SESSION;
 
 import com.google.common.base.Supplier;
 import com.google.common.base.Throwables;
 
+import com.google.common.io.CountingOutputStream;
+import com.google.common.io.FileBackedOutputStream;
+
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.ImmutableCapabilities;
+import org.openqa.selenium.SessionNotCreatedException;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.remote.Command;
 import org.openqa.selenium.remote.CommandCodec;
 import org.openqa.selenium.remote.CommandInfo;
+import org.openqa.selenium.remote.Dialect;
 import org.openqa.selenium.remote.DriverCommand;
 import org.openqa.selenium.remote.HttpCommandExecutor;
+import org.openqa.selenium.remote.ProtocolHandshake;
 import org.openqa.selenium.remote.Response;
+import org.openqa.selenium.remote.ResponseCodec;
 import org.openqa.selenium.remote.http.HttpClient;
 import org.openqa.selenium.remote.http.HttpRequest;
+import org.openqa.selenium.remote.http.HttpResponse;
 import org.openqa.selenium.remote.http.W3CHttpCommandCodec;
 import org.openqa.selenium.remote.service.DriverService;
 
+import java.io.BufferedInputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
 import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.net.ConnectException;
 import java.net.URL;
 import java.util.Map;
@@ -111,8 +130,83 @@ private void setCommandCodec(CommandCodec<HttpRequest> newCodec) {
  setPrivateFieldValue("commandCodec", newCodec);
  }
 
+ private void setResponseCodec(ResponseCodec<HttpResponse> codec) {
+ setPrivateFieldValue("responseCodec", codec);
+ }
+
+ private HttpClient getClient() {
+ //noinspection unchecked
+ return getPrivateFieldValue("client", HttpClient.class);
+ }
+
+ private Response createSession(Command command) throws IOException {
+ if (getCommandCodec() != null) {
+ throw new SessionNotCreatedException("Session already exists");
+ }
+ ProtocolHandshake handshake = new ProtocolHandshake() {
+ @SuppressWarnings("unchecked")
+ public Result createSession(HttpClient client, Command command)
+ throws IOException {
+ Capabilities desired = (Capabilities) command.getParameters().get("desiredCapabilities");
+ desired = desired == null ? new ImmutableCapabilities() : desired;
+
+ int threshold = (int) Math.min(Runtime.getRuntime().freeMemory() / 10, Integer.MAX_VALUE);
+ FileBackedOutputStream os = new FileBackedOutputStream(threshold);
+ try (
+ CountingOutputStream counter = new CountingOutputStream(os);
+ Writer writer = new OutputStreamWriter(counter, UTF_8);
+ NewAppiumSessionPayload payload = NewAppiumSessionPayload.create(desired)) {
+
+ payload.writeTo(writer);
+
+ try (InputStream rawIn = os.asByteSource().openBufferedStream();
+ BufferedInputStream contentStream = new BufferedInputStream(rawIn)) {
+
+ Method createSessionMethod = this.getClass().getSuperclass()
+ .getDeclaredMethod("createSession", HttpClient.class, InputStream.class, long.class);
+ createSessionMethod.setAccessible(true);
+
+ Optional<Result> result = (Optional<Result>) createSessionMethod
+ .invoke(this, client, contentStream, counter.getCount());
+
+ if (result.isPresent()) {
+ Result toReturn = result.get();
+ System.out.print(format("Detected dialect: %s", toReturn.getDialect()));
+ return toReturn;
+ }
+ } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
+ throw new WebDriverException(format("It is impossible to create a new session "
+ + "because 'createSession' which takes %s, %s and %s was not found "
+ + "or it is not accessible",
+ HttpClient.class.getSimpleName(),
+ InputStream.class.getSimpleName(),
+ long.class.getSimpleName()), e);
+ }
+ } finally {
+ os.reset();
+ }
+
+ throw new SessionNotCreatedException(
+ format(
+ "Unable to create new remote session. "
+ + "desired capabilities = %s",
+ desired));
+ }
+ };
+
+ ProtocolHandshake.Result result = handshake
+ .createSession(getClient(), command);
+ Dialect dialect = result.getDialect();
+ setCommandCodec(dialect.getCommandCodec());
+ for (Map.Entry<String, CommandInfo> entry : getAdditionalCommands().entrySet()) {
+ defineCommand(entry.getKey(), entry.getValue());
+ }
+ setResponseCodec(dialect.getResponseCodec());
+ return result.createResponse();
+ }
+
  @Override
- public Response execute(Command command) throws WebDriverException {
+ public Response execute(Command command) throws WebDriverException, IOException {
  if (DriverCommand.NEW_SESSION.equals(command.getName())) {
  serviceOptional.ifPresent(driverService -> {
  try {
@@ -125,7 +219,12 @@ public Response execute(Command command) throws WebDriverException {
 
  Response response;
  try {
- response = super.execute(command);
+ if (!NEW_SESSION.equals(command.getName())) {
+ response = super.execute(command);
+ }
+ else {
+ response = createSession(command);
+ }
  } catch (Throwable t) {
  Throwable rootCause = Throwables.getRootCause(t);
  if (rootCause instanceof ConnectException

src/main/java/org/openqa/selenium/remote/NewSessionPayload.java renamed to src/main/java/io/appium/java_client/remote/NewAppiumSessionPayload.java

@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.writeTo
 
-package org.openqa.selenium.remote;
+package io.appium.java_client.remote;
 
 import static com.google.common.collect.ImmutableMap.of;
 import static com.google.common.collect.ImmutableMap.toImmutableMap;
@@ -38,15 +38,12 @@
 import com.google.common.io.CharStreams;
 import com.google.common.io.FileBackedOutputStream;
 
-import io.appium.java_client.remote.AndroidMobileCapabilityType;
-import io.appium.java_client.remote.IOSMobileCapabilityType;
-import io.appium.java_client.remote.MobileCapabilityType;
-import io.appium.java_client.remote.YouiEngineCapabilityType;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.ImmutableCapabilities;
 import org.openqa.selenium.json.Json;
 import org.openqa.selenium.json.JsonInput;
 import org.openqa.selenium.json.JsonOutput;
+import org.openqa.selenium.remote.Dialect;
 import org.openqa.selenium.remote.session.CapabilitiesFilter;
 import org.openqa.selenium.remote.session.CapabilityTransform;
 import org.openqa.selenium.remote.session.ChromeFilter;
@@ -59,22 +56,33 @@
 import org.openqa.selenium.remote.session.StripAnyPlatform;
 import org.openqa.selenium.remote.session.W3CPlatformNameNormaliser;
 
-import javax.annotation.Nullable;
 import java.io.Closeable;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Reader;
 import java.io.StringReader;
 import java.io.Writer;
-import java.util.*;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Queue;
+import java.util.ServiceLoader;
+import java.util.Set;
+import java.util.TreeMap;
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import javax.annotation.Nullable;
 
 
-public class NewSessionPayload implements Closeable {
+class NewAppiumSessionPayload implements Closeable {
 
  private static final List<String> APPIUM_CAPABILITIES = ImmutableList.<String>builder()
  .addAll(getAppiumCapabilities(MobileCapabilityType.class))
@@ -88,11 +96,7 @@ public class NewSessionPayload implements Closeable {
  private static final String FIRST_MATCH = "firstMatch";
  private static final String ALWAYS_MATCH = "alwaysMatch";
 
- private final Set<CapabilitiesFilter> adapters;
- private final Set<CapabilityTransform> transforms;
- private final boolean forceMobileJSONWP;
-
- private final static Predicate<String> ACCEPTED_W3C_PATTERNS = Stream.of(
+ private static final Predicate<String> ACCEPTED_W3C_PATTERNS = Stream.of(
  "^[\\w-]+:.*$",
  "^acceptInsecureCerts$",
  "^browserName$",
@@ -107,12 +111,16 @@ public class NewSessionPayload implements Closeable {
  .map(Pattern::asPredicate)
  .reduce(identity -> false, Predicate::or);
 
+ private final Set<CapabilitiesFilter> adapters;
+ private final Set<CapabilityTransform> transforms;
+ private final boolean forceMobileJSONWP;
+
  private final Json json = new Json();
  private final FileBackedOutputStream backingStore;
 
  private static List<String> getAppiumCapabilities(Class<?> capabilityList) {
  return Arrays.stream(capabilityList.getDeclaredFields()).map(field -> {
-  field.setAccessible(true);
+ field.setAccessible(true);
  try {
  return field.get(capabilityList).toString();
  } catch (IllegalAccessException e) {
@@ -121,7 +129,7 @@ private static List<String> getAppiumCapabilities(Class<?> capabilityList) {
  }).filter(s -> !FORCE_MJSONWP.equals(s)).collect(toList());
  }
 
- public static NewSessionPayload create(Capabilities caps) throws IOException {
+ public static NewAppiumSessionPayload create(Capabilities caps) throws IOException {
  boolean forceMobileJSONWP =
  ofNullable(caps.getCapability(FORCE_MJSONWP))
  .map(o -> Boolean.class.isAssignableFrom(o.getClass()) && Boolean.class.cast(o))
@@ -131,10 +139,10 @@ public static NewSessionPayload create(Capabilities caps) throws IOException {
  capabilityMap.remove(FORCE_MJSONWP);
  Map<String, ?> source = of(DESIRED_CAPABILITIES, capabilityMap);
  String json = new Json().toJson(source);
- return new NewSessionPayload(new StringReader(json), forceMobileJSONWP);
+ return new NewAppiumSessionPayload(new StringReader(json), forceMobileJSONWP);
  }
 
- private NewSessionPayload(Reader source, boolean forceMobileJSONWP) throws IOException {
+ private NewAppiumSessionPayload(Reader source, boolean forceMobileJSONWP) throws IOException {
  this.forceMobileJSONWP = forceMobileJSONWP;
  // Dedicate up to 10% of all RAM or 20% of available RAM (whichever is smaller) to storing this
  // payload.
@@ -244,22 +252,22 @@ public void writeTo(Appendable appendable) throws IOException {
 
  // Write the first capability we get as the desired capability.
  json.name(DESIRED_CAPABILITIES);
- json.write(first, MAP_TYPE);
+ json.write(first);
 
  // And write the first capability for gecko13
  json.name(CAPABILITIES);
  json.beginObject();
 
  json.name(DESIRED_CAPABILITIES);
- json.write(first, MAP_TYPE);
+ json.write(first);
 
  // Then write everything into the w3c payload. Because of the way we do this, it's easiest
  // to just populate the "firstMatch" section. The spec says it's fine to omit the
  // "alwaysMatch" field, so we do this.
  json.name(FIRST_MATCH);
  json.beginArray();
  //noinspection unchecked
- getW3C().forEach(map -> json.write(map, MAP_TYPE));
+ getW3C().forEach(json::write);
  json.endArray();
 
  json.endObject(); // Close "capabilities" object
@@ -286,7 +294,7 @@ private void writeMetaData(JsonOutput out) throws IOException {
 
  default:
  out.name(name);
- out.write(input.<Object>read(Object.class), Object.class);
+ out.write(input.<Object>read(Object.class));
  break;
  }
  }
@@ -297,11 +305,9 @@ private void writeMetaData(JsonOutput out) throws IOException {
  * Stream the {@link Capabilities} encoded in the payload used to create this instance. The
  * {@link Stream} will start with a {@link Capabilities} object matching the OSS capabilities, and
  * will then expand each of the "{@code firstMatch}" and "{@code alwaysMatch}" contents as defined
- * in the W3C WebDriver spec.
- * <p>
- * The OSS {@link Capabilities} are listed first because converting the OSS capabilities to the
- * equivalent W3C capabilities isn't particularly easy, so it's hoped that this approach gives us
- * the most compatible implementation.
+ * in the W3C WebDriver spec. The OSS {@link Capabilities} are listed first because converting the
+ * OSS capabilities to the equivalent W3C capabilities isn't particularly easy, so it's hoped that
+ * this approach gives us the most compatible implementation.
  */
  public Stream<Capabilities> stream() throws IOException {
  // OSS first
@@ -399,9 +405,10 @@ public Object getValue() {
  @Override
  public Object setValue(Object value) {
  return stringObjectEntry.setValue(value);
- }})
+ }
+ })
  .collect(toImmutableMap(Map.Entry::getKey, Map.Entry::getValue)))
- .map(map -> (Map<String, Object>) map);
+ .map(map -> map);
  } else {
  fromOss = Stream.of();
  }

src/test/java/io/appium/java_client/pagefactory_tests/DesktopBrowserCompatibilityTest.java

@@ -18,9 +18,11 @@
 
 import static io.appium.java_client.pagefactory.LocatorGroupStrategy.ALL_POSSIBLE;
 import static io.github.bonigarcia.wdm.WebDriverManager.chromedriver;
+import static io.github.bonigarcia.wdm.WebDriverManager.firefoxdriver;
 import static java.time.Duration.ofSeconds;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotEquals;
+import static org.openqa.selenium.firefox.FirefoxDriver.PROFILE;
 
 import io.appium.java_client.android.AndroidDriver;
 import io.appium.java_client.pagefactory.AndroidFindBy;
@@ -32,6 +34,10 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.chrome.ChromeDriver;
+import org.openqa.selenium.firefox.FirefoxDriver;
+import org.openqa.selenium.firefox.FirefoxDriverLogLevel;
+import org.openqa.selenium.firefox.FirefoxOptions;
+import org.openqa.selenium.firefox.FirefoxProfile;
 import org.openqa.selenium.support.FindBy;
 import org.openqa.selenium.support.FindBys;
 import org.openqa.selenium.support.PageFactory;
@@ -54,11 +60,17 @@ public class DesktopBrowserCompatibilityTest {
  * The starting.
  */
  @BeforeClass public static void beforeClass() {
- chromedriver().setup();
+ firefoxdriver().setup();
  }
 
- @Test public void chromeTest() {
- WebDriver driver = new ChromeDriver();
+ @Test public void fireFoxTest() {
+ FirefoxOptions firefoxOptions = new FirefoxOptions();
+ firefoxOptions.setLogLevel(FirefoxDriverLogLevel.TRACE);
+
+ FirefoxProfile firefoxProfile = new FirefoxProfile();
+ firefoxOptions.setCapability(PROFILE, firefoxProfile);
+
+ WebDriver driver = new FirefoxDriver(firefoxOptions);
  try {
  PageFactory
  .initElements(new AppiumFieldDecorator(driver, ofSeconds(15)),
@@ -73,4 +85,4 @@ public class DesktopBrowserCompatibilityTest {
  driver.quit();
  }
  }
-}
+}