Skip to content

Enforce deterministic field order in Schema generated from KafkaIO classes. #36295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 10, 2025
Merged

Enforce deterministic field order in Schema generated from KafkaIO classes. #36295

merged 1 commit into from
Oct 10, 2025

Conversation

baeminbo
Copy link
Contributor

To prevent potential serialization issues, this change adds the @SchemaFieldNumber annotation to KafkaIO classes that use DefaultSchema. This guarantees a deterministic field order, which is not ensured when schemas are generated with AutoValueSchema, JavaBeanSchema, or JavaFieldSchema.

related to: #30276, b/443606305#comment29

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 Gemini Code Assist
Copy link
Contributor

Summary of Changes

Hello @baeminbo, 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 robustness of Apache Beam's KafkaIO component by ensuring that schemas generated for its internal classes maintain a deterministic field order. By explicitly defining the field numbering through annotations, the change mitigates potential serialization inconsistencies and improves the reliability of data processing with KafkaIO. Additionally, new tests have been added to validate these schema generations.

Highlights

  • Deterministic Schema Field Order: Introduced @SchemaFieldNumber annotations to various KafkaIO-related classes (ErrorHandling, KafkaIO.KafkaHeader, KafkaIO.ByteArrayKafkaRecord, KafkaReadSchemaTransformConfiguration, KafkaSourceDescriptor, KafkaWriteSchemaTransformConfiguration) to ensure a consistent field order when schemas are generated using DefaultSchema. This addresses potential serialization issues that can arise from non-deterministic field ordering in AutoValueSchema, JavaBeanSchema, or JavaFieldSchema.
  • Schema Verification Tests: Added new unit tests (testByteArrayKafkaRecordSchema, testKafkaSourceDescriptorSchema, testKafkaHeaderSchema, testKafkaReadSchemaTransformConfigurationSchema, testKafkaWriteSchemaTransformConfigurationSchema) to explicitly verify the correctness and deterministic nature of the generated schemas for the affected KafkaIO classes.
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 GitHub Actions
Copy link
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

@baeminbo
Enforce deterministic field order in Schema generated from KafkaIO cl…
15bb463 
…asses.

To prevent potential serialization issues, this change adds the `@SchemaFieldNumber` annotation to KafkaIO classes that use `DefaultSchema`. This guarantees a deterministic field order, which is not ensured when schemas are generated with `AutoValueSchema`, `JavaBeanSchema`, or `JavaFieldSchema`.
@baeminbo baeminbo force-pushed the kafkaio-schema-update branch from 61a18b5 to 15bb463 Compare September 29, 2025 04:14
@baeminbo
Copy link
Contributor Author

Run Java PreCommit

@github-actions GitHub Actions
Copy link
Contributor

Assigning reviewers:

R: @ahmedabu98 for label java.
R: @fozzie15 for label kafka.

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

@HurSungYun HurSungYun mentioned this pull request Oct 2, 2025
Open
3 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 6, 2025

Reminder, please take a look at this pr: @ahmedabu98 @fozzie15

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @Abacn for label java.
R: @johnjcasey for label kafka.

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)

@Abacn
Copy link
Contributor

Abacn commented Oct 8, 2025

@tomstepp @johnjcasey could take a look?

@tomstepp
Copy link
Contributor

tomstepp commented Oct 8, 2025

LGTM in general. Assuming pipelines are update compatible across this change? @baeminbo

@baeminbo
Copy link
Contributor Author

baeminbo commented Oct 8, 2025

LGTM in general. Assuming pipelines are update compatible across this change? @baeminbo

Yes, right. Currently, this issue can randomly corrupt the states persisted in storage with SchemaCoder at job update, thus the replacement job will encounter unrecoverable problems in deserializing the states from the original job.

@tomstepp
Copy link
Contributor

To clarify, it sounds like this does fix updates where the original pipeline includes this change. But I was not sure if it works with original pipeline on an SDK version before this change upgrading to newer SDK version with this change. Would the original order be incompatible with the new enforced order?

@tomstepp
Copy link
Contributor

@johnjcasey or @an2x would you have any additional feedback?

@reuvenlax
Copy link
Contributor

LGTM

@reuvenlax reuvenlax merged commit d4438b6 into apache:master Oct 10, 2025
24 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

io java kafka Next Action: Reviewers reassigned-reviewers

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@baeminbo @Abacn @tomstepp @reuvenlax