Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Adding permission check for the view tab on datasource editor #37308

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

ankitakinger
Copy link
Contributor

@ankitakinger ankitakinger commented Nov 10, 2024

Description

Adding permission check for the view tab on datasource editor

Fixes #37317

Automation

/ok-to-test tags="@tag.Sanity, @tag.Datasource"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11766974110
Commit: bd2ecfe
Cypress dashboard.
Tags: @tag.Sanity, @tag.Datasource
Spec:


Sun, 10 Nov 2024 18:51:27 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced feature flag checks for tab rendering based on user permissions.
    • Conditional display of the "View Data" tab, ensuring only authorized users can access it.
  • Bug Fixes

    • Improved control flow for tab activation based on datasource validity and user permissions.

Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

Walkthrough

The changes in DatasourceTabs.tsx implement feature flag checks and modify tab rendering logic based on user permissions. New imports for useFeatureFlag, FEATURE_FLAG, and getHasCreateDatasourceActionPermission are introduced. The active tab is conditionally set based on the validity of the datasource, plugin authorization, and user permissions. The rendering of the VIEW_DATA tab and its associated panel is now dependent on whether the user has permission to create datasource actions, enhancing the control flow of the component.

Changes

File Change Summary
app/client/src/pages/Editor/DatasourceInfo/DatasorceTabs.tsx - Added imports for useFeatureFlag, FEATURE_FLAG, and getHasCreateDatasourceActionPermission.
- Introduced canCreateDatasourceActions variable for permission checks.
- Updated TabsContainer to conditionally set the active tab based on datasource validity and permissions.
- Wrapped Tab and TabPanelContainer for VIEW_MODE_TABS.VIEW_DATA in conditional checks for permissions.

Possibly related PRs

Suggested labels

Bug, Enhancement, IDE Product, ok-to-test, Needs Triaging, IDE Pod

Suggested reviewers

  • hetunandu
  • ApekshaBhosale

🌟 In the realm of code where features align,
Tabs now dance with permissions divine.
With flags waving bright, access is clear,
Only the worthy can venture near!
So let’s celebrate this code's new grace,
A joyful leap in the user’s space! 🎉


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@ankitakinger ankitakinger added the ok-to-test Required label for CI label Nov 10, 2024
@github-actions github-actions bot added the Bug Something isn't working label Nov 10, 2024
@ankitakinger
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11766977430.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 37308.
recreate: .

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
app/client/src/pages/Editor/DatasourceInfo/DatasorceTabs.tsx (2)

78-84: Consider adding type safety for datasource permissions

The permission check implementation is clean and well-structured. However, consider adding type safety for the datasource permissions array.

- props.datasource?.userPermissions ?? [],
+ props.datasource?.userPermissions ?? ([] as string[]),

88-91: Consider extracting complex condition for better readability

The default tab selection logic could be more maintainable if split into intermediate variables.

+ const canViewData = (isDatasourceValid || isPluginAuthorized) && canCreateDatasourceActions;
  defaultValue={
-   (isDatasourceValid || isPluginAuthorized) && canCreateDatasourceActions
+   canViewData
      ? VIEW_MODE_TABS.VIEW_DATA
      : VIEW_MODE_TABS.CONFIGURATIONS
  }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c2bf6c8 and bd2ecfe.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/DatasourceInfo/DatasorceTabs.tsx (2 hunks)
🔇 Additional comments (3)
app/client/src/pages/Editor/DatasourceInfo/DatasorceTabs.tsx (3)

22-24: LGTM: Clean import additions

The new imports are well-organized and properly utilized throughout the component.


94-98: LGTM: Clean conditional rendering implementation

The permission-based conditional rendering of the VIEW_DATA tab is well-implemented.


103-120: Verify consistent permission checks across the application

The conditional panel rendering is well-implemented with proper separation of concerns for different datasource types.

Copy link

Deploy-Preview-URL: https://ce-37308.dp.appsmith.com

Copy link
Contributor

@brayn003 brayn003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@github-actions github-actions bot added Platform Administration Pod Issues related to platform administration & management RBAC Product Issues, requests and enhancements around RBAC. Task A simple Todo labels Nov 11, 2024
@ankitakinger ankitakinger merged commit 5c075e8 into release Nov 11, 2024
49 checks passed
@ankitakinger ankitakinger deleted the fix/datasource-tabs-permissions branch November 11, 2024 08:58
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 20, 2024
…ppsmithorg#37308)

## Description

Adding permission check for the view tab on datasource editor

Fixes [appsmithorg#37317](appsmithorg#37317)

## Automation

/ok-to-test tags="@tag.Sanity, @tag.Datasource"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11766974110>
> Commit: bd2ecfe
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11766974110&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity, @tag.Datasource`
> Spec:
> <hr>Sun, 10 Nov 2024 18:51:27 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced feature flag checks for tab rendering based on user
permissions.
- Conditional display of the "View Data" tab, ensuring only authorized
users can access it.

- **Bug Fixes**
- Improved control flow for tab activation based on datasource validity
and user permissions.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working ok-to-test Required label for CI Platform Administration Pod Issues related to platform administration & management RBAC Product Issues, requests and enhancements around RBAC. Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Add create actions using the current DS permission for view tab on datasource editor
2 participants