fix(ui/ingest): ingest tab should show with manage ingestion privilege

[anshbansal]

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 tab visibility on the Manage Ingestion Page based on user privileges and configuration.
  • Dynamically determined default tab on the Manage Ingestion Page.
  • Introduced end-to-end tests for managing metadata ingestion and secret privileges.

• Bug Fixes

  • Updated the error message for secret update failures to be more specific.
  • Defaulted secret descriptions to an empty string if undefined.

• Improvements

  • Simplified logic for displaying header links based on user privileges for managing ingestion or secrets.
  • Improved interaction model in tests for managing secrets for better maintainability.

[chriscollins3456]

I think this is a fair enough change! one request about changing the default selected tab to be secrets if they can only view secrets and not ingestion sources.

[chriscollins3456]

looks good!

[jjoyce0510]

Thank you!!!

[jjoyce0510]

nice work - thank you!

[jjoyce0510]

Stamped!

[coderabbitai]

Walkthrough

The recent updates enhance user privilege management and improve secret handling in the DataHub web application. The ManageIngestionPage utilizes hooks to dynamically control tab visibility based on user roles. The SecretsList ensures descriptions are always defined, while the error messaging for updates has been clarified. Additionally, the user privilege checks in HeaderLinks have been streamlined, leading to a more consistent user interface.

Changes

File Path	Change Summary
datahub-web-react/src/app/ingest/...	Updated ManageIngestionPage.tsx to use hooks for dynamic tab visibility and privilege management.
datahub-web-react/src/app/ingest/secret/...	Adjusted SecretsList.tsx to default description to an empty string and enhance error messaging.
datahub-web-react/src/app/shared/admin/...	Simplified logic in HeaderLinks.tsx for checking user privileges affecting display elements.
smoke-test/tests/cypress/cypress/e2e/...	Introduced new test interactions in ingestion source creation and added tests for managing privileges.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ManageIngestionPage
    participant useAppConfig
    participant useUserContext
    participant HeaderLinks
    participant SecretsList

    User->>ManageIngestionPage: Access page
    ManageIngestionPage->>useAppConfig: Fetch app config
    ManageIngestionPage->>useUserContext: Fetch user context
    useAppConfig-->>ManageIngestionPage: Return config
    useUserContext-->>ManageIngestionPage: Return user privileges
    ManageIngestionPage->>ManageIngestionPage: Determine tab visibility
    ManageIngestionPage->>User: Render appropriate tabs

    User->>SecretsList: Update secret description
    SecretsList->>SecretsList: Handle undefined description
    SecretsList->>User: Return success/failure message

    User->>HeaderLinks: Access header links
    HeaderLinks->>useUserContext: Fetch user context
    useUserContext-->>HeaderLinks: Return user privileges
    HeaderLinks->>User: Display elements based on privileges

Loading

Poem

🐰 In DataHub's realm, with changes bright,
Tabs now dance to user rights.
Secrets whisper without a fuss,
Error messages clear for us.
Privileges check with mindful care,
Enhancing features we all share.
Such updates bring a joyful cheer,
For DataHub's future, ever clear! 🌟

---

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 71e79ba and 82cc8f2.

Files selected for processing (3)

• datahub-web-react/src/app/ingest/ManageIngestionPage.tsx (3 hunks)
• datahub-web-react/src/app/ingest/secret/SecretsList.tsx (2 hunks)
• datahub-web-react/src/app/shared/admin/HeaderLinks.tsx (1 hunks)

Additional comments not posted (6)

datahub-web-react/src/app/ingest/ManageIngestionPage.tsx (3)

5-6: Approved new hooks imports.

The addition of useAppConfig and useUserContext hooks is aligned with the changes described in the PR summary, allowing conditional rendering based on user permissions.

---

77-78: Approved conditional tab rendering.

The conditional rendering of the Sources and Secrets tabs based on the respective privileges is correctly implemented.

---

53-61: Ensure correct tab selection logic based on user privileges.

The logic for determining which tabs to show based on user permissions (manageIngestion and manageSecrets) seems correct. However, ensure that the default tab selection logic at line 60 adheres to the previous comments about setting the default tab to TabType.Secrets if the user can only view secrets.

Verification successful

---

Default tab selection logic is correctly implemented based on user privileges.

The implementation in ManageIngestionPage.tsx correctly sets the default tab to TabType.Secrets if the user can only view secrets.

• datahub-web-react/src/app/ingest/ManageIngestionPage.tsx:
  • Line 60: const defaultTab = showIngestionTab ? TabType.Sources : TabType.Secrets;

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Check if the default tab selection logic is correctly implemented.

# Test: Search for the default tab logic implementation. Expect: Correct tab selection based on user privileges.
rg --type typescript $'const defaultTab = showIngestionTab ? TabType.Sources : TabType.Secrets'

Length of output: 131

---

---

Script:

#!/bin/bash
# Description: Check if the default tab selection logic is correctly implemented.

# Test: Search for the default tab logic implementation. Expect: Correct tab selection based on user privileges.
rg --type ts $'const defaultTab = showIngestionTab ? TabType.Sources : TabType.Secrets'

Length of output: 88

---

---

Script:

#!/bin/bash
# Description: Check if the default tab selection logic is correctly implemented by searching for related patterns.

# Test: Search for the default tab logic implementation and related variables.
rg --type ts 'defaultTab'
rg --type ts 'showIngestionTab'
rg --type ts 'TabType'

Length of output: 6878

datahub-web-react/src/app/shared/admin/HeaderLinks.tsx (1)

78-78: Approved updated logic for showing ingestion link.

The change from an AND to an OR condition in the permissions check allows users with either manageIngestion or manageSecrets privileges to see the ingestion link, aligning with the PR's objective to enhance control flow based on user privileges.

