chore: Minimum byte length should be consistent by harshsbhat · Pull Request #2880 · unkeyed/unkey

harshsbhat · 2025-02-09T14:15:41Z

What does this PR do?

The minimum byte length for keys is 8 on the dashboard and 16 on the API. This PR makes sure that it is consistent on both API and Dashboard by making it 16 on the dashboard.

Fixes #2564

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

Bug Fixes
- Enhanced input validation for numeric byte fields across dashboard forms and APIs. Users now must enter a value of at least 16 for key and default byte settings, ensuring more robust and consistent input handling while keeping error messaging unchanged.

changeset-bot · 2025-02-09T14:15:45Z

⚠️ No Changeset found

Latest commit: 96e4ab3

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 · 2025-02-09T14:15:47Z

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

vercel · 2025-02-09T14:15:48Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2025-02-09T14:15:51Z

📝 Walkthrough

Walkthrough

This pull request updates numeric validation for byte length fields across both the web app and API backend. The minimum allowed value for the key’s byte length in the key creation form and default bytes setting has been increased to 16. The changes adjust the validation rules in multiple files by updating the minimum constraints in the form schemas and TRPC procedures.

Changes

File(s)	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/…/validation.ts apps/dashboard/lib/trpc/routers/key/create.ts	Updated the validation for the `bytes` field, changing the minimum value from 1 (or no explicit minimum) to 16, while retaining the default value of 16.
apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx apps/dashboard/lib/trpc/routers/api/setDefaultBytes.ts	Modified the validation for the `defaultBytes` field by increasing the minimum allowed value from 8 to 16; maximum remains at 255 and the field stays optional.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant "Key Creation Service"
    participant "Validation Module"
    
    User->>Key Creation Service: Submit key creation form (bytes field)
    Key Creation Service->>Validation Module: Validate bytes (value must be ≥ 16)
    Validation Module-->>Key Creation Service: Return validation result
    Key Creation Service-->>User: Respond with success or error

Assessment against linked issues

Objective	Addressed	Explanation
Enforce a minimum byte length of 16 for both the key creation form and Default Bytes setting [#2564]	✅
Utilize the configured default byte length for key creation when the field is not provided [#2564]	❌	The change applies a static default of 16 rather than using a dynamic `api.defaultByteLength` value.

Possibly related PRs

fix: keys setting vulns #2718: Updates in the default bytes validation logic in the setDefaultApiBytes procedure are similar to the changes here.
fix: key creation and default prefix #2816: Aligns with modifications enforcing a minimum constraint of 16 for the bytes field in the createKey procedure.
fix: Default Bytes should only allow numbers #2380: Implements stricter validation for byte fields, closely related to the current updates.

Suggested labels

Feature

Suggested reviewers

mcstepp
perkinsjr
chronark

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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. (Beta)
@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 · 2025-02-09T14:15:53Z

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

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (1)

apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx (1)
73-73: Update UI description to reflect new minimum byte length.

The description still mentions "8 to 255" but should be updated to "16 to 255" to match the new validation.
-            <span className="font-bold">8 to 255</span>
+            <span className="font-bold">16 to 255</span>

🧹 Nitpick comments (1)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/validation.ts (1)
13-14: Consider improving error message for better clarity.

While the validation change is correct, the error message could be more specific about the minimum value requirement.
       message:
         issue.code === "invalid_type"
-            ? "Amount must be a number and greater than 0"
+            ? "Amount must be a number and at least 16"
            : defaultError,

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 67213d2 and 96e4ab3.

📒 Files selected for processing (4)

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/api/setDefaultBytes.ts (1 hunks)
apps/dashboard/lib/trpc/routers/key/create.ts (1 hunks)

🔇 Additional comments (3)

apps/dashboard/lib/trpc/routers/api/setDefaultBytes.ts (1)

14-14: LGTM! Minimum byte length updated to 16.

The change aligns with the PR objective to standardize minimum byte length across the dashboard and API.

apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx (1)

24-24: LGTM! Minimum byte length updated to 16.

The validation change aligns with the PR objective.

apps/dashboard/lib/trpc/routers/key/create.ts (1)

14-14: LGTM! Minimum byte length updated to 16.

The change aligns with the PR objective and maintains consistency with other files.

fix: Minimum byte length should be consistent

96e4ab3

harshsbhat requested review from chronark, mcstepp, ogzhanolguncu and perkinsjr as code owners February 9, 2025 14:15

github-actions bot added the Bug Something isn't working label Feb 9, 2025

vercel bot deployed to Preview – engineering February 9, 2025 14:16 View deployment

coderabbitai bot reviewed Feb 9, 2025

View reviewed changes

chronark approved these changes Feb 9, 2025

View reviewed changes

chronark enabled auto-merge February 9, 2025 16:37

vercel bot deployed to Preview – play February 10, 2025 10:06 View deployment

vercel bot deployed to Preview – www February 10, 2025 10:07 View deployment

vercel bot deployed to Preview – dashboard February 10, 2025 10:08 View deployment

chronark added this pull request to the merge queue Feb 10, 2025

Merged via the queue into unkeyed:main with commit 3d678ad Feb 10, 2025
24 of 27 checks passed

coderabbitai bot mentioned this pull request Feb 13, 2025

fix: Stop whitespace in prefixes and fixes validation on bytes #2893

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Minimum byte length should be consistent#2880

chore: Minimum byte length should be consistent#2880
chronark merged 1 commit intounkeyed:mainfrom
harshsbhat:min-bytes

harshsbhat commented Feb 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Feb 9, 2025

Uh oh!

vercel bot commented Feb 9, 2025 •

edited

Loading

Uh oh!

vercel bot commented Feb 9, 2025

Uh oh!

coderabbitai bot commented Feb 9, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

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

Uh oh!

github-actions bot commented Feb 9, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

harshsbhat commented Feb 9, 2025 • 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 Feb 9, 2025

⚠️ No Changeset found

Uh oh!

vercel bot commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Feb 9, 2025

Uh oh!

coderabbitai bot commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

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

Uh oh!

github-actions bot commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

harshsbhat commented Feb 9, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Feb 9, 2025 •

edited

Loading

coderabbitai bot commented Feb 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Feb 9, 2025 •

edited

Loading