Skip to content

fix: ENG-1637: Unifiy Byte length across the menu #2920

Merged
chronark merged 3 commits intomainfrom
bytes-fix
Feb 27, 2025
Merged

fix: ENG-1637: Unifiy Byte length across the menu #2920
chronark merged 3 commits intomainfrom
bytes-fix

Conversation

@perkinsjr
Copy link
Member

@perkinsjr perkinsjr commented Feb 26, 2025

What does this PR do?

Makes Bytes 8-255 with errors across the entire dashboard including tRPC errors.

Fixes # ENG-1637

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?

  • Test A
  • Test B

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

  • Bug Fixes
    • Clarified error messages and refined input validation for key sizes to ensure users enter a valid range (8–255 bytes).
  • Refactor
    • Enhanced error handling to provide meaningful messages during key creation errors.

@linear
Copy link

linear bot commented Feb 26, 2025

@changeset-bot
Copy link

changeset-bot bot commented Feb 26, 2025

⚠️ No Changeset found

Latest commit: b1d892f

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 Feb 26, 2025

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 Feb 26, 2025 7:50pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2025 7:50pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2025 7:50pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2025 7:50pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

Warning

Rate limit exceeded

@perkinsjr has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2ae5106 and b1d892f.

📒 Files selected for processing (4)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (1 hunks)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/validation.ts (1 hunks)
  • apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx (1 hunks)
  • apps/dashboard/lib/trpc/routers/key/create.ts (1 hunks)
📝 Walkthrough

Walkthrough

This pull request modifies the key creation and validation logic across several components. The CreateKey component's error handling has been improved to provide a default error message when specific error details are unavailable. Additionally, the validation logic for the bytes field has been adjusted, lowering the minimum value requirement from 16 to 8, introducing a maximum limit of 255 bytes, and updating error messages accordingly. Similar changes were made to the defaultBytes field validation, ensuring consistency in error reporting and validation criteria.

Changes

Files Change Summary
apps/dashboard/.../new/client.tsx Enhanced error handling in the CreateKey component: added a default error message for unspecified errors.
apps/dashboard/.../new/validation.ts, apps/dashboard/.../settings/default-bytes.tsx, apps/dashboard/.../routers/key/create.ts Updated validation logic: changed the minimum bytes value from 16 to 8, introduced a maximum constraint of 255, and reformatted error messages for clarity.

Possibly related PRs

  • fix: create key toggle issue #2711: The changes in the main PR regarding error handling in the CreateKey component are related to the modifications in the CreateKey component of the retrieved PR, which also involves updates to the same component's functionality and error handling.
  • fix: UI for update and create key #2795: The changes in the main PR regarding the validation logic for the bytes field are related to the modifications in the CreateKey component of the retrieved PR, which also involves validation logic for similar fields.
  • fix: key creation and default prefix #2816: The changes in the main PR related to the validation logic for the bytes field are directly connected to the modifications in the createKey procedure in the retrieved PR, which also updates the validation for the bytes parameter.

Suggested labels

Bug, Needs Approval

Suggested reviewers

  • mcstepp
  • chronark
  • ogzhanolguncu
  • 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 generate docstrings to generate docstrings for this 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 Feb 26, 2025

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

@chronark chronark added this pull request to the merge queue Feb 27, 2025
Merged via the queue into main with commit 81c9b63 Feb 27, 2025
27 of 29 checks passed
@chronark chronark deleted the bytes-fix branch February 27, 2025 15:45
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.

2 participants