feat: show disabled in the keys list if key is disabled #2645

harshsbhat · 2024-11-05T13:54:18Z

What does this PR do?

Displays disabled in the keys list after disabling them.

Fixes #2632

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?

Go to https://app.unkey.com/apis/api_123/keys/ks_123
Go to keys tab. ( Make sure you have at least one key disabled. )
See that you can see disabled in front of the disabled key kind of like the ss

Checklist

Required

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 an "Enabled" property for keys, enhancing tracking of key status.
- Added a "Disabled" badge in the UI for keys that are not enabled, improving visibility of key status.

changeset-bot · 2024-11-05T13:54:22Z

⚠️ No Changeset found

Latest commit: 5290f5c

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 · 2024-11-05T13:54:25Z

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	Nov 9, 2024 2:31pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 9, 2024 2:31pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 9, 2024 2:31pm
workflows	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 9, 2024 2:31pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 9, 2024 2:31pm

coderabbitai · 2024-11-05T13:54:26Z

📝 Walkthrough

Walkthrough

The changes in the keys.tsx file introduce an enabled property to the KeysByOwnerId type, indicating whether each key is enabled or disabled. This property is derived from the curr.enabled field during the reduction process. Additionally, a "Disabled" badge is conditionally rendered for keys that are not enabled, enhancing the user interface by clearly indicating the status of each key.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx	Added `enabled` property to `KeysByOwnerId` type and implemented conditional rendering for a "Disabled" badge.

Assessment against linked issues

Objective	Addressed	Explanation
Show status of the Key on the key list page (#2632)	✅

Possibly related PRs

feat: Show keyId after creating a new key #2107: This PR modifies the user interface for displaying API key information, which may relate to the changes in the keys.tsx file that also deal with key management and display.

Suggested labels

🕹️ oss.gg, :joystick: 50 points, hacktoberfest

Suggested reviewers

mcstepp
chronark
perkinsjr

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.

vercel · 2024-11-05T13:54:26Z

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

A member of the Team first needs to authorize it.

github-actions · 2024-11-05T13:54:32Z

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

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (1)
125-126: Consider improving the visual hierarchy of the disabled status

While the implementation works correctly, consider these improvements for better UX:

Use a more distinct badge variant (e.g., "destructive" or "outline") to make the disabled status more prominent

Move the disabled status badge before the permissions/roles badges since it's a more critical piece of information
                    <Badge variant="secondary">
                      {Intl.NumberFormat(undefined, { notation: "compact" }).format(k.permissions)}{" "}
                      Permission
                      {k.permissions !== 1 ? "s" : ""}
                    </Badge>

+                   {!k.enabled && <Badge variant="destructive">Disabled</Badge>}
+
                    <Badge variant="secondary">
                      {Intl.NumberFormat(undefined, { notation: "compact" }).format(k.roles)} Role
                      {k.roles !== 1 ? "s" : ""}
                    </Badge>
-
-                    {!k.enabled && <Badge variant="secondary">Disabled</Badge>}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06cf362 and d0dcef1.

📒 Files selected for processing (1)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (3 hunks)

🔇 Additional comments (2)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/keys.tsx (2)

37-37: LGTM: Type definition properly extended

The addition of the enabled boolean property to KeysByOwnerId type is correct and necessary for tracking key status.

52-52: LGTM: Proper data mapping

The enabled status is correctly mapped from the source data to the transformed object.

harshsbhat · 2024-11-09T14:31:37Z

I was thinking about keeping the Badge destructive like this. To differentiate it from others. Wdyt?

@chronark

feat: show disabled in the keys list if key is disabled

d0dcef1

harshsbhat requested review from perkinsjr, chronark and mcstepp as code owners November 5, 2024 13:54

github-actions bot added the Feature New feature or request label Nov 5, 2024

vercel bot deployed to Preview – engineering November 5, 2024 13:55 View deployment

coderabbitai bot reviewed Nov 5, 2024

View reviewed changes

Merge branch 'main' into harshbhat/enabled-status

4d96c0b

vercel bot deployed to Preview – engineering November 6, 2024 06:26 View deployment

Merge branch 'main' into harshbhat/enabled-status

493ee86

vercel bot deployed to Preview – engineering November 6, 2024 12:33 View deployment

Merge branch 'main' into harshbhat/enabled-status

d960cc4

vercel bot deployed to Preview – engineering November 7, 2024 02:59 View deployment

Merge branch 'main' into harshbhat/enabled-status

91185af

vercel bot deployed to Preview – engineering November 7, 2024 19:50 View deployment

chronark approved these changes Nov 7, 2024

View reviewed changes

vercel bot deployed to Preview – workflows November 7, 2024 20:47 View deployment

vercel bot deployed to Preview – play November 7, 2024 20:47 View deployment

vercel bot deployed to Preview – www November 7, 2024 20:50 View deployment

vercel bot deployed to Preview – dashboard November 7, 2024 20:50 View deployment

Merge branch 'main' into harshbhat/enabled-status

ee5c605

vercel bot deployed to Preview – engineering November 8, 2024 04:41 View deployment

Merge branch 'main' into harshbhat/enabled-status

45c3b8a

vercel bot deployed to Preview – engineering November 8, 2024 07:46 View deployment

Merge branch 'main' into harshbhat/enabled-status

5290f5c

vercel bot deployed to Preview – engineering November 9, 2024 14:31 View deployment

chronark merged commit 4eabc08 into unkeyed:main Nov 13, 2024
4 of 8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: show disabled in the keys list if key is disabled #2645

feat: show disabled in the keys list if key is disabled #2645

harshsbhat commented Nov 5, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Nov 5, 2024 •

edited

Loading

vercel bot commented Nov 5, 2024 •

edited

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

vercel bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024 •

edited

Loading

coderabbitai bot left a comment

harshsbhat commented Nov 9, 2024

feat: show disabled in the keys list if key is disabled #2645

feat: show disabled in the keys list if key is disabled #2645

Conversation

harshsbhat commented Nov 5, 2024 • edited by coderabbitai bot Loading

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

changeset-bot bot commented Nov 5, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Nov 5, 2024 • edited Loading

coderabbitai bot commented Nov 5, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

vercel bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

harshsbhat commented Nov 9, 2024

harshsbhat commented Nov 5, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Nov 5, 2024 •

edited

Loading

vercel bot commented Nov 5, 2024 •

edited

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Nov 5, 2024 •

edited

Loading