[INT-282] visual-java: retrieve data from browser in bulk when possible (#235)

Author: perf2711

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

@@ -3,6 +3,9 @@
 import static com.saucelabs.visual.utils.EnvironmentVariables.isNotBlank;
 import static com.saucelabs.visual.utils.EnvironmentVariables.valueOrDefault;
 
+import com.saucelabs.visual.exception.InvalidIgnoreSelectorException;
+import com.saucelabs.visual.exception.InvalidVisualRegionException;
+import com.saucelabs.visual.exception.InvalidWebElementException;
 import com.saucelabs.visual.exception.VisualApiException;
 import com.saucelabs.visual.graphql.*;
 import com.saucelabs.visual.graphql.type.*;
@@ -153,6 +156,7 @@ public VisualApi build() {
   }
 
   private final GraphQLClient client;
+  private final BulkDriverHelper bulkDriverHelper;
 
   private final VisualBuild build;
   private final String jobId;
@@ -170,7 +174,7 @@ public VisualApi build() {
   /**
    * Creates a VisualApi instance for a given Visual Backend {@link DataCenter}
    *
-   * @param driver The {@link org.openqa.selenium.WebDriver} instance where the tests should run at
+   * @param driver The {@link WebDriver} instance where the tests should run at
    * @param username SauceLabs username
    * @param accessKey SauceLabs access key
    */
@@ -181,7 +185,7 @@ public VisualApi(RemoteWebDriver driver, String username, String accessKey) {
   /**
    * Creates a VisualApi instance for a given Visual Backend {@link DataCenter}
    *
-   * @param driver The {@link org.openqa.selenium.WebDriver} instance where the tests should run at
+   * @param driver The {@link WebDriver} instance where the tests should run at
    * @param region Visual Backend Region. For available values, see: {@link DataCenter}
    * @param username SauceLabs username
    * @param accessKey SauceLabs access key
@@ -193,7 +197,7 @@ public VisualApi(RemoteWebDriver driver, DataCenter region, String username, Str
   /**
    * Creates a VisualApi instance with a custom backend URL
    *
-   * @param driver The {@link org.openqa.selenium.WebDriver} instance where the tests should run at
+   * @param driver The {@link WebDriver} instance where the tests should run at
    * @param url Visual Backend URL
    * @param username SauceLabs username
    * @param accessKey SauceLabs access key
@@ -205,8 +209,7 @@ public VisualApi(RemoteWebDriver driver, String url, String username, String acc
   /**
    * 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 driver The {@link WebDriver} instance where the tests should run with
    * @param url Visual Backend URL
    * @param username SauceLabs username
    * @param accessKey SauceLabs access key
@@ -224,8 +227,7 @@ public VisualApi(
   /**
    * 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 driver The {@link WebDriver} instance where the tests should run with
    * @param url Visual Backend URL
    * @param username SauceLabs username
    * @param accessKey SauceLabs access key
@@ -265,6 +267,7 @@ private VisualApi(
     this.build = VisualBuild.getBuildOnce(this, buildAttributes);
     this.driver = driver;
     this.isSauceSession = isSauceSession;
+    this.bulkDriverHelper = new BulkDriverHelper(driver);
     refreshWebDriverSessionInfo();
   }
 
@@ -313,6 +316,7 @@ private VisualApi(Builder builder) {
     this.driver = driver;
     this.client = new GraphQLClient(url, username, accessKey, requestConfig);
     this.sessionMetadataBlob = sessionMetadataBlob;
+    this.bulkDriverHelper = new BulkDriverHelper(driver);
   }
 
   /**
@@ -652,24 +656,14 @@ private String sauceVisualCheckLocal(String snapshotName, CheckOptions options)
     SnapshotUpload uploadResult =
         this.client.execute(mutation, CreateSnapshotUploadMutation.Data.class).result;
 
-    // upload image
-    this.client.upload(uploadResult.getImageUploadUrl(), screenshot, "image/png");
-
     // add ignore regions
     List<RegionIn> ignoreRegions = extractIgnoreList(options);
+    ignoreRegions.addAll(
+        extractElementsToIgnoreRegions(
+            Optional.ofNullable(options.getIgnoreElements()).orElse(Collections.emptyList())));
+    ignoreRegions.addAll(extractIgnoreSelectors(options));
 
-    for (WebElement element : options.getIgnoreElements()) {
-      RegionIn ignoreRegion = VisualRegion.ignoreChangesFor(element).toRegionIn();
-      ignoreRegions.add(ignoreRegion);
-    }
-
-    for (IgnoreSelectorIn selector : options.getIgnoreSelectors()) {
-      VisualRegion region = getIgnoreRegionFromSelector(selector);
-      if (region != null) {
-        ignoreRegions.add(region.toRegionIn());
-      }
-    }
-
+    // make regions relative to viewport
     List<RegionIn> visibleIgnoreRegions = new ArrayList<>();
     for (RegionIn region : ignoreRegions) {
       Rectangle regionRect =
@@ -686,6 +680,9 @@ private String sauceVisualCheckLocal(String snapshotName, CheckOptions options)
       }
     }
 
+    // upload image
+    this.client.upload(uploadResult.getImageUploadUrl(), screenshot, "image/png");
+
     // upload dom if present / enabled
     Boolean shouldCaptureDom = Optional.ofNullable(options.getCaptureDom()).orElse(this.captureDom);
     if (shouldCaptureDom != null && shouldCaptureDom) {
@@ -790,22 +787,6 @@ private WebElement getClipElement(CheckOptions checkOptions) {
     return null;
   }
 
-  private VisualRegion getIgnoreRegionFromSelector(IgnoreSelectorIn ignoreSelector) {
-    SelectorIn selector = ignoreSelector.getSelector();
-    By bySelector;
-
-    switch (selector.getType()) {
-      case XPATH:
-        bySelector = By.xpath(selector.getValue());
-        break;
-      default:
-        return null;
-    }
-
-    WebElement element = driver.findElement(bySelector);
-    return new VisualRegion(element, ignoreSelector.getDiffingOptions());
-  }
-
   private static DiffingMethod toDiffingMethod(CheckOptions options) {
     if (options == null || options.getDiffingMethod() == null) {
       return DiffingMethod.BALANCED;
@@ -887,33 +868,58 @@ private List<RegionIn> extractIgnoreList(CheckOptions options) {
     }
 
     List<IgnoreRegion> ignoredRegions =
-        options.getIgnoreRegions() == null ? Arrays.asList() : options.getIgnoreRegions();
+        options.getIgnoreRegions() == null ? Collections.emptyList() : options.getIgnoreRegions();
 
     List<VisualRegion> visualRegions =
-        options.getRegions() == null ? Arrays.asList() : options.getRegions();
+        options.getRegions() == null ? Collections.emptyList() : options.getRegions();
 
-    List<RegionIn> result = new ArrayList<>();
-    for (int i = 0; i < ignoredRegions.size(); i++) {
-      IgnoreRegion ignoreRegion = ignoredRegions.get(i);
-      if (validate(ignoreRegion) == null) {
-        throw new VisualApiException("options.ignoreRegion[" + i + "] is an invalid ignore region");
-      }
-      result.add(
-          VisualRegion.ignoreChangesFor(
-                  ignoreRegion.getName(),
-                  ignoreRegion.getX(),
-                  ignoreRegion.getY(),
-                  ignoreRegion.getWidth(),
-                  ignoreRegion.getHeight())
-              .toRegionIn());
-    }
-    for (int i = 0; i < visualRegions.size(); i++) {
-      VisualRegion region = visualRegions.get(i);
+    List<VisualRegion> allVisualRegions =
+        new ArrayList<>(ignoredRegions.size() + visualRegions.size());
+    allVisualRegions.addAll(visualRegions);
+
+    for (IgnoreRegion ignoreRegion : ignoredRegions) {
+      allVisualRegions.add(new VisualRegion(ignoreRegion));
+    }
+
+    return extractRegions(allVisualRegions);
+  }
+
+  private List<RegionIn> extractRegions(List<VisualRegion> regions) {
+    List<RegionIn> result = new ArrayList<>(regions.size());
+    List<WebElement> bulkWebElements = new ArrayList<>();
+    List<VisualRegion> bulkRegions = new ArrayList<>();
+
+    for (VisualRegion region : regions) {
       if (validate(region) == null) {
-        throw new VisualApiException("options.region[" + i + "] is an invalid visual region");
+        throw new InvalidVisualRegionException(region, "Visual region is invalid");
+      }
+
+      WebElement element = region.getElement();
+      if (element != null) {
+        bulkWebElements.add(element);
+        bulkRegions.add(region);
+      } else {
+        result.add(region.toRegionIn());
       }
-      result.add(region.toRegionIn());
     }
+
+    List<Boolean> bulkIsDisplayed = bulkDriverHelper.areDisplayed(bulkWebElements);
+    for (int i = 0; i < bulkIsDisplayed.size(); i++) {
+      VisualRegion region = bulkRegions.get(i);
+      Boolean isDisplayed = bulkIsDisplayed.get(i);
+      if (!isDisplayed) {
+        throw new InvalidVisualRegionException(
+            region, "Visual region's web element does not exist (yet)");
+      }
+    }
+
+    List<Rectangle> bulkRectangles = bulkDriverHelper.getRects(bulkWebElements);
+    for (int i = 0; i < bulkRectangles.size(); i++) {
+      VisualRegion region = bulkRegions.get(i);
+      Rectangle rectangle = bulkRectangles.get(i);
+      result.add(VisualRegion.ignoreChangesFor(region.getName(), rectangle).toRegionIn());
+    }
+
     return result;
   }
 
@@ -924,31 +930,89 @@ private List<ElementIn> extractIgnoreElements(CheckOptions options) {
             : Arrays.asList();
 
     List<ElementIn> result = new ArrayList<>();
-    for (int i = 0; i < ignoredElements.size(); i++) {
+
+    List<Boolean> bulkIsDisplayed = bulkDriverHelper.areDisplayed(ignoredElements);
+    for (int i = 0; i < bulkIsDisplayed.size(); i++) {
       WebElement element = ignoredElements.get(i);
-      if (validate(element) == null) {
-        throw new VisualApiException("options.ignoreElement[" + i + "] does not exist (yet)");
+      Boolean isDisplayed = bulkIsDisplayed.get(i);
+      if (!isDisplayed) {
+        throw new InvalidWebElementException(element, "Web element does not exist (yet)");
       }
+
       result.add(VisualRegion.ignoreChangesFor(element).toElementIn());
     }
+
     return result;
   }
 
-  private WebElement validate(WebElement element) {
-    if (element instanceof RemoteWebElement && element.isDisplayed()) {
-      return element;
+  private List<RegionIn> extractElementsToIgnoreRegions(List<WebElement> elements) {
+    List<RegionIn> result = new ArrayList<>();
+
+    List<Boolean> bulkIsDisplayed = bulkDriverHelper.areDisplayed(elements);
+    for (int i = 0; i < bulkIsDisplayed.size(); i++) {
+      WebElement element = elements.get(i);
+      Boolean isDisplayed = bulkIsDisplayed.get(i);
+      if (!isDisplayed) {
+        throw new InvalidWebElementException(element, "Web element does not exist (yet)");
+      }
     }
-    return null;
+
+    List<Rectangle> bulkRectangles = bulkDriverHelper.getRects(elements);
+    for (Rectangle rectangle : bulkRectangles) {
+      result.add(VisualRegion.ignoreChangesFor(rectangle).toRegionIn());
+    }
+
+    return result;
   }
 
-  private IgnoreRegion validate(IgnoreRegion region) {
-    if (region == null) {
-      return null;
+  private List<RegionIn> extractIgnoreSelectors(CheckOptions options) {
+    List<IgnoreSelectorIn> selectors =
+        options != null && options.getIgnoreSelectors() != null
+            ? options.getIgnoreSelectors()
+            : Arrays.asList();
+
+    List<List<WebElement>> elementLists =
+        bulkDriverHelper.resolveElements(
+            selectors.stream().map(IgnoreSelectorIn::getSelector).collect(Collectors.toList()));
+
+    for (int i = 0; i < selectors.size(); i++) {
+      List<WebElement> elements = elementLists.get(i);
+      IgnoreSelectorIn selector = selectors.get(i);
+      if (elements == null || elements.isEmpty()) {
+        throw new InvalidIgnoreSelectorException(selector, "Web element does not exist");
+      }
     }
-    if (region.getHeight() <= 0 || region.getWidth() <= 0) {
-      return null;
+
+    List<RegionIn> result = new ArrayList<>();
+
+    List<RegionIn> flatRegions =
+        extractElementsToIgnoreRegions(
+            elementLists.stream().flatMap(List::stream).collect(Collectors.toList()));
+
+    for (int listIndex = 0, regionIndex = 0; listIndex < elementLists.size(); listIndex++) {
+      IgnoreSelectorIn selector = selectors.get(listIndex);
+      List<WebElement> elements = elementLists.get(listIndex);
+      List<RegionIn> regions = flatRegions.subList(regionIndex, regionIndex + elements.size());
+
+      result.addAll(
+          regions.stream()
+              .map(
+                  region ->
+                      new VisualRegion(
+                              new IgnoreRegion(
+                                  region.getName(),
+                                  region.getX(),
+                                  region.getY(),
+                                  region.getWidth(),
+                                  region.getHeight()),
+                              selector.getDiffingOptions())
+                          .toRegionIn())
+              .collect(Collectors.toList()));
+
+      regionIndex += regions.size();
     }
-    return region;
+
+    return result;
   }
 
   private VisualRegion validate(VisualRegion region) {
@@ -958,10 +1022,6 @@ private VisualRegion validate(VisualRegion region) {
     if (0 < region.getHeight() * region.getWidth()) {
       return region;
     }
-    WebElement ele = region.getElement();
-    if (ele != null && ele.isDisplayed() && ele.getRect() != null) {
-      return region;
-    }
     return null;
   }
 

visual-java/src/main/java/com/saucelabs/visual/exception/InvalidIgnoreSelectorException.java

@@ -0,0 +1,16 @@
+package com.saucelabs.visual.exception;
+
+import com.saucelabs.visual.graphql.type.IgnoreSelectorIn;
+
+public class InvalidIgnoreSelectorException extends VisualApiException {
+  private final IgnoreSelectorIn ignoreSelectorIn;
+
+  public InvalidIgnoreSelectorException(IgnoreSelectorIn selector, String message) {
+    super(message);
+    this.ignoreSelectorIn = selector;
+  }
+
+  public IgnoreSelectorIn getIgnoreSelectorIn() {
+    return ignoreSelectorIn;
+  }
+}

visual-java/src/main/java/com/saucelabs/visual/exception/InvalidSelectorException.java

@@ -0,0 +1,16 @@
+package com.saucelabs.visual.exception;
+
+import com.saucelabs.visual.graphql.type.SelectorIn;
+
+public class InvalidSelectorException extends VisualApiException {
+  private final SelectorIn selectorIn;
+
+  public InvalidSelectorException(SelectorIn selector, String message) {
+    super(message);
+    this.selectorIn = selector;
+  }
+
+  public SelectorIn getSelectorIn() {
+    return selectorIn;
+  }
+}

visual-java/src/main/java/com/saucelabs/visual/exception/InvalidVisualRegionException.java

@@ -0,0 +1,16 @@
+package com.saucelabs.visual.exception;
+
+import com.saucelabs.visual.model.VisualRegion;
+
+public class InvalidVisualRegionException extends VisualApiException {
+  private final VisualRegion visualRegion;
+
+  public InvalidVisualRegionException(VisualRegion visualRegion, String message) {
+    super(message);
+    this.visualRegion = visualRegion;
+  }
+
+  public VisualRegion getVisualRegion() {
+    return visualRegion;
+  }
+}