[java] specify nullability in other java packages by asolntsev · Pull Request #17194 · SeleniumHQ/selenium

asolntsev · 2026-03-09T17:36:33Z

🔗 Related Issues

Partially implements #14291

💥 What does this PR do?

Adds JSpecify nullability annotations to packages

org.openqa.selenium.docker.*

🔄 Types of changes

Cleanup (formatting, renaming)

Partially implements SeleniumHQ#14291

qodo-code-review · 2026-03-09T17:37:04Z

Review Summary by Qodo

Add JSpecify nullability annotations to events, interactions, and logging packages

✨ Enhancement 📦 Other

Walkthroughs

Description

• Add JSpecify @NullMarked annotations to events, interactions, and logging packages
• Remove class-level @NullMarked annotations, replace with package-level declarations
• Improve nullability handling in UnboundZmqEventBus by making sockets final and initializing in
  constructor
• Update Encodable interface to use @Nullable Object in return types for better null-safety
• Add @NullMarked method annotations to logging and remote driver implementations

File Changes

1. java/src/org/openqa/selenium/events/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/events/package-info.java

2. java/src/org/openqa/selenium/events/local/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/events/local/package-info.java

3. java/src/org/openqa/selenium/events/zeromq/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/events/zeromq/package-info.java

View more (32)

4. java/src/org/openqa/selenium/events/zeromq/UnboundZmqEventBus.java 🐞 Bug fix +24/-24

Make socket fields final and initialize in constructor

java/src/org/openqa/selenium/events/zeromq/UnboundZmqEventBus.java

5. java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java ✨ Enhancement +1/-0

Add DataFlowIssue suppression annotation

java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java

6. java/src/org/openqa/selenium/interactions/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/interactions/package-info.java

7. java/src/org/openqa/selenium/interactions/Actions.java ✨ Enhancement +2/-6

Remove class-level NullMarked, make actionDuration final

java/src/org/openqa/selenium/interactions/Actions.java

8. java/src/org/openqa/selenium/interactions/CompositeAction.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/CompositeAction.java

9. java/src/org/openqa/selenium/interactions/Coordinates.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/Coordinates.java

10. java/src/org/openqa/selenium/interactions/Encodable.java ✨ Enhancement +2/-3

Update return type to use Nullable Object

java/src/org/openqa/selenium/interactions/Encodable.java

11. java/src/org/openqa/selenium/interactions/InputSource.java ✨ Enhancement +0/-3

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/InputSource.java

12. java/src/org/openqa/selenium/interactions/Interaction.java ✨ Enhancement +0/-3

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/Interaction.java

13. java/src/org/openqa/selenium/interactions/Interactive.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/Interactive.java

14. java/src/org/openqa/selenium/interactions/KeyInput.java ✨ Enhancement +2/-4

Remove class-level NullMarked, update encode return type

java/src/org/openqa/selenium/interactions/KeyInput.java

15. java/src/org/openqa/selenium/interactions/Locatable.java ✨ Enhancement +0/-3

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/Locatable.java

16. java/src/org/openqa/selenium/interactions/MoveTargetOutOfBoundsException.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/MoveTargetOutOfBoundsException.java

17. java/src/org/openqa/selenium/interactions/Pause.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/Pause.java

18. java/src/org/openqa/selenium/interactions/PointerInput.java ✨ Enhancement +2/-4

Remove class-level NullMarked, update encode return type

java/src/org/openqa/selenium/interactions/PointerInput.java

19. java/src/org/openqa/selenium/interactions/Sequence.java ✨ Enhancement +6/-7

Remove class-level NullMarked, update encode return types

java/src/org/openqa/selenium/interactions/Sequence.java

20. java/src/org/openqa/selenium/interactions/SourceType.java ✨ Enhancement +0/-2

Remove class-level NullMarked annotation

java/src/org/openqa/selenium/interactions/SourceType.java

21. java/src/org/openqa/selenium/interactions/WheelInput.java ✨ Enhancement +2/-4

Remove class-level NullMarked, update encode return type

java/src/org/openqa/selenium/interactions/WheelInput.java

22. java/src/org/openqa/selenium/logging/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/logging/package-info.java

23. java/src/org/openqa/selenium/logging/profiler/package-info.java ✨ Enhancement +21/-0

Create package-info with NullMarked annotation

java/src/org/openqa/selenium/logging/profiler/package-info.java

24. java/src/org/openqa/selenium/logging/LocalLogs.java ✨ Enhancement +3/-0

