fix(models): chart schema fields mapping, add dataHubAction entity, t…

[shirshanka]

This PR does a few things

• Fixes an issue with schema field urn generation in GraphQL for charts where the underlying urn for the field was previously not being used
• Adds dataHubAction as a new entity type (no aspects yet). This allows us to use dataHubAction urns in the source field for attribution
• Adds the testResults aspect to a host of entity types, to support easy sync-ing of metadata test results back to those entities.

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

  • Introduced a new data structure for tracking DataHub actions, enhancing action identification within the system.
  • Added a testResults aspect to multiple entities, improving the capability to manage and track data process test results.
  • Implemented a new GraphQL query to retrieve detailed information about charts based on their unique resource names (URNs).

• Bug Fixes

  • Enhanced error handling and logging in schema field processing, increasing robustness in URN parsing operations.

• Tests

  • Added a comprehensive suite of tests for validating schema fields associated with charts, ensuring reliability in metadata management features.

[coderabbitai]

Walkthrough

The changes enhance the robustness and functionality of the DataHub system. Key updates include improved error handling and logging in the InputFieldsMapper, the introduction of a new DataHubActionKey record for identifying actions, and the addition of the testResults aspect to multiple entities in the metadata model. These modifications collectively strengthen the system's ability to manage data processes and provide better tracking of test outcomes.

Changes

File Path	Change Summary
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/chart/mappers/InputFieldsMapper.java	Enhanced error handling and logging in the apply method, added support for URISyntaxException, and introduced @Slf4j.
metadata-models/src/main/pegasus/com/linkedin/metadata/key/DataHubActionKey.pdl	Introduced DataHubActionKey record with a unique identifier for actions within the DataHub system.
metadata-models/src/main/resources/entity-registry.yml	Added testResults aspect to multiple entities and introduced a new dataHubAction entity with its key aspect.
smoke-test/tests/schema_fields/queries/get_chart_field.gql	Introduced a new GraphQL query to fetch detailed information about a chart based on its URN.
smoke-test/tests/schema_fields/test_schemafields.py	Added a suite of tests for validating schema fields associated with charts, utilizing pytest framework.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InputFieldsMapper
    participant SchemaField
    
    User->>InputFieldsMapper: Invoke apply(schemaField)
    InputFieldsMapper->>SchemaField: Try to parse URN
    alt URN Parsing Successful
        InputFieldsMapper->>User: Return processed InputFields
    else URN Parsing Fails
        InputFieldsMapper->>InputFieldsMapper: Log error message
        InputFieldsMapper->>User: Return original entityUrn
    end

Loading

Poem

🐇 In fields of data, I hop with glee,
Improvements abound, as bright as can be!
With logs that now sing and aspects anew,
Our DataHub blooms, fresh and true.
Together we dance, in code we delight,
Celebrating changes from morning till night! 🌼

---

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 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 9321e94 and 203ff79.

Files selected for processing (3)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/chart/mappers/InputFieldsMapper.java (2 hunks)
• metadata-models/src/main/pegasus/com/linkedin/metadata/key/DataHubActionKey.pdl (1 hunks)
• metadata-models/src/main/resources/entity-registry.yml (22 hunks)

Files skipped from review due to trivial changes (1)

• metadata-models/src/main/pegasus/com/linkedin/metadata/key/DataHubActionKey.pdl

Additional comments not posted (27)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/chart/mappers/InputFieldsMapper.java (4)

8-8: Import for URISyntaxException is appropriate.

The import is necessary for the error handling in the apply method.

---

12-12: Import for Slf4j is appropriate.

The import is necessary for the logging functionality in the class.

---

15-15: Addition of @Slf4j annotation is appropriate.

The annotation is necessary for enabling logging in the class.

---

38-50: Enhanced error handling and logging in apply method.

The changes improve the robustness of the method by handling URISyntaxException and logging errors. The control flow and functionality are enhanced.

Ensure that the logging configuration is correctly set up to capture these logs.

metadata-models/src/main/resources/entity-registry.yml (23)

77-77: Addition of testResults aspect to dataJob is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

