Add package-info files with @NullMarked #1331

msridhar · 2025-11-06T01:36:21Z

This lets us get better nullness error messages in IntelliJ

Summary by CodeRabbit

Chores
- Enhanced null-safety annotations across the codebase to improve type checking and code reliability at the package level.

coderabbitai · 2025-11-06T01:38:57Z

Walkthrough

This change introduces package-level null-safety annotations across fifteen packages within the NullAway project. Multiple new package-info.java files are added to packages including the root com.uber.nullaway package and its subpackages covering annotations, dataflow, fixserialization, generics, handlers, and jarinfer. Each file imports org.jspecify.annotations.NullMarked and applies the @NullMarked annotation at the package level, establishing compile-time null-safety semantics for all types within their respective packages.

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely describes the main change: adding package-info files with @NullMarked annotations across multiple packages.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch add-package-info

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c6fa9f6 and 2e58302.

📒 Files selected for processing (15)

nullaway/src/main/java/com/uber/nullaway/annotations/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/dataflow/cfg/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/dataflow/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/fixserialization/adapters/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/fixserialization/location/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/fixserialization/out/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/fixserialization/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/generics/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/handlers/contract/fieldcontract/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/handlers/contract/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/handlers/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/handlers/stream/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/handlers/temporary/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/jarinfer/package-info.java (1 hunks)
nullaway/src/main/java/com/uber/nullaway/package-info.java (1 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: msridhar
Repo: uber/NullAway PR: 1259
File: jdk-recent-unit-tests/src/test/java/com/uber/nullaway/jdk17/SwitchTests.java:318-321
Timestamp: 2025-08-29T18:41:43.584Z
Learning: Classes annotated with NullMarked are analyzed by NullAway even if they are not in packages specified by the AnnotatedPackages configuration. The NullMarked annotation guarantees NullAway analysis.

Learnt from: msridhar
Repo: uber/NullAway PR: 1245
File: guava-recent-unit-tests/src/test/java/com/uber/nullaway/guava/NullAwayGuavaParametricNullnessTests.java:101-102
Timestamp: 2025-08-14T18:50:06.159Z
Learning: In NullAway JSpecify tests, when JDK version requirements exist due to bytecode annotation reading capabilities, prefer failing tests over skipping them on unsupported versions to ensure CI catches regressions and enforces proper JDK version usage for developers.

Learnt from: msridhar
Repo: uber/NullAway PR: 1248
File: nullaway/src/main/java/com/uber/nullaway/generics/GenericsChecks.java:847-857
Timestamp: 2025-08-28T04:54:20.953Z
Learning: In NullAway's GenericsChecks.java, NewClassTree support for explicit type argument substitution requires more extensive changes beyond just modifying the conditional in compareGenericTypeParameterNullabilityForCall. The maintainers prefer to handle NewClassTree support in a separate follow-up rather than expanding the scope of PRs focused on specific issues like super constructor calls.

Learnt from: msridhar
Repo: uber/NullAway PR: 1316
File: jdk-javac-plugin/src/main/java/com/uber/nullaway/javacplugin/NullnessAnnotationSerializer.java:261-293
Timestamp: 2025-10-29T23:56:18.236Z
Learning: In NullAway's jdk-javac-plugin NullnessAnnotationSerializer, type variable bounds with annotations (e.g., `T extends Nullable Object`) are checked at their declaration sites by the typeParamHasAnnotation method for both class-level and method-level type parameters. The hasJSpecifyAnnotationDeep method is designed to check type uses (return types, parameters, etc.) and does not need a TYPEVAR case because type variable declaration bounds are already handled separately.

📚 Learning: 2025-08-29T18:41:43.584Z

Learnt from: msridhar
Repo: uber/NullAway PR: 1259
File: jdk-recent-unit-tests/src/test/java/com/uber/nullaway/jdk17/SwitchTests.java:318-321
Timestamp: 2025-08-29T18:41:43.584Z
Learning: Classes annotated with NullMarked are analyzed by NullAway even if they are not in packages specified by the AnnotatedPackages configuration. The NullMarked annotation guarantees NullAway analysis.

Applied to files:

nullaway/src/main/java/com/uber/nullaway/handlers/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/adapters/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/temporary/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/contract/fieldcontract/package-info.java
nullaway/src/main/java/com/uber/nullaway/annotations/package-info.java
nullaway/src/main/java/com/uber/nullaway/generics/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/contract/package-info.java
nullaway/src/main/java/com/uber/nullaway/jarinfer/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/out/package-info.java
nullaway/src/main/java/com/uber/nullaway/package-info.java
nullaway/src/main/java/com/uber/nullaway/dataflow/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/stream/package-info.java
nullaway/src/main/java/com/uber/nullaway/dataflow/cfg/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/location/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/package-info.java

📚 Learning: 2025-08-14T18:50:06.159Z

Learnt from: msridhar
Repo: uber/NullAway PR: 1245
File: guava-recent-unit-tests/src/test/java/com/uber/nullaway/guava/NullAwayGuavaParametricNullnessTests.java:101-102
Timestamp: 2025-08-14T18:50:06.159Z
Learning: In NullAway JSpecify tests, when JDK version requirements exist due to bytecode annotation reading capabilities, prefer failing tests over skipping them on unsupported versions to ensure CI catches regressions and enforces proper JDK version usage for developers.

Applied to files:

nullaway/src/main/java/com/uber/nullaway/handlers/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/adapters/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/temporary/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/contract/fieldcontract/package-info.java
nullaway/src/main/java/com/uber/nullaway/annotations/package-info.java
nullaway/src/main/java/com/uber/nullaway/generics/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/contract/package-info.java
nullaway/src/main/java/com/uber/nullaway/jarinfer/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/out/package-info.java
nullaway/src/main/java/com/uber/nullaway/package-info.java
nullaway/src/main/java/com/uber/nullaway/dataflow/package-info.java
nullaway/src/main/java/com/uber/nullaway/handlers/stream/package-info.java
nullaway/src/main/java/com/uber/nullaway/dataflow/cfg/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/location/package-info.java
nullaway/src/main/java/com/uber/nullaway/fixserialization/package-info.java

📚 Learning: 2025-10-29T23:56:18.236Z

Learnt from: msridhar
Repo: uber/NullAway PR: 1316
File: jdk-javac-plugin/src/main/java/com/uber/nullaway/javacplugin/NullnessAnnotationSerializer.java:261-293
Timestamp: 2025-10-29T23:56:18.236Z
Learning: In NullAway's jdk-javac-plugin NullnessAnnotationSerializer, type variable bounds with annotations (e.g., `T extends Nullable Object`) are checked at their declaration sites by the typeParamHasAnnotation method for both class-level and method-level type parameters. The hasJSpecifyAnnotationDeep method is designed to check type uses (return types, parameters, etc.) and does not need a TYPEVAR case because type variable declaration bounds are already handled separately.

Applied to files:

nullaway/src/main/java/com/uber/nullaway/annotations/package-info.java
nullaway/src/main/java/com/uber/nullaway/generics/package-info.java
nullaway/src/main/java/com/uber/nullaway/jarinfer/package-info.java

📚 Learning: 2025-08-28T04:54:20.953Z

Learnt from: msridhar
Repo: uber/NullAway PR: 1248
File: nullaway/src/main/java/com/uber/nullaway/generics/GenericsChecks.java:847-857
Timestamp: 2025-08-28T04:54:20.953Z
Learning: In NullAway's GenericsChecks.java, NewClassTree support for explicit type argument substitution requires more extensive changes beyond just modifying the conditional in compareGenericTypeParameterNullabilityForCall. The maintainers prefer to handle NewClassTree support in a separate follow-up rather than expanding the scope of PRs focused on specific issues like super constructor calls.

Applied to files:

nullaway/src/main/java/com/uber/nullaway/generics/package-info.java

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

GitHub Check: Build and test on macos-latest
GitHub Check: Build and test on ubuntu-latest
GitHub Check: Build spring-framework with snapshot
GitHub Check: Build and test on windows-latest
GitHub Check: Build caffeine with snapshot

🔇 Additional comments (15)

nullaway/src/main/java/com/uber/nullaway/handlers/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

The syntax and structure are correct. This will enable stricter null-safety semantics for all types in this package, improving IDE error messages as intended.

nullaway/src/main/java/com/uber/nullaway/generics/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/handlers/stream/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/fixserialization/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/jarinfer/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/annotations/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/handlers/temporary/package-info.java (1)

1-4: LGTM! Package-level @NullMarked annotation correctly applied.

nullaway/src/main/java/com/uber/nullaway/dataflow/cfg/package-info.java (1)

1-4: LGTM! Package-level null-safety correctly applied.

The syntax is correct for package-info.java files where the annotation precedes the package declaration. This establishes null-safety semantics for the entire com.uber.nullaway.dataflow.cfg package.

nullaway/src/main/java/com/uber/nullaway/dataflow/package-info.java (1)

1-4: LGTM! Consistent package-level annotation.

The implementation correctly applies @NullMarked to the com.uber.nullaway.dataflow package, following the same pattern as the subpackages.

nullaway/src/main/java/com/uber/nullaway/handlers/contract/package-info.java (1)

1-4: LGTM! Package annotation correctly applied.

The @NullMarked annotation is properly configured for the com.uber.nullaway.handlers.contract package.

nullaway/src/main/java/com/uber/nullaway/fixserialization/adapters/package-info.java (1)

1-4: LGTM! Null-safety annotation applied correctly.

The package-level @NullMarked annotation is correctly configured for com.uber.nullaway.fixserialization.adapters.

nullaway/src/main/java/com/uber/nullaway/fixserialization/out/package-info.java (1)

1-4: LGTM! Package annotation correctly implemented.

The @NullMarked annotation is properly applied to the com.uber.nullaway.fixserialization.out package.

nullaway/src/main/java/com/uber/nullaway/fixserialization/location/package-info.java (1)

1-4: LGTM! Consistent null-safety configuration.

The @NullMarked annotation is correctly configured for the com.uber.nullaway.fixserialization.location package, consistent with the PR's objective.

nullaway/src/main/java/com/uber/nullaway/handlers/contract/fieldcontract/package-info.java (1)

1-4: LGTM! Package-level null-safety correctly established.

The @NullMarked annotation is properly applied to com.uber.nullaway.handlers.contract.fieldcontract. All seven package-info.java files in this PR follow the correct pattern and will enable improved null-safety error messages in IntelliJ as intended.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-11-06T01:43:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.43%. Comparing base (c6fa9f6) to head (2e58302).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #1331   +/-   ##
=========================================
  Coverage     88.43%   88.43%           
  Complexity     2566     2566           
=========================================
  Files            96       96           
  Lines          8605     8605           
  Branches       1707     1707           
=========================================
  Hits           7610     7610           
  Misses          500      500           
  Partials        495      495

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Add package-info files with @NullMarked

2e58302

msridhar enabled auto-merge (squash) November 6, 2025 01:58

msridhar requested a review from yuxincs November 6, 2025 01:58

yuxincs approved these changes Nov 6, 2025

View reviewed changes

msridhar merged commit 52033ec into master Nov 6, 2025
11 checks passed

msridhar deleted the add-package-info branch November 6, 2025 01:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add package-info files with @NullMarked #1331

Add package-info files with @NullMarked #1331

Uh oh!

msridhar commented Nov 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 6, 2025

Uh oh!

codecov bot commented Nov 6, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add package-info files with @NullMarked #1331

Add package-info files with @NullMarked #1331

Uh oh!

Conversation

msridhar commented Nov 6, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 6, 2025

Walkthrough

Pre-merge checks and finishing touches

Uh oh!

codecov bot commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

msridhar commented Nov 6, 2025 •

edited by coderabbitai bot

Loading

codecov bot commented Nov 6, 2025 •

edited

Loading