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

chronark · 2024-12-09T08:22:55Z

Summary by CodeRabbit

New Features
- Updated the CreateKey component with enhanced user guidance, including example formats for the prefix field.
- Improved error handling for JSON input in the metadata field.
Bug Fixes
- Clarified logic for handling the refillDay during form submission.
User Experience Enhancements
- Maintained responsiveness and interaction features, including toggling visibility for the API key and snippet.

changeset-bot · 2024-12-09T08:22:59Z

⚠️ No Changeset found

Latest commit: dc7b578

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-12-09T08:22:59Z

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	Dec 9, 2024 8:33am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 9, 2024 8:33am
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 9, 2024 8:33am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 9, 2024 8:33am

coderabbitai · 2024-12-09T08:23:03Z

📝 Walkthrough

Walkthrough

The changes in this pull request focus on the CreateKey component within the new/client.tsx file. Key modifications include an updated FormDescription for the prefix field to provide an example format, and clarified logic for handling the refillDay in the onSubmit function. While the core functionality of various FormField components remains unchanged, improvements have been made in user guidance and error handling, particularly for JSON input in the metadata field. The overall structure and responsiveness of the form are preserved.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx	- Updated `FormDescription` for `prefix` field to include example format. - Clarified `refillDay` logic in `onSubmit` function. - Retained core functionality of `FormField` components. - Improved error handling for JSON input in metadata field. - Maintained form structure and user interaction features.

Possibly related PRs

fix: create key toggle issue #2711: The changes in this PR also modify the CreateKey component in the new/client.tsx file, particularly in the onSubmit function and error handling for form submissions, which are directly related to the enhancements made in the main PR.

Suggested reviewers

mcstepp
perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c3bc3b0 and dc7b578.

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

github-actions · 2024-12-09T08:23:08Z

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

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (3)
254-257: LGTM! Clear and helpful example format.

The example effectively shows how the prefix will be used in the final API key format. The monospace font helps distinguish the format pattern clearly.

Consider adding a concrete example with actual values to make it even clearer:
-              {"<prefix>_randombytes"}
+              {"<prefix>_randombytes"} (e.g. "myapp_abc123")
Line range hint 47-54: Fix the refill day reset logic

There's a bug in the refill day handling code. The statement refill?.refillDay === undefined is a comparison that doesn't have any effect. It should be an assignment to reset the refill day for daily intervals.

Apply this fix:
    const refill = values.limit?.refill;
    if (refill?.interval === "daily") {
-     refill?.refillDay === undefined;
+     refill.refillDay = undefined;
    }
    if (refill?.interval === "monthly" && !refill.refillDay) {
      refill.refillDay = 1;
    }
Line range hint 673-686: Enhance JSON validation error handling

The current JSON validation provides a generic "Invalid JSON" error message. Consider enhancing the error handling to provide more specific feedback about syntax errors.

Here's an improved version:
    try {
      if (field.value) {
        const parsed = JSON.parse(field.value);
        field.onChange(JSON.stringify(parsed, null, 2));
        form.clearErrors("meta");
      }
    } catch (_e) {
+     const error = _e as SyntaxError;
      form.setError("meta", {
        type: "manual",
-       message: "Invalid JSON",
+       message: `Invalid JSON: ${error.message}`,
      });
    }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a7a2e62 and c3bc3b0.

📒 Files selected for processing (1)

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

docs: add an example of how the prefix looks

c3bc3b0

chronark requested review from perkinsjr, mcstepp and ogzhanolguncu as code owners December 9, 2024 08:22

vercel bot deployed to Preview – play December 9, 2024 08:23 View deployment

vercel bot deployed to Preview – engineering December 9, 2024 08:24 View deployment

vercel bot deployed to Preview – www December 9, 2024 08:24 View deployment

coderabbitai bot reviewed Dec 9, 2024

View reviewed changes

chore: use span

dc7b578

vercel bot deployed to Preview – engineering December 9, 2024 08:28 View deployment

vercel bot deployed to Preview – play December 9, 2024 08:29 View deployment

vercel bot deployed to Preview – www December 9, 2024 08:30 View deployment

vercel bot deployed to Preview – dashboard December 9, 2024 08:33 View deployment

chronark enabled auto-merge December 9, 2024 08:40

chronark disabled auto-merge December 9, 2024 14:09

chronark merged commit 62764a6 into main Dec 9, 2024
25 of 27 checks passed

chronark deleted the prefix-explanation branch December 9, 2024 14:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

chronark commented Dec 9, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Dec 9, 2024 •

edited

Loading

vercel bot commented Dec 9, 2024 •

edited

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Dec 9, 2024 •

edited

Loading

coderabbitai bot left a comment

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

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

Conversation

chronark commented Dec 9, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

Summary by CodeRabbit

changeset-bot bot commented Dec 9, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Dec 9, 2024 • edited Loading

coderabbitai bot commented Dec 9, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Dec 9, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

chronark commented Dec 9, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Dec 9, 2024 •

edited

Loading

vercel bot commented Dec 9, 2024 •

edited

Loading

coderabbitai bot commented Dec 9, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Dec 9, 2024 •

edited

Loading