[java] Add missing event handlers for TargetLocator interface (#13559)

valfirst · pujagani · web-flow · commit 0b2265c759e8 · 2024-02-08T14:29:44.000+01:00
* [java] Add missing event handlers for `TargetLocator` interface

* Fix formatting

---------

Co-authored-by: Puja Jagani &lt;puja.jagani93@gmail.com&gt;
diff --git a/java/src/org/openqa/selenium/support/events/WebDriverListener.java b/java/src/org/openqa/selenium/support/events/WebDriverListener.java
@@ -1083,24 +1083,177 @@ default void beforeAnyTargetLocatorCall(
   default void afterAnyTargetLocatorCall(
       WebDriver.TargetLocator targetLocator, Method method, Object[] args, Object result) {}
 
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#frame(int)} ()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param index The zero-based index.
+   */
+  default void beforeFrame(WebDriver.TargetLocator targetLocator, int index) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#frame(int)} ()} is
+   * called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param index The zero-based index.
+   */
+  default void afterFrame(WebDriver.TargetLocator targetLocator, int index, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#frame(String)}
+   * ()} is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param nameOrId The name of the frame window, the id of the &lt;frame&gt; or &lt;iframe&gt;
+   *     element, or the (zero-based) index.
+   */
+  default void beforeFrame(WebDriver.TargetLocator targetLocator, String nameOrId) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#frame(String)} ()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param nameOrId The name of the frame window, the id of the &lt;frame&gt; or &lt;iframe&gt;
+   *     element, or the (zero-based) index.
+   * @param driver The current driver instance.
+   */
+  default void afterFrame(
+      WebDriver.TargetLocator targetLocator, String nameOrId, WebDriver driver) {}
+
   /**
    * This action will be performed each time before {@link
-   * org.openqa.selenium.WebDriver.TargetLocator#window(String)}
+   * WebDriver.TargetLocator#frame(WebElement)} ()} is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param frameElement The frame element to switch to.
+   */
+  default void beforeFrame(WebDriver.TargetLocator targetLocator, WebElement frameElement) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#frame(WebElement)}
+   * ()} is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param frameElement The frame element to switch to.
+   * @param driver The current driver instance.
+   */
+  default void afterFrame(
+      WebDriver.TargetLocator targetLocator, WebElement frameElement, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#parentFrame()} is
+   * called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   */
+  default void beforeParentFrame(WebDriver.TargetLocator targetLocator) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#parentFrame()} is
+   * called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param driver The current driver instance.
+   */
+  default void afterParentFrame(WebDriver.TargetLocator targetLocator, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#window(String)}.
    *
    * @param targetLocator the target locator being used for the action
    * @param nameOrHandle The name of the window or the handle as returned by {@link
-   *     org.openqa.selenium.WebDriver#getWindowHandle()} or <code>null</code> if switching to a new
-   *     window created by {@link org.openqa.selenium.WebDriver.TargetLocator#newWindow(WindowType)}
+   *     WebDriver#getWindowHandle()} or <code>null</code> if switching to a new window created by
+   *     {@link WebDriver.TargetLocator#newWindow(WindowType)}
    */
   default void beforeWindow(WebDriver.TargetLocator targetLocator, String nameOrHandle) {}
 
   /**
-   * @param targetLocator the target locator being used for the action
+   * This action will be performed each time after {@link WebDriver.TargetLocator#window(String)}.
+   *
+   * @param targetLocator The target locator being used for the action.
    * @param nameOrHandle The name of the window or the handle as returned by {@link
-   *     org.openqa.selenium.WebDriver#getWindowHandle()} or <code>null</code> if switching to a new
-   *     window created by {@link org.openqa.selenium.WebDriver.TargetLocator#newWindow(WindowType)}
-   * @param driver WebDriver
+   *     WebDriver#getWindowHandle()} or <code>null</code> if switching to a new window created by
+   *     {@link WebDriver.TargetLocator#newWindow(WindowType)}.
+   * @param driver The current driver instance.
    */
   default void afterWindow(
       WebDriver.TargetLocator targetLocator, String nameOrHandle, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link
+   * WebDriver.TargetLocator#newWindow(WindowType)} is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param typeHint The type of new browser window to be created. The created window is not
+   *     guaranteed to be of the requested type; if the driver does not support the requested type,
+   *     a new browser window will be created of whatever type the driver does support.
+   */
+  default void beforeNewWindow(WebDriver.TargetLocator targetLocator, WindowType typeHint) {}
+
+  /**
+   * This action will be performed each time after {@link
+   * WebDriver.TargetLocator#newWindow(WindowType)} is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param typeHint The type of new browser window to be created. The created window is not
+   *     guaranteed to be of the requested type; if the driver does not support the requested type,
+   *     a new browser window will be created of whatever type the driver does support.
+   * @param driver The current driver instance.
+   */
+  default void afterNewWindow(
+      WebDriver.TargetLocator targetLocator, WindowType typeHint, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#defaultContent()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   */
+  default void beforeDefaultContent(WebDriver.TargetLocator targetLocator) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#defaultContent()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param driver The current driver instance.
+   */
+  default void afterDefaultContent(WebDriver.TargetLocator targetLocator, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#activeElement()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   */
+  default void beforeActiveElement(WebDriver.TargetLocator targetLocator) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#activeElement()}
+   * is called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param driver The current driver instance.
+   */
+  default void afterActiveElement(WebDriver.TargetLocator targetLocator, WebDriver driver) {}
+
+  /**
+   * This action will be performed each time before {@link WebDriver.TargetLocator#alert()} is
+   * called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   */
+  default void beforeAlert(WebDriver.TargetLocator targetLocator) {}
+
+  /**
+   * This action will be performed each time after {@link WebDriver.TargetLocator#alert()} is
+   * called.
+   *
+   * @param targetLocator The target locator being used for the action.
+   * @param alert The found alert.
+   */
+  default void afterAlert(WebDriver.TargetLocator targetLocator, Alert alert) {}
 }
diff --git a/java/test/org/openqa/selenium/support/events/EventFiringDecoratorTest.java b/java/test/org/openqa/selenium/support/events/EventFiringDecoratorTest.java
@@ -48,6 +48,7 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.WebElement;
+import org.openqa.selenium.WindowType;
 import org.openqa.selenium.interactions.Actions;
 import org.openqa.selenium.interactions.Sequence;
 import org.openqa.selenium.remote.RemoteWebDriver;
@@ -780,8 +781,8 @@ public void afterExecuteAsyncScript(
 
   @Test
   void shouldFireTargetLocatorEvents() {
-    WebDriver driver = mock(WebDriver.class);
-    WebDriver.TargetLocator targetLocator = mock(WebDriver.TargetLocator.class);
+    WebDriver driver = mock();
+    WebDriver.TargetLocator targetLocator = mock();
     when(driver.switchTo()).thenReturn(targetLocator);
 
     CollectorListener listener =
@@ -798,6 +799,49 @@ public void afterAnyTargetLocatorCall(
             acc.append("afterAnyTargetLocatorCall ").append(method.getName()).append("\n");
           }
 
+          @Override
+          public void beforeFrame(WebDriver.TargetLocator targetLocator, int index) {
+            acc.append("beforeFrame ").append(index).append("\n");
+          }
+
+          @Override
+          public void afterFrame(
+              WebDriver.TargetLocator targetLocator, int index, WebDriver driver) {
+            acc.append("afterFrame ").append(index).append("\n");
+          }
+
+          @Override
+          public void beforeFrame(WebDriver.TargetLocator targetLocator, String nameOrId) {
+            acc.append("beforeFrame ").append(nameOrId).append("\n");
+          }
+
+          @Override
+          public void afterFrame(
+              WebDriver.TargetLocator targetLocator, String nameOrId, WebDriver driver) {
+            acc.append("afterFrame ").append(nameOrId).append("\n");
+          }
+
+          @Override
+          public void beforeFrame(WebDriver.TargetLocator targetLocator, WebElement frameElement) {
+            acc.append("beforeFrame ").append(frameElement).append("\n");
+          }
+
+          @Override
+          public void afterFrame(
+              WebDriver.TargetLocator targetLocator, WebElement frameElement, WebDriver driver) {
+            acc.append("afterFrame ").append(frameElement).append("\n");
+          }
+
+          @Override
+          public void beforeParentFrame(WebDriver.TargetLocator targetLocator) {
+            acc.append("beforeParentFrame").append("\n");
+          }
+
+          @Override
+          public void afterParentFrame(WebDriver.TargetLocator targetLocator, WebDriver driver) {
+            acc.append("afterParentFrame").append("\n");
+          }
+
           @Override
           public void beforeWindow(WebDriver.TargetLocator targetLocator, String windowName) {
             acc.append("beforeWindow ").append(windowName).append("\n");
@@ -808,11 +852,62 @@ public void afterWindow(
               WebDriver.TargetLocator targetLocator, String windowName, WebDriver driver) {
             acc.append("afterWindow ").append(windowName).append("\n");
           }
+
+          @Override
+          public void beforeNewWindow(WebDriver.TargetLocator targetLocator, WindowType typeHint) {
+            acc.append("beforeNewWindow ").append(typeHint).append("\n");
+          }
+
+          @Override
+          public void afterNewWindow(
+              WebDriver.TargetLocator targetLocator, WindowType typeHint, WebDriver driver) {
+            acc.append("afterNewWindow ").append(typeHint).append("\n");
+          }
+
+          @Override
+          public void beforeDefaultContent(WebDriver.TargetLocator targetLocator) {
+            acc.append("beforeDefaultContent").append("\n");
+          }
+
+          @Override
+          public void afterDefaultContent(WebDriver.TargetLocator targetLocator, WebDriver driver) {
+            acc.append("afterDefaultContent").append("\n");
+          }
+
+          @Override
+          public void beforeActiveElement(WebDriver.TargetLocator targetLocator) {
+            acc.append("beforeActiveElement").append("\n");
+          }
+
+          @Override
+          public void afterActiveElement(WebDriver.TargetLocator targetLocator, WebDriver driver) {
+            acc.append("afterActiveElement").append("\n");
+          }
+
+          @Override
+          public void beforeAlert(WebDriver.TargetLocator targetLocator) {
+            acc.append("beforeAlert").append("\n");
+          }
+
+          @Override
+          public void afterAlert(WebDriver.TargetLocator targetLocator, Alert alert) {
+            acc.append("afterAlert").append("\n");
+          }
         };
 
     WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
-
-    decorated.switchTo().window("windowName");
+    WebDriver.TargetLocator decoratedTargetLocator = decorated.switchTo();
+
+    decoratedTargetLocator.frame(3);
+    decoratedTargetLocator.frame("frame-id");
+    WebElement frameElement = mock();
+    decoratedTargetLocator.frame(frameElement);
+    decoratedTargetLocator.parentFrame();
+    decoratedTargetLocator.window("windowName");
+    decoratedTargetLocator.newWindow(WindowType.TAB);
+    decoratedTargetLocator.defaultContent();
+    decoratedTargetLocator.activeElement();
+    decoratedTargetLocator.alert();
 
     assertThat(listener.acc.toString().trim())
         .isEqualTo(
@@ -822,12 +917,60 @@ public void afterWindow(
                 "beforeAnyWebDriverCall switchTo",
                 "afterAnyWebDriverCall switchTo",
                 "afterAnyCall switchTo",
+                "beforeAnyCall frame",
+                "beforeAnyTargetLocatorCall frame",
+                "beforeFrame 3",
+                "afterFrame 3",
+                "afterAnyTargetLocatorCall frame",
+                "afterAnyCall frame",
+                "beforeAnyCall frame",
+                "beforeAnyTargetLocatorCall frame",
+                "beforeFrame frame-id",
+                "afterFrame frame-id",
+                "afterAnyTargetLocatorCall frame",
+                "afterAnyCall frame",
+                "beforeAnyCall frame",
+                "beforeAnyTargetLocatorCall frame",
+                "beforeFrame " + frameElement,
+                "afterFrame " + frameElement,
+                "afterAnyTargetLocatorCall frame",
+                "afterAnyCall frame",
+                "beforeAnyCall parentFrame",
+                "beforeAnyTargetLocatorCall parentFrame",
+                "beforeParentFrame",
+                "afterParentFrame",
+                "afterAnyTargetLocatorCall parentFrame",
+                "afterAnyCall parentFrame",
                 "beforeAnyCall window",
                 "beforeAnyTargetLocatorCall window",
                 "beforeWindow windowName",
                 "afterWindow windowName",
                 "afterAnyTargetLocatorCall window",
-                "afterAnyCall window"));
+                "afterAnyCall window",
+                "beforeAnyCall newWindow",
+                "beforeAnyTargetLocatorCall newWindow",
+                "beforeNewWindow tab",
+                "afterNewWindow tab",
+                "afterAnyTargetLocatorCall newWindow",
+                "afterAnyCall newWindow",
+                "beforeAnyCall defaultContent",
+                "beforeAnyTargetLocatorCall defaultContent",
+                "beforeDefaultContent",
+                "afterDefaultContent",
+                "afterAnyTargetLocatorCall defaultContent",
+                "afterAnyCall defaultContent",
+                "beforeAnyCall activeElement",
+                "beforeAnyTargetLocatorCall activeElement",
+                "beforeActiveElement",
+                "afterActiveElement",
+                "afterAnyTargetLocatorCall activeElement",
+                "afterAnyCall activeElement",
+                "beforeAnyCall alert",
+                "beforeAnyTargetLocatorCall alert",
+                "beforeAlert",
+                "afterAlert",
+                "afterAnyTargetLocatorCall alert",
+                "afterAnyCall alert"));
   }
 
   @Test
@@ -857,7 +1000,7 @@ public void beforeAnyWebDriverCall(WebDriver driver, Method method, Object[] arg
           }
         };
 
-    WebDriver decorated = new EventFiringDecorator(listener).decorate(driver);
+    WebDriver decorated = new EventFiringDecorator<>(listener).decorate(driver);
 
     assertThatNoException().isThrownBy(decorated::getWindowHandle);
   }
