Allow for customization of the BrowserContext (#112)

This would also open up a pattern to be able to further customize the `BrowserContext`, or other things within Playwright.

I initially tried to do it via properties (i.e. `quarkus.playwright.*`, but unfortunately a `QuarkusTestResourceConfigurableLifecycleManager` doesn't have access to `@ConfigMapping`s (I checked with Georgios).

Author: edeandrea

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

docs/modules/ROOT/pages/includes/attributes.adoc

@@ -1,3 +1,4 @@
 :project-version: 2.0.0
 
-:examples-dir: ./../examples/
+:examples-dir: ./../examples/
+:runtime-dir: ./../../../../runtime

docs/modules/ROOT/pages/index.adoc

@@ -101,4 +101,20 @@ USER 1001
 CMD ["./application", "-Dquarkus.http.host=0.0.0.0"]
 ----
 
+== Additional Configuration
+
+There is additional configuration options available on the `@BrowserContextConfig` and `@WithPlaywright` annotations:
+
+.io.quarkiverse.playwright.BrowserContextConfig
+[source,java,subs="+attributes,macros+"]
+----
+include::{runtime-dir}/src/main/java/io/quarkiverse/playwright/BrowserContextConfig.java[]
+----
+
+.io.quarkiverse.playwright.WithPlaywright
+[source,java,subs="+attributes,macros+"]
+----
+include::{runtime-dir}/src/main/java/io/quarkiverse/playwright/WithPlaywright.java[]
+----
+
 include::includes/quarkus-playwright.adoc[leveloffset=+1, opts=optional]

docs/pom.xml

@@ -98,6 +98,12 @@
             <plugin>
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
+                <configuration>
+                    <attributes>
+                        <allow-uri-read/>
+                        <safe-mode>UNSAFE</safe-mode>
+                    </attributes>
+                </configuration>
             </plugin>
         </plugins>
     </build>

docs/templates/includes/attributes.adoc

@@ -1,3 +1,4 @@
 :project-version: ${release.current-version}
 
-:examples-dir: ./../examples/
+:examples-dir: ./../examples/
+:runtime-dir: ./../../../../runtime

integration-tests/pom.xml

@@ -50,6 +50,12 @@
             <artifactId>quarkus-junit5</artifactId>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.27.3</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <pluginManagement>

integration-tests/src/test/java/org/acme/PlaywrightConfigTest.java

@@ -0,0 +1,76 @@
+package org.acme;
+
+import static org.assertj.core.api.Assertions.*;
+
+import java.net.URL;
+import java.util.concurrent.TimeUnit;
+
+import jakarta.ws.rs.core.HttpHeaders;
+
+import org.junit.jupiter.api.Test;
+
+import com.microsoft.playwright.BrowserContext;
+import com.microsoft.playwright.Response;
+import com.microsoft.playwright.TimeoutError;
+import com.microsoft.playwright.assertions.PlaywrightAssertions;
+
+import io.quarkiverse.playwright.BrowserContextConfig;
+import io.quarkiverse.playwright.InjectPlaywright;
+import io.quarkiverse.playwright.WithPlaywright;
+import io.quarkus.test.common.http.TestHTTPResource;
+import io.quarkus.test.junit.QuarkusTest;
+
+@QuarkusTest
+@WithPlaywright(browserContext = @BrowserContextConfig(userAgent = "playwright-browser", defaultNavigationTimeout = "PT10s"))
+class PlaywrightConfigTest {
+    @InjectPlaywright
+    BrowserContext context;
+
+    @TestHTTPResource("/")
+    URL index;
+
+    @Test
+    void timeoutWorks() {
+        var page = context.newPage();
+        page.route(
+                index.toString(),
+                r -> {
+                    try {
+                        // Introduce intentional timeout
+                        TimeUnit.SECONDS.sleep(12);
+                    } catch (InterruptedException e) {
+                        throw new RuntimeException(e);
+                    }
+
+                    r.resume();
+                });
+
+        assertThatExceptionOfType(TimeoutError.class)
+                .isThrownBy(() -> page.navigate(index.toString()));
+    }
+
+    @Test
+    void testConfig() {
+        var page = context.newPage();
+
+        page.onRequest(r -> assertThat(r.headerValue(HttpHeaders.USER_AGENT)).isEqualTo("playwright-browser"));
+
+        var response = page.navigate(index.toString());
+
+        assertThat(response)
+                .extracting(Response::status)
+                .isEqualTo(200);
+
+        page.waitForLoadState();
+
+        PlaywrightAssertions.assertThat(page)
+                .hasTitle("My Awesome App");
+
+        // Make sure the web app is loaded and hits the backend
+        var quinoaEl = page.waitForSelector(".toast-body.received");
+        var greeting = quinoaEl.innerText();
+
+        assertThat(greeting)
+                .isEqualTo("Hello from RESTEasy Reactive");
+    }
+}

integration-tests/src/test/java/org/acme/WithDefaultPlaywrightTest.java

@@ -1,7 +1,11 @@
 package org.acme;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 import java.net.URL;
 
+import jakarta.ws.rs.core.HttpHeaders;
+
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -28,6 +32,8 @@ public class WithDefaultPlaywrightTest {
     @Test
     public void testIndex() {
         final Page page = context.newPage();
+        page.onRequest(r -> assertThat(r.headerValue(HttpHeaders.USER_AGENT)).isNotEqualTo("playwright-browser"));
+
         Response response = page.navigate(index.toString());
         Assertions.assertEquals("OK", response.statusText());
 

integration-tests/src/test/java/org/acme/WithFirefoxPlaywrightTest.java

@@ -1,9 +1,12 @@
 package org.acme;
 
 import static io.quarkiverse.playwright.WithPlaywright.Browser.FIREFOX;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import java.net.URL;
 
+import jakarta.ws.rs.core.HttpHeaders;
+
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -30,6 +33,8 @@ public class WithFirefoxPlaywrightTest {
     @Test
     public void testIndex() {
         final Page page = context.newPage();
+        page.onRequest(r -> assertThat(r.headerValue(HttpHeaders.USER_AGENT)).isNotEqualTo("playwright-browser"));
+
         Response response = page.navigate(index.toString());
         Assertions.assertEquals("OK", response.statusText());