feat(siblings) Add flag to prevent combining siblings in the UI

[chriscollins3456]

This PR adds a new flag that disables combining siblings in the UI so that we always show the separate view. This really applies to search results, entity profile pages, autocomplete, and lineage. The only custom behavior is that we show the "Composed of" section still so that an entity can still see their siblings if they exist, there's just no combined page.

So if this flag is turned on, siblings really just becomes a new section in the entity sidebar that shows you the other siblings related to you.

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 a new feature flag, showSeparateSiblings, to control the visibility of sibling entities across the application.
  • Enhanced the search and display logic to adapt based on the showSeparateSiblings configuration.

• Bug Fixes

  • Improved the rendering behavior of sibling entities in various components, ensuring correct visibility based on the new configuration.

• Documentation

  • Updated application configuration documentation to include details on the showSeparateSiblings feature flag and its effects.

[coderabbitai]

Walkthrough

The recent changes introduce a new feature flag, showSeparateSiblings, enabling enhanced control over the display of sibling entities throughout the application. This new capability allows users to tailor their experience based on preferences for sibling visibility, improving overall usability and flexibility within the user interface.

Changes

Files	Change Summary
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/featureflags/FeatureFlags.java, datahub-graphql-core/src/main/resources/app.graphql	Added a new boolean field, showSeparateSiblings, to manage visibility of siblings in feature flags and GraphQL.
datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/config/AppConfigResolver.java	Updated AppConfigResolver to retrieve and set the new showSeparateSiblings feature flag in application config.
datahub-web-react/src/app/entity/shared/containers/profile/header/PlatformContent/PlatformContentView.tsx, datahub-web-react/src/app/entity/shared/containers/profile/sidebar/SidebarSiblingsSection.tsx	Introduced logic to conditionally render sibling platforms based on showSeparateSiblings.
datahub-web-react/src/app/search/SearchBar.tsx, datahub-web-react/src/app/search/SearchResults.tsx, datahub-web-react/src/app/search/autoComplete/AutoCompleteEntity.tsx	Integrated showSeparateSiblings into search functionalities to modify sibling handling in results.
datahub-web-react/src/app/useAppConfig.ts	Added a new hook, useIsShowSeparateSiblingsEnabled, to check for the feature flag in app configuration.
metadata-service/configuration/src/main/resources/application.yaml	Introduced the showSeparateSiblings feature flag in the metadata service configuration, defaulting to false.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AppConfig
    participant FeatureFlags
    participant UIComponents

    User->>AppConfig: Request App Configuration
    AppConfig->>FeatureFlags: Check for showSeparateSiblings
    FeatureFlags-->>AppConfig: Return showSeparateSiblings value
    AppConfig-->>User: Provide updated settings
    User->>UIComponents: Display UI based on settings
    UIComponents->>UIComponents: Render siblings based on showSeparateSiblings

Loading

Poem

🐇 In the garden of code, a change did bloom,
A flag for siblings, dispelling the gloom.
With a hop and a skip, we toggle with glee,
Visibility now dances, oh what joy to see!
So let the siblings frolic, side by side,
In this whimsical world, let our features abide! 🌼

---

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

Outside diff range, codebase verification and nitpick comments (8)

datahub-web-react/src/appConfigContext.tsx (1)

57-57: Add a comment for the new configuration property.

To maintain consistency and improve readability, add a comment explaining the purpose of the showSeparateSiblings property.

+        // Flag to show separate siblings instead of combining them
        showSeparateSiblings: false,

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

72-72: Add a comment for the new GraphQL field.

To maintain consistency and improve readability, add a comment explaining the purpose of the showSeparateSiblings field.

+            # Flag to show separate siblings instead of combining them
            showSeparateSiblings

datahub-web-react/src/app/entity/shared/containers/profile/sidebar/SidebarSiblingsSection.tsx (6)

10-10: Add a comment for the new hook import.

To maintain consistency and improve readability, add a comment explaining the purpose of the useIsShowSeparateSiblingsEnabled hook.

+// Hook to check if the showSeparateSiblings flag is enabled
import { useIsShowSeparateSiblingsEnabled } from '../../../../../useAppConfig';

---

20-20: Add a comment for the new configuration variable.

To maintain consistency and improve readability, add a comment explaining the purpose of the showSeparateSiblings variable.

+    // Check if the showSeparateSiblings flag is enabled
    const showSeparateSiblings = useIsShowSeparateSiblingsEnabled();

---

27-27: Fix the comment formatting.

