feat: Show keyId after creating a new key by harshsbhat · Pull Request #2107 · unkeyed/unkey

harshsbhat · 2024-09-17T18:58:45Z

What does this PR do?

Fixes #2106

It displays the keyId after creating a new key.

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?

Test A
Test B

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
- Enhanced user interface for displaying API key information in the CreateKey component.
- Key ID is now presented within a Code component for improved clarity.
- Introduced a copy button for easy copying of the key ID.
- Retained alert message emphasizing key visibility limitations.

changeset-bot · 2024-09-17T18:58:50Z

⚠️ No Changeset found

Latest commit: 403156b

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-09-17T18:58:52Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2024-09-17T18:58:55Z

Walkthrough

The changes in this pull request enhance the CreateKey component of the user interface by reorganizing the layout to improve the display of API key information. The key ID is now explicitly labeled and presented alongside a CopyButton, allowing users to easily copy the key ID. An alert message regarding the key's visibility is retained, emphasizing that the key is only shown once and cannot be recovered.

Changes

Files	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx	Enhanced `CreateKey` component UI by reorganizing the layout, adding a label for the key ID, and improving copy functionality.

Assessment against linked issues

Objective	Addressed	Explanation
key_id should be displayed after creating new API key (Issue #2106)	✅

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8938219 and 403156b.

Files selected for processing (1)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (1)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/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 generate interesting stats about this repository and render them as a table.
-- @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 · 2024-09-17T18:58:57Z

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

chronark

I think this placement may be too confusing. We already observe users mixing up key and keyId and displaying it with equal hierarchy will likely just amplify this.

A better place would be where the apiId is displayed right now, but that requires reworking the layout

harshsbhat · 2024-09-18T08:27:19Z

I think this placement may be too confusing. We already observe users mixing up key and keyId and displaying it with equal hierarchy will likely just amplify this.

A better place would be where the apiId is displayed right now, but that requires reworking the layout

What do you think about this one?

chronark · 2024-09-18T08:31:12Z

that works 👍

harshsbhat · 2024-09-18T08:32:22Z

@chronark
Yeah, I have also observed that many people are confused between Key and KeyID. Is it possible to change the prefix of keyId from key_123 to either keyId_123 or key_id_123? I think it's too late to change this now. It will create many consistency issues with the keys that have already been issued. But wdyt?

chronark · 2024-09-18T08:34:53Z

I don't think that would cause consistency issues, what is your concern?

harshsbhat · 2024-09-18T10:58:49Z

PC:

Phone:

this is the new design

I have pushed the changes

that works 👍

vercel · 2024-09-18T11:01:21Z

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 18, 2024 3:25pm
planetfall	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 3:25pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 3:25pm
workflows	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 3:25pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2024 3:25pm

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

harshsbhat added 2 commits September 18, 2024 00:24

Show keyId after creating a new key

fc97d5b

lint

22c91d0

harshsbhat requested review from chronark, mcstepp and perkinsjr as code owners September 17, 2024 18:58

Merge branch 'main' into harshbhat/show-keyId

08ef910

chronark requested changes Sep 18, 2024

View reviewed changes

Merge branch 'main' into harshbhat/show-keyId

fec0edf

Requested changes

8938219

vercel bot deployed to Preview – www September 18, 2024 11:02 View deployment

vercel bot deployed to Preview – planetfall September 18, 2024 11:03 View deployment

vercel bot deployed to Preview – workflows September 18, 2024 11:04 View deployment

vercel bot deployed to Preview – dashboard September 18, 2024 11:05 View deployment

chronark requested changes Sep 18, 2024

View reviewed changes

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx Outdated Show resolved Hide resolved

Removed unused component

403156b

chronark enabled auto-merge September 18, 2024 15:18

chronark approved these changes Sep 18, 2024

View reviewed changes

chronark self-assigned this Sep 18, 2024

vercel bot deployed to Preview – www September 18, 2024 15:20 View deployment

vercel bot deployed to Preview – planetfall September 18, 2024 15:21 View deployment

vercel bot deployed to Preview – workflows September 18, 2024 15:22 View deployment

vercel bot deployed to Preview – play September 18, 2024 15:22 View deployment

vercel bot deployed to Preview – dashboard September 18, 2024 15:25 View deployment

chronark added this pull request to the merge queue Sep 18, 2024

Merged via the queue into unkeyed:main with commit 4ae69e9 Sep 18, 2024

This was referenced Sep 18, 2024

feat: Recoverable keys feature for the dashboard #2110

Closed

fix: Improve errors and remove parser to get accurate toasts #2115

Merged

fix: upsert identity when creating keys in dashboard #2111

Closed

feat: encrypt metadata feature #2059

Closed

coderabbitai bot mentioned this pull request Oct 10, 2024

fix: breadcrumb cache issue #2215

Merged

17 tasks

coderabbitai bot mentioned this pull request Nov 5, 2024

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

Merged

18 tasks

This was referenced Dec 9, 2024

docs: add an example of how the prefix looks #2722

Merged

feat: new navbar and breadcrumbs #2743

Merged

feat: metrics ui component #2745

Merged

Replace breadcrumbs #2749

Closed

coderabbitai bot mentioned this pull request Dec 16, 2024

refactor: replace breadcrumbs with new top navbar #2753

Merged

18 tasks

coderabbitai bot mentioned this pull request Dec 28, 2024

feat: create recoverable keys from dashboard #2783

Closed

18 tasks

coderabbitai bot mentioned this pull request Jan 8, 2025

fix: UI for update and create key #2795

Merged

18 tasks

coderabbitai bot mentioned this pull request Apr 22, 2025

feat: keys create wizard #3156

Merged

18 tasks

coderabbitai bot mentioned this pull request May 8, 2025

fix: wording and style issues #3235

Merged

18 tasks

Conversation

harshsbhat commented Sep 17, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Sep 17, 2024

Uh oh!

coderabbitai bot commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chronark left a comment

Choose a reason for hiding this comment

Uh oh!

harshsbhat commented Sep 18, 2024

Uh oh!

chronark commented Sep 18, 2024

Uh oh!

harshsbhat commented Sep 18, 2024

Uh oh!

chronark commented Sep 18, 2024

Uh oh!

harshsbhat commented Sep 18, 2024

Uh oh!

vercel bot commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

harshsbhat commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Sep 17, 2024 •

edited

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Sep 17, 2024 •

edited

Loading

vercel bot commented Sep 18, 2024 •

edited

Loading