Fixed an issue related to screenshots being recorded unnecessarily

wakaleo · wakaleo · commit bf72ff2237b1 · 2025-05-18T16:16:57.000+10:00
diff --git a/pom.xml b/pom.xml
@@ -62,10 +62,10 @@
         <commons.collections.version>4.4</commons.collections.version>
         <commons.compress.version>1.27.1</commons.compress.version>
         <commons.net.version>3.11.1</commons.net.version>
-        <commons.codec.version>1.17.1</commons.codec.version>
-        <freemarker.version>2.3.33</freemarker.version>
-        <selenium.version>4.29.0</selenium.version>
-        <htmlunit.driver.version>4.29.0</htmlunit.driver.version>
+        <commons.codec.version>1.18.0</commons.codec.version>
+        <freemarker.version>2.3.34</freemarker.version>
+        <selenium.version>4.32.0</selenium.version>
+        <htmlunit.driver.version>4.32.0</htmlunit.driver.version>
         <jsonassert.version>1.5.1</jsonassert.version>
         <jsoup.version>1.15.4</jsoup.version>
         <joda-time.version>2.13.0</joda-time.version>
@@ -84,15 +84,15 @@
         <jimfs.version>1.3.0</jimfs.version>
         <jbehave.version>4.8.3</jbehave.version>
         <ant.version>1.10.12</ant.version>
-        <restassured.version>5.5.0</restassured.version>
+        <restassured.version>5.5.2</restassured.version>
         <wiremock.version>3.13.0</wiremock.version>
         <thymeleaf.version>3.1.2.RELEASE</thymeleaf.version>
         <javassist.version>3.29.2-GA</javassist.version>
         <jackson.version>2.18.1</jackson.version>
         <xchart.version>3.5.2</xchart.version>
         <ehcache.version>3.10.8</ehcache.version>
         <!-- Kotlin config -->
-        <kotlin.version>2.1.10</kotlin.version>
+        <kotlin.version>2.1.21</kotlin.version>
         <kotlin.compiler.jvmTarget>17</kotlin.compiler.jvmTarget>
     </properties>
     <dependencyManagement>
