Fix: bug fix for empty key values pair in elastic search mapping

[milindgupta9]

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 by CodeRabbit

• New Features

  • Enhanced handling of input format in search document processing to improve robustness.
  • Expanded capabilities of test entity information retrieval for more dynamic input.

• Bug Fixes

  • Improved prevention of runtime exceptions related to input string formats.

• Tests

  • Added new assertions in the test suite to validate the transformation logic, ensuring expected JSON structure.

[coderabbitai]

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 code changes enhance the robustness of the SearchDocumentTransformer by improving the handling of the fieldValue string, preventing runtime exceptions. Additionally, the TestEntityUtil class now accepts an extra parameter, expanding its functionality. The test suite has also been updated to verify new data structures, ensuring comprehensive validation of changes made in the transformation logic.

Changes

File	Change Summary
.../SearchDocumentTransformer.java	Improved handling of fieldValue in setSearchableValue to prevent ArrayIndexOutOfBoundsException.
.../TestEntityUtil.java	Modified getTestEntityInfo method to include an additional parameter (key3, value3), enhancing its functionality.
.../SearchDocumentTransformerTest.java	Added assertion in testTransform to check for the presence of "key3" in the JSON response, improving test coverage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SearchDocumentTransformer
    participant TestEntityUtil
    participant JSONParser

    User->>SearchDocumentTransformer: Call setSearchableValue(fieldValue)
    SearchDocumentTransformer->>JSONParser: Parse fieldValue
    JSONParser-->>SearchDocumentTransformer: Return parsed key-values
    SearchDocumentTransformer->>User: Return transformed document

    User->>TestEntityUtil: Call getTestEntityInfo(urn, key3, value3)
    TestEntityUtil-->>User: Return TestEntityInfo

Loading

Poem

🐰 In fields of code, where data flows,
A rabbit hops, and knowledge grows.
With checks in place, no more despair,
For every key, we handle with care.
Our tests now dance, with joy they sing,
To celebrate the changes spring! 🌸

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[coderabbitai]

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 304fc4e and 1d281b7.

Files selected for processing (3)

• metadata-io/src/main/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformer.java (1 hunks)
• metadata-io/src/test/java/com/linkedin/metadata/TestEntityUtil.java (1 hunks)
• metadata-io/src/test/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformerTest.java (1 hunks)

Additional comments not posted (3)

metadata-io/src/test/java/com/linkedin/metadata/TestEntityUtil.java (1)

68-69: Ensure the new key-value pair is necessary.

The addition of the "key3" key with an empty string value to the customProperties map should be verified to ensure it is necessary and correctly handled downstream.

metadata-io/src/test/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformerTest.java (1)

88-88: LGTM!

The new assertion correctly verifies that the value of the "key3" field within the "esObjectField" object in the parsed JSON is an empty string.

metadata-io/src/main/java/com/linkedin/metadata/search/transformer/SearchDocumentTransformer.java (1)

290-293: LGTM!

The added check correctly handles cases where the fieldValue string does not contain an equal sign, preventing potential runtime exceptions.

[david-leifker]

Thanks!

[david-leifker]

@milindgupta9 - Please take a look at the test failures in the following module.

> Task :metadata-io:test FAILED

[milindgupta9]

@david-leifker your approval is required. Can you approve it?

[david-leifker]

@milindgupta9 - Please take a look at the failing metadata-io:test, from the log here.

879 tests completed, 3 failed, 71 skipped

> Task :metadata-io:test FAILED

[milindgupta9]

@david-leifker I have fixed unit tests, can you take a pass now.

[david-leifker]

Nice, tests passing. Thank you!

[milindgupta9]

Thanks @david-leifker for merging the PR