fix(backend): allow excluding soft-deleted entities in relationship-queries; exclude soft-deleted members of groups

[ksrinath]

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 GraphQL API to include an includeSoftDelete parameter for filtering relationships, allowing users to specify if soft-deleted entities should be included in query results.
  • Updated input structure for relationship queries to support more nuanced data retrieval.

• Bug Fixes

  • Improved the filtering logic for entity existence checks to be case-insensitive, ensuring greater robustness in the identification of entities.

• Tests

  • Added comprehensive unit tests to validate the behavior of the EntityRelationshipsResultResolver and the exists method, enhancing overall test coverage.

[coderabbitai]

Walkthrough

This update enhances the GraphQL API's ability to manage entity relationships by introducing an option to include or exclude soft-deleted entities. The modifications span resolver classes and GraphQL input types, significantly improving data-fetching capabilities and filtering logic. Additionally, new unit tests were added to ensure robustness, allowing for more nuanced interactions with the API.

Changes

Files	Change Summary
datahub-graphql-core/.../GmsGraphQLEngine.java	Enhanced configureCorpGroupResolvers to include entityService in EntityRelationshipsResultResolver.
datahub-graphql-core/.../resolvers/load/EntityRelationshipsResultResolver.java	Added constructor and modified methods to support includeSoftDelete for refined relationship filtering.
datahub-graphql-core/.../entity.graphql	Introduced includeSoftDelete field to RelationshipsInput, defaulting to true.
datahub-graphql-core/.../resolvers/load/EntityRelationshipsResultResolverTest.java	Added unit tests to validate behavior of EntityRelationshipsResultResolver regarding soft-deletion.
datahub-web-react/.../group.graphql	Modified several queries to include includeSoftDelete parameter in relationship inputs.
metadata-io/.../EntityServiceImpl.java	Updated exists method for case-insensitive schema name comparison.
metadata-io/.../EntityServiceTest.java	Added testExists method to validate entity existence checks with soft-deletion logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Resolver
    participant EntityService

    Client->>API: Query with RelationshipsInput
    API->>Resolver: Pass input to resolve relationships
    Resolver->>EntityService: Check existence (includeSoftDelete)
    EntityService-->>Resolver: Return existing entities
    Resolver-->>API: Return filtered relationships
    API-->>Client: Return response with relationships

Loading

🐇 In the fields where I hop and play,
New features bloom like flowers in May.
With soft-deletes, I now can choose,
To see or hide, I win, I won’t lose!
Hooray for changes, oh what a treat,
In the world of data, a rabbit's sweet feat! 🌼✨

---

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 3733a40 and b8759e2.

Files selected for processing (7)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/GmsGraphQLEngine.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (4 hunks)
• datahub-graphql-core/src/main/resources/entity.graphql (1 hunks)
• datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolverTest.java (1 hunks)
• datahub-web-react/src/graphql/group.graphql (5 hunks)
• metadata-io/src/main/java/com/linkedin/metadata/entity/EntityServiceImpl.java (1 hunks)
• metadata-io/src/test/java/com/linkedin/metadata/entity/EntityServiceTest.java (1 hunks)

Additional comments not posted (21)

datahub-graphql-core/src/test/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolverTest.java (3)

1-23: LGTM! Imports are correct and necessary.

The imports include necessary libraries and classes for testing, mocking, and assertions.

---

25-95: LGTM! Class setup is comprehensive and correct.

The class EntityRelationshipsResultResolverTest includes setup methods, mock objects, and test data initialization.

---

97-117: LGTM! Test cases are correctly testing the functionality.

The file includes two test cases: testIncludeSoftDeleted and testExcludeSoftDeleted.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (4)

Line range hint 1-22:
LGTM! Imports are correct and necessary.

The imports include necessary libraries and classes for the resolver functionality.

---

35-44: LGTM! Class setup is enhanced correctly.

The class EntityRelationshipsResultResolver includes a new constructor and modified methods to handle entity relationships more effectively.

---

61-70: LGTM! The get method is updated correctly.

The get method has been updated to include a new parameter, includeSoftDelete, allowing for more nuanced handling of entity relationships.

---

89-110: LGTM! The mapEntityRelationships method is updated correctly.

The mapEntityRelationships method has been updated to include a new parameter, includeSoftDelete, enhancing the filtering logic.

datahub-web-react/src/graphql/group.graphql (5)

51-51: LGTM! The getGroup query is modified correctly.

The getGroup query has been modified to include includeSoftDelete: false in the relationships input, ensuring that soft-deleted entities are excluded from the query results.

---

90-90: LGTM! The getAllGroupMembers query is modified correctly.

The getAllGroupMembers query has been modified to include includeSoftDelete: false in the relationships input, ensuring that soft-deleted entities are excluded from the query results.

---

132-132: LGTM! The getGroupMembers query is modified correctly.

The getGroupMembers query has been modified to include includeSoftDelete: false in the relationships input, ensuring that soft-deleted entities are excluded from the query results.

---

174-174: LGTM! The getNativeGroupMembers query is modified correctly.

The getNativeGroupMembers query has been modified to include includeSoftDelete: false in the relationships input, ensuring that soft-deleted entities are excluded from the query results.

---

235-235: LGTM! The listGroups query is modified correctly.

