Merge branch 'trunk' into add-jspecify-annotations-by

diemol · web-flow · commit a1bf9e087c5f · 2024-08-14T18:41:52.000+02:00
diff --git a/.github/workflows/stage-release.yml b/.github/workflows/stage-release.yml
@@ -6,6 +6,7 @@ on:
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
 
 jobs:
   github-release:
@@ -20,7 +21,6 @@ jobs:
       - name: Extract version from branch name
         id: extract_version
         run: |
-          BRANCH_NAME="${{ github.event.pull_request.head.ref }}"
           VERSION=$(echo $BRANCH_NAME | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
           echo "VERSION=$VERSION" >> $GITHUB_ENV
       - name: Prep git
diff --git a/.skipped-tests b/.skipped-tests
@@ -19,6 +19,7 @@
 -//javascript/atoms:test-chrome
 -//javascript/atoms:test-edge
 -//javascript/atoms:test-firefox-beta
+-//javascript/chrome-driver/...
 -//javascript/node/selenium-webdriver:test-bidi-network-test.js-chrome
 -//javascript/node/selenium-webdriver:test-builder-test.js-chrome
 -//javascript/node/selenium-webdriver:test-builder-test.js-firefox
@@ -54,3 +55,4 @@
 -//rb/spec/integration/selenium/webdriver:element-chrome
 -//rb/spec/integration/selenium/webdriver:element-chrome-bidi
 -//rb/spec/integration/selenium/webdriver:element-chrome-remote
+-//rust/tests/...
diff --git a/common/src/web/javascriptPage.html b/common/src/web/javascriptPage.html
@@ -279,6 +279,10 @@ <h1>Type Stuff</h1>
   </div>
 </div>
 
+<form id="aParentFormId">
+  <input type="text" name="tagName">
+</form>
+
 </body>
 </html>
 
diff --git a/java/src/org/openqa/selenium/JavascriptExecutor.java b/java/src/org/openqa/selenium/JavascriptExecutor.java
@@ -20,6 +20,8 @@
 import java.util.Collections;
 import java.util.Set;
 import java.util.stream.Collectors;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.internal.Require;
 
 /**
@@ -30,6 +32,7 @@
  * request or when trying to access another frame. Most times when troubleshooting failure it's best
  * to view the browser's console after executing the WebDriver request.
  */
+@NullMarked
 public interface JavascriptExecutor {
   /**
    * Executes JavaScript in the context of the currently selected frame or window. The script
@@ -63,7 +66,7 @@ public interface JavascriptExecutor {
    * @param args The arguments to the script. May be empty
    * @return One of Boolean, Long, Double, String, List, Map or WebElement. Or null.
    */
-  Object executeScript(String script, Object... args);
+  @Nullable Object executeScript(String script, @Nullable Object... args);
 
   /**
    * Execute an asynchronous piece of JavaScript in the context of the currently selected frame or
@@ -139,7 +142,7 @@ public interface JavascriptExecutor {
    * @return One of Boolean, Long, String, List, Map, WebElement, or null.
    * @see WebDriver.Timeouts#scriptTimeout(java.time.Duration)
    */
-  Object executeAsyncScript(String script, Object... args);
+  @Nullable Object executeAsyncScript(String script, @Nullable Object... args);
 
   /**
    * Commonly used scripts may be "pinned" to the WebDriver session, allowing them to be called
@@ -186,7 +189,7 @@ default Set<ScriptKey> getPinnedScripts() {
    *
    * @see #executeScript(String, Object...)
    */
-  default Object executeScript(ScriptKey key, Object... args) {
+  default @Nullable Object executeScript(ScriptKey key, @Nullable Object... args) {
     Require.stateCondition(
         key instanceof UnpinnedScriptKey, "Script key should have been generated by this driver");
 
diff --git a/java/src/org/openqa/selenium/OutputType.java b/java/src/org/openqa/selenium/OutputType.java
@@ -22,13 +22,15 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Base64;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * Defines the output type for a screenshot.
  *
  * @see TakesScreenshot
  * @param <T> Type for the screenshot output.
  */
+@NullMarked
 public interface OutputType<T> {
   /** Obtain the screenshot as base64 data. */
   OutputType<String> BASE64 =
diff --git a/java/src/org/openqa/selenium/TakesScreenshot.java b/java/src/org/openqa/selenium/TakesScreenshot.java
@@ -16,6 +16,8 @@
 // under the License.
 package org.openqa.selenium;
 
+import org.jspecify.annotations.NullMarked;
+
 /**
  * Indicates a driver or an HTML element that can capture a screenshot and store it in different
  * ways.
@@ -29,6 +31,7 @@
  *
  * @see OutputType
  */
+@NullMarked
 public interface TakesScreenshot {
   /**
    * Capture the screenshot and store it in the specified location.
diff --git a/java/src/org/openqa/selenium/WebDriver.java b/java/src/org/openqa/selenium/WebDriver.java
@@ -22,6 +22,8 @@
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.logging.LoggingPreferences;
 import org.openqa.selenium.logging.Logs;
 
@@ -46,6 +48,7 @@
  * <p>Most implementations of this interface follow <a href="https://w3c.github.io/webdriver/">W3C
  * WebDriver specification</a>
  */
+@NullMarked
 public interface WebDriver extends SearchContext {
   // Navigation
 
@@ -74,7 +77,7 @@ public interface WebDriver extends SearchContext {
    *
    * @return The URL of the page currently loaded in the browser
    */
-  String getCurrentUrl();
+  @Nullable String getCurrentUrl();
 
   // General properties
 
@@ -87,7 +90,7 @@ public interface WebDriver extends SearchContext {
    * @return The title of the current page, with leading and trailing whitespace stripped, or null
    *     if one is not already set
    */
-  String getTitle();
+  @Nullable String getTitle();
 
   /**
    * Find all elements within the current page using the given mechanism. This method is affected by
@@ -142,7 +145,7 @@ public interface WebDriver extends SearchContext {
    *
    * @return The source of the current page
    */
-  String getPageSource();
+  @Nullable String getPageSource();
 
   /**
    * Close the current window, quitting the browser if it's the last window currently open.
@@ -261,7 +264,7 @@ interface Options {
      * @param name the name of the cookie
      * @return the cookie, or null if no cookie with the given name is present
      */
-    Cookie getCookieNamed(String name);
+    @Nullable Cookie getCookieNamed(String name);
 
     /**
      * @return the interface for managing driver timeouts.
diff --git a/javascript/atoms/domcore.js b/javascript/atoms/domcore.js
@@ -169,6 +169,11 @@ bot.dom.core.isElement = function (node, opt_tagName) {
   if (opt_tagName && (typeof opt_tagName !== 'string')) {
     opt_tagName = opt_tagName.toString();
   }
+  // because node.tagName.toUpperCase() fails when tagName is "tagName"
+  if (node instanceof HTMLFormElement) {
+    return !!node && node.nodeType == goog.dom.NodeType.ELEMENT &&
+    (!opt_tagName || "FORM" == opt_tagName);
+  }
   return !!node && node.nodeType == goog.dom.NodeType.ELEMENT &&
     (!opt_tagName || node.tagName.toUpperCase() == opt_tagName);
 };
diff --git a/py/requirements.txt b/py/requirements.txt
@@ -2,8 +2,8 @@ async-generator==1.10
 attrs==23.2.0
 certifi==2023.11.17
 cffi==1.16.0
-cryptography==42.0.7
-debugpy==1.8.1
+cryptography==42.0.8
+debugpy==1.8.5
 h11==0.14.0
 idna==3.7
 importlib-metadata==6.8.0
diff --git a/py/selenium/webdriver/common/actions/input_device.py b/py/selenium/webdriver/common/actions/input_device.py
@@ -16,6 +16,8 @@
 # under the License.
 
 import uuid
+from typing import Any
+from typing import List
 from typing import Optional
 
 
@@ -24,14 +26,14 @@ class InputDevice:
 
     def __init__(self, name: Optional[str] = None):
         self.name = name or uuid.uuid4()
-        self.actions = []
+        self.actions: List[Any] = []
 
-    def add_action(self, action):
+    def add_action(self, action: Any) -> None:
         """"""
         self.actions.append(action)
 
-    def clear_actions(self):
+    def clear_actions(self) -> None:
         self.actions = []
 
-    def create_pause(self, duration: int = 0):
+    def create_pause(self, duration: int = 0) -> None:
         pass
diff --git a/py/selenium/webdriver/common/selenium_manager.py b/py/selenium/webdriver/common/selenium_manager.py
@@ -23,6 +23,7 @@
 import sysconfig
 from pathlib import Path
 from typing import List
+from typing import Optional
 
 from selenium.common import WebDriverException
 
@@ -67,9 +68,11 @@ def _get_binary() -> Path:
         if exe is not None:
             compiled_path = compiled_path.with_suffix(exe)
 
-        if (path := os.getenv("SE_MANAGER_PATH")) is not None:
-            logger.debug("Selenium Manager set by env SE_MANAGER_PATH to: %s", path)
-            path = Path(path)
+        path: Optional[Path] = None
+
+        if (env_path := os.getenv("SE_MANAGER_PATH")) is not None:
+            logger.debug("Selenium Manager set by env SE_MANAGER_PATH to: %s", env_path)
+            path = Path(env_path)
         elif compiled_path.exists():
             path = compiled_path
         else:
@@ -92,7 +95,7 @@ def _get_binary() -> Path:
 
             path = Path(__file__).parent.joinpath(location)
 
-        if not path.is_file():
+        if path is None or not path.is_file():
             raise WebDriverException(f"Unable to obtain working Selenium Manager binary; {path}")
 
         logger.debug("Selenium Manager binary found at: %s", path)
diff --git a/py/selenium/webdriver/ie/options.py b/py/selenium/webdriver/ie/options.py
@@ -15,6 +15,8 @@
 # specific language governing permissions and limitations
 # under the License.
 from enum import Enum
+from typing import Any
+from typing import Dict
 
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.common.options import ArgOptions
@@ -362,8 +364,8 @@ class Options(ArgOptions):
 
     def __init__(self) -> None:
         super().__init__()
-        self._options = {}
-        self._additional = {}
+        self._options: Dict[str, Any] = {}
+        self._additional: Dict[str, Any] = {}
 
     @property
     def options(self) -> dict:
@@ -375,7 +377,7 @@ def additional_options(self) -> dict:
         """:Returns: The additional options."""
         return self._additional
 
-    def add_additional_option(self, name: str, value):
+    def add_additional_option(self, name: str, value) -> None:
         """Adds an additional option not yet added as a safe option for IE.
 
         :Args:
diff --git a/py/test/selenium/webdriver/common/visibility_tests.py b/py/test/selenium/webdriver/common/visibility_tests.py
@@ -29,6 +29,7 @@ def test_should_allow_the_user_to_tell_if_an_element_is_displayed_or_not(driver,
     assert driver.find_element(by=By.ID, value="none").is_displayed() is False
     assert driver.find_element(by=By.ID, value="suppressedParagraph").is_displayed() is False
     assert driver.find_element(by=By.ID, value="hidden").is_displayed() is False
+    assert driver.find_element(by=By.ID, value="aParentFormId").is_displayed() is True
 
 
 def test_visibility_should_take_into_account_parent_visibility(driver, pages):
diff --git a/rust/BUILD.bazel b/rust/BUILD.bazel
@@ -1,5 +1,5 @@
 load("@crates//:defs.bzl", "all_crate_deps")
-load("//rust:defs.bzl", "rust_binary", "rust_library", "rust_test", "rust_test_suite", "rustfmt_config")
+load("//rust:defs.bzl", "rust_binary", "rust_library", "rust_test", "rustfmt_config")
 
 rustfmt_config(
     name = "enable-rustfmt",
@@ -92,6 +92,7 @@ rust_library(
         exclude = ["main.rs"],
     ),
     edition = "2021",
+    visibility = ["//rust:__subpackages__"],
     deps = all_crate_deps(normal = True),
 )
 
@@ -117,22 +118,3 @@ rust_test(
     edition = "2021",
     tags = ["no-sandbox"],
 )
-
-rust_test_suite(
-    name = "integration",
-    size = "small",
-    srcs = glob(["tests/**/*_tests.rs"]),
-    data = [
-        "tests/common.rs",
-        ":selenium-manager",
-    ],
-    edition = "2021",
-    tags = [
-        "no-sandbox",
-        "requires-network",
-    ],
-    deps = [":selenium_manager"] + all_crate_deps(
-        normal = True,
-        normal_dev = True,
-    ),
-)
diff --git a/rust/Cargo.Bazel.lock b/rust/Cargo.Bazel.lock
diff --git a/rust/Cargo.lock b/rust/Cargo.lock
diff --git a/rust/Cargo.toml b/rust/Cargo.toml
diff --git a/rust/src/firefox.rs b/rust/src/firefox.rs
diff --git a/rust/tests/BUILD.bazel b/rust/tests/BUILD.bazel
diff --git a/rust/tests/browser_download_tests.rs b/rust/tests/browser_download_tests.rs
diff --git a/scripts/github-actions/ci-build.sh b/scripts/github-actions/ci-build.sh
