Implement retry behavior within WebPage#get call

Author: volosied

dev/com.ibm.ws.jsf.2.2_fat.2/fat/src/com/ibm/ws/jsf22/fat/FATSuite.java

@@ -122,6 +122,22 @@ public static ExtendedWebDriver getWebDriver() throws Exception {
         if(DRIVER == null) {
             throw new Exception("Failed to initialize WebDriver after multiple attempts! See log for details.");
         }
+
+        // Register the driver reset callback statically for the WebPage to use if exceptions occur.
+        WebPage.setDriverResetCallback(() -> {
+            Log.info(c, "DriverResetCallback", "Resetting WebDriver due to some error. See log for details");
+            if (DRIVER != null) {
+                try {
+                    DRIVER.quit();
+                } catch (Exception e) {
+                    // no-op
+                }
+                DRIVER = null;
+            }
+            DRIVER = getWebDriver();
+            return DRIVER;
+        });
+
         return DRIVER;
     }
 

dev/com.ibm.ws.jsf.2.2_fat/fat/src/com/ibm/ws/jsf22/fat/FATSuite.java

@@ -133,6 +133,22 @@ public static ExtendedWebDriver getWebDriver() throws Exception {
         if(DRIVER == null) {
             throw new Exception("Failed to initialize WebDriver after multiple attempts! See log for details.");
         }
+
+        // Register the driver reset callback statically for the WebPage to use if exceptions occur.
+        WebPage.setDriverResetCallback(() -> {
+            Log.info(c, "DriverResetCallback", "Resetting WebDriver due to some error. See log for details");
+            if (DRIVER != null) {
+                try {
+                    DRIVER.quit();
+                } catch (Exception e) {
+                    // no-op
+                }
+                DRIVER = null;
+            }
+            DRIVER = getWebDriver();
+            return DRIVER;
+        });
+
         return DRIVER;
     }
 

dev/com.ibm.ws.jsf.2.3_fat.2/fat/src/com/ibm/ws/jsf23/fat/FATSuite.java

@@ -107,6 +107,22 @@ public static ExtendedWebDriver getWebDriver() throws Exception {
         if(DRIVER == null) {
             throw new Exception("Failed to initialize WebDriver after multiple attempts! See log for details.");
         }
+
+        // Register the driver reset callback statically for the WebPage to use if exceptions occur.
+        WebPage.setDriverResetCallback(() -> {
+            Log.info(c, "DriverResetCallback", "Resetting WebDriver due to some error. See log for details");
+            if (DRIVER != null) {
+                try {
+                    DRIVER.quit();
+                } catch (Exception e) {
+                    // no-op
+                }
+                DRIVER = null;
+            }
+            DRIVER = getWebDriver();
+            return DRIVER;
+        });
+
         return DRIVER;
     }
 

dev/com.ibm.ws.jsf.2.3_fat/fat/src/com/ibm/ws/jsf23/fat/FATSuite.java

@@ -139,6 +139,22 @@ public static ExtendedWebDriver getWebDriver() throws Exception {
         if(DRIVER == null) {
             throw new Exception("Failed to initialize WebDriver after multiple attempts! See log for details.");
         }
+
+        // Register the driver reset callback statically for the WebPage to use if exceptions occur.
+        WebPage.setDriverResetCallback(() -> {
+            Log.info(c, "DriverResetCallback", "Resetting WebDriver due to some error. See log for details");
+            if (DRIVER != null) {
+                try {
+                    DRIVER.quit();
+                } catch (Exception e) {
+                    // no-op
+                }
+                DRIVER = null;
+            }
+            DRIVER = getWebDriver();
+            return DRIVER;
+        });
+
         return DRIVER;
     }
 

dev/io.openliberty.faces.fat.selenium.util.internal/src/io/openliberty/faces/fat/selenium/util/internal/WebPage.java

