Skip to content
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.

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

[FLINK-16555] Block Enum as key type #11518

Closed
wants to merge 2 commits into from

Conversation

qqibrow
Copy link
Contributor

@qqibrow qqibrow commented Mar 26, 2020

What is the purpose of the change

This PR blocks enum type as key type. Because hashCode() of Enum type calls Object.hashCode(), therefore keyBy on Enum type could lead to incorrect data routing.

Brief change log

Block Enum as key type

Verifying this change

This change added tests and can be verified as follows:

  • Added unit test to test enum cannot be used as key type

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

hashCode() of Enum type calls Object.hashCode(), therefore keyBy on Enum
type could lead to incorrect data routing.
@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit bf5170b (Thu Mar 26 04:48:16 UTC 2020)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Mar 26, 2020

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

@qqibrow
Copy link
Contributor Author

qqibrow commented Mar 27, 2020

@flinkbot run azure

Copy link
Member

@klion26 klion26 left a comment

Choose a reason for hiding this comment

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

thanks for your contribution, left some minor comments~


@Test
public void testEnumKeyRejection() {
KeySelector<Tuple2<TestEnum, String>, TestEnum> keySelector =
Copy link
Member

Choose a reason for hiding this comment

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

can we reuse the function testKeyRejection for the newly added test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

testArrayKeyRejection should be a better name. it only used for arrays and cannot be
used for enum type.

@qqibrow
Copy link
Contributor Author

qqibrow commented Apr 1, 2020

@klion26 could you take another look? thanks!

Copy link
Member

@klion26 klion26 left a comment

Choose a reason for hiding this comment

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

Thanks for the update.
Previously, I thought that we can refactor the function testKeyRejection so that we can also reuse testKeyRejction to test the newly added test
Apart from this, the changes LGTM.

@aljoscha
Copy link
Contributor

aljoscha commented Apr 8, 2020

Thanks for this PR! And thanks to @klion26 for the initial good review. 🍵

I made some slight changes, for example I used a lambda for the KeySelector, you can see the final result on master.

@aljoscha aljoscha closed this Apr 8, 2020
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.

5 participants