[ErrorProne] Fix FormatStringShouldUsePlaceholders string concat when Preconditions is used

[stankiewicz]

Fixes error prone https://errorprone.info/bugpattern/FormatStringShouldUsePlaceholders

---

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

• Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
• Update CHANGES.md with noteworthy changes.
• If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

[stankiewicz]

partially fixes #37743

[gemini-code-assist]

Summary of Changes

Hello, 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 numerous instances of Preconditions.checkState and checkNotNull calls throughout the codebase. The primary goal is to replace direct string concatenation within the error messages with format specifiers, aligning with best practices for constructing error messages and resolving an 'Error Prone' warning. This change improves the maintainability and readability of the code while ensuring more reliable error reporting.

Highlights

• Error Prone Fix: Addressed the Error Prone bug pattern 'FormatStringShouldUsePlaceholders' by refactoring string concatenation in Preconditions.checkState and checkNotNull messages to use format specifiers.
• Improved Error Messages: Enhanced the clarity and robustness of error messages across various components by utilizing parameterized string formatting, preventing potential issues with string concatenation.

🧠 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

• runners/flink/src/main/java/org/apache/beam/runners/flink/adapter/BeamFlinkDataStreamAdapter.java
  • Updated Preconditions.checkStateNotNull message to use a format specifier.
• runners/flink/src/main/java/org/apache/beam/runners/flink/translation/functions/FlinkSideInputReader.java
  • Updated checkNotNull message to use a format specifier.
• runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/windmill/state/RangeCoder.java
  • Updated two Preconditions.checkState messages to use format specifiers.
• runners/java-fn-execution/src/main/java/org/apache/beam/runners/fnexecution/control/ReferenceCountingExecutableStageContextFactory.java
  • Updated Preconditions.checkState message to use a format specifier.
• runners/prism/java/src/main/java/org/apache/beam/runners/prism/PrismLocator.java
  • Updated checkStateNotNull message to use a format specifier.
• sdks/java/core/src/main/java/org/apache/beam/sdk/coders/BigDecimalCoder.java
  • Updated checkNotNull messages to use direct format specifiers instead of String.format.
• sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/AutoValueSchema.java
  • Updated Preconditions.checkState message to use format specifiers for field number validation.
• sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/JavaBeanSchema.java
  • Updated Preconditions.checkState message to use format specifiers for field number validation.
• sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/JavaFieldSchema.java
  • Updated Preconditions.checkState message to use format specifiers for field number validation.
• sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/DoFnOutputReceivers.java
  • Updated checkState message to use a format specifier for schema validation.
• sdks/java/harness/src/main/java/org/apache/beam/fn/harness/FnApiDoFnRunner.java
  • Updated checkState messages to use format specifiers for output receiver schema validation.
• sdks/java/io/cassandra/src/main/java/org/apache/beam/sdk/io/cassandra/CassandraIO.java
  • Updated checkState messages to use format specifiers for CassandraIO configuration validation.
• sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BeamRowToStorageApiProto.java
  • Updated Preconditions.checkNotNull and checkState messages to use format specifiers for BigQuery schema conversion.
• sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java
  • Updated checkState message to use a format specifier for Kafka topic partition validation.
• sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaUnboundedSource.java
  • Updated checkState message to use format specifiers for Kafka partition existence validation.
• sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/WatchForKafkaTopicPartitions.java
  • Updated checkState message to use a format specifier for Kafka topic partition retrieval.
• sdks/java/sdk/util/InstanceBuilder.java
  • Updated checkState messages to use format specifiers for factory method and constructor validation.

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. ↩

[stankiewicz]

R: @scwhittle
I remember we were discussing finding the rest of those.

[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

[scwhittle]

Can FormatStringShouldUsePlaceholders be added in checks so that there are not regressions?

[stankiewicz]

Can FormatStringShouldUsePlaceholders be added in checks so that there are not regressions?

We are running error prone 2.31 which works with java 11. this check is added with 2.45 which is compiled with java 21 so it won't be that easy. I will check what what we can do but I think this should be follow up task to bump it. We have long list if disabled checks that has to be enabled as well.

[stankiewicz]

Run Java_GCP_IO_Direct PreCommit

[stankiewicz]

Run Java PreCommit