Skip to content

feat(ingest): Support protobuf description for enum field #11027

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
david-leifker merged 6 commits into from
Sep 5, 2024
Merged

feat(ingest): Support protobuf description for enum field #11027

david-leifker merged 6 commits into from
Sep 5, 2024

Conversation

@eunseokyang
Copy link
Contributor

@eunseokyang eunseokyang commented Jul 30, 2024 •
edited by coderabbitai bot
Loading

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary

This PR introduces support for displaying descriptions for enum fields in Protobuf schemas during ingestion in DataHub. A new method has been added to ensure these descriptions are properly captured and shown.

Screenshots

enum TimestampUnitType {
  MILLISECOND = 0; // 10^-3 seconds
  MICROSECOND = 1; // 10^-6 seconds
  NANOSECOND = 2; // 10^-9 seconds
}

As-Is:
image

Enum field descriptions are not displayed during Protobuf ingestion.
To-Be:
image

Enum field descriptions are now correctly displayed.

Summary by CodeRabbit

  • New Features
    • Introduced methods for enhanced enum handling in Protobuf definitions, allowing for easier retrieval of enum descriptors and values with comments.
  • Refactor
    • Streamlined the visitField method for better clarity and modularity, resulting in improved code maintainability.
    • Added helper methods for creating schema fields and generating field descriptions, enhancing readability and separation of concerns.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 30, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes enhance the ProtobufField and ProtobufExtensionFieldVisitor classes, introducing new methods for handling enum types and streamlining existing logic. The updates improve code readability and maintainability by breaking down complex methods into smaller, focused units. This modular approach facilitates easier future modifications and clarifies the functionality of the code, particularly in managing field descriptions and tag associations.

Changes

Files Change Summary
metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufField.java Added methods for handling enum types and refactored existing methods for better readability and maintainability.
metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/visitors/field/ProtobufExtensionFieldVisitor.java Refactored visitField method, introducing helper methods for tag and glossary term processing, and abstracted SchemaField creation for clarity.

Poem

🐇 In the land where fields do play,
New methods hop in bright array.
Enums dance with comments near,
Code now sings, so crisp and clear!
With every change, a joyful leap,
Our Protobuf dreams, we’ll gladly keep! ✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata community-contribution PR or Issue raised by member(s) of DataHub Community labels Jul 30, 2024
coderabbitai[bot]
coderabbitai bot reviewed Jul 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a6eb1f4 and efb9c7a.

Files selected for processing (2)
  • metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufField.java (5 hunks)
  • metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/visitors/field/ProtobufExtensionFieldVisitor.java (3 hunks)
Additional comments not posted (10)
metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/visitors/field/ProtobufExtensionFieldVisitor.java (6)

38-44: Refactored method improves readability and maintainability.

The visitField method has been refactored to call helper methods for tag and glossary term associations and to encapsulate the logic for creating a SchemaField. This improves readability and maintainability.

46-64: Well-structured method for creating SchemaField.

The createSchemaField method consolidates the logic for setting various properties of the SchemaField, improving code clarity and maintainability.

66-78: Isolated logic for generating field descriptions.

The createFieldDescription method effectively isolates the logic for generating field descriptions, especially for enum types, improving readability and maintainability.

80-93: Isolated logic for appending enum values and comments.

The appendEnumValues method effectively isolates the logic for appending enum values and their comments to the description string, improving readability and maintainability.

95-108: Isolated logic for retrieving and processing tag associations.

The getTagAssociations method effectively isolates the logic for retrieving and processing tag associations, improving readability and maintainability.

110-119: Isolated logic for retrieving and processing glossary term associations.

The getGlossaryTermAssociations method effectively isolates the logic for retrieving and processing glossary term associations, improving readability and maintainability.

metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufField.java (4)

320-322: Correctly identifies enum fields.

The isEnum method correctly identifies if a field is of enum type by comparing the field's type to TYPE_ENUM.

324-335: Correctly retrieves enum descriptor.

The getEnumDescriptor method correctly retrieves the enum descriptor for enum fields by extracting the short enum type name and finding the matching enum descriptor.

337-341: Correctly retrieves enum values.

The getEnumValues method correctly retrieves the enum values for enum fields by calling getEnumDescriptor and getting the value list.

343-369: Correctly retrieves enum values and comments.

The getEnumValuesWithComments method correctly retrieves the enum values and their associated comments for enum fields by mapping the enum values to their comments using the source code locations.

@david-leifker david-leifker self-requested a review July 31, 2024 16:55
@david-leifker
Copy link
Collaborator

david-leifker commented Aug 6, 2024

Very nice! Please add or update 1 unit test with an enum. Thanks!

@david-leifker david-leifker self-assigned this Aug 6, 2024
@eunseokyang
Copy link
Contributor Author

eunseokyang commented Aug 14, 2024 •
edited
Loading

@david-leifker Thank you for your time and assistance. I added a test case for enum in proto, so please take another look! 9a76918

@david-leifker david-leifker enabled auto-merge (squash) September 5, 2024 15:29
@david-leifker
Copy link
Collaborator

david-leifker commented Sep 5, 2024

Thanks!

@david-leifker david-leifker merged commit 59f9a4b into datahub-project:master Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@david-leifker david-leifker david-leifker approved these changes

Assignees

@david-leifker david-leifker

Labels

community-contribution PR or Issue raised by member(s) of DataHub Community ingestion PR or Issue related to the ingestion of metadata

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@eunseokyang @david-leifker