Changes to allow editable dataset name

[jayasimhankv]

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

Problem statement:

We have seen the need for business users to be able to maintain an editable dataset name (aka “business name”), which is separate from the default dataset properties’ name. A previous PR was submitted back in late 2022 which also attempted at adding both editable name for the dataset as well as editable label for schema fields. [Original PR: https://github.com//pull/6171]

This PR is only confined to being able to add an editable name to a dataset. Please review and let me know if there are any questions/changes.

High level changes:

Model:

• Include name field in EditableDatasetProperties (currently has only description)

UI/app changes:

• Change entityHeader.tsx to allow editing dataset’s name based on a privilege check. This provides the ability to edit the name in the header and call the mutation to save it.
• Change datasetEntity.tsx’s displayName property to give preference to editable properties’ name field if one exists.

UI/graphql changes:

• Include name field in editableProperties on various fragments, so it can be displayed in the UI.

Resolver changes:

• Allow name to be updated for dataset entity.
• Add a new method updateDatasetName that checks for the privilege and then updates the name field in editable dataset properties.
• Mapper changes to get and set name field from and to editableDatasetProperties aspect.

Working Examples:
With the EditProperties privilege granted to the user, the edit icon is shown in entity header, allowing the user to update it.

With the editable properties’ name updated in the entity’s aspect, the updated editable name (aka “business name”) is displayed.

Search page shows an example of two datasets - one with the default dataset properties’ name and one with editable dataset properties’s name updated earlier:

Search example showing look up by editable properties’ name:



Search example showing look up by non-editable properties’ name:

Example of a user that does not possess the EditProperties privilege - the edit icon in dataset’s header is not provided:

Graphql mutation call for a user that has permissions to update the dataset name:

UI page shows updated name:

Entity json data - the dataset properties’ name is left intact and only the editable dataset properties’ name is updated as seen below:

Graphql mutation call returning unauthorized exception for a user that does NOT have permissions to update the dataset name:

Summary by CodeRabbit

• New Features

  • Introduced the ability to edit dataset names, configurable through the editableDatasetNameEnabled flag.

• Improvements

  • Enhanced dataset properties to support editable names.
  • Updated GraphQL queries and fragments to manage editable dataset names effectively.

• API Updates

  • Added name field to DatasetEditableProperties in GraphQL schemas and API responses.

• Configuration

  • Integrated editableDatasetNameEnabled into application configuration settings.

[gabe-lyons]

do you know why these enum values were moved aroud?

[jjoyce0510]

Overall this makes a LOT of sense.

One request I'd have is to add this edit button BEHIND A FEATURE FLAG (can add via application.yaml > featureFlags) so that we can disable this by default, unless people want it enabled.

I think it's somewhat risky from a product pov to allow any dataset names to be editable by default (and perhaps confusing), but if an org wants to opt in this makes a lot a lot of sense.

Step to add a feature flag:

1. Add application.yaml > featureFlags > editableDatasetNames flag
2. Add to FeatureFlags.java
3. Add to app.graphql AppConfig type in GraphQL the new editableDatasetName field
4. Edit AppConfigResolver to map the featureFlag object from YAML to the GraphQL editableDatasetName field.
5. Fetch new field inside of app.graphql on the datahub-web-react side
6. Add it to DEFAULT_APP_CONFIG in appConfigContext.tsx
7. Finally, inside the EntityHeader.tsx component, add useAppConfig to get the feature flags
8. Show or hide the edit capability based on whether the flag is true

[jayasimhankv]

Overall this makes a LOT of sense.

One request I'd have is to add this edit button BEHIND A FEATURE FLAG (can add via application.yaml > featureFlags) so that we can disable this by default, unless people want it enabled.

I think it's somewhat risky from a product pov to allow any dataset names to be editable by default (and perhaps confusing), but if an org wants to opt in this makes a lot a lot of sense.

Step to add a feature flag:

1. Add application.yaml > featureFlags > editableDatasetNames flag
2. Add to FeatureFlags.java
3. Add to app.graphql AppConfig type in GraphQL the new editableDatasetName field
4. Edit AppConfigResolver to map the featureFlag object from YAML to the GraphQL editableDatasetName field.
5. Fetch new field inside of app.graphql on the datahub-web-react side
6. Add it to DEFAULT_APP_CONFIG in appConfigContext.tsx
7. Finally, inside the EntityHeader.tsx component, add useAppConfig to get the feature flags
8. Show or hide the edit capability based on whether the flag is true

Thanks for the review and feedback. I will work on this and get back to you.

[coderabbitai]

Walkthrough

The changes enhance Datahub by introducing the ability to edit dataset display names, supported by a feature flag for greater flexibility. Updates span the backend, frontend, and GraphQL schema, allowing for the configuration and retrieval of editable names, while maintaining user experience and permission checks effectively.

Changes

File(s)	Change Summary
datahub-graphql-core/src/main/java/com/.../FeatureFlags.java	Added editableDatasetNameEnabled flag.
datahub-graphql-core/src/main/java/com/.../AppConfigResolver.java	Updated get method to set the editable dataset name flag.
datahub-graphql-core/src/main/resources/app.graphql	Added editableDatasetNameEnabled field to FeatureFlagsConfig.
datahub-graphql-core/src/main/resources/entity.graphql	Added name field to DatasetEditableProperties and DatasetEditablePropertiesUpdate.
datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx	Introduced isNameEditable prop and updated name logic.
datahub-web-react/src/app/useAppConfig.ts	Added useIsEditableDatasetNameEnabled function.
datahub-web-react/src/appConfigContext.tsx	Updated DEFAULT_APP_CONFIG to include editableDatasetNameEnabled.
datahub-web-react/src/graphql/app.graphql	Included editableDatasetNameEnabled in appConfig query.
datahub-web-react/src/graphql/fragments.graphql, datahub-web-react/src/graphql/search.graphql	Added name field to editableProperties in various fragments.
metadata-models/src/main/pegasus/com/.../EditableDatasetProperties.pdl	Added name field for editable dataset properties.
metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.entities.snapshot.json, metadata-service/restli-api/src/main/snapshot/com.linkedin.platform.platform.snapshot.json	Added name field for editable dataset display name.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant Database

    User->>Frontend: Request to edit dataset name
    Frontend->>Backend: API call to update dataset name
    Backend->>Backend: Check if editableDatasetNameEnabled flag is true
    Backend->>Backend: Validate user permissions
    Backend->>Database: Update dataset name
    Database-->>Backend: Acknowledge update
    Backend-->>Frontend: Respond with success
    Frontend-->>User: Display updated name

Loading

Poem

In the land of data, names take flight,
Editable fields bring joy and delight.
With features unlocked, we frolic and play,
Changing names freely in a new, bright way.
So hop along, let’s dance and sing,
For every dataset, new names we bring! 🐇✨

---

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 1565fb0 and 71d2c14.

Files selected for processing (13)

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/mutate/UpdateNameResolver.java (4 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/dataset/mappers/DatasetMapper.java (2 hunks)
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/dataset/mappers/DatasetUpdateInputMapper.java (1 hunks)
• datahub-graphql-core/src/main/resources/entity.graphql (2 hunks)
• datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx (4 hunks)
• datahub-web-react/src/app/entity/shared/containers/profile/header/EntityHeader.tsx (1 hunks)
• datahub-web-react/src/graphql/browse.graphql (1 hunks)
• datahub-web-react/src/graphql/fragments.graphql (1 hunks)
• datahub-web-react/src/graphql/preview.graphql (1 hunks)
• datahub-web-react/src/graphql/search.graphql (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/dataset/EditableDatasetProperties.pdl (1 hunks)
• metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.entities.snapshot.json (1 hunks)
• metadata-service/restli-api/src/main/snapshot/com.linkedin.platform.platform.snapshot.json (1 hunks)

Additional comments not posted (14)

metadata-models/src/main/pegasus/com/linkedin/dataset/EditableDatasetProperties.pdl (1)

23-30: Field addition looks good; verify search integration.

The addition of the name field with @Searchable annotation is appropriate for the objectives of this PR.

Please ensure that the integration with the search functionality is tested, particularly that TEXT_PARTIAL behaves as expected.

Verification successful

---

Field addition looks good; verify search integration.

The addition of the name field with @Searchable annotation is consistent with other usages of TEXT_PARTIAL in the codebase and appears to be well-integrated with the search functionality.

• EditableDatasetProperties.pdl line 23-30: The name field with TEXT_PARTIAL is appropriately added and matches existing patterns.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the integration of the new field with the search functionality.

# Test: Search for the new field in the search configuration files.
rg --type pdl -A 5 $'TEXT_PARTIAL'

Length of output: 61

---

Script:

#!/bin/bash
# Description: Verify the integration of the new field with the search functionality.

# Locate all .pdl files and search for the usage of TEXT_PARTIAL within them.
fd --extension pdl --exec rg 'TEXT_PARTIAL' {}

Length of output: 1177

---

Script:

#!/bin/bash
# Description: Verify the integration of the new field with the search functionality.

# Locate all .pdl files and search for the usage of TEXT_PARTIAL within them, including context lines for better understanding.
fd --extension pdl --exec rg -A 5 -B 5 'TEXT_PARTIAL' {}

Length of output: 6996

datahub-web-react/src/app/entity/shared/containers/profile/header/EntityHeader.tsx (1)

74-75: Privilege check addition is appropriate.

The addition of the EntityType.Dataset case in the getCanEditName function is consistent with the PR's objectives.

Please verify that the privilege check (canEditProperties) is consistent across other parts of the application.

Verification successful

---

Privilege check is consistent across the application.

The canEditProperties privilege check is used consistently in various parts of the application, including UI components, mocks, GraphQL fragments, and authorization logic.

• datahub-web-react/src/app/entity/shared/tabs/Properties/PropertiesTab.tsx
• datahub-web-react/src/app/entity/shared/containers/profile/header/EntityHeader.tsx
• datahub-web-react/src/Mocks.tsx
• datahub-web-react/src/graphql/fragments.graphql
• datahub-graphql-core/src/main/resources/auth.graphql
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/structuredproperties/RemoveStructuredPropertiesResolver.java
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/structuredproperties/UpsertStructuredPropertiesResolver.java
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/authorization/AuthorizationUtils.java
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/mutate/UpdateNameResolver.java
• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/entity/EntityPrivilegesResolver.java

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistency of the privilege check.

# Test: Search for other occurrences of `canEditProperties` in the codebase.
rg --type tsx -A 5 $'canEditProperties'

Length of output: 66

---

Script:

#!/bin/bash
# Description: Verify the consistency of the privilege check.

# Find all .tsx files and search for occurrences of `canEditProperties`
fd -e tsx -x rg 'canEditProperties' {}

Length of output: 184

---

Script:

#!/bin/bash
# Description: Verify the consistency of the privilege check.

# Search for occurrences of `canEditProperties` and include surrounding context
rg 'canEditProperties' -A 5 -B 5

Length of output: 12977

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

20-20: GraphQL query update is correct.

The addition of the name field to the editableProperties object in the getBrowseResults query aligns with the PR's objectives.

Please verify that the GraphQL schema has been updated accordingly and that there are no inconsistencies.

Verification successful

---

GraphQL schema update is consistent.

The name field is present in various GraphQL schema files, confirming that its addition to the editableProperties object in the getBrowseResults query aligns with the existing schema structure.

• datahub-web-react/src/graphql/browse.graphql: The name field is present as expected.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistency of the GraphQL schema.

# Test: Search for the `name` field in the GraphQL schema files.
rg --type graphql -A 5 $'name'

Length of output: 61

---

Script:

#!/bin/bash
# Description: Verify the consistency of the GraphQL schema.

# Find all GraphQL schema files and search for the `name` field within them.
fd -e graphql -e gql | xargs rg 'name'

Length of output: 39313

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

12-12: GraphQL fragment update is correct.

The addition of the name field to the editableProperties object in the entityPreview fragment is consistent with the changes made in browse.graphql.

Please verify that the GraphQL schema has been updated accordingly and that there are no inconsistencies.

Verification successful

---

GraphQL schema update verified.

The name field addition to the editableProperties object in the entityPreview fragment is consistent with the changes in browse.graphql. The GraphQL schema has been updated accordingly, and no inconsistencies were found.

• datahub-web-react/src/graphql/preview.graphql
• datahub-web-react/src/graphql/browse.graphql

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/binbash
# Description: Verify the consistency of the GraphQL schema.

# Test: Search for the `name` field in the GraphQL schema files.
rg --type graphql -A 5 $'name'

Length of output: 61

---

Script:

#!/bin/bash
# Description: Verify the consistency of the GraphQL schema.

# Test: Search for the `name` field in the GraphQL schema files.
rg 'name' --glob '*.graphql' -A 5

Length of output: 182651

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/dataset/mappers/DatasetUpdateInputMapper.java (1)

114-120: Conditional property updates implemented correctly.

The changes to conditionally update the description and name of a dataset based on the input properties are implemented correctly. This ensures that only non-null values update the dataset properties, preventing unintended data loss or corruption.

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/types/dataset/mappers/DatasetMapper.java (1)

225-225: Proper handling of dataset names with prioritization of editable names.

The logic to prioritize the editable dataset name over the default name if it exists is implemented correctly. This aligns with the PR's goal to allow business users to maintain a separate "business name" for datasets.

Also applies to: 252-254

datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/resolvers/mutate/UpdateNameResolver.java (1)

244-273: Robust implementation of dataset name updating with proper authorization checks.

The new updateDatasetName method includes comprehensive authorization checks and handles potential exceptions gracefully. This ensures that only authorized users can update the dataset name, aligning with the PR's security requirements.

datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx (1)

278-278: Correct implementation of name prioritization in UI components.

The changes to prioritize displaying the editable dataset name in various UI components are implemented correctly. This ensures that the UI reflects the most relevant name for business users, aligning with the PR's objectives.

Also applies to: 306-306, 356-356

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

338-338: Approved: Addition of the name field to editableProperties.

The addition of the name field to editableProperties in the nonSiblingsDatasetSearchFields fragment aligns with the PR's objectives and appears correctly implemented.

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

254-254: Approved: Addition of the name field to editableProperties.

The addition of the name field to editableProperties in the nonRecursiveDatasetFields fragment is well-placed and supports the functionality of editable dataset names.

Recommendation for UI Integration Testing

Ensure that the UI components consuming this fragment are properly updated to handle the new name field, particularly in areas where dataset names are displayed or edited.

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

3464-3468: Addition of editable name field to DatasetEditableProperties type

The addition of the name field to DatasetEditableProperties allows for the dataset name to be editable, which aligns with the PR's objectives. This change is consistent and well-documented with a comment describing its purpose.

---

4837-4840: Addition of editable name field to DatasetEditablePropertiesUpdate input type

The addition of the name field to the DatasetEditablePropertiesUpdate input type is correctly implemented. This change enables the updating of the dataset's name through GraphQL mutations, supporting the functionality described in the PR.

metadata-service/restli-api/src/main/snapshot/com.linkedin.platform.platform.snapshot.json (1)

2246-2253: Added new field name to EditableDatasetProperties

The addition of the name field to the EditableDatasetProperties model is consistent with the PR's objective to allow editable dataset names. This field is optional and supports partial text search, which is suitable for user-facing features where partial matches are common. The documentation string "Editable display name of the Dataset" is clear and informative.

metadata-service/restli-api/src/main/snapshot/com.linkedin.entity.entities.snapshot.json (1)

2246-2253: Review of the newly added name field in editableDatasetProperties

The addition of the name field to the editableDatasetProperties aspect is implemented correctly. It is marked as optional and searchable, which aligns with the need for flexibility in editing and searching by this new business name. The field type is string, and it is indexed as TEXT_PARTIAL, which is suitable for partial text search queries.

[jayasimhankv]

@jjoyce0510 - implemented feature flag changes to enable editable dataset name. Please review.

Attached some screenshots for reference:
Application yaml with editable dataset name flag defaulted to false:

UI does not allow the name to be edited:

Enabled flag through docker environment var for testing:

UI allows name to be edited:

Updated name:

[coderabbitai]

Actionable comments posted: 0

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

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

189-189: Issue found: editableDatasetNameEnabled flag cannot be toggled.

The editableDatasetNameEnabled feature flag is defined in the FeatureFlags class with a default value of false, but there are no methods or configuration files that allow this flag to be dynamically toggled. This means the feature flag is effectively hardcoded to false.

To resolve this, consider the following actions:

• Implement a setter method in the FeatureFlags class to allow the editableDatasetNameEnabled flag to be set programmatically.
• Ensure that the flag can be configured through external configuration files (e.g., YAML, JSON) to allow for dynamic management across different deployment environments.

Locations to address:

• datahub-graphql-core/src/main/java/com/linkedin/datahub/graphql/featureflags/FeatureFlags.java

Analysis chain

Method call addition approved: setEditableDatasetNameEnabled.

The addition of the setEditableDatasetNameEnabled method call in the AppConfigResolver class is correctly implemented to propagate the feature flag state into the GraphQL schema. This enables the frontend to access and utilize the flag.

Please verify that the feature flag is correctly configured in the backend configuration files to ensure that it behaves as expected across different deployment environments.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the configuration of `editableDatasetNameEnabled` in backend configuration files.

# Test: Search for the configuration of the new feature flag in backend configuration files.
rg --type yaml 'editableDatasetNameEnabled'

Length of output: 43

---

Script:

#!/bin/bash
# Description: Verify the configuration of `editableDatasetNameEnabled` in backend configuration files.

# Test: Search for the configuration of the new feature flag in properties files.
rg --type properties 'editableDatasetNameEnabled'

# Test: Search for the configuration of the new feature flag in JSON files.
rg --type json 'editableDatasetNameEnabled'

# Test: Search for the configuration of the new feature flag in Java files to see if it's set programmatically.
rg --type java 'editableDatasetNameEnabled'

Length of output: 321

---

Script:

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

# Test: Find the definition and usage of `editableDatasetNameEnabled` in the `FeatureFlags` class.
ast-grep --lang java --pattern 'class FeatureFlags {
  $$$
  private boolean editableDatasetNameEnabled = $_;
  $$$
}'

# Test: Find all references to `editableDatasetNameEnabled` in the codebase.
rg 'editableDatasetNameEnabled'

Length of output: 670

---

Script:

#!/bin/bash
# Description: Verify if the `editableDatasetNameEnabled` flag can be toggled in the `FeatureFlags` class.

# Test: Find methods in `FeatureFlags` class that allow setting the `editableDatasetNameEnabled` flag.
ast-grep --lang java --pattern 'class FeatureFlags {
  $$$
  public void setEditableDatasetNameEnabled($_) {
    $$$
  }
  $$$
}'

# Test: Find configuration files that might override the default value of `editableDatasetNameEnabled`.
rg 'editableDatasetNameEnabled' --type yaml --type json

Length of output: 187

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 71d2c14 and 19b9f22.

Files selected for processing (7)

• 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/EntityHeader.tsx (4 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)

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

• datahub-web-react/src/app/entity/shared/containers/profile/header/EntityHeader.tsx

Additional comments not posted (5)

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

31-34: Function useIsEditableDatasetNameEnabled correctly implements feature flag access.

The function is consistent with the existing pattern of accessing feature flags from the application configuration. It should work as intended if the AppConfig and AppConfigContext are correctly set up.

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

24-24: Proper initialization of editableDatasetNameEnabled feature flag.

The feature flag editableDatasetNameEnabled is correctly declared and initialized. This should facilitate controlled rollout of the feature across the platform.

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

57-57: Addition of editableDatasetNameEnabled to DEFAULT_APP_CONFIG.

The new feature flag has been correctly added to the default application configuration. This ensures that the feature is disabled by default, aligning with the feature flag's intended use.

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

72-72: Inclusion of editableDatasetNameEnabled in appConfig query.

The addition of the editableDatasetNameEnabled field to the appConfig query is correct and necessary for the frontend to access this feature flag. This change should enable the UI to conditionally display the dataset name editing functionality based on the feature flag status.

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

504-504: Field addition approved: editableDatasetNameEnabled in FeatureFlagsConfig.

The addition of editableDatasetNameEnabled as a non-nullable Boolean is appropriate for managing feature availability. It ensures that there is always a definitive true or false state for this feature flag.

Please ensure that this new feature flag is utilized appropriately across the frontend components to control the visibility and functionality of dataset name editing.

[jjoyce0510]

Thanks - taking another pass here now that the feature flags were added

[rtekal]

@jjoyce0510 Do you need any more information. Will you be able to give your comments by end of today please.

[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 19b9f22 and 4d836c3.

Files selected for processing (10)

• 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-graphql-core/src/main/resources/entity.graphql (2 hunks)
• datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx (4 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)
• datahub-web-react/src/graphql/fragments.graphql (1 hunks)
• datahub-web-react/src/graphql/search.graphql (1 hunks)

Additional comments not posted (14)

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

24-24: LGTM! Addition of feature flag is consistent.

The new editableDatasetNameEnabled field follows the existing pattern for feature flags and is initialized to false, ensuring a safe default state.

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

31-34: LGTM! New hook for feature flag is consistent.

The useIsEditableDatasetNameEnabled function is consistent with other hooks in the file, using useAppConfig to access the feature flag.

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

57-57: LGTM! Addition to default config is consistent.

The editableDatasetNameEnabled property is added to DEFAULT_APP_CONFIG with a default value of false, consistent with other feature flags.

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

72-72: LGTM! Addition of editableDatasetNameEnabled field.

The addition of the editableDatasetNameEnabled field to the featureFlags in the appConfig query is appropriate and aligns with the PR objectives.

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

511-514: LGTM! Addition of editableDatasetNameEnabled field.

The editableDatasetNameEnabled field is correctly added to the FeatureFlagsConfig type with a clear description, aligning with the PR objectives.

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

189-189: LGTM! Addition of setEditableDatasetNameEnabled.

The inclusion of setEditableDatasetNameEnabled in the get method of AppConfigResolver is consistent with the existing feature flag pattern and aligns with the PR objectives.

datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx (4)

287-287: Prioritize editableProperties for dataset name.

The logic for determining the dataset name now prioritizes editableProperties. This change aligns with the PR objective to allow editing of dataset names, ensuring that the most relevant name is displayed.

---

315-315: Consistent prioritization of editableProperties in search results.

The search result rendering now also prioritizes editableProperties for the dataset name, maintaining consistency across different components.

---

365-365: Update displayName method to use editableProperties.

The displayName method has been updated to first check editableProperties for the dataset name. This ensures that any edited name is consistently displayed across the application.

---

223-223: Ensure feature flag controls the isNameEditable prop.

The isNameEditable prop is set to true, which allows dataset names to be editable. Consider using a feature flag to control this behavior, as discussed in the PR comments, to mitigate risks and provide flexibility.

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

338-338: Include name in editableProperties for search fields.

The addition of the name field to editableProperties within the nonSiblingsDatasetSearchFields fragment enhances the ability to query editable dataset names. This change supports the PR objective of making dataset names editable and retrievable.

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

254-254: Enhance nonRecursiveDatasetFields with name in editableProperties.

The inclusion of the name field in editableProperties within the nonRecursiveDatasetFields fragment allows for more detailed querying of dataset names. This aligns with the goal of enabling editable dataset names.

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

3485-3489: Addition of name field in DatasetEditableProperties is appropriate.

The new name field allows for editing the dataset's display name, aligning with the PR's objectives. The change is consistent with the existing structure.

---

4858-4861: Addition of name field in DatasetEditablePropertiesUpdate is appropriate.

The name field is non-nullable, ensuring that a name update is always provided. This supports the functionality of updating dataset names.

Verify the non-null requirement for name.

Ensure that the non-null constraint aligns with the intended functionality and does not introduce issues in scenarios where a name update might not be needed.

[jjoyce0510]

This looks great. Thanks for the contribution!

[jjoyce0510]

Looks only like minor things -- yarn lint appears to be failing.

To comply with linting:

JAVA

./gradlew datahub-graphql-core:spotlessApply

TYPESCRIPT

cd datahub-web-react && yarn prettier --write src && yarn run lint, then fix issues. If you have "prettier" issues

[jayasimhankv]

Thanks for your review. Yes, will address the listing and spotless issues and commit as soon as I am able.

[jayasimhankv]

Looks only like minor things -- yarn lint appears to be failing.

To comply with linting:

JAVA

./gradlew datahub-graphql-core:spotlessApply

TYPESCRIPT

cd datahub-web-react && yarn prettier --write src && yarn run lint, then fix issues. If you have "prettier" issues

Committed files after yarn lint fixes. There weren't any spotless fixes.

[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 4d836c3 and 1cc326c.

Files selected for processing (2)

• datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx (4 hunks)
• datahub-web-react/src/app/entity/shared/containers/profile/header/EntityHeader.tsx (4 hunks)

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

• datahub-web-react/src/app/entity/dataset/DatasetEntity.tsx

Additional comments not posted (4)

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

20-20: Import addition looks good.

The addition of useIsEditableDatasetNameEnabled is appropriate for checking if the dataset name editing feature is enabled.

---

75-76: Addition of EntityType.Dataset case is appropriate.

The new case correctly checks for the privilege to edit dataset properties, aligning with the PR's objective.

---

100-104: Update to canEditName logic is sensible.

Incorporating useIsEditableDatasetNameEnabled ensures that the editability of the dataset name is controlled by the feature flag, which is a good practice.

---

115-115: Explicitly setting isNameEditable to false is a good practice.

Ensuring that isNameEditable defaults to false prevents potential errors if canEditName is undefined.

[rtekal]

@jjoyce0510 Thank you very much for your review. Hope it can get merged and be part of a release soon.
I can try to repay you... please tag me if I can be of any help.