Skip to content

[ErrorProne] enable AutoValueSubclassLeaked, EscapedEntity, JUnitIncompatibleType, EqualsUnsafeCast#38256

Merged
kennknowles merged 2 commits intoapache:masterfrom
stankiewicz:error_prone_bulk4
Apr 23, 2026
Merged

[ErrorProne] enable AutoValueSubclassLeaked, EscapedEntity, JUnitIncompatibleType, EqualsUnsafeCast#38256
kennknowles merged 2 commits intoapache:masterfrom
stankiewicz:error_prone_bulk4

Conversation

@stankiewicz
Copy link
Copy Markdown
Contributor

Description

This PR resolves violations for several ErrorProne checks that were previously disabled in BeamModulePlugin.groovy.

Changes by ErrorProne Check

AutoValueSubclassLeaked

  • sdks/java/io/google-cloud-platform:
    • BigQueryIO.java: Added static builder() methods to TypedRead and Write classes to avoid direct referencing of generated AutoValue builders.
    • BigQueryIOTranslation.java: Updated to use new static builder methods.
    • BigQueryCoderProviderRegistrar.java: Replaced direct reference to AutoValue_RowMutation.class with RowMutation.class.
    • WritePartition.java: Added public static factory method of(...) to Result class.
    • WriteTables.java: Added public static factory method of(...) to Result class.
    • BigQueryIOWriteTest.java: Updated to use new factory methods.
  • runners/java-fn-execution:
    • DefaultJobBundleFactory.java: Added builder() method to ServerInfo to avoid direct reference to AutoValue_DefaultJobBundleFactory_ServerInfo.Builder.
    • DefaultJobBundleFactoryTest.java: Updated to use the new builder.
  • sdks/java/io/mongodb:
    • MongoDbIO.java: Replaced getClass() == AutoValue_FindQuery.class with instanceof FindQuery to avoid direct references to generated classes.
  • sdks/java/core:
    • GenerateSequenceTest.java: Replaced direct instantiation of AutoValue_GenerateSequence with factory methods.

EscapedEntity

  • sdks/java/io/hadoop-format:
    • HadoopFormatIO.java: Fixed HTML entities like < and " inside Javadoc {@code ...} blocks.
  • sdks/java/core:
    • ApproximateQuantiles.java: Fixed HTML entities like < inside Javadoc {@code ...} blocks.

JUnitIncompatibleType

  • sdks/java/core:
    • LogicalTypesTest.java: Fixed incompatible types in assertEquals by using the correct expected class type.

EqualsUnsafeCast

  • sdks/java/core:
    • TestPOJOs.java: Fixed wrong class in instanceof check in equals method (checked PojoWithNestedArray but cast to PojoWithIterable).

Build Configuration

  • buildSrc:
    • BeamModulePlugin.groovy: Enabled AutoValueSubclassLeaked, EqualsUnsafeCast, EscapedEntity, NonCanonicalType, UnescapedEntity, and JUnitIncompatibleType by removing them from disabledChecks.

Verification

  • Verified that compilation passes for the affected modules.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

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

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enables a suite of ErrorProne checks that were previously disabled in the project's build configuration. To support this, the codebase has been refactored to eliminate direct dependencies on generated AutoValue classes, improve Javadoc documentation by fixing escaped entities, and resolve type-related issues in tests. These changes improve code quality and maintainability by enforcing stricter static analysis rules.

Highlights

  • ErrorProne Configuration: Enabled several previously disabled ErrorProne checks in BeamModulePlugin.groovy, including AutoValueSubclassLeaked, EqualsUnsafeCast, EscapedEntity, and JUnitIncompatibleType.
  • AutoValue Refactoring: Updated various components to avoid direct references to generated AutoValue classes by introducing static builder or factory methods.
  • Javadoc and Type Fixes: Corrected HTML entities in Javadoc blocks and resolved type inconsistencies in unit tests to satisfy the newly enabled checks.

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

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.

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.

…EscapedEntity, JUnitIncompatibleType, EqualsUnsafeCast
@stankiewicz
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request enables several previously disabled ErrorProne checks, including AutoValueSubclassLeaked, EscapedEntity, and NonCanonicalType. The changes involve refactoring the codebase to avoid direct references to generated AutoValue classes by introducing static factory methods, using instanceof checks, and updating Javadoc to resolve entity escaping issues. Feedback was provided to improve the Javadoc formatting in ApproximateQuantiles.java by using literal characters within a {@code} block instead of removing the block entirely.

Comment on lines +510 to +511
* weight, and picking out the (k * step + offset)-th elements of this list for 0 &lt;= k &lt;
* count.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While removing {@code} resolves the EscapedEntity check, it's generally better to keep the code formatting for mathematical expressions in Javadoc. You can use the literal characters inside the {@code} block instead of HTML entities.

Suggested change
* weight, and picking out the (k * step + offset)-th elements of this list for 0 &lt;= k &lt;
* count.
* weight, and picking out the (k * step + offset)-th elements of this list for {@code 0 <= k <
* count}.

@stankiewicz stankiewicz marked this pull request as ready for review April 22, 2026 17:11
@stankiewicz
Copy link
Copy Markdown
Contributor Author

flaky flink, same happening on master -https://github.com/apache/beam/actions/runs/24769744791/job/72472821150

@github-actions
Copy link
Copy Markdown
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@github-actions
Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @Abacn for label java.
R: @liferoad for label build.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Copy link
Copy Markdown
Member

@kennknowles kennknowles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these are legit bugs! (like the equals check that demanded a particular hidden class). Great.

@kennknowles kennknowles merged commit 3ea73d2 into apache:master Apr 23, 2026
33 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants