fix(ingest): improve auto_materialize_referenced_tags_terms error handling

[hsheth2]

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

• Bug Fixes
  • Improved error messages for invalid URNs, providing additional context.
  • Enhanced validation to handle reserved characters more explicitly in URNs.
  • Added error handling to better manage invalid URN scenarios during data ingestion.

[coderabbitai]

Walkthrough

The recent updates improve error handling and validation processes in avro_codegen.py and source_helpers.py. Specifically, generate_urn_class now provides more detailed error messages and explicit handling of reserved characters. Additionally, auto_materialize_referenced_tags_terms in source_helpers.py now imports and handles InvalidUrnError exceptions, enhancing robustness.

Changes

File Path	Change Summary
metadata-ingestion/scripts/avro_codegen.py	Enhanced error messages in generate_urn_class and improved handling of reserved characters.
metadata-ingestion/src/datahub/ingestion/...	Imported InvalidUrnError and added error handling in auto_materialize_referenced_tags_terms.

Poem

In code so fine, changes bloom,
Errors caught in brighter room,
With careful checks and clearer lines,
Our URN class now brightly shines.
Tags and terms, no longer stray,
In perfect order, they now stay.
🐇✨

---

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 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 Configration 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 a4bce6a and dcc0283.

Files selected for processing (2)

• metadata-ingestion/scripts/avro_codegen.py (2 hunks)
• metadata-ingestion/src/datahub/ingestion/api/source_helpers.py (2 hunks)

Additional comments not posted (3)

metadata-ingestion/src/datahub/ingestion/api/source_helpers.py (2)

40-40: Import statement looks good.

The import statement for InvalidUrnError is necessary for the error handling added later in the file.

---

176-187: Error handling looks good.

The error handling for InvalidUrnError ensures that invalid URNs are properly managed and logged without causing the function to fail.

However, ensure that the usage of InvalidUrnError is consistent and correctly implemented across the codebase.

Verification successful

---

The usage of InvalidUrnError is consistent and correctly implemented across the codebase.

The error handling for InvalidUrnError ensures that invalid URNs are properly managed and logged without causing the function to fail. The usage of InvalidUrnError is consistent across various files, including _urn_base.py, source_helpers.py, and multiple test files.

• metadata-ingestion/src/datahub/utilities/urns/_urn_base.py
• metadata-ingestion/src/datahub/ingestion/api/source_helpers.py
• Various test files under metadata-ingestion/tests/unit/urns/

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `InvalidUrnError` in the codebase.

# Test: Search for the usage of `InvalidUrnError`. Expect: Consistent and correct implementation.
rg --type python 'InvalidUrnError'

Length of output: 65

---

Script:

#!/bin/bash
# Description: Verify the usage of `InvalidUrnError` in the codebase.

# Test: Search for the usage of `InvalidUrnError`. Expect: Consistent and correct implementation.
rg -t py 'InvalidUrnError'

Length of output: 6132

metadata-ingestion/scripts/avro_codegen.py (1)

Line range hint 583-604: Enhanced error messages and validation look good.

The error messages now include the class name and field name for better clarity. The handling of reserved characters is more explicit, improving validation.

However, ensure that the usage of generate_urn_class is consistent and correctly implemented across the codebase.

Verification successful

---

Enhanced error messages and validation look good.

The error messages now include the class name and field name for better clarity. The handling of reserved characters is more explicit, improving validation.

• The function generate_urn_class is used consistently and correctly implemented across the codebase.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `generate_urn_class` in the codebase.

# Test: Search for the usage of `generate_urn_class`. Expect: Consistent and correct implementation.
rg --type python 'generate_urn_class'

Length of output: 68

---

Script:

#!/bin/bash
# Description: Verify the usage of `generate_urn_class` in the codebase.

# Find all Python files and search for the usage of `generate_urn_class`.
fd -e py -x rg 'generate_urn_class' {}

Length of output: 163

---

Script:

#!/bin/bash
# Description: Extract context around the usage and definition of `generate_urn_class`.

# Search for the definition and usage of `generate_urn_class` and include context lines.
fd -e py -x rg -A 5 -B 5 'generate_urn_class' {}

Length of output: 770