feat(propagation): Add graphql API

[shirshanka]

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 GraphQL schema with types for Documentation, DocumentationAssociation, and MetadataAttribution.
  • Added a documentation field to the SchemaFieldEntity, enhancing metadata details.
  • Enhanced schemaFieldFields and entityField fragments to include new documentation and attribution details.

• Improvements

  • Added constants for better integration within the application.
  • Enhanced metadata attribution handling within the GraphQL API.
  • Refined data mapping processes for documentation and metadata attribution.

• Documentation

  • Updated comments and documentation within the code to improve clarity and understanding.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update significantly enhances the GraphQL schema and associated mappers, focusing on metadata attribution and documentation. New constants and utility classes are introduced to improve the integration of documentation features into the GraphQL API. These changes enrich the metadata capabilities of entities within the system, leading to a more robust and flexible architecture.

Changes

Files	Change Summary
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java	Added COMMON_SCHEMA_FILE and DOCUMENTATION_ASPECT_NAME constants.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java	Introduced configureMetadataAttributionResolver method and updated schema configuration.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/DocumentationMapper.java	Added DocumentationMapper for transforming internal models to GraphQL objects.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/MetadataAttributionMapper.java	Introduced MetadataAttributionMapper for mapping metadata attribution to GraphQL models.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldMapper.java	Enhanced apply method to utilize DocumentationMapper.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldType.java	Updated ASPECTS_TO_FETCH to include DOCUMENTATION_ASPECT_NAME.
datahub-graphql-core/src/main/resources/common.graphql	Defined new types: Documentation, DocumentationAssociation, and MetadataAttribution.
datahub-graphql-core/src/main/resources/entity.graphql	Added documentation field to SchemaFieldEntity.
datahub-web-react/src/graphql/fragments.graphql	Enhanced schemaFieldFields fragment with new documentation and nested structures.
datahub-web-react/src/graphql/search.graphql	Expanded entityField fragment structure in SchemaFieldEntity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GmsGraphQLEngine
    participant DocumentationMapper
    participant MetadataAttributionMapper
    
    User->>GmsGraphQLEngine: Request data
    GmsGraphQLEngine->>DocumentationMapper: Transform Documentation model
    GmsGraphQLEngine->>MetadataAttributionMapper: Transform Metadata Attribution model
    DocumentationMapper->>GmsGraphQLEngine: Return transformed Documentation
    MetadataAttributionMapper->>GmsGraphQLEngine: Return transformed Metadata Attribution
    GmsGraphQLEngine->>User: Send response with enriched data

Loading

Poem

In the meadow where rabbits play,
New schemas hop and dance today.
With docs and metadata bright,
They weave a tapestry of light.
Hooray for changes, let them bloom,
In code they jump, dispelling gloom! 🐰✨

---

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 da72ba2 and bd80760.

