Skip to content

[Dataflow Streaming] Fix nullness supression in StreamingModeExecutionContext#38842

Open
arunpandianp wants to merge 5 commits into
apache:masterfrom
arunpandianp:contextnullness
Open

[Dataflow Streaming] Fix nullness supression in StreamingModeExecutionContext#38842
arunpandianp wants to merge 5 commits into
apache:masterfrom
arunpandianp:contextnullness

Conversation

@arunpandianp
Copy link
Copy Markdown
Contributor

Please add a meaningful description for your change here


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 enhances the null safety of the StreamingModeExecutionContext class by replacing broad nullness suppression with explicit nullability annotations and robust validation. These changes ensure that potential null states are handled safely, reducing the risk of runtime errors and improving the overall maintainability of the streaming execution logic.

Highlights

  • Null Safety Improvements: Removed the broad @SuppressWarnings("nullness") annotation and introduced explicit @nullable annotations across the StreamingModeExecutionContext class to improve type safety.
  • Defensive Programming: Replaced generic checkNotNull calls with checkStateNotNull and added explicit null checks to handle potentially uninitialized state components, preventing runtime null pointer exceptions.
  • Refactoring and Initialization: Streamlined the initialization of operational limits and tag encoding, and improved the handling of optional state families within the StepContext.
New Features

🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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.

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 improves null safety in StreamingModeExecutionContext.java by removing the 'nullness' warning suppression, adding @nullable annotations, and replacing checkNotNull with checkStateNotNull. It also refactors StepContext to eagerly initialize several collections and clear them on start, and wraps state/timer initialization with a null check on stateFamily. The review feedback suggests further optimizing getNextFiredTimer and getNextFiredUserTimer by returning early if stateFamily is null, which prevents unnecessary processing and potential NullPointerExceptions.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +906 to +907
public <W extends BoundedWindow> @Nullable TimerData getNextFiredTimer(Coder<W> windowCoder) {
Iterator<TimerData> firedSystemTimers = cachedFiredSystemTimers;
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

For stateless steps, stateFamily is null. To avoid unnecessary processing and potential NullPointerExceptions when filtering timers, we can return null immediately if stateFamily is null.

    public <W extends BoundedWindow> @Nullable TimerData getNextFiredTimer(Coder<W> windowCoder) {
      if (stateFamily == null) {
        return null;
      }
      Iterator<TimerData> firedSystemTimers = cachedFiredSystemTimers;

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.

do it? seems like will reduce allocations in common case, even if null exception isn't a concern

Comment on lines +965 to +967
public <W extends BoundedWindow> @Nullable TimerData getNextFiredUserTimer(
Coder<W> windowCoder) {
PeekingIterator<TimerData> firedUserTimers = cachedFiredUserTimers;
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

Similar to getNextFiredTimer, we can return null immediately if stateFamily is null to avoid unnecessary processing and safely guarantee that userTimerInternals is non-null for subsequent operations.

    public <W extends BoundedWindow> @Nullable TimerData getNextFiredUserTimer(
        Coder<W> windowCoder) {
      if (stateFamily == null) {
        return null;
      }
      PeekingIterator<TimerData> firedUserTimers = cachedFiredUserTimers;

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.

ditto

@arunpandianp
Copy link
Copy Markdown
Contributor Author

R: @scwhittle

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 8, 2026

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

Copy link
Copy Markdown
Contributor

@scwhittle scwhittle left a comment

Choose a reason for hiding this comment

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

[edited] missed one commit

Comment on lines +906 to +907
public <W extends BoundedWindow> @Nullable TimerData getNextFiredTimer(Coder<W> windowCoder) {
Iterator<TimerData> firedSystemTimers = cachedFiredSystemTimers;
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.

do it? seems like will reduce allocations in common case, even if null exception isn't a concern

Comment on lines +965 to +967
public <W extends BoundedWindow> @Nullable TimerData getNextFiredUserTimer(
Coder<W> windowCoder) {
PeekingIterator<TimerData> firedUserTimers = cachedFiredUserTimers;
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.

ditto

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.

rm todo

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done.

private WindmillStateInternals<Object> stateInternals;
private WindmillTimerInternals systemTimerInternals;
private WindmillTimerInternals userTimerInternals;
private @Nullable WindmillStateInternals<Object> stateInternals;
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.

MonotonicNonNull might help reduce necessary annotations within functions for some of these,

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Marked them as MonotonicNonNull, not sure if there are any checks that can be removed though.

@arunpandianp arunpandianp requested a review from scwhittle June 8, 2026 09:01
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