feat: assertions default timeout (#1023)

Author: yury-s

README.md

@@ -11,9 +11,9 @@ Playwright is a Java library to automate [Chromium](https://www.chromium.org/Hom
 
 |          | Linux | macOS | Windows |
 |   :---   | :---: | :---: | :---:   |
-| Chromium <!-- GEN:chromium-version -->104.0.5112.57<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Chromium <!-- GEN:chromium-version -->104.0.5112.81<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | WebKit <!-- GEN:webkit-version -->16.0<!-- GEN:stop --> | ✅ | ✅ | ✅ |
-| Firefox <!-- GEN:firefox-version -->102.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Firefox <!-- GEN:firefox-version -->103.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 
 Headless execution is supported for all the browsers on all platforms. Check out [system requirements](https://playwright.dev/java/docs/next/intro/#system-requirements) for details.
 

playwright/src/main/java/com/microsoft/playwright/BrowserType.java

@@ -1028,15 +1028,19 @@ public LaunchPersistentContextOptions setViewportSize(ViewportSize viewportSize)
     }
   }
   /**
-   * This method attaches Playwright to an existing browser instance.
+   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
+   * {@code BrowserType.launchServer} in Node.js, the major and minor version needs to match the client version (1.2.3 → is
+   * compatible with 1.2.x).
    *
    * @param wsEndpoint A browser websocket endpoint to connect to.
    */
   default Browser connect(String wsEndpoint) {
     return connect(wsEndpoint, null);
   }
   /**
-   * This method attaches Playwright to an existing browser instance.
+   * This method attaches Playwright to an existing browser instance. When connecting to another browser launched via
+   * {@code BrowserType.launchServer} in Node.js, the major and minor version needs to match the client version (1.2.3 → is
+   * compatible with 1.2.x).
    *
    * @param wsEndpoint A browser websocket endpoint to connect to.
    */

playwright/src/main/java/com/microsoft/playwright/assertions/PlaywrightAssertions.java

@@ -20,6 +20,7 @@
 import com.microsoft.playwright.Locator;
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.impl.APIResponseAssertionsImpl;
+import com.microsoft.playwright.impl.AssertionsTimeout;
 import com.microsoft.playwright.impl.LocatorAssertionsImpl;
 import com.microsoft.playwright.impl.PageAssertionsImpl;
 
@@ -86,5 +87,17 @@ static PageAssertions assertThat(Page page) {
     return new PageAssertionsImpl(page);
   }
 
+  /**
+   * Changes default timeout for Playwright assertions from 5 seconds to the speicified value.
+   * <pre>{@code
+   * PlaywrightAssertions.setDefaultAssertionTimeout(30_000);
+   * }</pre>
+   *
+   * @param timeout Timeout in milliseconds.
+   */
+  static void setDefaultAssertionTimeout(double milliseconds) {
+    AssertionsTimeout.setDefaultTimeout(milliseconds);
+  }
+
 }
 

playwright/src/main/java/com/microsoft/playwright/impl/AssertionsBase.java

@@ -52,7 +52,7 @@ void expectImpl(String expression, List<ExpectedTextValue> expectedText, Object
 
   void expectImpl(String expression, FrameExpectOptions expectOptions, Object expected, String message) {
     if (expectOptions.timeout == null) {
-      expectOptions.timeout = 5_000.0;
+      expectOptions.timeout = AssertionsTimeout.defaultTimeout;
     }
     if (expectOptions.isNot) {
       message = message.replace("expected to", "expected not to");

playwright/src/main/java/com/microsoft/playwright/impl/AssertionsTimeout.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed 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.
+ */
+
+package com.microsoft.playwright.impl;
+
+import com.microsoft.playwright.PlaywrightException;
+
+public class AssertionsTimeout {
+  static double defaultTimeout = 5_000;
+
+  public static void setDefaultTimeout(double ms) {
+    if (ms < 0) {
+      throw new PlaywrightException("Timeout cannot be negative");
+    }
+    defaultTimeout = ms;
+  }
+}

playwright/src/test/java/com/microsoft/playwright/TestLocatorAssertions.java

@@ -17,6 +17,7 @@
 package com.microsoft.playwright;
 
 import com.microsoft.playwright.assertions.LocatorAssertions;
+import com.microsoft.playwright.assertions.PlaywrightAssertions;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.opentest4j.AssertionFailedError;
@@ -980,4 +981,35 @@ void locatorCountShouldWorkWithDeletedMapInMainWorld() {
     page.locator("#searchResultTableDiv .x-grid3-row").count();
     assertThat(page.locator("#searchResultTableDiv .x-grid3-row")).hasCount(0);
   }
+
+  @Test
+  void defaultTimeoutHasTextFail() {
+    page.setContent("<div></div>");
+    Locator locator = page.locator("div");
+    PlaywrightAssertions.setDefaultAssertionTimeout(1000);
+    AssertionFailedError exception = assertThrows(AssertionFailedError.class, () -> assertThat(locator).hasText("foo"));
+    assertTrue(exception.getMessage().contains("Locator.expect with timeout 1000ms"), exception.getMessage());
+    // Restore default.
+    PlaywrightAssertions.setDefaultAssertionTimeout(5_000);
+  }
+
+  @Test
+  void defaultTimeoutHasTextPass() {
+    page.setContent("<div>foo</div>");
+    Locator locator = page.locator("div");
+    PlaywrightAssertions.setDefaultAssertionTimeout(1000);
+    assertThat(locator).hasText("foo");
+    // Restore default.
+    PlaywrightAssertions.setDefaultAssertionTimeout(5_000);
+  }
+
+  @Test
+  void defaultTimeoutZeroHasTextPass() {
+    page.setContent("<div>foo</div>");
+    Locator locator = page.locator("div");
+    PlaywrightAssertions.setDefaultAssertionTimeout(0);
+    assertThat(locator).hasText("foo");
+    // Restore default.
+    PlaywrightAssertions.setDefaultAssertionTimeout(5_000);
+  }
 }

scripts/CLI_VERSION

@@ -1 +1 @@
-1.25.0-alpha-jul-28-2022
+1.25.0-alpha-1659639526000

tools/api-generator/src/main/java/com/microsoft/playwright/tools/ApiGenerator.java

@@ -675,6 +675,14 @@ void writeTo(List<String> output, String offset) {
       }
       return;
     }
+    if ("PlaywrightAssertions.setDefaultAssertionTimeout".equals(jsonPath)) {
+      writeJavadoc(params, output, offset);
+      output.add(offset + "static void setDefaultAssertionTimeout(double milliseconds) {");
+      output.add(offset + "  AssertionsTimeout.setDefaultTimeout(milliseconds);");
+      output.add(offset + "}");
+      output.add("");
+      return;
+    }
     int numOverloads = 1;
     for (int i = 0; i < params.size(); i++) {
       if (params.get(i).type.isTypeUnion()) {
@@ -952,6 +960,7 @@ void writeTo(List<String> output, String offset) {
       output.add("import com.microsoft.playwright.Locator;");
       output.add("import com.microsoft.playwright.Page;");
       output.add("import com.microsoft.playwright.impl.APIResponseAssertionsImpl;");
+      output.add("import com.microsoft.playwright.impl.AssertionsTimeout;");
       output.add("import com.microsoft.playwright.impl.LocatorAssertionsImpl;");
       output.add("import com.microsoft.playwright.impl.PageAssertionsImpl;");
     }