datahub-web-react/src/app/ingest/secret/SecretsList.tsx (2)

121-121: Approved default description handling.

The addition of a fallback empty string for the description field when creating a new secret ensures that the field is never undefined, which improves robustness and prevents potential runtime errors.

---

130-130: Approved updated error message content.

The change in the error message content from "Failed to update ingestion source" to "Failed to update secret" corrects the context of the error message, making it relevant to the current operation.

[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 82cc8f2 and e528b80.

Files selected for processing (3)

• datahub-web-react/src/app/ingest/ManageIngestionPage.tsx (3 hunks)
• datahub-web-react/src/app/ingest/secret/SecretsList.tsx (2 hunks)
• datahub-web-react/src/app/shared/admin/HeaderLinks.tsx (1 hunks)

Additional comments not posted (6)

datahub-web-react/src/app/ingest/ManageIngestionPage.tsx (3)

5-6: Imports look good!

The imports of useAppConfig and useUserContext are necessary for the new logic.

---

75-76: Conditional rendering of tabs looks good!

The code correctly conditionally renders the tabs based on the visibility logic.

---

53-59: Logic for tab visibility looks good!

The code correctly uses the useUserContext and useAppConfig hooks to manage tab visibility based on user privileges and configuration.

However, ensure that the usage of these hooks is consistent throughout the codebase.

Verification successful

---

Consistent usage of useUserContext and useAppConfig hooks

The useUserContext and useAppConfig hooks are used consistently across the codebase to manage user context and application configuration settings.

• The hooks are used in various components, ensuring that user-related data and application configuration settings are fetched and utilized appropriately.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `useUserContext` and `useAppConfig` hooks in the codebase.

# Test: Search for the usage of `useUserContext` and `useAppConfig`. Expect: Consistent usage.
rg --type tsx -A 5 $'useUserContext'
rg --type tsx -A 5 $'useAppConfig'

Length of output: 125

---

Script:

#!/bin/bash
# Description: Verify the usage of `useUserContext` and `useAppConfig` hooks in the codebase.

# Test: Search for the usage of `useUserContext` and `useAppConfig`. Expect: Consistent usage.
rg 'useUserContext' --glob '*.tsx' -A 5
rg 'useAppConfig' --glob '*.tsx' -A 5

Length of output: 89036

datahub-web-react/src/app/shared/admin/HeaderLinks.tsx (1)

78-78: Logic for showIngestion looks good!

The code correctly modifies the condition for showIngestion to include either me.platformPrivileges?.manageIngestion or me.platformPrivileges?.manageSecrets being truthy.

datahub-web-react/src/app/ingest/secret/SecretsList.tsx (2)

121-121: Handling of description field looks good!

The code correctly defaults the description field to an empty string if state.description is undefined.

---

130-130: Improved error message looks good!

The error message for updating a secret has been correctly modified to mention the failure to update the secret specifically.

[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 e528b80 and b66bacb.

Files selected for processing (3)

• smoke-test/tests/cypress/cypress/e2e/mutations/ingestion_source.js (1 hunks)
• smoke-test/tests/cypress/cypress/e2e/mutations/manage_ingestion_secret_privilege.js (1 hunks)
• smoke-test/tests/cypress/cypress/e2e/mutations/managing_secrets.js (4 hunks)

Additional comments not posted (14)

smoke-test/tests/cypress/cypress/e2e/mutations/ingestion_source.js (1)

14-14: New interaction step added to select the correct source option.

The addition of cy.clickOptionWithId('[data-node-key="Sources"]'); ensures that the correct source option is selected before proceeding with the test. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

smoke-test/tests/cypress/cypress/e2e/mutations/managing_secrets.js (3)

30-30: New interaction step added to select the correct source option.

The addition of cy.clickOptionWithId('[data-node-key="Sources"]'); ensures that the correct source option is selected before proceeding with the test. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

63-64: New interaction step added to select the correct source option.

The addition of cy.clickOptionWithId('[data-node-key="Sources"]'); ensures that the correct source option is selected before proceeding with the test. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

102-103: New interaction step added to select the correct source option.

The addition of cy.clickOptionWithId('[data-node-key="Sources"]'); ensures that the correct source option is selected before proceeding with the test. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

smoke-test/tests/cypress/cypress/e2e/mutations/manage_ingestion_secret_privilege.js (10)

7-15: New interaction steps added to enter user details and submit the form.

The addition of these steps ensures that the user details are correctly entered and the form is submitted. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

18-23: New interaction steps added to enter user credentials and submit the form.

The addition of these steps ensures that the user credentials are correctly entered and the form is submitted. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

25-29: New interaction steps added to update and save policy details.

The addition of these steps ensures that the policy details are correctly updated and saved. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

31-33: New interaction steps added to click, focus, and type in an input field.

The addition of these steps ensures that the input field is correctly clicked, focused, and typed in. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

35-37: New interaction steps added to click a button.

The addition of these steps ensures that the button is correctly clicked. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

39-52: New interaction steps added to create a policy.

The addition of these steps ensures that the policy is correctly created. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

54-57: New interaction steps added to search and toggle the status of a metadata policy.

The addition of these steps ensures that the metadata policy status is correctly searched and toggled. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

59-71: New interaction steps added to edit a policy.

The addition of these steps ensures that the policy is correctly edited. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

73-113: New interaction steps added to deactivate existing "All Users" policies.

The addition of these steps ensures that the existing "All Users" policies are correctly deactivated. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.

---

115-198: New interaction steps added to manage ingestion and secret privileges.

The addition of these steps ensures that the ingestion and secret tabs are correctly visible based on user privileges. This is a necessary step to ensure the test functions correctly in the context of the application's user interface.