Skip to content

Sort SchemaTransform configuration schema fields by name to establish consistency #24344

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
chamikaramj merged 5 commits into from
Dec 1, 2022
Merged

Sort SchemaTransform configuration schema fields by name to establish consistency #24344

chamikaramj merged 5 commits into from
Dec 1, 2022

Conversation

@ahmedabu98
Copy link
Contributor

@ahmedabu98 ahmedabu98 commented Nov 23, 2022 •
edited
Loading

TypedSchemaTransformProvider::configurationSchema returns an inconsistently ordered Schema object. A consistent Schema is needed to use configuration Row objects to instantiate and build SchemaTransforms. The solution in this PR is to sort the fields by name.

Fixes #24361

@github-actions github-actions bot added the java label Nov 23, 2022
@ahmedabu98 ahmedabu98 marked this pull request as ready for review November 23, 2022 23:09
@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 23, 2022

R: @chamikaramj

@github-actions
Copy link
Contributor

github-actions bot commented Nov 23, 2022

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

chamikaramj
chamikaramj reviewed Nov 23, 2022
View reviewed changes
Copy link
Contributor

@chamikaramj chamikaramj left a comment

Choose a reason for hiding this comment

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

Thanks.

@chamikaramj
Copy link
Contributor

chamikaramj commented Nov 23, 2022

Let's also create a Github issue to track this.

@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 27, 2022

R: @chamikaramj
Thanks for the feedback, PTAL. I thought the sort code belongs in the Schema class, lmk what you think.

@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 27, 2022

Fixes #24361

chamikaramj
chamikaramj reviewed Nov 28, 2022
View reviewed changes
Copy link
Contributor

@chamikaramj chamikaramj left a comment

Choose a reason for hiding this comment

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

Thanks.

.../core/src/main/java/org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.java Outdated
@Internal
@Experimental(Kind.SCHEMAS)
@SuppressWarnings({
"nullness" // TODO(https://github.com/apache/beam/issues/20506)
Copy link
Contributor

@chamikaramj chamikaramj Nov 28, 2022

Choose a reason for hiding this comment

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

What's the error you got here ? We should try to fix checker-framework warnings in new code instead of surpassing.

Copy link
Contributor Author

@ahmedabu98 ahmedabu98 Nov 29, 2022

Choose a reason for hiding this comment

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

No longer running into this now that sorting method is in Schema.java, will remove

sdks/java/core/src/main/java/org/apache/beam/sdk/schemas/Schema.java

/** Returns an identical Schema with sorted fields. */
public Schema sorted() {
Schema sortedSchema =
Copy link
Contributor

@chamikaramj chamikaramj Nov 28, 2022

Choose a reason for hiding this comment

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

Can we add an assertion or a unit test that will break if any new properties are added to the Schema object that are not copied over here ?

Copy link
Contributor Author

@ahmedabu98 ahmedabu98 Nov 29, 2022

Choose a reason for hiding this comment

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

Done, PTAL

chamikaramj
chamikaramj approved these changes Nov 29, 2022
View reviewed changes
Copy link
Contributor

@chamikaramj chamikaramj left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks.

@chamikaramj
Copy link
Contributor

chamikaramj commented Nov 30, 2022

Seems like the new test is failing.

https://ci-beam.apache.org/job/beam_PreCommit_Java_Commit/25057/testReport/junit/org.apache.beam.sdk.schemas/SchemaTest/testSortedMethodIncludesAllSchemaFields/

@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 30, 2022

Jacoco creates synthetic fields when it runs, which get picked up by Class::getDeclaredFields.

@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 30, 2022

Run Java PreCommit

2 similar comments
@chamikaramj
Copy link
Contributor

chamikaramj commented Nov 30, 2022

Run Java PreCommit

@ahmedabu98
Copy link
Contributor Author

ahmedabu98 commented Nov 30, 2022

Run Java PreCommit

@chamikaramj chamikaramj merged commit 4718cdf into apache:master Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chamikaramj chamikaramj chamikaramj approved these changes

Assignees

No one assigned

Labels

java

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

TypedSchemaTransformProvider returns an inconsistent configuration Schema object

2 participants

@ahmedabu98 @chamikaramj