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.

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

fix(ingest/protobuf): Improve String Handling for Multilingual Support in Descriptions #10975

Merged
merged 4 commits into from
Sep 5, 2024
Merged

fix(ingest/protobuf): Improve String Handling for Multilingual Support in Descriptions #10975

merged 4 commits into from
Sep 5, 2024

Conversation

eunseokyang
Copy link
Contributor

@eunseokyang eunseokyang commented Jul 24, 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

Description

Support for Multilingual Characters: By returning the original string directly, we ensure that all characters, including those outside the ISO-8859-1 range (e.g., Korean, Chinese, Japanese), are preserved and correctly displayed.

Upon further investigation on this issue, it has been identified that the root cause of the broken UTF-8 characters is user error, specifically related to incorrect handling of character encodings in user input or data processing.

AS-IS
image

TO-BE
image

Summary by CodeRabbit

  • New Features

    • Enhanced comment handling to support UTF-8 characters, improving compatibility with various text formats.

  • Bug Fixes

    • Removed unnecessary intermediate processing, streamlining comment concatenation.

  • Refactor

    • Simplified the implementation of the comment processing method for better performance and readability.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 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 in ProtobufUtils.java focus on streamlining the collapseLocationComments method. The updated implementation simplifies the process by removing the intermediate variable used for comment concatenation and processing. Additionally, the removal of ISO-8859-1 encoding allows the method to return UTF-8 characters directly, enhancing comment fidelity in various contexts.

Changes

File Change Summary
.../ProtobufUtils.java Modified collapseLocationComments method to eliminate intermediate variable and remove ISO-8859-1 encoding, returning UTF-8 comments instead.

Sequence Diagram(s)

(No sequence diagrams generated as the changes do not entail complex control flow modifications.)

Poem

🐇 In the code where comments play,
A rabbit hops in bright array.
With UTF-8, they dance and sing,
No more lost in ASCII's ring!
Simplified, our joy is clear,
Oh, what fun, let's give a cheer! 🎉

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 24, 2024
@eunseokyang eunseokyang changed the title fix(ingest/protobuf): Support for Multilingual Characters for Description fix(ingest/protobuf): Improve String Handling for Multilingual Support in Descriptions Jul 24, 2024
coderabbitai[bot]
coderabbitai bot reviewed Jul 24, 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 f0f226c and 4e6b0e7.

Files selected for processing (1)
  • metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/ProtobufUtils.java (2 hunks)
Additional comments not posted (1)
metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/ProtobufUtils.java (1)

24-24: LGTM! Simplified code and enhanced character handling.

The changes simplify the code and improve the handling of multilingual characters by directly returning the concatenated and processed string without converting it to ISO-8859-1 encoding.

However, ensure that the changes do not introduce any regressions or unexpected behavior.

Verification successful

Verification Successful: No issues found with the collapseLocationComments method changes.

The updated collapseLocationComments method is used consistently across multiple classes (ProtobufOneOfField, ProtobufMessage, ProtobufField, and ProtobufEnum). The changes simplify the code and improve character handling without introducing any regressions or unexpected behavior.

  • ProtobufOneOfField.java: Lines 9-19
  • ProtobufMessage.java: Lines 9-14
  • ProtobufField.java: Lines 9-34
  • ProtobufEnum.java: Lines 9-19
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `collapseLocationComments` method in the codebase to ensure no regressions.

# Test: Search for the method usage. Expect: No regressions or unexpected behavior.
rg --type java -A 5 $'collapseLocationComments'

Length of output: 5025

Script:

#!/bin/bash
# Description: Verify the context and usage of the `collapseLocationComments` method in the identified classes.

# Check the usage in ProtobufOneOfField.java
rg --type java -A 10 -B 10 'collapseLocationComments' metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufOneOfField.java

# Check the usage in ProtobufMessage.java
rg --type java -A 10 -B 10 'collapseLocationComments' metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufMessage.java

# Check the usage in ProtobufField.java
rg --type java -A 10 -B 10 'collapseLocationComments' metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufField.java

# Check the usage in ProtobufEnum.java
rg --type java -A 10 -B 10 'collapseLocationComments' metadata-integration/java/datahub-protobuf/src/main/java/datahub/protobuf/model/ProtobufEnum.java

Length of output: 3858

@wngus606 wngus606 mentioned this pull request Jul 24, 2024
Closed
5 tasks
@david-leifker
Copy link
Collaborator

Thanks for this! It has been awhile since I wrote that code, but it was definitely not working with UTF8 characters at one time. I'd be happy to merge this PR if a unit test using a UTF8 character could be added.

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

@david-leifker I have added a unit test for verifying UTF-8 characters in protobuf comments. PTAL! 1f5fd5b

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

Thanks!

@david-leifker david-leifker merged commit e456748 into datahub-project:master Sep 5, 2024
32 checks passed
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

@happyprg happyprg happyprg 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.
3 participants
@eunseokyang @david-leifker @happyprg