Merge branch '4.2.x' into geb-133-serviceloader

Author: JonasPammer

README.md

@@ -90,6 +90,21 @@ Optionally, in specific test classes, either call [`ContainerGebTestDescriptionS
 in a Spock `setupSpec` method to apply your naming convention (And use a `cleanupSpec` to limit this to one class),
 or set the `testDescription` Property on your ContainerGebConfiguration annotation.
 
+#### Remove Implicit Wait
+
+* `grails.geb.timeouts.implicitlyWait`
+  * purpose: amount of time the driver should wait when searching for an element if it is not immediately present.
+  * defaults to `0` seconds, which means that if an element is not found, it will immediately return an error.
+  * Warning: Do not mix implicit and explicit waits. Doing so can cause unpredictable wait times.
+    Consult the [Geb](https://www.gebish.org/manual/current/#implicit-assertions-waiting) 
+    and/or [Selenium](https://www.selenium.dev/documentation/webdriver/waits/) documentation for details.
+* `grails.geb.timeouts.pageLoad`
+  * purpose: amount of time to wait for a page load to complete before throwing an error.
+  * defaults to `300` seconds
+* `grails.geb.timeouts.script`
+  * purpose: amount of time to wait for an asynchronous script to finish execution before throwing an error.
+  * defaults to `30` seconds
+
 #### Observability and Tracing
 Selenium integrates with [OpenTelemetry](https://opentelemetry.io) to support observability and tracing out of the box. By default, Selenium [enables tracing](https://www.selenium.dev/blog/2021/selenium-4-observability).
 

spock-container-test-app/src/integration-test/groovy/org/demo/spock/RootPageSpec.groovy

@@ -3,7 +3,6 @@ package org.demo.spock
 import geb.report.CompositeReporter
 import geb.report.PageSourceReporter
 import geb.report.Reporter
-import geb.report.ScreenshotReporter
 import grails.plugin.geb.ContainerGebConfiguration
 import grails.plugin.geb.ContainerGebSpec
 import grails.testing.mixin.integration.Integration
@@ -19,7 +18,7 @@ class RootPageSpec extends ContainerGebSpec {
     @Override
     Reporter createReporter() {
         // Override the default reporter to demonstrate how this can be customized
-        new CompositeReporter(new ScreenshotReporter(), new PageSourceReporter())
+        new CompositeReporter(new PageSourceReporter())
     }
 
     void 'should display the correct title on the home page'() {

src/testFixtures/groovy/grails/plugin/geb/GrailsGebSettings.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 original author or authors
+ * Copyright 2024-2025 original author or authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,13 +37,19 @@ class GrailsGebSettings {
 
     private static VncRecordingMode DEFAULT_RECORDING_MODE = VncRecordingMode.SKIP
     private static VncRecordingFormat DEFAULT_RECORDING_FORMAT = VncRecordingFormat.MP4
+    private static int DEFAULT_TIMEOUT_IMPLICITLY_WAIT = 0
+    private static int DEFAULT_TIMEOUT_PAGE_LOAD = 300
+    private static int DEFAULT_TIMEOUT_SCRIPT = 30
 
     String tracingEnabled
     String recordingDirectoryName
     String reportingDirectoryName
     VncRecordingMode recordingMode
     VncRecordingFormat recordingFormat
     LocalDateTime startTime
+    int implicitlyWait
+    int pageLoadTimeout
+    int scriptTimeout
 
     GrailsGebSettings(LocalDateTime startTime) {
         tracingEnabled = System.getProperty('grails.geb.tracing.enabled', 'false')
@@ -55,9 +61,16 @@ class GrailsGebSettings {
         recordingFormat = VncRecordingFormat.valueOf(
                 System.getProperty('grails.geb.recording.format', DEFAULT_RECORDING_FORMAT.name())
         )
+        implicitlyWait = getIntProperty('grails.geb.timeouts.implicitlyWait', DEFAULT_TIMEOUT_IMPLICITLY_WAIT)
+        pageLoadTimeout = getIntProperty('grails.geb.timeouts.pageLoad', DEFAULT_TIMEOUT_PAGE_LOAD)
+        scriptTimeout = getIntProperty('grails.geb.timeouts.script', DEFAULT_TIMEOUT_SCRIPT)
         this.startTime = startTime
     }
 
+    private static int getIntProperty(String propertyName, int defaultValue) {
+        Integer.getInteger(propertyName, defaultValue) ?: defaultValue
+    }
+
     boolean isRecordingEnabled() {
         recordingMode != VncRecordingMode.SKIP
     }

src/testFixtures/groovy/grails/plugin/geb/WebDriverContainerHolder.groovy

@@ -26,6 +26,7 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.PackageScope
 import groovy.util.logging.Slf4j
 import org.openqa.selenium.WebDriver
+import org.openqa.selenium.WebDriver.Timeouts
 import org.openqa.selenium.chrome.ChromeOptions
 import org.openqa.selenium.remote.RemoteWebDriver
 import org.spockframework.runtime.extension.IMethodInvocation
@@ -125,7 +126,11 @@ class WebDriverContainerHolder {
         currentBrowser = new Browser(new Configuration(configObject, new Properties(), null, null))
 
         WebDriver driver = new RemoteWebDriver(currentContainer.seleniumAddress, new ChromeOptions())
-        driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(30))
+        driver.manage().timeouts().with {
+            implicitlyWait(Duration.ofSeconds(grailsGebSettings.implicitlyWait))
+            pageLoadTimeout(Duration.ofSeconds(grailsGebSettings.pageLoadTimeout))
+            scriptTimeout(Duration.ofSeconds(grailsGebSettings.scriptTimeout))
+        }
 
         currentBrowser.driver = driver
 

src/testFixtures/groovy/grails/plugin/geb/support/ReportingSupport.groovy

@@ -18,6 +18,7 @@ package grails.plugin.geb.support
 import geb.report.CompositeReporter
 import geb.report.PageSourceReporter
 import geb.report.Reporter
+import geb.report.ScreenshotReporter
 import grails.plugin.geb.ContainerGebSpec
 import groovy.transform.CompileStatic
 import groovy.transform.SelfType
@@ -41,6 +42,6 @@ trait ReportingSupport {
      * The reporter that Geb should use when reporting is enabled.
      */
     Reporter createReporter() {
-        new CompositeReporter(new PageSourceReporter())
+        return new CompositeReporter(new PageSourceReporter(), new ScreenshotReporter())
     }
 }