Merge branch 'trunk' into jspecify-interactions

Author: diemol

java/src/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementAccount.java

@@ -18,6 +18,8 @@
 package org.openqa.selenium.federatedcredentialmanagement;
 
 import java.util.Map;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Represents an account displayed in a FedCM account list.
@@ -27,29 +29,30 @@
  * @see <a href="https://w3c-fedid.github.io/FedCM/#webdriver-accountlist">
  *     https://w3c-fedid.github.io/FedCM/#webdriver-accountlist</a>
  */
+@NullMarked
 public class FederatedCredentialManagementAccount {
-  private final String accountId;
-  private final String email;
-  private final String name;
-  private final String givenName;
-  private final String pictureUrl;
+  private final @Nullable String accountId;
+  private final @Nullable String email;
+  private final @Nullable String name;
+  private final @Nullable String givenName;
+  private final @Nullable String pictureUrl;
 
   /**
    * The config URL of the identity provider that provided this account.
    *
    * <p>This allows identifying the IDP in multi-IDP cases.
    */
-  private final String idpConfigUrl;
+  private final @Nullable String idpConfigUrl;
 
   /**
    * The login state for this account.
    *
    * <p>One of LOGIN_STATE_SIGNIN and LOGIN_STATE_SIGNUP.
    */
-  private final String loginState;
+  private final @Nullable String loginState;
 
-  private final String termsOfServiceUrl;
-  private final String privacyPolicyUrl;
+  private final @Nullable String termsOfServiceUrl;
+  private final @Nullable String privacyPolicyUrl;
 
   public static final String LOGIN_STATE_SIGNIN = "SignIn";
   public static final String LOGIN_STATE_SIGNUP = "SignUp";
@@ -66,39 +69,39 @@ public FederatedCredentialManagementAccount(Map<String, String> dict) {
     privacyPolicyUrl = (String) dict.getOrDefault("privacyPolicyUrl", null);
   }
 
-  public String getAccountid() {
+  public @Nullable String getAccountid() {
     return accountId;
   }
 
-  public String getEmail() {
+  public @Nullable String getEmail() {
     return email;
   }
 
-  public String getName() {
+  public @Nullable String getName() {
     return name;
   }
 
-  public String getGivenName() {
+  public @Nullable String getGivenName() {
     return givenName;
   }
 
-  public String getPictureUrl() {
+  public @Nullable String getPictureUrl() {
     return pictureUrl;
   }
 
-  public String getIdpConfigUrl() {
+  public @Nullable String getIdpConfigUrl() {
     return idpConfigUrl;
   }
 
-  public String getLoginState() {
+  public @Nullable String getLoginState() {
     return loginState;
   }
 
-  public String getTermsOfServiceUrl() {
+  public @Nullable String getTermsOfServiceUrl() {
     return termsOfServiceUrl;
   }
 
-  public String getPrivacyPolicyUrl() {
+  public @Nullable String getPrivacyPolicyUrl() {
     return privacyPolicyUrl;
   }
 }

java/src/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementDialog.java

@@ -18,12 +18,15 @@
 package org.openqa.selenium.federatedcredentialmanagement;
 
 import java.util.List;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Represents an open dialog of the Federated Credential Management API.
  *
  * @see <a href="https://w3c-fedid.github.io/FedCM/">https://w3c-fedid.github.io/FedCM/</a>
  */
+@NullMarked
 public interface FederatedCredentialManagementDialog {
 
   String DIALOG_TYPE_ACCOUNT_LIST = "AccountChooser";
@@ -44,13 +47,13 @@ public interface FederatedCredentialManagementDialog {
    *
    * <p>One of DIALOG_TYPE_ACCOUNT_LIST and DIALOG_TYPE_AUTO_REAUTH.
    */
-  String getDialogType();
+  @Nullable String getDialogType();
 
   /** Returns the title of the dialog. */
-  String getTitle();
+  @Nullable String getTitle();
 
   /** Returns the subtitle of the dialog or null if none. */
-  String getSubtitle();
+  @Nullable String getSubtitle();
 
   void clickDialog();
 

java/src/org/openqa/selenium/federatedcredentialmanagement/HasFederatedCredentialManagement.java

@@ -17,10 +17,13 @@
 
 package org.openqa.selenium.federatedcredentialmanagement;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.openqa.selenium.Beta;
 
 /** Used by classes to indicate that they can interact with FedCM dialogs. */
 @Beta
+@NullMarked
 public interface HasFederatedCredentialManagement {
   /**
    * Disables the promise rejection delay.
@@ -45,5 +48,5 @@ public interface HasFederatedCredentialManagement {
    * <p>Can be used with WebDriverWait like: wait.until(driver ->
    * ((HasFederatedCredentialManagement) driver). getFederatedCredentialManagementDialog() != null);
    */
-  FederatedCredentialManagementDialog getFederatedCredentialManagementDialog();
+  @Nullable FederatedCredentialManagementDialog getFederatedCredentialManagementDialog();
 }

py/selenium/webdriver/common/bidi/cdp.py

@@ -166,8 +166,8 @@ class CdpConnectionClosed(WsConnectionClosed):
     def __init__(self, reason):
         """Constructor.
 
-        :param reason:
-        :type reason: wsproto.frame_protocol.CloseReason
+        Args:
+            reason: wsproto.frame_protocol.CloseReason
         """
         self.reason = reason
 
@@ -205,8 +205,11 @@ def __init__(self, ws, session_id, target_id):
     async def execute(self, cmd: Generator[dict, T, Any]) -> T:
         """Execute a command on the server and wait for the result.
 
-        :param cmd: any CDP command
-        :returns: a CDP result
+        Args:
+            cmd: any CDP command
+
+        Returns:
+            a CDP result
         """
         cmd_id = next(self.id_iter)
         cmd_event = trio.Event()
@@ -261,18 +264,20 @@ async def wait_for(self, event_type: type[T], buffer_size=10) -> AsyncGenerator[
     def _handle_data(self, data):
         """Handle incoming WebSocket data.
 
-        :param dict data: a JSON dictionary
+        Args:
+            data: a JSON dictionary
         """
         if "id" in data:
             self._handle_cmd_response(data)
         else:
             self._handle_event(data)
 
-    def _handle_cmd_response(self, data):
+    def _handle_cmd_response(self, data: dict):
         """Handle a response to a command. This will set an event flag that
         will return control to the task that called the command.
 
-        :param dict data: response as a JSON dictionary
+        Args:
+            data: response as a JSON dictionary
         """
         cmd_id = data["id"]
         try:
@@ -295,10 +300,11 @@ def _handle_cmd_response(self, data):
             self.inflight_result[cmd_id] = return_
         event.set()
 
-    def _handle_event(self, data):
+    def _handle_event(self, data: dict):
         """Handle an event.
 
-        :param dict data: event as a JSON dictionary
+        Args:
+            data: event as a JSON dictionary
         """
         global devtools
         event = devtools.util.parse_json_event(data)
@@ -325,9 +331,10 @@ class CdpSession(CdpBase):
     def __init__(self, ws, session_id, target_id):
         """Constructor.
 
-        :param trio_websocket.WebSocketConnection ws:
-        :param devtools.target.SessionID session_id:
-        :param devtools.target.TargetID target_id:
+        Args:
+            ws: trio_websocket.WebSocketConnection
+            session_id: devtools.target.SessionID
+            target_id: devtools.target.TargetID
         """
         super().__init__(ws, session_id, target_id)
 
@@ -394,7 +401,8 @@ class corresponds to the "root" session, i.e. the implicitly created
     def __init__(self, ws):
         """Constructor.
 
-        :param trio_websocket.WebSocketConnection ws:
+        Args:
+            ws: trio_websocket.WebSocketConnection
         """
         super().__init__(ws, session_id=None, target_id=None)
         self.sessions = {}