feat(deprecation) Return actor entity with deprecation aspect

[chriscollins3456]

Along with the current urn of the actor that we return with a Deprecation aspect to the graphql API, let's also return a hydrated actorEntity. This will be used in the UI later.

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

  • Added support for handling Deprecation entities in GraphQL, enhancing the deprecation tracking capabilities.

• Enhancements

  • Updated Deprecation type in the GraphQL schema to include a new actorEntity field for more detailed information on who deprecated an item.

[coderabbitai]

Walkthrough

This update integrates a new handling capability for the Deprecation entity within the DataHub GraphQL engine. A method to configure deprecation resolvers was added, and the DeprecationMapper was enhanced to map actorEntities. Changes were also made to the GraphQL schema to include a new actorEntity field in the Deprecation type.

Changes

File Path	Change Summary
datahub-graphql-core/src/main/java/.../GmsGraphQLEngine.java	Added configureDeprecationResolvers method to handle deprecation resolvers.
datahub-graphql-core/src/main/java/.../DeprecationMapper.java	Enhanced apply method to set the actorEntity field using UrnToEntityMapper.map().
datahub-graphql-core/src/main/resources/entity.graphql	Updated Deprecation type to include a new actorEntity field of type Entity.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQLServer
    participant GmsGraphQLEngine
    participant DeprecationMapper
    participant ActorEntityMapper

    Client ->> GraphQLServer: Request for Deprecation entity
    GraphQLServer ->> GmsGraphQLEngine: Process Deprecation entity
    GmsGraphQLEngine ->> DeprecationMapper: Map Deprecation fields
    DeprecationMapper ->> ActorEntityMapper: Map Actor to ActorEntity
    ActorEntityMapper -->> DeprecationMapper: Return ActorEntity
    DeprecationMapper -->> GmsGraphQLEngine: Return Deprecation entity with ActorEntity
    GmsGraphQLEngine -->> GraphQLServer: Return complete Deprecation entity
    GraphQLServer -->> Client: Return response with Deprecation entity

Loading

Poem

A change so grand within the code,
Deprecations now do swiftly flowed,
With actors mapped for all to see,
In GraphQL harmony we'll be.
Entities now gained their stage,
As mappers wrote a brand new page.
DataHub sings in joyful glee,
For seamless queries, wild and free.

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 286a3cc and 3d1d964.

Files selected for processing (3)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (3 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/common/mappers/DeprecationMapper.java (1 hunks)
• datahub-graphql-core/src/main/resources/entity.graphql (1 hunks)

Additional comments not posted (3)

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

Line range hint 10-12: LGTM!

The map function correctly delegates to the apply method of the INSTANCE.

---

22-23: LGTM! But verify the UrnToEntityMapper.map function.

The code changes are approved. The new line correctly maps the actor field to the actorEntity field.

However, ensure that the UrnToEntityMapper.map function correctly handles the mapping.

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

8186-8190: Ensure the new field is used correctly in the GraphQL schema.

The new field actorEntity is correctly added to the Deprecation type. Ensure this field is utilized correctly in the GraphQL queries and mutations, and that the corresponding resolver is implemented.

[coderabbitai]

Tip

Codebase Verification

Method configureDeprecationResolvers is not invoked in configureRuntimeWiring.

The configureDeprecationResolvers method is not being called within the configureRuntimeWiring method, which means the deprecation resolvers are not being configured as intended.

• Ensure that configureDeprecationResolvers is invoked within the configureRuntimeWiring method.

Analysis chain

LGTM! Verify the method invocation.

The code changes are approved.

However, ensure that the configureDeprecationResolvers method is correctly invoked in the configureRuntimeWiring method.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that the `configureDeprecationResolvers` method is correctly invoked in the `configureRuntimeWiring` method.

# Test: Search for the method invocation. Expect: The method is invoked.
rg --type java $'configureDeprecationResolvers'

Length of output: 346

---

---

Script:

#!/bin/bash
# Description: Verify the context of the `configureDeprecationResolvers` method invocation within the `configureRuntimeWiring` method.

# Test: Search for the `configureRuntimeWiring` method and its content.
rg --type java 'void configureRuntimeWiring' -A 20

Length of output: 2792

---

---

Script:

#!/bin/bash
# Description: Verify the context of the `configureDeprecationResolvers` method invocation within the `configureRuntimeWiring` method.

# Test: Search for the `configureRuntimeWiring` method and its content, extending the search to capture more lines.
rg --type java 'void configureRuntimeWiring' -A 40

Length of output: 5426