browser: nearby filter (#1543)

Author: MykolaGolubyev

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/AdditionalBrowserInteractions.java

@@ -32,5 +32,7 @@ public interface AdditionalBrowserInteractions {
 
     List<WebElement> filterByRegexp(List<WebElement> webElements, String regexp);
 
+    List<WebElement> filterByNearby(List<WebElement> webElements, WebElement target);
+
     WebElement parentByCss(SearchContext element, String css);
 }

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/BrowserInjectedJavaScript.java

@@ -77,6 +77,14 @@ public List<WebElement> filterByRegexp(List<WebElement> webElements, String rege
                 webElements, regexp);
     }
 
+    @Override
+    @SuppressWarnings("unchecked")
+    public List<WebElement> filterByNearby(List<WebElement> webElements, WebElement target) {
+        injectScript();
+        return (List<WebElement>) javascriptExecutor.executeScript(returnTwoArgFunc("filterByNearby"),
+                webElements, target);
+    }
+
     @Override
     public WebElement parentByCss(SearchContext element, String css) {
         injectScript();

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/PageElement.java

@@ -32,9 +32,8 @@
 import org.testingisdocumenting.webtau.browser.page.path.filter.ByNumberPageElementsFilter;
 import org.testingisdocumenting.webtau.browser.page.path.filter.ByRegexpPageElementsFilter;
 import org.testingisdocumenting.webtau.browser.page.path.filter.ByTextPageElementsFilter;
-import org.testingisdocumenting.webtau.browser.page.path.finder.ByCssPageElementFinder;
-import org.testingisdocumenting.webtau.browser.page.path.finder.ParentByCssPageElementFinder;
-import org.testingisdocumenting.webtau.browser.page.path.finder.ParentPageElementFinder;
+import org.testingisdocumenting.webtau.browser.page.path.filter.NearbyPageElementFilter;
+import org.testingisdocumenting.webtau.browser.page.path.finder.*;
 import org.testingisdocumenting.webtau.data.ValuePath;
 import org.testingisdocumenting.webtau.data.render.PrettyPrintable;
 import org.testingisdocumenting.webtau.data.render.PrettyPrinter;
@@ -265,6 +264,10 @@ public PageElement parent(String css) {
         return withFinder(new ParentByCssPageElementFinder(additionalBrowserInteractions, css));
     }
 
+    public PageElement nearby(PageElement target) {
+        return withFilter(new NearbyPageElementFilter(additionalBrowserInteractions, target));
+    }
+
     public PageElement get(String text) {
         return withFilter(new ByTextPageElementsFilter(additionalBrowserInteractions, text));
     }

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/PageElementFinder.java

@@ -18,13 +18,12 @@
 package org.testingisdocumenting.webtau.browser.page.path;
 
 import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
-import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebElement;
 
 import java.util.List;
 
 public interface PageElementFinder {
-    List<WebElement> find(SearchContext parent);
+    List<WebElement> find(PageElementPathSearchContext parent);
 
     /**
      * @param isFirst isFirst is this the first entry in the path

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/PageElementPath.java

@@ -17,17 +17,16 @@
 
 package org.testingisdocumenting.webtau.browser.page.path;
 
-import org.testingisdocumenting.webtau.browser.page.path.finder.ByCssPageElementFinder;
-import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
-import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
+import org.testingisdocumenting.webtau.browser.page.path.finder.ByCssPageElementFinder;
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
-import static java.util.stream.Collectors.toList;
+import static java.util.stream.Collectors.*;
 
 public class PageElementPath {
     private List<PageElementPathEntry> entries;
@@ -64,16 +63,16 @@ public static PageElementPath css(String cssSelector) {
     }
 
     public List<WebElement> find(WebDriver driver) {
-        SearchContext root = driver;
+        var context = new PageElementPathSearchContext(driver, null);
 
         List<WebElement> webElements = Collections.emptyList();
         for (PageElementPathEntry entry : entries) {
-            webElements = entry.find(root);
+            webElements = entry.find(context);
             if (webElements.isEmpty()) {
                 return webElements;
             }
 
-            root = webElements.get(0);
+            context = PageElementPathSearchContext.fromElement(webElements.get(0));
         }
 
         return webElements;

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/PageElementPathEntry.java

@@ -18,7 +18,6 @@
 package org.testingisdocumenting.webtau.browser.page.path;
 
 import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
-import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebElement;
 
 import java.util.ArrayList;
@@ -44,8 +43,8 @@ PageElementPathEntry copy() {
         return copy;
     }
 
-    List<WebElement> find(SearchContext parent) {
-        List<WebElement> elements = finder.find(parent);
+    List<WebElement> find(PageElementPathSearchContext searchContext) {
+        List<WebElement> elements = finder.find(searchContext);
         if (elements.isEmpty()) {
             return elements;
         }

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/PageElementPathSearchContext.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.browser.page.path;
+
+import org.openqa.selenium.SearchContext;
+import org.openqa.selenium.WebElement;
+
+public record PageElementPathSearchContext(SearchContext searchContext, WebElement parent) {
+    static PageElementPathSearchContext fromElement(WebElement element) {
+        return new PageElementPathSearchContext(element, element);
+    }
+
+    public boolean hasParent() {
+        return parent != null;
+    }
+}

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/filter/NearbyPageElementFilter.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2023 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.browser.page.path.filter;
+
+import org.openqa.selenium.WebElement;
+import org.testingisdocumenting.webtau.browser.AdditionalBrowserInteractions;
+import org.testingisdocumenting.webtau.browser.page.NullWebElement;
+import org.testingisdocumenting.webtau.browser.page.PageElement;
+import org.testingisdocumenting.webtau.browser.page.path.PageElementsFilter;
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
+
+import java.util.Collections;
+import java.util.List;
+
+import static org.testingisdocumenting.webtau.WebTauCore.*;
+
+public class NearbyPageElementFilter implements PageElementsFilter {
+    private final AdditionalBrowserInteractions additionalBrowserInteractions;
+    private final PageElement target;
+
+    public NearbyPageElementFilter(AdditionalBrowserInteractions additionalBrowserInteractions, PageElement target) {
+        this.additionalBrowserInteractions = additionalBrowserInteractions;
+        this.target = target;
+    }
+
+    @Override
+    public List<WebElement> filter(List<WebElement> original) {
+        WebElement targetElement = target.findElement();
+        if (targetElement instanceof NullWebElement) {
+            return Collections.emptyList();
+        }
+
+        return additionalBrowserInteractions.filterByNearby(original, targetElement);
+    }
+
+    @Override
+    public TokenizedMessage description() {
+        return tokenizedMessage().classifier("nearby").add(target.describe());
+    }
+}

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/finder/ByCssPageElementFinder.java

@@ -18,9 +18,9 @@
 package org.testingisdocumenting.webtau.browser.page.path.finder;
 
 import org.testingisdocumenting.webtau.browser.page.path.PageElementFinder;
+import org.testingisdocumenting.webtau.browser.page.path.PageElementPathSearchContext;
 import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
 import org.openqa.selenium.By;
-import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebElement;
 
 import java.util.List;
@@ -35,8 +35,8 @@ public ByCssPageElementFinder(String css) {
     }
 
     @Override
-    public List<WebElement> find(SearchContext parent) {
-        return parent.findElements(By.cssSelector(css));
+    public List<WebElement> find(PageElementPathSearchContext parent) {
+        return parent.searchContext().findElements(By.cssSelector(css));
     }
 
     @Override

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/path/finder/ByRelativeAbovePageElementFinder.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2021 webtau maintainers
+ * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.testingisdocumenting.webtau.browser.page.path.finder;
+
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.support.locators.RelativeLocator;
+import org.testingisdocumenting.webtau.browser.page.PageElement;
+
+import java.util.function.Function;
+
+public class ByRelativeAbovePageElementFinder extends ByRelativePageElementFinder {
+    public ByRelativeAbovePageElementFinder(PageElement target) {
+        super(target, "above");
+    }
+
+    protected Function<WebElement, RelativeLocator.RelativeBy> direction(RelativeLocator.RelativeBy chainStart) {
+        return chainStart::above;
+    }
+}