mark wait.until as non-nullable (#17007)

They always return true/false, WebDriver or Webelement. They never return null.

Author: asolntsev

java/src/org/openqa/selenium/TimeoutException.java

@@ -17,6 +17,8 @@
 
 package org.openqa.selenium;
 
+import org.jspecify.annotations.Nullable;
+
 /** Thrown when a command does not complete in enough time. */
 public class TimeoutException extends WebDriverException {
 
@@ -30,7 +32,7 @@ public TimeoutException(Throwable cause) {
     super(cause);
   }
 
-  public TimeoutException(String message, Throwable cause) {
+  public TimeoutException(String message, @Nullable Throwable cause) {
     super(message, cause);
   }
 }

java/src/org/openqa/selenium/firefox/FirefoxDriver.java

@@ -27,6 +27,7 @@
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import org.jspecify.annotations.NonNull;
 import org.openqa.selenium.Beta;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.ImmutableCapabilities;
@@ -183,6 +184,7 @@ private static Capabilities checkCapabilitiesAndProxy(Capabilities capabilities)
     return caps;
   }
 
+  @NonNull
   @Override
   public Capabilities getCapabilities() {
     return capabilities;

java/src/org/openqa/selenium/remote/Augmenter.java

@@ -21,6 +21,7 @@
 import static net.bytebuddy.matcher.ElementMatchers.anyOf;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 
+import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
@@ -212,7 +213,9 @@ private WebDriver augment(WebDriver driver, List<Augmentation<?>> matchingAugmen
             .asSubclass(driver.getClass());
 
     try {
-      WebDriver toReturn = definition.getDeclaredConstructor().newInstance();
+      Constructor<? extends WebDriver> constructor = definition.getDeclaredConstructor();
+      constructor.setAccessible(true);
+      WebDriver toReturn = constructor.newInstance();
 
       copyFields(driver.getClass(), driver, toReturn);
 
@@ -285,7 +288,7 @@ private void copyFields(Class<?> clazz, Object source, Object target) {
   }
 
   private void copyField(Object source, Object target, Field field) {
-    if (Modifier.isFinal(field.getModifiers())) {
+    if (Modifier.isStatic(field.getModifiers())) {
       return;
     }
 

java/src/org/openqa/selenium/remote/RemoteWebDriver.java

@@ -46,6 +46,7 @@
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import org.jspecify.annotations.NonNull;
 import org.openqa.selenium.AcceptedW3CCapabilityKeys;
 import org.openqa.selenium.Alert;
 import org.openqa.selenium.Beta;
@@ -357,6 +358,7 @@ protected void setCommandExecutor(CommandExecutor executor) {
     this.executor = executor;
   }
 
+  @NonNull
   @Override
   public Capabilities getCapabilities() {
     if (capabilities == null) {

java/src/org/openqa/selenium/support/ui/ExpectedCondition.java

@@ -18,7 +18,6 @@
 package org.openqa.selenium.support.ui;
 
 import com.google.common.base.Function;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.WebDriver;
 
@@ -29,13 +28,12 @@
  *
  * <p>Note that it is expected that ExpectedConditions are idempotent. They will be called in a loop
  * by the {@link WebDriverWait} and any modification of the state of the application under test may
- * have unexpected side-effects.
+ * have unexpected side effects.
  *
  * @param <T> The return type
  */
 // NB: this originally extended Guava's Function interface since Java didn't have one. To avoid code
 // such as "com.google.common.base.Function condition = ExpectedConditions.elementFound(By);"
 // breaking at compile time, we continue to extend Guava's Function interface.
-@NullMarked
 public interface ExpectedCondition<T extends @Nullable Object>
     extends Function<WebDriver, T>, java.util.function.Function<WebDriver, T> {}

java/src/org/openqa/selenium/support/ui/ExpectedConditions.java

@@ -26,7 +26,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.Alert;
 import org.openqa.selenium.By;
@@ -42,7 +41,6 @@
 import org.openqa.selenium.WebElement;
 
 /** Canned {@link ExpectedCondition}s which are generally useful within webdriver tests. */
-@NullMarked
 @SuppressWarnings("MismatchedJavadocCode")
 public class ExpectedConditions {
   private static final Logger LOG = Logger.getLogger(ExpectedConditions.class.getName());

java/src/org/openqa/selenium/support/ui/FluentWait.java

@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.function.Function;
 import java.util.function.Supplier;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.internal.Require;
@@ -76,7 +77,7 @@ public class FluentWait<T> implements Wait<T> {
 
   protected Duration timeout = DEFAULT_WAIT_DURATION;
   protected Duration interval = DEFAULT_WAIT_DURATION;
-  protected Supplier<String> messageSupplier = () -> null;
+  protected Supplier<@Nullable String> messageSupplier = () -> null;
 
   protected final List<Class<? extends Throwable>> ignoredExceptions = new ArrayList<>();
 
@@ -117,6 +118,7 @@ public FluentWait<T> withTimeout(Duration timeout) {
    * @return A self reference.
    */
   public FluentWait<T> withMessage(final String message) {
+    Require.nonNull("Message", message);
     this.messageSupplier = () -> message;
     return this;
   }
@@ -128,7 +130,7 @@ public FluentWait<T> withMessage(final String message) {
    * @return A self reference.
    */
   public FluentWait<T> withMessage(Supplier<String> messageSupplier) {
-    this.messageSupplier = messageSupplier;
+    this.messageSupplier = Require.nonNull("Message supplier", messageSupplier);
     return this;
   }
 
@@ -165,7 +167,7 @@ public <K extends Throwable> FluentWait<T> ignoreAll(Collection<Class<? extends
    * @see #ignoreAll(Collection)
    */
   public FluentWait<T> ignoring(Class<? extends Throwable> exceptionType) {
-    return this.ignoreAll(List.<Class<? extends Throwable>>of(exceptionType));
+    return this.ignoreAll(List.of(exceptionType));
   }
 
   /**
@@ -198,7 +200,7 @@ public FluentWait<T> ignoring(
    * @throws TimeoutException If the timeout expires.
    */
   @Override
-  public <V> V until(Function<? super T, V> isTrue) {
+  public <V> V until(Function<? super T, @Nullable V> isTrue) {
     Instant end = clock.instant().plus(timeout);
 
     Throwable lastException;
@@ -220,7 +222,7 @@ public <V> V until(Function<? super T, V> isTrue) {
       // Check the timeout after evaluating the function to ensure conditions
       // with a zero timeout can succeed.
       if (end.isBefore(clock.instant())) {
-        String message = messageSupplier != null ? messageSupplier.get() : null;
+        String message = messageSupplier.get();
 
         String timeoutMessage =
             String.format(
@@ -272,7 +274,7 @@ private Throwable propagateIfNotIgnored(Throwable e) {
    *     on a function.
    * @return Nothing will ever be returned; this return type is only specified as a convenience.
    */
-  protected RuntimeException timeoutException(String message, Throwable lastException) {
+  protected RuntimeException timeoutException(String message, @Nullable Throwable lastException) {
     throw new TimeoutException(message, lastException);
   }
 }

java/src/org/openqa/selenium/support/ui/WebDriverWait.java

@@ -19,6 +19,7 @@
 
 import java.time.Clock;
 import java.time.Duration;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.NotFoundException;
 import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.WebDriver;
@@ -79,7 +80,7 @@ public WebDriverWait(
   }
 
   @Override
-  protected RuntimeException timeoutException(String message, Throwable lastException) {
+  protected RuntimeException timeoutException(String message, @Nullable Throwable lastException) {
     WebDriver exceptionDriver = driver;
     TimeoutException ex = new TimeoutException(message, lastException);
     ex.addInfo(WebDriverException.DRIVER_INFO, exceptionDriver.getClass().getName());

java/src/org/openqa/selenium/support/ui/package-info.java

@@ -0,0 +1,21 @@
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC 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.
+
+@NullMarked
+package org.openqa.selenium.support.ui;
+
+import org.jspecify.annotations.NullMarked;

java/test/org/openqa/selenium/remote/AugmenterTest.java

@@ -28,6 +28,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import org.jspecify.annotations.NonNull;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.By;
@@ -114,8 +115,7 @@ void proxyShouldNotAppearInStackTraces() {
     // This will force the class to be enhanced
     final Capabilities caps = new ImmutableCapabilities("magic.numbers", true);
 
-    DetonatingDriver driver = new DetonatingDriver();
-    driver.setCapabilities(caps);
+    DetonatingDriver driver = new DetonatingDriver(caps);
 
     WebDriver returned =
         getAugmenter()
@@ -337,12 +337,17 @@ public interface MyInterface {
 
   public static class DetonatingDriver extends RemoteWebDriver {
 
-    private Capabilities caps;
+    private final Capabilities caps;
 
-    public void setCapabilities(Capabilities caps) {
+    protected DetonatingDriver() {
+      this(null);
+    }
+
+    public DetonatingDriver(Capabilities caps) {
       this.caps = caps;
     }
 
+    @NonNull
     @Override
     public Capabilities getCapabilities() {
       return caps;
@@ -366,6 +371,7 @@ public interface HasNumbers {
 
   public static class ChildRemoteDriver extends RemoteWebDriver implements HasMagicNumbers {
 
+    @NonNull
     @Override
     public Capabilities getCapabilities() {
       return new FirefoxOptions();
@@ -379,6 +385,7 @@ public int getMagicNumber() {
 
   public static class WithFinals extends RemoteWebDriver {
 
+    @NonNull
     @Override
     public Capabilities getCapabilities() {
       return new ImmutableCapabilities();