Add NullMarked annotations to abstract methods

java/src/org/openqa/selenium/logging/LocalLogs.java

25. java/src/org/openqa/selenium/logging/CompositeLocalLogs.java ✨ Enhancement +2/-0

Add NullMarked annotation to get method

java/src/org/openqa/selenium/logging/CompositeLocalLogs.java

26. java/src/org/openqa/selenium/logging/HandlerBasedLocalLogs.java ✨ Enhancement +2/-0

Add NullMarked annotation to get method

java/src/org/openqa/selenium/logging/HandlerBasedLocalLogs.java

27. java/src/org/openqa/selenium/logging/StoringLocalLogs.java ✨ Enhancement +2/-0

Add NullMarked annotation to get method

java/src/org/openqa/selenium/logging/StoringLocalLogs.java

28. java/src/org/openqa/selenium/logging/SessionLogs.java ✨ Enhancement +2/-1

Add Nullable annotation to getLogs parameter

java/src/org/openqa/selenium/logging/SessionLogs.java

29. java/src/org/openqa/selenium/chromium/ChromiumDriver.java ✨ Enhancement +2/-0

Add NullMarked annotation to onLogEvent method

java/src/org/openqa/selenium/chromium/ChromiumDriver.java

30. java/src/org/openqa/selenium/remote/AddHasLogEvents.java ✨ Enhancement +2/-0

Add NullMarked annotation to onLogEvent method

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

31. java/src/org/openqa/selenium/remote/RemoteLogs.java ✨ Enhancement +2/-0

Add NullMarked annotation to get method

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

32. java/src/org/openqa/selenium/remote/RemoteWebDriver.java ✨ Enhancement +2/-0

Add NullMarked annotation to perform method

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

33. java/src/org/openqa/selenium/events/BUILD.bazel ⚙️ Configuration changes +2/-1

Add jspecify dependency to events library

java/src/org/openqa/selenium/events/BUILD.bazel

34. java/src/org/openqa/selenium/events/local/BUILD.bazel ⚙️ Configuration changes +1/-0

Add jspecify dependency to local events library

java/src/org/openqa/selenium/events/local/BUILD.bazel

35. java/src/org/openqa/selenium/events/zeromq/BUILD.bazel ⚙️ Configuration changes +1/-0

Add jspecify dependency to zeromq events library

java/src/org/openqa/selenium/events/zeromq/BUILD.bazel

qodo-code-review · 2026-03-09T17:37:05Z

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. RejectedEvent may be null 🐞 Bug ✓ Correctness

Description

ZeroMqEventBus.RejectedEvent.fromJson can construct a RejectedEvent with null name/data when the
JSON omits those fields, but the class lives in an @NullMarked package so those fields/getters are
treated as non-null. This can cause runtime NPEs in rejected-event handlers and can also trigger
nullness-check failures in builds running NullAway.

Code

