[java] Trying alternative way of configuring http client behind a RemoteWebDriver: implementing ability to pass ClientConfig to HttpCommandExecutor constructor

Author: barancev

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

@@ -27,6 +27,7 @@
 import org.openqa.selenium.logging.LogType;
 import org.openqa.selenium.logging.NeedsLocalLogs;
 import org.openqa.selenium.logging.profiler.HttpProfilerLogEntry;
+import org.openqa.selenium.remote.http.ClientConfig;
 import org.openqa.selenium.remote.http.HttpClient;
 import org.openqa.selenium.remote.http.HttpRequest;
 import org.openqa.selenium.remote.http.HttpResponse;
@@ -60,6 +61,10 @@ public HttpCommandExecutor(URL addressOfRemoteServer) {
     this(emptyMap(), addressOfRemoteServer);
   }
 
+  public HttpCommandExecutor(ClientConfig config) {
+    this(emptyMap(), config, defaultClientFactory);
+  }
+
   /**
    * Creates an {@link HttpCommandExecutor} that supports non-standard
    * {@code additionalCommands} in addition to the standard.
@@ -68,26 +73,42 @@ public HttpCommandExecutor(URL addressOfRemoteServer) {
    * @param addressOfRemoteServer URL of remote end Selenium server
    */
   public HttpCommandExecutor(
-      Map<String, CommandInfo> additionalCommands,
-      URL addressOfRemoteServer) {
+    Map<String, CommandInfo> additionalCommands,
+    URL addressOfRemoteServer)
+  {
     this(additionalCommands, addressOfRemoteServer, defaultClientFactory);
   }
 
   public HttpCommandExecutor(
-      Map<String, CommandInfo> additionalCommands,
-      URL addressOfRemoteServer,
-      HttpClient.Factory httpClientFactory) {
+    Map<String, CommandInfo> additionalCommands,
+    URL addressOfRemoteServer,
+    HttpClient.Factory httpClientFactory)
+  {
+    this(additionalCommands,
+         ClientConfig.defaultConfig().baseUrl(addressOfRemoteServer),
+         httpClientFactory);
+  }
+
+  public HttpCommandExecutor(
+    Map<String, CommandInfo> additionalCommands,
+    ClientConfig config,
+    HttpClient.Factory httpClientFactory)
+  {
     try {
-      remoteServer = addressOfRemoteServer == null
-          ? new URL(System.getProperty("webdriver.remote.server", "http://localhost:4444/"))
-          : addressOfRemoteServer;
+      if (config.baseUri() != null) {
+        remoteServer = config.baseUrl();
+      } else {
+        remoteServer = new URL(
+          System.getProperty("webdriver.remote.server", "http://localhost:4444/"));
+        config = config.baseUrl(remoteServer);
+      }
     } catch (MalformedURLException e) {
       throw new WebDriverException(e);
     }
 
     this.additionalCommands = additionalCommands;
     this.httpClientFactory = httpClientFactory;
-    this.client = httpClientFactory.createClient(remoteServer);
+    this.client = httpClientFactory.createClient(config);
   }
 
   /**
@@ -126,7 +147,7 @@ public Response execute(Command command) throws IOException {
       if (!GET_ALL_SESSIONS.equals(command.getName())
           && !NEW_SESSION.equals(command.getName())) {
         throw new NoSuchSessionException(
-            "Session ID is null. Using WebDriver after calling quit()?");
+          "Session ID is null. Using WebDriver after calling quit()?");
       }
     }
 
@@ -149,7 +170,7 @@ public Response execute(Command command) throws IOException {
 
     if (commandCodec == null || responseCodec == null) {
       throw new WebDriverException(
-          "No command or response codec has been defined. Unable to proceed");
+        "No command or response codec has been defined. Unable to proceed");
     }
 
     HttpRequest httpRequest = commandCodec.encode(command);
@@ -180,8 +201,8 @@ public Response execute(Command command) throws IOException {
     } catch (UnsupportedCommandException e) {
       if (e.getMessage() == null || "".equals(e.getMessage())) {
         throw new UnsupportedOperationException(
-            "No information from server. Command name was: " + command.getName(),
-            e.getCause());
+          "No information from server. Command name was: " + command.getName(),
+          e.getCause());
       }
       throw e;
     }

java/client/test/org/openqa/selenium/remote/RemoteWebDriverInitializationTest.java

@@ -17,6 +17,8 @@
 
 package org.openqa.selenium.remote;
 
+import static java.util.Collections.emptyMap;
+import static java.util.Collections.singletonMap;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.ArgumentMatchers.any;
@@ -35,14 +37,22 @@
 
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
+import org.mockito.ArgumentCaptor;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.ImmutableCapabilities;
 import org.openqa.selenium.Platform;
 import org.openqa.selenium.SessionNotCreatedException;
+import org.openqa.selenium.remote.http.ClientConfig;
+import org.openqa.selenium.remote.http.Contents;
+import org.openqa.selenium.remote.http.HttpClient;
+import org.openqa.selenium.remote.http.HttpResponse;
 import org.openqa.selenium.testing.UnitTests;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.time.Duration;
 import java.util.UUID;
 
 @Category(UnitTests.class)
@@ -182,6 +192,30 @@ public void quit() {
     }
   }
 
+  @Test
+  public void canPassClientConfig() throws MalformedURLException {
+    HttpClient client = mock(HttpClient.class);
+    when(client.execute(any())).thenReturn(new HttpResponse().setStatus(200).setContent(
+      Contents.asJson(singletonMap("value", ImmutableMap.of(
+        "sessionId", UUID.randomUUID().toString(),
+        "capabilities", new ImmutableCapabilities().asMap())))));
+
+    HttpClient.Factory factory = mock(HttpClient.Factory.class);
+    ArgumentCaptor<ClientConfig > config = ArgumentCaptor.forClass(ClientConfig.class);
+    when(factory.createClient(config.capture())).thenReturn(client);
+
+    CommandExecutor executor = new HttpCommandExecutor(
+      emptyMap(),
+      ClientConfig.defaultConfig().readTimeout(Duration.ofSeconds(1)),
+      factory);
+
+    RemoteWebDriver driver = new RemoteWebDriver(executor, new ImmutableCapabilities());
+
+    ClientConfig usedConfig = config.getValue();
+    assertThat(usedConfig.baseUrl()).isEqualTo(new URL("http://localhost:4444/"));
+    assertThat(usedConfig.readTimeout()).isEqualTo(Duration.ofSeconds(1));
+  }
+
   public void verifyNoCommands(CommandExecutor executor) {
     try {
       verify(executor).execute(argThat(cmd -> cmd.getName().equals(DriverCommand.NEW_SESSION)));