Skip to content

[ErrorProne] Enable StaticAssignmentInConstructor check#37786

Open
stankiewicz wants to merge 2 commits intoapache:masterfrom
stankiewicz:error_prone_StaticAssignmentInConstructor
Open

[ErrorProne] Enable StaticAssignmentInConstructor check#37786
stankiewicz wants to merge 2 commits intoapache:masterfrom
stankiewicz:error_prone_StaticAssignmentInConstructor

Conversation

@stankiewicz
Copy link
Contributor

This PR removes the StaticAssignmentInConstructor configuration from the disabledChecks list in BeamModulePlugin.groovy, enabling Error Prone to start catching and preventing unintentional static state mutations inside constructors across the codebase.

Mutating static state from a constructor is highly error-prone. Changes only in tests.


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.

…d re-enable StaticAssignmentInConstructor checkstyle rule.
@gemini-code-assist
Copy link
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 enhances code quality and robustness by activating the StaticAssignmentInConstructor Error Prone check. This enforcement aims to eliminate a common source of bugs and concurrency issues by disallowing direct modification of static fields within constructors. To align with this new rule, various test files were updated to employ atomic wrapper classes for static variables, ensuring thread-safe operations and adherence to best practices for shared state management.

Highlights

  • Error Prone Check Enabled: The StaticAssignmentInConstructor Error Prone check has been enabled by removing it from the disabled checks list in BeamModulePlugin.groovy. This will prevent unintentional static state mutations inside constructors across the codebase.
  • Test Code Refactoring for Concurrency: Several test files were refactored to comply with the newly enabled Error Prone check. Static fields that were previously directly assigned in constructors or static initializers have been updated to use thread-safe atomic classes such as AtomicBoolean, AtomicInteger, and AtomicReference.
  • Specific Suppression for Testing: One test class, SparkRunnerKryoRegistratorTest.java, received a @SuppressWarnings("StaticAssignmentInConstructor") annotation, as the pattern is intentionally used within that test for specific testing purposes.

🧠 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
  • buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy
    • Removed the StaticAssignmentInConstructor check from the list of disabled Error Prone checks.
  • runners/direct-java/src/test/java/org/apache/beam/runners/direct/BoundedReadEvaluatorFactoryTest.java
    • Replaced a static boolean field with AtomicBoolean for thread-safe state management.
    • Updated references to the static field to use get() and set() methods of AtomicBoolean.
  • runners/direct-java/src/test/java/org/apache/beam/runners/direct/UnboundedReadEvaluatorFactoryTest.java
    • Replaced static int fields with AtomicInteger for thread-safe counter operations.
    • Updated references to the static fields to use get(), set(), and incrementAndGet() methods of AtomicInteger.
  • runners/google-cloud-dataflow-java/worker/src/test/java/org/apache/beam/runners/dataflow/worker/StreamingDataflowWorkerTest.java
    • Replaced a static FakeClock field with AtomicReference<FakeClock> for thread-safe object reference management.
    • Updated references to the static field to use get() and set() methods of AtomicReference.
  • runners/spark/3/src/test/java/org/apache/beam/runners/spark/structuredstreaming/aggregators/metrics/sink/InMemoryMetrics.java
    • Replaced static WithMetricsSupport and MetricRegistry fields with AtomicReference wrappers for thread-safe object reference management.
    • Updated references to the static fields to use get() and set() methods of AtomicReference.
  • runners/spark/src/test/java/org/apache/beam/runners/spark/aggregators/metrics/sink/InMemoryMetrics.java
    • Replaced static WithMetricsSupport and MetricRegistry fields with AtomicReference wrappers for thread-safe object reference management.
    • Updated references to the static fields to use get() and set() methods of AtomicReference.
  • runners/spark/src/test/java/org/apache/beam/runners/spark/coders/SparkRunnerKryoRegistratorTest.java
    • Added @SuppressWarnings("StaticAssignmentInConstructor") to the class to allow intentional static assignments for testing.
  • sdks/java/io/hcatalog/src/test/java/org/apache/beam/sdk/io/hcatalog/HiveDatabaseTestHelper.java
    • Replaced static Connection and Statement fields with AtomicReference wrappers for thread-safe object reference management.
    • Updated references to the static fields to use get() and set() methods of AtomicReference.
  • sdks/java/io/jms/src/test/java/org/apache/beam/sdk/io/jms/JmsIOTest.java
    • Replaced a static int field with AtomicInteger for thread-safe counter operations.
    • Updated references to the static field to use getAndIncrement() method of AtomicInteger.
  • sdks/java/io/snowflake/src/test/java/org/apache/beam/sdk/io/snowflake/test/FakeSnowflakeDatabase.java
    • Replaced a static HashMap with ConcurrentHashMap for thread-safe map operations.
    • Updated the clean() method to use clear() on the ConcurrentHashMap.
Activity
  • No human activity (comments, reviews, etc.) has been recorded for this pull request yet.
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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

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

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.

1 participant