99-99: Addition of testResults aspect to dataFlow is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

106-106: Addition of testResults aspect to dataProcess is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

117-117: Addition of testResults aspect to dataProcessInstance is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

143-143: Addition of testResults aspect to chart is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

167-167: Addition of testResults aspect to dashboard is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

185-185: Addition of testResults aspect to notebook is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

203-203: Addition of testResults aspect to corpuser is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

217-217: Addition of testResults aspect to corpGroup is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

228-228: Addition of testResults aspect to domain is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

249-249: Addition of testResults aspect to container is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

258-258: Addition of testResults aspect to tag is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

274-274: Addition of testResults aspect to glossaryTerm is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

285-285: Addition of testResults aspect to glossaryNode is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

357-357: Addition of testResults aspect to dataHubIngestionSource is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

375-375: Addition of testResults aspect to mlModelGroup is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

386-386: Addition of testResults aspect to mlModelDeployment is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

405-405: Addition of testResults aspect to mlFeatureTable is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

424-424: Addition of testResults aspect to mlFeature is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

441-441: Addition of testResults aspect to mlPrimaryKey is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

478-478: Addition of testResults aspect to schemaField is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

546-546: Addition of testResults aspect to dataProduct is appropriate.

The addition enhances the entity by enabling the tracking of test results.

---

574-577: Addition of dataHubAction entity is appropriate.

The addition allows for the use of dataHubAction

[jjoyce0510]

Do we need the other aspects, or I guess that will come in a followup?

[shirshanka]

don't need other aspects - this is required to allow source in metadataAttribution to contain a dataHubAction urn.

[jjoyce0510]

What is the case where this was happening?

[jjoyce0510]

I guess nowhere, just defensive

[jjoyce0510]

I see - this is where the bad mapping was happening. Got it

[shirshanka]

Mainly a protection from bad data - in case we have mal formatted schema field urns.

[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 203ff79 and 00ff600.

Files selected for processing (2)

• smoke-test/tests/schema_fields/queries/get_chart_field.gql (1 hunks)
• smoke-test/tests/schema_fields/test_schemafields.py (1 hunks)

Additional comments not posted (11)

smoke-test/tests/schema_fields/queries/get_chart_field.gql (1)

1-20: LGTM! Ensure the fields are necessary.

The GraphQL query structure is correct and fetches relevant fields. Ensure that all fetched fields are necessary for the intended functionality.

smoke-test/tests/schema_fields/test_schemafields.py (10)

1-25: LGTM! Ensure all imports are necessary.

The imports include necessary modules for testing and DataHub interactions. Ensure that all imported modules are necessary for the tests.

---

27-34: LGTM! Ensure the dataset URNs creation logic is necessary.

The logger setup is correct, and dataset URNs are created using a random start index. Ensure that this logic is necessary for the tests.

---

37-52: LGTM! The FileEmitter class is implemented correctly.

The FileEmitter class is used to emit events to a file sink and is implemented correctly.

---

54-62: LGTM! The fixtures are defined correctly.

The fixtures provide URNs for a chart and an upstream schema field and are defined correctly.

---

64-102: LGTM! The create_test_data function creates necessary test data.

The create_test_data function creates test data for schema fields and is implemented correctly.

---

107-119: LGTM! The ingest_cleanup_data fixture handles test data correctly.

The ingest_cleanup_data fixture creates, ingests, and cleans up test data correctly.

---

122-125: LGTM! The test_healthchecks function serves its purpose.

The test_healthchecks function is a placeholder for health checks and serves its purpose correctly.

---

128-130: LGTM! The get_gql_query function reads the file correctly.

The get_gql_query function reads a GraphQL query from a file and is implemented correctly.

---

133-165: LGTM! The validate_schema_field_urn_for_chart function validates the schema field URN correctly.

The validate_schema_field_urn_for_chart function validates the schema field URN for a chart and is implemented correctly.

---

171-177: LGTM! The test_schema_field_gql_mapper_for_charts function tests the schema field GQL mapper correctly.

The test_schema_field_gql_mapper_for_charts function tests the schema field GQL mapper for charts and is implemented correctly.