Files selected for processing (11)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (6 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/DocumentationMapper.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/MetadataAttributionMapper.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldMapper.java (2 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldType.java (2 hunks)
• datahub-graphql-core/src/main/resources/common.graphql (1 hunks)
• datahub-graphql-core/src/main/resources/entity.graphql (1 hunks)
• datahub-web-react/src/graphql/fragments.graphql (1 hunks)
• datahub-web-react/src/graphql/search.graphql (1 hunks)
• li-utils/src/main/java/com/linkedin/metadata/Constants.java (3 hunks)

Files skipped from review due to trivial changes (1)

• li-utils/src/main/java/com/linkedin/metadata/Constants.java

Additional comments not posted (22)

datahub-graphql-core/src/main/resources/common.graphql (3)

1-9: LGTM!

The Documentation type is correctly defined with a single field documentations which is a list of DocumentationAssociation.

---

11-24: LGTM!

The DocumentationAssociation type is correctly defined with three fields: documentation, attribution, and sourceDetail.

---

26-49: LGTM!

The MetadataAttribution type is correctly defined with four fields: time, actor, source, and sourceDetail.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/MetadataAttributionMapper.java (3)

1-13: LGTM!

The singleton pattern is correctly implemented with a private constructor and a public static instance.

---

14-18: LGTM!

The map method is correctly implemented and adheres to best practices.

---

20-34: LGTM!

The apply method is correctly implemented and adheres to best practices.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/Constants.java (1)

27-27: LGTM!

The new constant COMMON_SCHEMA_FILE is correctly defined and added to the list of schema files.

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

19-23: LGTM!

The map method correctly uses the apply method of the singleton instance.

---

25-35: LGTM!

The apply method correctly maps documentation associations using the mapDocAssociation method.

---

37-46: LGTM!

The mapDocAssociation method correctly maps the documentation and attribution fields.

---

48-53: LGTM!

The mapConnectionEntity method correctly sets the URN and type fields.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldMapper.java (2)

12-12: LGTM!

The import statement for DocumentationMapper is correct and necessary for the new functionality.

---

50-53: LGTM!

The enhancement correctly maps documentation attributes to the SchemaFieldEntity using the DocumentationMapper.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/schemafield/SchemaFieldType.java (2)

3-3: LGTM!

The import statement for DOCUMENTATION_ASPECT_NAME is correct and necessary for the new functionality.

---

33-34: LGTM!

The enhancement correctly includes the documentation aspect in the set of aspects to fetch.

datahub-web-react/src/graphql/search.graphql (1)

977-982: Ensure proper usage of entityDisplayNameFields and platformFields.

The addition of entityDisplayNameFields and the conditional fragment for Dataset to retrieve the platform field enhances the data representation. Verify that these fields are correctly defined and used in the schema.

Verification successful

---

Ensure proper usage of entityDisplayNameFields and platformFields.

The fragments entityDisplayNameFields and platformFields are defined and utilized in various .graphql files within the codebase. This confirms that the fields are correctly integrated into the schema.

• entityDisplayNameFields definition and usage:

  • Defined in datahub-web-react/src/graphql/fragments.graphql
  • Used in multiple files, including datahub-web-react/src/graphql/search.graphql and datahub-web-react/src/graphql/fragments.graphql

• platformFields definition and usage:

  • Defined in datahub-web-react/src/graphql/fragments.graphql
  • Used in multiple files, including datahub-web-react/src/graphql/search.graphql, datahub-web-react/src/graphql/preview.graphql, and datahub-web-react/src/graphql/lineage.graphql

These findings confirm that the fragments are correctly defined and utilized in the schema.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the definitions and usage of `entityDisplayNameFields` and `platformFields`.

# Test: Search for the definitions of `entityDisplayNameFields` and `platformFields`. Expect: Definitions should be present.
rg --type graphql -A 5 $'fragment entityDisplayNameFields'
rg --type graphql -A 5 $'fragment platformFields'

Length of output: 174

---

Script:

#!/bin/bash
# Description: Verify the definitions and usage of `entityDisplayNameFields` and `platformFields`.

# Find all .graphql files and search for the definitions of `entityDisplayNameFields` and `platformFields`.
fd -e graphql -x rg 'fragment entityDisplayNameFields' {} +
fd -e graphql -x rg 'fragment platformFields' {} +

Length of output: 7109

---

Script:

#!/bin/bash
# Description: Verify the usage of `entityDisplayNameFields` and `platformFields` in the codebase.

# Search for the usage of `entityDisplayNameFields` and `platformFields` in the codebase.
rg '...entityDisplayNameFields' --glob '*.graphql'
rg '...platformFields' --glob '*.graphql'

Length of output: 6826

datahub-web-react/src/graphql/fragments.graphql (1)

739-769: Ensure proper usage of documentation and parent fields.

The addition of documentation and parent fields with nested structures enhances the metadata representation. Verify that these fields are correctly defined and used in the schema.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (4)

99-99: Import statement for MetadataAttribution looks good.

The import statement is necessary for the new functionality.

---

3185-3199: Method configureMetadataAttributionResolver looks good.

The method correctly configures data fetchers for the actor and source fields of the MetadataAttribution type.

---

795-795: Method call to configureMetadataAttributionResolver looks good.

The method call correctly integrates the new resolver configuration into the runtime wiring.

---

849-850: Method call to fileBasedSchema looks good.

The method call correctly integrates the new schema file COMMON_SCHEMA_FILE into the GraphQL engine's schema configuration.

datahub-graphql-core/src/main/resources/entity.graphql (1)

3228-3232: LGTM! Verify the usage of the new field in the codebase.

The addition of the documentation field to the SchemaFieldEntity type is well-integrated and consistent with the existing schema structure.

However, ensure that the new field is utilized correctly in the codebase.

[chriscollins3456]

looks good just one line to add from my comment!

[chriscollins3456]

one thing that's missing is adding the new common.graphql file on the backend to our docs website auto-generation list. So we can add the following line to docs-website/graphql/generateGraphQLSchema.sh:

cat ../../datahub-graphql-core/src/main/resources/common.graphql >> combined.graphql