feat(java): ✨ updated waitUntil method with timeout param (#962)

Author: WasiqB

core-java/src/main/java/io/github/boykaframework/actions/drivers/DriverActions.java

@@ -48,6 +48,7 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.interactions.Actions;
+import org.openqa.selenium.support.ui.WebDriverWait;
 
 /**
  * Device / Browser specific actions.
@@ -149,6 +150,17 @@ public <T> void waitUntil (final Function<WebDriver, T> condition) {
         });
     }
 
+    @Override
+    public <T> void waitUntil (final Function<WebDriver, T> condition, final Duration timeout) {
+        LOGGER.traceEntry ();
+        LOGGER.info ("Waiting for the expected condition for {} duration...", timeout);
+        ofNullable (this.listener).ifPresent (l -> l.onWaitUntil (timeout));
+        performDriverAction (driver -> {
+            final var wait = new WebDriverWait (driver, timeout);
+            wait.until (condition);
+        });
+    }
+
     private <D extends WebDriver> void saveLogType (final D driver, final String logType, final String logPath) {
         final var logEntries = driver.manage ()
             .logs ()

core-java/src/main/java/io/github/boykaframework/actions/interfaces/drivers/IDriverActions.java

@@ -58,4 +58,13 @@ public interface IDriverActions {
      * @param <T> type of condition
      */
     <T> void waitUntil (final Function<WebDriver, T> condition);
+
+    /**
+     * Wait for a specific condition to be true.
+     *
+     * @param condition condition to wait for
+     * @param timeout Wait duration for the condition
+     * @param <T> type of condition
+     */
+    <T> void waitUntil (final Function<WebDriver, T> condition, Duration timeout);
 }

core-java/src/main/java/io/github/boykaframework/actions/interfaces/listeners/drivers/IDriverActionsListener.java

@@ -59,4 +59,11 @@ default void onSaveLogs () {
     default void onWaitUntil () {
         // not implemented.
     }
+
+    /**
+     * Handle wait until method.
+     */
+    default void onWaitUntil (final Duration timeout) {
+        // not implemented.
+    }
 }

core-java/src/test/java/io/github/boykaframework/testng/ui/theinternet/WindowTest.java

@@ -28,6 +28,7 @@
 import static io.github.boykaframework.testng.ui.theinternet.pages.HomePage.homePage;
 import static io.github.boykaframework.testng.ui.theinternet.pages.MultiWindowPage.multiWindowPage;
 import static java.text.MessageFormat.format;
+import static java.time.Duration.ofSeconds;
 import static org.openqa.selenium.WindowType.TAB;
 import static org.openqa.selenium.support.ui.ExpectedConditions.urlMatches;
 
@@ -129,8 +130,8 @@ public void testOpenWindow () {
             .findFirst ();
         assertWithMessage ("Window").that (newWindow.isPresent ())
             .isTrue ();
-        onWindow ().switchTo (newWindow.get ());
-        withDriver ().waitUntil (urlMatches (format ("{0}windows/new", URL)));
+        onWindow ().switchTo (newWindow.orElseThrow ());
+        withDriver ().waitUntil (urlMatches (format ("{0}windows/new", URL)), ofSeconds (10));
         navigate ().verifyUrl ()
             .isEqualTo (format ("{0}windows/new", URL));
         onElement (multiWindowPage ().getTitle ()).verifyText ()

package.json

@@ -38,8 +38,8 @@
     "@stylistic/eslint-plugin-js": "^2.12.1",
     "@stylistic/eslint-plugin-ts": "^2.12.1",
     "@types/node": "^22.10.2",
-    "@typescript-eslint/eslint-plugin": "^8.18.2",
-    "@typescript-eslint/parser": "^8.18.2",
+    "@typescript-eslint/eslint-plugin": "^8.19.0",
+    "@typescript-eslint/parser": "^8.19.0",
     "commitlint": "^19.6.1",
     "eslint": "^9.17.0",
     "eslint-config-google": "^0.14.0",
@@ -63,7 +63,7 @@
     "release-it": "^17.11.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.2",
-    "typescript-eslint": "^8.18.2"
+    "typescript-eslint": "^8.19.0"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",

pnpm-lock.yaml

@@ -56,3 +56,15 @@ import org.openqa.selenium.support.ui.ExpectedConditions;
 . . .
 withDriver ().waitUntil (ExpectedConditions.urlMatches (URL));
 ```
+
+### `waitUntil(condition, timeout)` {#wait-until-with-timeout}
+
+This method will wait for any given condition to be true. It takes in Selenium WebDrivers `ExpectedCondition<Boolean>` object as parameter.
+
+```java
+import static io.github.boykaframework.actions.drivers.DriverActions.withDriver;
+import org.openqa.selenium.support.ui.ExpectedConditions;
+import java.time.Duration;
+. . .
+withDriver ().waitUntil (ExpectedConditions.urlMatches (URL), Duration.ofSeconds(10));
+```

website/docs/api/actions/drivers/driver-actions.md

@@ -22,3 +22,7 @@ This method will get executed after saving all the driver logs.
 ## `onWaitUntil` {#on-wait-until}
 
 This method will get executed after waiting until a particular condition.
+
+## `onWaitUntil(timeout)` {#on-wait-until-timeout}
+
+This method will get executed after waiting until a particular condition for provided timeout.