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: A user can collapse/expand APIs when creating a new root key #2124

Merged
merged 7 commits into from
Sep 23, 2024

Conversation

mcstepp
Copy link
Collaborator

@mcstepp mcstepp commented Sep 23, 2024

What does this PR do?

Currently when a user creates a new root key, we show all the APIs by default. This PR converts those APIs cards into Collapsible cards, default collapsed. The user can expand each API card to add permissions if necessary.

Screenshot 2024-09-23 at 12 54 47 PM
Screenshot 2024-09-23 at 12 55 03 PM
Screenshot 2024-09-23 at 12 55 14 PM

Fixes #1980

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

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?

Manual testing.

  1. Log into Unkey
  2. Ensure that you have at least 1 API created
  3. Go to Settings > Root Keys > Create New Root Key
  4. Observe that API card is collapsed. On title click, the card expands. Additional cards can independently expand/collapse.

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 a collapsible UI component for displaying API permissions in the Client component.
    • Each API card now features a collapsible trigger, allowing users to expand or collapse content related to API permissions.
  • Improvements

    • Enhanced the layout of API cards to a dynamic collapsible structure for better user interaction.

Copy link

linear bot commented Sep 23, 2024

Copy link

changeset-bot bot commented Sep 23, 2024

⚠️ No Changeset found

Latest commit: bfdd294

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

Copy link

vercel bot commented Sep 23, 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 23, 2024 5:50pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 23, 2024 5:50pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 23, 2024 5:50pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
planetfall ⬜️ Ignored (Inspect) Visit Preview Sep 23, 2024 5:50pm
workflows ⬜️ Ignored (Inspect) Visit Preview Sep 23, 2024 5:50pm

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

Walkthrough

The changes implement a collapsible UI component within the Client component of the application to enhance the display of API permissions. The API cards have been modified to include a collapsible trigger, allowing users to expand or collapse the content that details permissions for each API. State management for the collapsible cards is introduced, enabling dynamic interaction with the UI.

Changes

File Path Change Summary
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx Introduced a collapsible UI for API permissions, added state management for card states, and modified rendering logic for API cards.

Assessment against linked issues

Objective Addressed Explanation
Show a manageable list of APIs when creating a new root key (#1980)

Possibly related PRs

Suggested reviewers

  • chronark
  • perkinsjr

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 768056e and bfdd294.

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

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.

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.

Copy link
Contributor

github-actions bot commented Sep 23, 2024

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

@chronark
Copy link
Collaborator

Why do you prefer this way of collapsing over the way we do it for editing permissions?

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: 2

Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx (1)

168-168: Use break-words instead of break-all for better text wrapping

The break-all class breaks words at arbitrary points, which can affect readability. Using break-words ensures that words only break at appropriate points, improving the user interface.

Apply this diff to refine the code:

- <CardTitle className="break-all">{api.name}</CardTitle>
+ <CardTitle className="break-words">{api.name}</CardTitle>
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1f81043 and c4bcbfa.

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

11-11: Importing Collapsible components is appropriate

The addition of Collapsible, CollapsibleContent, and CollapsibleTrigger imports is necessary for implementing the collapsible API cards feature.


26-26: Importing ChevronRight icon for collapsible triggers

Including the ChevronRight icon enhances the visual indication of collapsible sections.


154-227: Implementation of collapsible API cards is effective

Wrapping each API card with the Collapsible component and managing its state enhances the user experience by reducing clutter. The use of cardStatesMap to track the open states is appropriate.

@mcstepp
Copy link
Collaborator Author

mcstepp commented Sep 23, 2024

Why do you prefer this way of collapsing over the way we do it for editing permissions?

The permissions navigates to a new page. This one are elements within the same form - i didn't want to lose reference to form data without a more robust state management solution. This way allows me to manage the open/close state and retain the form data when creating a new root key.

@chronark chronark removed their assignment Sep 23, 2024
Copy link
Collaborator

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

image

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.

Creating a new root key shows all APIs
3 participants