Skip to content

Fix PipelineOptions display-data NPE#38525

Open
aIbrahiim wants to merge 4 commits into
apache:masterfrom
aIbrahiim:fix-pvr-flink-display-data-npe
Open

Fix PipelineOptions display-data NPE#38525
aIbrahiim wants to merge 4 commits into
apache:masterfrom
aIbrahiim:fix-pvr-flink-display-data-npe

Conversation

@aIbrahiim
Copy link
Copy Markdown
Contributor

@aIbrahiim aIbrahiim commented May 18, 2026

Fixes: #37273
Successful run: https://github.com/apache/beam/actions/runs/26025239650

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.

@github-actions github-actions Bot added the java label May 18, 2026
@aIbrahiim aIbrahiim marked this pull request as ready for review May 18, 2026 10:40
@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 addresses a NullPointerException occurring during PipelineOptions display-data serialization, specifically observed with newer Jackson versions. It introduces a defensive fallback mechanism in the deserialization logic to ensure stability when contextual deserializers fail, and includes a regression test to prevent future occurrences.

Highlights

  • NPE Fix in PipelineOptionsFactory: Added robust error handling in deserializeNode to catch NullPointerExceptions during JSON deserialization, falling back to standard Jackson tree-to-value conversion.
  • Improved Deserializer Logic: Updated computeDeserializerForMethod to ensure typeDeserializer and jsonDeserializer are both non-null before wrapping, preventing potential issues.
  • Regression Testing: Added a new test case in PipelineOptionsFactoryTest to verify that display-data population works correctly after a JSON round-trip for polymorphic options.
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 addresses a NullPointerException in PipelineOptionsFactory.deserializeNode that occurs with Jackson 2.18+ during display-data serialization. The changes introduce a null check for the deserializer and a try-catch block to fall back to standard Jackson deserialization if the custom deserializer fails. A regression test has been added to ensure stability. Review feedback suggests optimizing the deserializeNode method by moving the construction of JavaType into the specific fallback blocks where it is used, thereby avoiding unnecessary overhead in the common successful execution path.

@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

@Amar3tto Amar3tto requested a review from Abacn May 18, 2026 16:20
JsonParser parser = new TreeTraversingParser(node, MAPPER);
parser.nextToken();
return jsonDeserializer.deserialize(parser, DESERIALIZATION_CONTEXT.copy());
} catch (NullPointerException e) {
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.

catch an NPE is almost always an anti-pattern. Let me check what happens caused NPE here, and stack trace?

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.

ahh right it is not a long term fix, i refactored it and her'es the stack trace:

java.lang.IllegalArgumentException: Error while populating display data for component
'org.apache.beam.sdk.options.ProxyInvocationHandler$PipelineOptionsDisplayData': null
at PipelineOptionsTranslation.toProto(...)
at FlinkJobInvoker.createJobInvocation(...)
...
Caused by: java.lang.NullPointerException
at PipelineOptionsFactory.deserializeNode(PipelineOptionsFactory.java:1813)
at ProxyInvocationHandler.getValueFromJson(...)
at ProxyInvocationHandler$PipelineOptionsDisplayData.populateDisplayData(...:446)
at DisplayData.from(...)
at ProxyInvocationHandler$Serializer.serialize(...)

Caused by: java.lang.NullPointerException
at org.apache.beam.sdk.options.PipelineOptionsFactory.deserializeNode(...)
at org.apache.beam.sdk.options.ProxyInvocationHandler.getValueFromJson(...)
at org.apache.beam.sdk.options.ProxyInvocationHandler$PipelineOptionsDisplayData.populateDisplayData(...:446)
at org.apache.beam.sdk.transforms.display.DisplayData.from(...)
at org.apache.beam.sdk.options.ProxyInvocationHandler$Serializer.serialize(...)
at org.apache.beam.sdk.util.construction.PipelineOptionsTranslation.toProto(...)
at org.apache.beam.runners.flink.FlinkJobInvoker.createJobInvocation(...)

@aIbrahiim aIbrahiim requested a review from Abacn May 18, 2026 19:18
@Abacn
Copy link
Copy Markdown
Contributor

Abacn commented May 18, 2026

R: @shunping (who is taking a look as well: #38531)

@github-actions
Copy link
Copy Markdown
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The PostCommit Python ValidatesRunner Flink job is flaky

2 participants