[java] Add JSpecify nullable annotations to exception classes

[iampopovich]

User description

🔗 Related Issues

partially fixes #14291

💥 What does this PR do?

same as
#16024
#16025

🔧 Implementation Notes

This pull request introduces nullness annotations from the jspecify library to improve type safety in exception classes within the Selenium Java codebase. The changes ensure that method parameters and classes explicitly handle nullable values, reducing ambiguity and potential runtime errors.

Addition of jspecify nullness annotations:

• java/src/org/openqa/selenium/InvalidCookieDomainException.java: Added @NullMarked to the class and @Nullable annotations to method parameters for constructors.
• java/src/org/openqa/selenium/UnableToSetCookieException.java: Applied @NullMarked to the class and @Nullable to constructor parameters.
• java/src/org/openqa/selenium/devtools/DevToolsException.java: Introduced @NullMarked for the class and @Nullable for constructor parameters, ensuring proper handling of nullable values.
• java/src/org/openqa/selenium/json/JsonException.java: Updated the class with @NullMarked and added @Nullable annotations to constructor parameters.
• java/src/org/openqa/selenium/remote/ScreenshotException.java: Enhanced the class with @NullMarked and applied @Nullable annotations to constructor parameters.

💡 Additional Considerations

🔄 Types of changes

• Cleanup (formatting, renaming)

---

PR Type

Enhancement

---

Description

• Add JSpecify nullable annotations to exception classes

• Improve type safety with @NullMarked and @nullable

• Update build dependencies for jspecify library

---

Changes diagram

flowchart LR
  A["Exception Classes"] --> B["Add @NullMarked"]
  A --> C["Add @Nullable to parameters"]
  B --> D["Type Safety Improvement"]
  C --> D
  E["Build Files"] --> F["Add jspecify dependency"]

Loading

---

Changes walkthrough 📝

	Relevant files
Enhancement	5 files InvalidCookieDomainException.java Add JSpecify annotations to cookie exception                          +7/-3      UnableToSetCookieException.java Add JSpecify annotations to cookie exception                          +7/-3      DevToolsException.java Add JSpecify annotations to DevTools exception                      +6/-3      JsonException.java Add JSpecify annotations to JSON exception                              +6/-3      ScreenshotException.java Add JSpecify annotations to screenshot exception                  +6/-3
Dependencies	2 files BUILD.bazel Add jspecify dependency to devtools build                                +1/-0      BUILD.bazel Add jspecify dependency to json build                                        +1/-0

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[qodo-merge-pro]

PR Reviewer Guide 🔍

(Review updated until commit 3b4cc24)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Null Dereference The constructor accepting a Throwable cause calls cause.getMessage() without null checking, which could cause a NullPointerException if a null cause is passed despite the @nullable annotation. public DevToolsException(@Nullable Throwable cause) { this(cause.getMessage(), cause); }

[qodo-merge-pro]

PR Code Suggestions ✨

Latest suggestions up to 3b4cc24
Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Add null check for cause parameter The constructor calls cause.getMessage() without null checking, which will throw a NullPointerException if cause is null. Add a null check before accessing the message. java/src/org/openqa/selenium/devtools/DevToolsException.java [27-29] public DevToolsException(@Nullable Throwable cause) { - this(cause.getMessage(), cause); + this(cause != null ? cause.getMessage() : null, cause); } Apply / Chat Suggestion importance[1-10]: 9 __ Why: The suggestion correctly identifies that calling cause.getMessage() can result in a NullPointerException since the cause parameter is annotated as @Nullable, and provides a valid fix.	High
Update

---

Previous suggestions

Suggestions up to commit 4cdd18a

Category	Suggestion	Impact
Possible issue	Add null check before method call The code assumes cause is non-null when calling cause.getMessage(), but the parameter is marked as @Nullable. This will throw a NullPointerException if cause is null. java/src/org/openqa/selenium/devtools/DevToolsException.java [27-29] public DevToolsException(@Nullable Throwable cause) { - this(cause.getMessage(), cause); + this(cause != null ? cause.getMessage() : null, cause); } Suggestion importance[1-10]: 9 __ Why: The suggestion correctly identifies a potential NullPointerException because the cause parameter is annotated as @Nullable but is dereferenced without a null check.	High

[iampopovich]

@pujagani @mk868 please review

[mk868]

I think, it's better to use artifact("org.jspecify:jspecify"),
At the top, an "artifact" load will be required:

load("//java:defs.bzl", "artifact", "java_export")

[mk868]

Maybe I'm wrong,
Were there problems with artifact("org.jspecify:jspecify"), here?