@@ -38,6 +38,23 @@ public class WebPage {
     public static final Duration LONG_TIMEOUT = Duration.ofMillis(16000);
 
     protected ExtendedWebDriver webDriver;
+    private static DriverResetCallback driverResetCallback = null;
+
+    /*
+     * Interface to reset the driver, see setDriverResetCallback
+     */
+    @FunctionalInterface
+    public interface DriverResetCallback {
+        ExtendedWebDriver resetDriver() throws Exception;
+    }
+
+    /*
+     * Set a callback to reset the driver 
+     * Must be called once within the FATSuite during driver initialization
+     */
+    public static void setDriverResetCallback(DriverResetCallback callback) {
+        driverResetCallback = callback;
+    }
 
     public WebPage(ExtendedWebDriver webDriver) {
         this.webDriver = webDriver;
@@ -52,7 +69,30 @@ public void setWebDriver(ExtendedWebDriver webDriver) {
     }
 
     public void get(String url) {
-        webDriver.get(url);
+        int maxAttempts = 2;
+        Exception lastException = null;
+        
+        for (int attempt = 1; attempt <= maxAttempts; attempt++) {
+            try {
+                webDriver.get(url);
+                return; 
+            } catch (Exception e) {
+                lastException = e;
+                
+                // callback exists and we have attempts left
+                if (driverResetCallback != null && attempt < maxAttempts) {
+                    try {
+                        Thread.sleep(10000); // Wait 10 seconds before retrying if it's some network issue. 
+                        webDriver = driverResetCallback.resetDriver();
+                    } catch (Exception resetEx) {
+                        // no-op, as we may have attempts left
+                    }
+                } else if (attempt == maxAttempts) {
+                    // Last attempt failed, throw exception
+                    throw new RuntimeException("Failed to navigate to URL after " + maxAttempts + " attempts: " + url, lastException);
+                }
+            }
+        }
     }
 
     public String getTitle() {

dev/io.openliberty.org.apache.myfaces.4.0_fat/fat/src/io/openliberty/org/apache/myfaces40/fat/FATSuite.java

@@ -56,6 +56,8 @@
 import io.openliberty.org.apache.myfaces40.fat.tests.bugfixes.MyFaces4628Test;
 import io.openliberty.org.apache.myfaces40.fat.tests.bugfixes.MyFaces4658Test;
 
+import io.openliberty.faces.fat.selenium.util.internal.WebPage;
+
 @RunWith(Suite.class)
 @SuiteClasses({
                 AcceptInputFileTest.class,
@@ -152,6 +154,22 @@ public static ExtendedWebDriver getWebDriver() throws Exception {
         if(DRIVER == null) {
             throw new Exception("Failed to initialize WebDriver after multiple attempts! See log for details.");
         }
+        
+        // Register the driver reset callback statically for the WebPage to use if exceptions occur.
+        WebPage.setDriverResetCallback(() -> {
+            Log.info(c, "DriverResetCallback", "Resetting WebDriver due to some error. See log for details");
+            if (DRIVER != null) {
+                try {
+                    DRIVER.quit();
+                } catch (Exception e) {
+                    // no-op
+                }
+                DRIVER = null;
+            }
+            DRIVER = getWebDriver();
+            return DRIVER;
+        });
+        
         return DRIVER;
     }
 

dev/io.openliberty.org.apache.myfaces.4.0_fat/fat/src/io/openliberty/org/apache/myfaces40/fat/tests/WebSocketTests.java

@@ -87,7 +87,7 @@ public void testOnErrorWebsocket() throws Exception {
 
         String contextRoot = "WebSocket";
 
-        String url = JSFUtils.createSeleniumURLString(server, contextRoot, "OnErrorWebSocketTest.jsf");;
+        String url = JSFUtils.createSeleniumURLString(server, contextRoot, "OnErrorWebSocketTest.jsf");
         WebPage page = new WebPage(driver);
         page.get(url);
         page.waitForPageToLoad();