Migrate remaining checkNotNull to checkArgumentNotNull/checkStateNotNull in options package #18719

[chandrakiranbolla1]

Addresses #18719

What happened

Currently, checkNotNull in the sdks/java/core/options package throws a NullPointerException (implying a bug in the code), even when validating user-supplied arguments.

What was done

Replaced Guava's checkNotNull with Beam's checkArgumentNotNull (throws IllegalArgumentException) for argument validation and checkStateNotNull (throws IllegalStateException) for internal state validation.

Files modified:

• SdkHarnessOptions.java: checkStateNotNull for return value check
• PipelineOptionsFactory.java: checkArgumentNotNull for argument check
• ValueProvider.java: 3x checkArgumentNotNull + 2x checkStateNotNull
• ValueProviders.java: checkStateNotNull for parsed result check
• PipelineOptionsValidator.java: 2x checkArgumentNotNull for argument checks
• ProxyInvocationHandler.java: checkArgumentNotNull for argument check
• MetricNameFilter.java: cleanup commented-out import

Testing Done

• Ran ./gradlew -p sdks/java/core compileJava successfully.
• Validated existing unit tests with ./gradlew :sdks:java:core:test on JDK 11. No new tests are needed since the behavior remains the same (just throwing preferred exception types).

-------------------------------------------------------------------------

---

• Make sure the PR title is formatted like: [#<GitHub issue id>] PR title ...
• Consider adding unit PR tests and UI PR tests
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

[gemini-code-assist]

Summary of Changes

Hello @chandrakiranbolla1, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors null validation logic within the Apache Beam SDK's options package and related utilities. The primary goal is to provide more precise error reporting by distinguishing between null values arising from invalid user arguments and those indicating an internal program state issue. This change replaces generic NullPointerExceptions with more specific IllegalArgumentException or IllegalStateException as appropriate, leading to clearer diagnostics and a more robust codebase.

Highlights

• Improved Null Check Semantics: Migrated null checks from Guava's checkNotNull to Beam's more specific checkArgumentNotNull and checkStateNotNull utilities.
• Enhanced Error Reporting: Ensured that IllegalArgumentException is thrown for invalid user-supplied arguments and IllegalStateException for failures related to internal program state, providing clearer diagnostics.
• Targeted Refactoring: Applied these changes primarily across several core files within the sdks/java/core/options package, as well as MetricNameFilter.java.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• sdks/java/core/src/main/java/org/apache/beam/sdk/metrics/MetricNameFilter.java
  • Replaced checkNotNull with checkArgumentNotNull for validating method parameters.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/PipelineOptionsFactory.java
  • Replaced checkNotNull with checkArgumentNotNull for validating method parameters in fromArgs, printHelp, and describe methods.
  • Adjusted line breaks in comments for improved readability.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/PipelineOptionsValidator.java
  • Replaced checkNotNull with checkArgumentNotNull for validating method parameters in the validate method.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/ProxyInvocationHandler.java
  • Replaced checkNotNull with checkArgumentNotNull for validating method parameters in the as method.
  • Adjusted line breaks in comments for improved readability.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/SdkHarnessOptions.java
  • Replaced checkNotNull with checkStateNotNull for a return value check in DefaultMaxCacheMemoryUsageMbFactory.
  • Replaced checkNotNull with checkArgumentNotNull for validating method parameters in SdkHarnessLogLevelOverrides.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProvider.java
  • Replaced checkNotNull with checkArgumentNotNull for constructor parameters in NestedValueProvider.
  • Replaced checkNotNull with checkArgumentNotNull and checkStateNotNull for contextual deserialization checks.
  • Updated a comment for clarity.
• sdks/java/core/src/main/java/org/apache/beam/sdk/options/ValueProviders.java
  • Replaced checkNotNull with checkStateNotNull for validating parsed options in updateSerializedOptions.
• start-build-env.sh
  • Corrected a dscl command to properly read group information.
  • Commented out a groupmod command related to Docker group management.

Activity

• No human activity (comments, reviews, or progress updates) was provided in the context for this pull request.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[chandrakiranbolla1]

R: @kennknowles

[github-actions]

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

[kennknowles]

Thanks! This moves the codebase in a good direction. I appreciate you noticing when to use checkStateNotNull versus checkArgumentNotNull also :-)

One note if you continue to contribute in this area: it looks like many of these null checks could eventually be removed, as they are checking things that are not marked @Nullable. This usually happens in places where people have disabled nullness type checking, so once nullness type checking is re-enabled we should discover we can remove the checks.

[kennknowles]

I've re-run the flaky tests. Let me know when they are green, if I am too slow to come back to this and merge.

[chandrakiranbolla1]

@kennknowles All the tests are now green! Thanks for re-running the flaky ones and for the helpful tip regarding the null checks.