diff --git a/serenity-core/src/main/java/net/serenitybdd/core/photography/PageSourceRecorder.java b/serenity-core/src/main/java/net/serenitybdd/core/photography/PageSourceRecorder.java
@@ -30,7 +30,7 @@ public Optional<File> intoDirectory(Path path) {
         byte[] pageSource = render(getPageSource());
 
 
-        if (WebDriverFactory.isAlive(driver) && (pageSource.length > 0)) {
+        if (WebDriverFactory.isAlive(driver) && (pageSource.length > 0) && shouldRecordPageSource()) {
             try {
                 Path pageSourceFile = Files.createTempFile(path, "pagesource", ".html");
                 Files.write(pageSourceFile, pageSource);
@@ -42,6 +42,11 @@ public Optional<File> intoDirectory(Path path) {
         return Optional.empty();
     }
 
+    private boolean shouldRecordPageSource() {
+        // Disable this for now
+        return false;
+    }
+
 
     private final static String HTML_PRISM_HIGHLIGHT = "<html lang='en'><head><link href='prism/prism.css' rel='stylesheet' /></head><body><script src='prism/prism.js'></script><body><div><pre><code class='language-html'>";
     private final static String HTML_CLOSE = "</code></pre></div></body></html>";
diff --git a/serenity-core/src/main/java/net/thucydides/core/steps/BaseStepListener.java b/serenity-core/src/main/java/net/thucydides/core/steps/BaseStepListener.java
@@ -1094,7 +1094,7 @@ private void takeEndOfStepScreenshotFor(final TestResult result) {
     }
 
     private void takeEndOfStepScreenshotForRecording(final TestResult result, List<ScreenshotAndHtmlSource> screenshots) {
-        if (currentTestIsABrowserTest()) {
+        if (currentTestIsABrowserTest() && shouldTakeEndOfStepScreenshotFor(result)) {
             takeRecord(MANDATORY_SCREENSHOT, result, screenshots);
         }
     }
@@ -1135,6 +1135,7 @@ private void take(final ScreenshotType screenshotType, TestResult result) {
     }
 
     private void takeRecord(final ScreenshotType screenshotType, TestResult result, List<ScreenshotAndHtmlSource> screenshots) {
+
         if (shouldTakeScreenshotsWithoutCurrentStep(result)) {
             try {
                 grabScreenshots(result).forEach(
diff --git a/serenity-core/src/main/java/net/thucydides/core/webdriver/capabilities/ChromiumOptionsBuilder.java b/serenity-core/src/main/java/net/thucydides/core/webdriver/capabilities/ChromiumOptionsBuilder.java
@@ -28,7 +28,7 @@ public static ChromiumOptions<?> fromDesiredCapabilities(DesiredCapabilities cap
                                                              String capabilitySectionName) {
         // General capabilities
         ChromiumOptions<?> chromiumOptions =
-                (capabilities.getBrowserName().equalsIgnoreCase("chrome") || capabilities.getBrowserName().equalsIgnoreCase("chromium")) ?
+                (capabilities.getBrowserName().isEmpty() || capabilities.getBrowserName().equalsIgnoreCase("chrome") || capabilities.getBrowserName().equalsIgnoreCase("chromium")) ?
                 new ChromeOptions() : new EdgeOptions();
 
         // Process standard W3C capabilities
diff --git a/serenity-reports/src/main/java/net/thucydides/core/reports/html/BaseReportingTask.java b/serenity-reports/src/main/java/net/thucydides/core/reports/html/BaseReportingTask.java
@@ -9,6 +9,7 @@
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
+import java.io.Writer;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
diff --git a/serenity-reports/src/main/java/net/thucydides/core/reports/html/HtmlAcceptanceTestReporter.java b/serenity-reports/src/main/java/net/thucydides/core/reports/html/HtmlAcceptanceTestReporter.java
@@ -27,6 +27,7 @@
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
+import java.io.Writer;
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
diff --git a/serenity-reports/src/main/java/net/thucydides/core/reports/html/HtmlMinifyingWriter.java b/serenity-reports/src/main/java/net/thucydides/core/reports/html/HtmlMinifyingWriter.java
@@ -0,0 +1,55 @@
+package net.thucydides.core.reports.html;
+
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.Writer;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+public class HtmlMinifyingWriter extends Writer {
+
+    public static Writer minifyingWriter(Path outputPath) throws IOException {
+        BufferedWriter baseWriter = Files.newBufferedWriter(outputPath, StandardCharsets.UTF_8);
+        if (outputPath.toString().endsWith(".html")) {
+            return new HtmlMinifyingWriter(baseWriter);
+        }
+        return baseWriter;
+    }
+
+    private final Writer delegate;
+    private final StringBuilder buffer = new StringBuilder();
+
+    public HtmlMinifyingWriter(Writer delegate) {
+        this.delegate = delegate;
+    }
+
+    @Override
+    public void write(char[] cbuf, int off, int len) {
+        buffer.append(cbuf, off, len);
+    }
+
+    @Override
+    public void flush() throws IOException {
+        compressAndWrite();
+        delegate.flush();
+    }
+
+    @Override
+    public void close() throws IOException {
+        compressAndWrite();
+        delegate.close();
+    }
+
+    private void compressAndWrite() throws IOException {
+        String content = buffer.toString();
+
+        // Basic HTML whitespace compression
+        String minified = content
+            .replaceAll(">\\s+<", "><")         // remove whitespace between tags
+            .replaceAll("\\s{2,}", " ")         // collapse multiple spaces
+            .replaceAll("^\\s+|\\s+$", "");     // trim leading/trailing whitespace
+
+        delegate.write(minified);
+    }
+}
diff --git a/serenity-screenplay-webdriver/src/test/java/net/serenitybdd/screenplay/webtests/integration/actions/DevToolsTest.java b/serenity-screenplay-webdriver/src/test/java/net/serenitybdd/screenplay/webtests/integration/actions/DevToolsTest.java
@@ -6,8 +6,8 @@
 import net.serenitybdd.screenplay.webtests.integration.ScreenplayInteractionTestBase;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.openqa.selenium.devtools.v131.performance.Performance;
-import org.openqa.selenium.devtools.v131.performance.model.Metric;
+import org.openqa.selenium.devtools.v136.performance.Performance;
+import org.openqa.selenium.devtools.v136.performance.model.Metric;
 
 import java.util.ArrayList;
 import java.util.List;

Original file line number	Diff line number	Diff line change
`@@ -1094,7 +1094,7 @@ private void takeEndOfStepScreenshotFor(final TestResult result) {`
`1094`	`1094`	`}`
`1095`	`1095`
`1096`	`1096`	`private void takeEndOfStepScreenshotForRecording(final TestResult result, List<ScreenshotAndHtmlSource> screenshots) {`
`1097`		`- if (currentTestIsABrowserTest()) {`
	`1097`	`+ if (currentTestIsABrowserTest() && shouldTakeEndOfStepScreenshotFor(result)) {`
`1098`	`1098`	`takeRecord(MANDATORY_SCREENSHOT, result, screenshots);`
`1099`	`1099`	`}`
`1100`	`1100`	`}`
`@@ -1135,6 +1135,7 @@ private void take(final ScreenshotType screenshotType, TestResult result) {`
`1135`	`1135`	`}`
`1136`	`1136`
`1137`	`1137`	`private void takeRecord(final ScreenshotType screenshotType, TestResult result, List<ScreenshotAndHtmlSource> screenshots) {`
	`1138`	`+`
`1138`	`1139`	`if (shouldTakeScreenshotsWithoutCurrentStep(result)) {`
`1139`	`1140`	`try {`
`1140`	`1141`	`grabScreenshots(result).forEach(`