Ensure consistent comment formatting throughout the file.

-    // showSeparateSiblings disables the combined view, but with this flag on we show siblings in the sidebar to navigate to them
+    // The showSeparateSiblings flag disables the combined view, but with this flag on we show siblings in the sidebar to navigate to them

---

42-44: Add a comment for the conditional logic.

To maintain consistency and improve readability, add a comment explaining the conditional logic for allSiblingsInGroup.

+    // Conditionally combine sibling entities based on the showSeparateSiblings flag
    const allSiblingsInGroup = showSeparateSiblings
        ? (siblingEntities as Dataset[])
        : ([...siblingEntities, entityDataWithoutSiblings] as Dataset[]);

---

48-50: Add a comment for the empty state check.

To maintain consistency and improve readability, add a comment explaining the empty state check.

+    // Return an empty fragment if no siblings exist after applying the new logic
    if (!allSiblingsInGroupThatExist.length) {
        return <></>;
    }

---

54-54: Add a comment for the safety check.

To maintain consistency and improve readability, add a comment explaining the safety check for the sibling group.

+    // Safety check: Do not render if the sibling group contains only the current entity
    if (!showSeparateSiblings && allSiblingsInGroupThatExist.length <= 1) {
        return <></>;
    }

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 30e9cfd and 9e07075.