java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[R149-152]
+    @SuppressWarnings("DataFlowIssue")
    private static RejectedEvent fromJson(JsonInput input) {
      EventName name = null;
      Object data = null;

Evidence
The PR marks the entire org.openqa.selenium.events.zeromq package as @NullMarked, making unannotated
reference types non-null by default; however fromJson initializes name/data to null and returns a
RejectedEvent built from those possibly-null values, while the fields/getters remain unannotated
(therefore non-null under @NullMarked). The repo’s Bazel rules enable NullAway for
org.openqa.selenium, so this inconsistency is likely to be caught by nullness tooling and is also a
real runtime risk if malformed JSON is received.
java/src/org/openqa/selenium/events/zeromq/package-info.java[18-21]
java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[140-173]
java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[175-181]
java/private/java_library.bzl[16-35]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`org.openqa.selenium.events.zeromq` is now `@NullMarked`, but `ZeroMqEventBus.RejectedEvent.fromJson` can still build a `RejectedEvent` with `null` `name`/`data` when the JSON payload is missing fields.

## Issue Context
Because the package is `@NullMarked`, `RejectedEvent.name`/`data` and their getters are implicitly non-null. Returning instances with nulls violates that contract and risks runtime NPEs.

## Fix Focus Areas
- java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[140-173]
- java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[175-181]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. Nullable prefs not annotated 🐞 Bug ⛯ Reliability

Description

LoggingPreferences.addPreferences explicitly accepts null (it checks prefs == null) but
org.openqa.selenium.logging is now @NullMarked, so the parameter is non-null by default. This makes
the nullness contract incorrect and can cause false-positive nullness errors at call sites (or force
suppressions) despite the method safely handling null.

Code

java/src/org/openqa/selenium/logging/package-info.java[R18-21]
+@NullMarked
+package org.openqa.selenium.logging;
+
+import org.jspecify.annotations.NullMarked;

Evidence
The PR makes the logging package @NullMarked, which implies non-null parameters by default; however
addPreferences still contains a null-guard for its parameter, indicating null is a supported input.
With NullAway enabled for org.openqa.selenium packages, keeping the parameter implicitly non-null
misrepresents the API’s behavior for nullness tooling.
java/src/org/openqa/selenium/logging/package-info.java[18-21]
java/src/org/openqa/selenium/logging/LoggingPreferences.java[71-85]
java/private/java_library.bzl[16-35]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`org.openqa.selenium.logging` is now `@NullMarked`, but `LoggingPreferences.addPreferences` still accepts `null` without marking the parameter `@Nullable`.

## Issue Context
The method has an explicit `prefs == null` guard, so null is an allowed input and should be reflected in the signature for nullness tooling.

## Fix Focus Areas
- java/src/org/openqa/selenium/logging/LoggingPreferences.java[18-28]
- java/src/org/openqa/selenium/logging/LoggingPreferences.java[71-85]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

ⓘ The new review experience is currently in Beta. Learn more

qodo-code-review · 2026-03-09T17:45:16Z

java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java

+    @SuppressWarnings("DataFlowIssue")
    private static RejectedEvent fromJson(JsonInput input) {
      EventName name = null;
      Object data = null;


1. Rejectedevent may be null 🐞 Bug ✓ Correctness

ZeroMqEventBus.RejectedEvent.fromJson can construct a RejectedEvent with null name/data when the JSON omits those fields, but the class lives in an @NullMarked package so those fields/getters are treated as non-null. This can cause runtime NPEs in rejected-event handlers and can also trigger nullness-check failures in builds running NullAway.

Agent Prompt

## Issue description `org.openqa.selenium.events.zeromq` is now `@NullMarked`, but `ZeroMqEventBus.RejectedEvent.fromJson` can still build a `RejectedEvent` with `null` `name`/`data` when the JSON payload is missing fields. ## Issue Context Because the package is `@NullMarked`, `RejectedEvent.name`/`data` and their getters are implicitly non-null. Returning instances with nulls violates that contract and risks runtime NPEs. ## Fix Focus Areas - java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[140-173] - java/src/org/openqa/selenium/events/zeromq/ZeroMqEventBus.java[175-181]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

asolntsev added 3 commits March 9, 2026 19:13

specify nullability in package org.openqa.selenium.events

028d888

Partially implements SeleniumHQ#14291

specify nullability in package org.openqa.selenium.interactions

b642216

Partially implements SeleniumHQ#14291

specify nullability in package org.openqa.selenium.logging

594c3ff

Partially implements SeleniumHQ#14291

asolntsev self-assigned this Mar 9, 2026

asolntsev added this to the 4.42.0 milestone Mar 9, 2026

selenium-ci added C-java Java Bindings B-build Includes scripting, bazel and CI integrations labels Mar 9, 2026

asolntsev changed the title ~~Nullability~~ [java] specify nullability in other java packages Mar 9, 2026

asolntsev removed the B-build Includes scripting, bazel and CI integrations label Mar 9, 2026

asolntsev marked this pull request as draft March 9, 2026 17:37

qodo-code-review bot reviewed Mar 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[java] specify nullability in other java packages#17194

[java] specify nullability in other java packages#17194
asolntsev wants to merge 3 commits intoSeleniumHQ:trunkfrom
asolntsev:nullability

asolntsev commented Mar 9, 2026

Uh oh!

qodo-code-review bot commented Mar 9, 2026

Uh oh!

qodo-code-review bot commented Mar 9, 2026 •

edited

Loading

Uh oh!

qodo-code-review bot Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

asolntsev commented Mar 9, 2026

🔗 Related Issues

💥 What does this PR do?

🔄 Types of changes

Uh oh!

qodo-code-review bot commented Mar 9, 2026

Review Summary by Qodo

Walkthroughs

File Changes

Uh oh!

qodo-code-review bot commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Uh oh!

qodo-code-review bot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

qodo-code-review bot commented Mar 9, 2026 •

edited

Loading