The listGroups query has been modified to include includeSoftDelete: false in the relationships input, ensuring that soft-deleted entities are excluded from the query results.

metadata-io/src/test/java/com/linkedin/metadata/entity/EntityServiceTest.java (6)

2151-2155: Ensure URNs are correctly set up.

The URNs existentUrn, softDeletedUrn, nonExistentUrn, and noStatusUrn are correctly defined. Ensure these URNs are used consistently throughout the test.

---

2157-2159: Initialize metadata once.

The SystemMetadata is created once and reused, which is efficient.

---

2160-2165: Ingest aspects for noStatusUrn.

The CorpUserInfo aspect is ingested for noStatusUrn to ensure its existence without a status.

---

2167-2171: Ingest aspects for existentUrn.

The Status aspect is added to existentUrn and ingested, ensuring it is not marked as removed.

---

2173-2177: Ingest aspects for softDeletedUrn.

The Status aspect is updated to removed and ingested for softDeletedUrn.

---

2179-2184: Verify the exists method's behavior.

The assertions correctly verify that:

1. Only existentUrn and noStatusUrn are returned when soft-deleted entities are excluded.
2. existentUrn, noStatusUrn, and softDeletedUrn are returned when soft-deleted entities are included.

These assertions ensure the exists method behaves as expected under different conditions.

metadata-io/src/main/java/com/linkedin/metadata/entity/EntityServiceImpl.java (1)

2179-2180: Change approved: Use case-insensitive comparison for aspect schema name.

Changing from equals() to equalsIgnoreCase() ensures that aspects are correctly identified regardless of letter casing, improving robustness.

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

1873-1874: Ensure the correct usage of entityService.

The additional parameter entityService in the EntityRelationshipsResultResolver constructor should be correctly utilized within the resolver.

Verify that the entityService is correctly used within the EntityRelationshipsResultResolver class and its methods.

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

1270-1274: LGTM! Ensure default value handling in resolver logic.

The new field includeSoftDelete in the RelationshipsInput input type allows clients to specify whether to include soft-deleted related entities in their queries. Ensure that the resolver logic correctly handles the default value of true.

[pedro93]

Code LGTM, has this been tested in instances with a substantial amount of relationships (100+)?
What's the performance impact of doing existence checks for all of the 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 b8759e2 and 69a1222.

Files selected for processing (1)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (4 hunks)

Additional comments not posted (9)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (9)

16-16: LGTM!

The import statement for EntityService is necessary for the new functionality.

---

35-36: LGTM!

The private final field _entityService is necessary for the new functionality.

---

38-39: LGTM!

The existing constructor has been updated to call the new constructor with null for the EntityService parameter.

---

41-44: LGTM!

The new constructor that accepts an EntityService parameter is necessary for the new functionality.

---

61-62: LGTM!

The addition of the includeSoftDelete parameter extracted from the input object is necessary for the new functionality.

---

69-70: LGTM!

The inclusion of the includeSoftDelete parameter in the mapEntityRelationships method call is necessary for the new functionality.

---

89-90: LGTM!

The addition of the includeSoftDelete parameter to the mapEntityRelationships method signature is necessary for the new functionality.

---

93-102: LGTM!

The logic to create a set of all related URNs and filter them based on the includeSoftDelete parameter is necessary for the new functionality.

---

107-110: LGTM!

The filtering logic in the stream to exclude soft-deleted entities based on the includeSoftDelete parameter is necessary for the new functionality.

[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 69a1222 and a6dfa9d.

Files selected for processing (1)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (4 hunks)

Additional comments not posted (7)

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/load/EntityRelationshipsResultResolver.java (7)

35-36: Initialize _entityService field.

The _entityService field is correctly initialized in the new constructor.

---

38-39: Delegate to the new constructor.

The existing constructor correctly delegates to the new constructor with null for _entityService.

---

61-62: Extract includeSoftDelete parameter.

The includeSoftDelete parameter is correctly extracted from the input object.

---

69-70: Pass includeSoftDelete parameter.

The includeSoftDelete parameter is correctly passed to the mapEntityRelationships method.

---

89-90: Include includeSoftDelete parameter.

The includeSoftDelete parameter is correctly included in the method signature.

---

93-102: Filter relationships based on includeSoftDelete.

The logic for filtering relationships based on the existence of entities when includeSoftDelete is false is correctly implemented.

---

107-110: Filter viewable relationships.

The logic for filtering viewable relationships based on the existence of entities and view permissions is correctly implemented.

[RyanHolstien]

Approved pending load test results requested by Pedro. I don't think this will significantly impact performance, but it has a large blast radius (all searches) so we should confirm that it does not impact search performance if it is going to be utilized by the UI.

[asikowitz]

Can you add filtered to EntityRelationshipsResult.pdl and populate it with the count of items filtered out by the soft deletion check.

You can look at EntityLineageResult.pdl for an example.

[asikowitz]

Also, can you add the same parameter and apply the same filter to the EntityWithLineage.lineage graphql query. So that means adding includeSoftDelete to LineageInput and updating EntityLineageResultResolver to apply the same filter. Thanks!

Out of scope of the ticket

[asikowitz]

@anshbansal can we schedule work for the above changes? (request from John)