Add requestConfig option for adjusting proxy / timeout settings in SDK (#224)

Co-authored-by: Logan Graham <[email protected]>

Author: omacranger

visual-java/src/main/java/com/saucelabs/visual/VisualApi.java

@@ -18,6 +18,7 @@
 import java.time.Duration;
 import java.util.*;
 import java.util.stream.Collectors;
+import org.apache.http.client.config.RequestConfig;
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.remote.RemoteWebDriver;
@@ -47,6 +48,7 @@ public static class Builder {
     private Boolean hideScrollBars;
     private DiffingMethodSensitivity diffingMethodSensitivity;
     private DiffingMethodTolerance diffingMethodTolerance;
+    private RequestConfig requestConfig;
 
     public Builder(RemoteWebDriver driver, String username, String accessKey) {
       this(driver, username, accessKey, resolveEndpoint());
@@ -108,14 +110,20 @@ public Builder withDiffingMethodTolerance(DiffingMethodTolerance diffingMethodTo
       return this;
     }
 
+    public Builder withRequestConfig(RequestConfig requestConfig) {
+      this.requestConfig = requestConfig;
+      return this;
+    }
+
     public VisualApi build() {
       VisualApi api =
           new VisualApi(
               driver,
               endpoint,
               username,
               accessKey,
-              new BuildAttributes(buildName, projectName, branchName, defaultBranchName));
+              new BuildAttributes(buildName, projectName, branchName, defaultBranchName),
+              requestConfig);
 
       if (this.captureDom != null) {
         api.setCaptureDom(this.captureDom);
@@ -201,6 +209,27 @@ public VisualApi(
       String username,
       String accessKey,
       BuildAttributes buildAttributes) {
+    this(driver, url, username, accessKey, buildAttributes, null);
+  }
+
+  /**
+   * Creates a VisualApi instance with a custom backend URL
+   *
+   * @param driver The {@link org.openqa.selenium.WebDriver} instance where the tests should run
+   *     with
+   * @param url Visual Backend URL
+   * @param username SauceLabs username
+   * @param accessKey SauceLabs access key
+   * @param buildAttributes like buildName, project, branch
+   * @param requestConfig RequestConfig object to override proxy / request settings for the client.
+   */
+  public VisualApi(
+      RemoteWebDriver driver,
+      String url,
+      String username,
+      String accessKey,
+      BuildAttributes buildAttributes,
+      RequestConfig requestConfig) {
     if (username == null
         || accessKey == null
         || username.trim().isEmpty()
@@ -209,7 +238,7 @@ public VisualApi(
           "Invalid SauceLabs credentials. "
               + "Please check your SauceLabs username and access key at https://app.saucelabs.com/user-settings");
     }
-    this.client = new GraphQLClient(url, username, accessKey);
+    this.client = new GraphQLClient(url, username, accessKey, requestConfig);
     this.sessionId = driver.getSessionId().toString();
     String jobIdString = (String) driver.getCapabilities().getCapability("jobUuid");
     this.jobId = jobIdString == null ? sessionId : jobIdString;
@@ -226,6 +255,18 @@ public VisualApi(
       String url,
       String username,
       String accessKey) {
+    this(jobId, driver, build, sessionMetadataBlob, url, username, accessKey, null);
+  }
+
+  VisualApi(
+      String jobId,
+      RemoteWebDriver driver,
+      VisualBuild build,
+      String sessionMetadataBlob,
+      String url,
+      String username,
+      String accessKey,
+      RequestConfig requestConfig) {
     if (username == null
         || accessKey == null
         || username.trim().isEmpty()
@@ -238,7 +279,7 @@ public VisualApi(
     this.jobId = jobId;
     this.sessionId = driver.getSessionId().toString();
     this.driver = driver;
-    this.client = new GraphQLClient(url, username, accessKey);
+    this.client = new GraphQLClient(url, username, accessKey, requestConfig);
     this.sessionMetadataBlob = sessionMetadataBlob;
   }
 

visual-java/src/main/java/com/saucelabs/visual/graphql/GraphQLClient.java

@@ -12,6 +12,7 @@
 import org.apache.http.HttpHeaders;
 import org.apache.http.HttpResponse;
 import org.apache.http.client.HttpClient;
+import org.apache.http.client.config.RequestConfig;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.entity.StringEntity;
 import org.apache.http.impl.client.HttpClients;
@@ -24,12 +25,26 @@ public class GraphQLClient {
   private final String authentication;
 
   private final ObjectMapper objectMapper;
+  private RequestConfig requestConfig = RequestConfig.DEFAULT;
 
   public GraphQLClient(String uri, String username, String accessKey) {
     this(HttpClients.createSystem(), uri, username, accessKey);
   }
 
+  public GraphQLClient(String uri, String username, String accessKey, RequestConfig requestConfig) {
+    this(HttpClients.createSystem(), uri, username, accessKey, requestConfig);
+  }
+
   public GraphQLClient(HttpClient client, String uri, String username, String accessKey) {
+    this(client, uri, username, accessKey, null);
+  }
+
+  public GraphQLClient(
+      HttpClient client,
+      String uri,
+      String username,
+      String accessKey,
+      RequestConfig requestConfig) {
     this.client = client;
     this.uri = uri;
     this.authentication =
@@ -39,6 +54,10 @@ public GraphQLClient(HttpClient client, String uri, String username, String acce
     objectMapper.registerModule(new Jdk8Module());
     objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 
+    if (requestConfig != null) {
+      this.requestConfig = requestConfig;
+    }
+
     this.objectMapper = objectMapper;
   }
 
@@ -52,6 +71,7 @@ public <D> D execute(GraphQLOperation operation, Class<D> responseType)
       request.setHeader(
           HttpHeaders.USER_AGENT,
           "sauce-visual-java/" + ArtifactVersion.getArtifactVersion().orElse("unknown"));
+      request.setConfig(requestConfig);
 
       String requestBody = this.objectMapper.writeValueAsString(operation);
       request.setEntity(new StringEntity(requestBody));