Files selected for processing (16)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/featureflags/FeatureFlags.java (1 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/config/AppConfigResolver.java (1 hunks)
• datahub-graphql-core/src/main/resources/app.graphql (1 hunks)
• datahub-web-react/src/app/entity/shared/containers/profile/header/PlatformContent/PlatformContentView.tsx (4 hunks)
• datahub-web-react/src/app/entity/shared/containers/profile/sidebar/SidebarSiblingsSection.tsx (3 hunks)
• datahub-web-react/src/app/entity/shared/siblingUtils.ts (2 hunks)
• datahub-web-react/src/app/lineage/controls/LineageVizToggles.tsx (3 hunks)
• datahub-web-react/src/app/search/SearchBar.tsx (4 hunks)
• datahub-web-react/src/app/search/SearchResults.tsx (2 hunks)
• datahub-web-react/src/app/search/autoComplete/AutoCompleteEntity.tsx (1 hunks)
• datahub-web-react/src/app/search/utils/combineSiblingsInSearchResults.test.ts (2 hunks)
• datahub-web-react/src/app/search/utils/combineSiblingsInSearchResults.ts (1 hunks)
• datahub-web-react/src/app/useAppConfig.ts (1 hunks)
• datahub-web-react/src/appConfigContext.tsx (1 hunks)
• datahub-web-react/src/graphql/app.graphql (1 hunks)
• metadata-service/configuration/src/main/resources/application.yaml (1 hunks)

Additional comments not posted (25)

datahub-web-react/src/app/useAppConfig.ts (1)

31-34: LGTM!

The new function useIsShowSeparateSiblingsEnabled is consistent with the existing pattern for feature flag functions.

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

24-24: LGTM!

The new field showSeparateSiblings is consistent with the existing pattern for feature flags.

datahub-web-react/src/app/search/utils/combineSiblingsInSearchResults.ts (1)

12-21: Ensure correct handling of showSeparateSiblings parameter.

The new parameter showSeparateSiblings alters the logic of how sibling entities are combined. Ensure that this parameter is correctly passed and handled throughout the codebase.

Verification successful

---

Ensure correct handling of showSeparateSiblings parameter.

The showSeparateSiblings parameter is correctly passed and handled in the combineSiblingsInSearchResults function usage within the codebase.

• datahub-web-react/src/app/search/SearchResults.tsx: The parameter is correctly passed to the function.
• datahub-web-react/src/app/search/utils/combineSiblingsInSearchResults.test.ts: The parameter is used in tests to verify different behaviors.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `combineSiblingsInSearchResults` function with the new parameter.

# Test: Search for the function usage. Expect: Correct handling of the new parameter.
rg --type javascript -A 5 $'combineSiblingsInSearchResults'

Length of output: 93

---

Script:

#!/bin/bash
# Description: Verify the usage of `combineSiblingsInSearchResults` function with the new parameter.

# Test: Search for the function usage. Expect: Correct handling of the new parameter.
rg 'combineSiblingsInSearchResults' -A 5

Length of output: 5229

---

Script:

#!/bin/bash
# Description: Verify all usages of `combineSiblingsInSearchResults` function with the new parameter.

# Test: Search for all instances of the function usage. Expect: Correct handling of the new parameter.
rg 'combineSiblingsInSearchResults' -A 5

Length of output: 5229

datahub-web-react/src/app/lineage/controls/LineageVizToggles.tsx (3)

11-11: New import for configuration state.

The import statement for useIsShowSeparateSiblingsEnabled is added to fetch the configuration state.

---

42-42: New hook usage to determine sibling visibility.

The useIsShowSeparateSiblingsEnabled hook is used to fetch the state of showSeparateSiblings.

---

56-77: Conditional rendering of "Compress Lineage" toggle.

The "Compress Lineage" toggle is now conditionally rendered based on the showSeparateSiblings state.

datahub-web-react/src/app/search/autoComplete/AutoCompleteEntity.tsx (2)

69-75: New logic for determining platforms to display.

The platformsToShow variable is introduced to determine which platforms to display based on the presence of siblings. The logic ensures that sibling platforms are only displayed when explicitly included.

---

75-75: Update to use platformsToShow.

The platforms variable is updated to use platformsToShow instead of directly referencing genericEntityProps?.siblingPlatforms.

datahub-web-react/src/app/entity/shared/containers/profile/header/PlatformContent/PlatformContentView.tsx (4)

15-15: New import for configuration state.

The import statement for useIsShowSeparateSiblingsEnabled is added to fetch the configuration state.

---

104-107: New variables for sibling platform visibility.

The variables shouldShowSeparateSiblings, showSiblingPlatformLogos, and showSiblingPlatformNames are introduced to determine whether to display sibling platform logos and names separately.

---

118-121: Conditional rendering of platform logos.

The rendering logic for platform logos is updated to use showSiblingPlatformLogos.

---

130-130: Conditional rendering of platform names.

The rendering logic for platform names is updated to use showSiblingPlatformNames.

datahub-web-react/src/app/entity/shared/siblingUtils.ts (2)

7-7: Import statement looks good.

The import statement correctly adds the useIsShowSeparateSiblingsEnabled hook.

---

271-275: Function modification looks good.

The function correctly integrates the new configuration setting and query parameter logic.

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

500-504: New field addition looks good.

The new field showSeparateSiblings is correctly defined and documented.

datahub-web-react/src/app/search/SearchResults.tsx (2)

32-32: Import statement looks good.

The import statement correctly adds the useIsShowSeparateSiblingsEnabled hook.

---

177-181: Component modification looks good.

The component correctly integrates the new state and updates the logic for combining sibling search results.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/config/AppConfigResolver.java (1)

189-189: Ensure proper handling of new feature flag showSeparateSiblings.

The addition of the new feature flag showSeparateSiblings looks correct. Ensure that its value is properly set and used in the application.

datahub-web-react/src/app/search/SearchBar.tsx (4)

27-27: Dependency on new hook useIsShowSeparateSiblingsEnabled.

The import of useIsShowSeparateSiblingsEnabled is correct and necessary for the new feature flag functionality.

---

161-162: Correct usage of the new hook to set finalCombineSiblings.

The logic to set finalCombineSiblings based on the value of isShowSeparateSiblingsEnabled is correct and ensures the intended behavior.

---

229-231: Ensure proper handling of finalCombineSiblings in combineSiblingsInAutoComplete.

The changes correctly pass finalCombineSiblings to the combineSiblingsInAutoComplete function, ensuring the new feature flag is respected.

---

240-240: Conditional rendering of siblings based on finalCombineSiblings.

The conditional rendering of siblings in AutoCompleteItem based on finalCombineSiblings is correct and ensures the intended behavior.

datahub-web-react/src/app/search/utils/combineSiblingsInSearchResults.test.ts (2)

494-494: Updated function call to include new boolean parameter.

The function call to combineSiblingsInSearchResults now includes the new boolean parameter set to false, which is correct and ensures the test case reflects the updated function signature.

---

510-510: Updated function call to include new boolean parameter.

The function call to combineSiblingsInSearchResults now includes the new boolean parameter set to false, which is correct and ensures the test case reflects the updated function signature.

metadata-service/configuration/src/main/resources/application.yaml (1)

374-374: LGTM! Ensure proper documentation and default value alignment.

The showSeparateSiblings feature flag is correctly added and follows the existing configuration pattern. Verify that this flag is documented and that its default value (false) aligns with the intended behavior.

[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 9e07075 and 6e02378.

Files selected for processing (1)

• datahub-web-react/src/app/useAppConfig.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• datahub-web-react/src/app/useAppConfig.ts