Skip to content

feat: Adds toggle for root key permissions#2062

Merged
perkinsjr merged 10 commits intounkeyed:mainfrom
harshsbhat:harshbhat/toggle-rootKey
Sep 9, 2024
Merged

feat: Adds toggle for root key permissions#2062
perkinsjr merged 10 commits intounkeyed:mainfrom
harshsbhat:harshbhat/toggle-rootKey

Conversation

@harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Sep 3, 2024

What does this PR do?

Fixes #1960

It creates a select all toggles for all the APIs as well as workspace permissions while creating the rootkey.

https://www.loom.com/share/13dd6733a9e44a089f082791dfc616d6?sid=9c9f5506-be92-4137-8d7f-af248236024a

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

Create a new root key with the permissions you desire to select. It should have toggles that say select all.

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Introduced "Select All Permissions" toggle for streamlined permission management at both workspace and API levels.
    • Added category-specific "Select All" toggles for more granular control over permission settings.
  • Improvements
    • Enhanced user experience by reducing the number of individual toggles needed for permission adjustments.

@changeset-bot
Copy link

changeset-bot bot commented Sep 3, 2024

⚠️ No Changeset found

Latest commit: 11c1a5b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Sep 3, 2024

@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

Walkthrough

The changes enhance the Client component in the client.tsx file by introducing new PermissionToggle components. A "Select All Permissions" toggle has been added at both the workspace and API levels, allowing users to manage permissions more efficiently. The component's logic has been updated to ensure that toggling these controls updates the state of individual permissions, providing a more streamlined user experience.

Changes

File Path Change Summary
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx Added new PermissionToggle components, including "Select All Permissions" toggles for workspace and API levels, enhancing permission management. Updated logic to handle state changes for individual permissions based on user actions. Altered label type in PermissionToggleProps to accept both string and React.ReactNode.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Client
    participant PermissionToggle

    User->>Client: Toggle "Select All Permissions"
    Client->>PermissionToggle: Check all permissions
    PermissionToggle-->>Client: Update individual permissions state
    Client-->>User: Reflect updated permissions
Loading

Assessment against linked issues

Objective Addressed Explanation
Toggle for permissions (Issue #1960)
Improve user experience for managing permissions

Possibly related PRs

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

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>.
    • 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 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.

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.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@harshsbhat
Copy link
Contributor Author

I don't know why the video is blinking like that. It's not an issue in the code. Mostly seems like an issue with loom.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fde3d83 and c39ff7f.

Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (2 hunks)
Additional comments not posted (4)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (4)

94-121: LGTM!

The new PermissionToggle component for selecting all workspace permissions is correctly implemented and enhances the user experience.


124-152: LGTM!

The new PermissionToggle component for selecting all permissions under each workspace permission category is correctly implemented and provides a more granular control over permissions.


181-208: LGTM!

The new PermissionToggle component for selecting all API permissions is correctly implemented and enhances the user experience.


209-253: LGTM!

The new PermissionToggle component for selecting all permissions under each API permission category is correctly implemented and provides a more granular control over permissions.

Copy link
Collaborator

@chronark chronark left a comment

Choose a reason for hiding this comment

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

Hmm, visually I'm not convinced yet. It's very dense and doesn't differentiate between toggling all or toggling a single permission I think

But I don't have a better suggestion right now

CleanShot 2024-09-03 at 17 31 35@2x

@harshsbhat
Copy link
Contributor Author

Hmm, visually I'm not convinced yet. It's very dense and doesn't differentiate between toggling all or toggling a single permission I think

But I don't have a better suggestion right now

CleanShot 2024-09-03 at 17 31 35@2x

Hmm. It does look pretty dense. So what should we do then? Close this for now? I didn't get what you meant by differentiate between toggling all or toggling a single permission

@harshsbhat
Copy link
Contributor Author

can you also check the encrypted meta feature whenever your free?

@harshsbhat
Copy link
Contributor Author

image

How about we add the checkbox right before the API. so [ ] API like this. Kind of like /root-keys

image

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c39ff7f and a58ee78.

Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx

@harshsbhat harshsbhat requested a review from chronark September 8, 2024 11:23
@vercel
Copy link

vercel bot commented Sep 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:32pm
planetfall ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:32pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:32pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:32pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:32pm

@vercel vercel bot temporarily deployed to Preview – dashboard September 9, 2024 12:11 Inactive
@vercel vercel bot temporarily deployed to Preview – www September 9, 2024 12:11 Inactive
@ogzhanolguncu
Copy link
Contributor

Refactored parts looks good to me 🚀

@vercel vercel bot temporarily deployed to Preview – dashboard September 9, 2024 12:19 Inactive
Copy link
Member

@perkinsjr perkinsjr left a comment

Choose a reason for hiding this comment

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

Currently the implementation doesn't give explict context to this toggle.

image

Because of the way the layout is right now it's hard to tell if this is a mistake that someone added a checkbox to a title or an action.

Some small tweaks that we can do before we overhaul this entirely.

  1. Make the top level action bold for example API
  2. Add the descriptor on the right that states "Enable all permissions for X"

Once those changes are made I will approve it.

@harshsbhat
Copy link
Contributor Author

Currently the implementation doesn't give explict context to this toggle.

image

Because of the way the layout is right now it's hard to tell if this is a mistake that someone added a checkbox to a title or an action.

Some small tweaks that we can do before we overhaul this entirely.

  1. Make the top level action bold for example API
  2. Add the descriptor on the right that states "Enable all permissions for X"

Once those changes are made I will approve it.

Done!

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a58ee78 and 11c1a5b.

Files selected for processing (1)
  • apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (5 hunks)
Additional comments not posted (6)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (6)

94-100: LGTM!

The code changes are approved.


106-114: LGTM!

The code changes are approved.


148-151: LGTM!

The code changes are approved.


156-166: LGTM!

The code changes are approved.


254-254: LGTM!

The code changes are approved.


266-266: LGTM!

The code changes are approved.

@vercel vercel bot temporarily deployed to Preview – dashboard September 9, 2024 18:26 Inactive
@vercel vercel bot temporarily deployed to Preview – planetfall September 9, 2024 18:30 Inactive
@vercel vercel bot temporarily deployed to Preview – workflows September 9, 2024 18:30 Inactive
@vercel vercel bot temporarily deployed to Preview – www September 9, 2024 18:31 Inactive
@vercel vercel bot temporarily deployed to Preview – play September 9, 2024 18:32 Inactive
@perkinsjr perkinsjr added this pull request to the merge queue Sep 9, 2024
Merged via the queue into unkeyed:main with commit 7820c2a Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Toggle for permissions

4 participants