fix: Default Bytes should only allow numbers #2380

harshsbhat · 2024-10-13T12:17:14Z

What does this PR do?

It makes sure that the user cannot type in "non number" characters for default bytes

Fixes #2359

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:

Go to API settings -> enter a string as a default byte. It won't allow you to do so.

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 the DefaultBytes component to accept only numeric input for better validation.
- Added a description emphasizing that the default byte size must be between 8 and 255.
Bug Fixes
- Updated input handling to ensure that the form state accurately reflects numeric values entered by the user.
Improvements
- Reformatted query conditions in the OverridePage component for improved readability without altering functionality.

changeset-bot · 2024-10-13T12:17:18Z

⚠️ No Changeset found

Latest commit: 897cdad

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-10-13T12:17:20Z

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	Oct 30, 2024 0:19am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 30, 2024 0:19am

vercel · 2024-10-13T12:17:21Z

@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-10-13T12:17:21Z

📝 Walkthrough

Walkthrough

The changes in this pull request focus on the DefaultBytes component in the default-bytes.tsx file. The primary modification involves adding a type="number" attribute to the Input component within a FormField, ensuring that only numeric values can be entered. Additionally, the onChange handler has been updated to convert input values to numbers, aligning the input behavior with the validation requirements.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx	Added `type="number"` to `Input` component and updated `onChange` handler to convert input to number.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/overrides/page.tsx	Reformatted query conditions in `db.query.ratelimitNamespaces.findFirst` for improved readability.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent non-numeric input in Default Bytes field (2359)	✅

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-10-13T12:17:28Z

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

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

apps/dashboard/app/(app)/apis/[apiId]/settings/default-bytes.tsx (2)
87-89: Excellent changes to restrict input to numbers only!

The modifications effectively address the issue of allowing only numeric input for the Default Bytes field:

Adding type="number" to the Input component restricts user input to numbers only.

Converting the input value to a number in the onChange handler ensures that the form state always contains a numeric value.

These changes align perfectly with the PR objectives and resolve the issue mentioned in #2359.

Consider adding a min and max attribute to the Input component to match the zod schema constraints:
 <Input
   className="max-w-sm"
   type="number"
+  min={8}
+  max={255}
   autoComplete="off"
   onChange={(e) => field.onChange(Number(e.target.value))}
 />
This will provide an additional layer of input validation directly in the browser.

Line range hint 52-57: Consider improving the error handling logic

The current implementation prevents submission when the defaultBytes value is unchanged or undefined. While this is a good check, it might be more user-friendly to handle this case differently.

Consider the following improvements:

Move this check to the form validation level by extending the zod schema:
const formSchema = z.object({
  // ... other fields
  defaultBytes: z
    .number()
    .min(8, "Byte size needs to be at least 8")
    .max(255, "Byte size cannot exceed 255")
    .refine((val) => val !== keyAuth.defaultBytes, {
      message: "Please provide a different byte-size than the existing one",
    })
    .optional(),
});
Remove the manual check in the onSubmit function:
 async function onSubmit(values: z.infer<typeof formSchema>) {
-  if (values.defaultBytes === keyAuth.defaultBytes || !values.defaultBytes) {
-    return toast.error(
-      "Please provide a different byte-size than already existing one as default",
-    );
-  }
   await setDefaultBytes.mutateAsync(values);
 }
These changes will provide more consistent error handling and improve the user experience by showing validation errors directly in the form.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7972170 and 1b86852.

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (1)

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

Line range hint 1-105: Summary of the review

The changes implemented in this PR effectively address the issue of allowing only numeric input for the Default Bytes field. The addition of type="number" and the conversion of input to a number in the onChange handler ensure that only valid numeric values are accepted and stored.

The overall implementation of the DefaultBytes component is solid, with proper form validation using zod and appropriate error handling. Two minor improvements were suggested:

Adding min and max attributes to the Input component for additional browser-level validation.

Refining the error handling logic for unchanged values by moving the check to the zod schema and simplifying the onSubmit function.

These suggestions aim to further enhance the user experience and maintain consistent validation throughout the component.

harsha-kidambi · 2024-10-13T12:36:10Z

/assign

oss-gg · 2024-10-13T12:36:12Z

The /assign command can only be used on issues, not on pull requests.

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

perkinsjr

see my last comment.

harshsbhat · 2024-10-14T03:46:44Z

see my last comment.
give me 2 seconds. I will fix & push this

harshsbhat · 2024-10-14T04:55:47Z

@perkinsjr using type="number" is going to keep that 0 at the start. Everything Is working fine now IMO. Please check

This will just make sure that onChange={(e) => field.onChange(Number(e.target.value.replace(/\D/g, "")))} the user cannot type a string AND not keep the 0 at the start too.

oss-gg · 2024-10-30T12:29:34Z

Awarding harshsbhat: 50 points 🕹️ Well done! Check out your new contribution on oss.gg/harshsbhat

fix: Default Bytes should only allow numbers

5bdd113

harshsbhat requested review from perkinsjr, chronark and mcstepp as code owners October 13, 2024 12:17

github-actions bot added 🕹️ 50 points Bug Something isn't working 🕹️ oss.gg labels Oct 13, 2024

Merge branch 'main' into harshbhat/defaultByte-Number

1b86852

vercel bot deployed to Preview – engineering October 13, 2024 12:18 View deployment

coderabbitai bot reviewed Oct 13, 2024

View reviewed changes

perkinsjr self-assigned this Oct 13, 2024

vercel bot deployed to Preview – dashboard October 13, 2024 15:57 View deployment

perkinsjr requested changes Oct 13, 2024

View reviewed changes

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

adding the field back on

bbbb66b

vercel bot deployed to Preview – engineering October 13, 2024 16:11 View deployment

perkinsjr requested changes Oct 13, 2024

View reviewed changes

Merge branch 'main' into harshbhat/defaultByte-Number

5ca2092

vercel bot deployed to Preview – engineering October 14, 2024 03:47 View deployment

new changes to make sure its not 0number

2a65fb8

vercel bot deployed to Preview – engineering October 14, 2024 04:46 View deployment

vercel bot deployed to Preview – dashboard October 14, 2024 14:02 View deployment

Merge branch 'main' into harshbhat/defaultByte-Number

78220bd

vercel bot deployed to Preview – engineering October 14, 2024 19:26 View deployment

Merge branch 'main' into harshbhat/defaultByte-Number

8d101ac

vercel bot deployed to Preview – engineering October 29, 2024 04:57 View deployment

Merge branch 'main' into harshbhat/defaultByte-Number

fe71f58

vercel bot deployed to Preview – engineering October 30, 2024 09:44 View deployment

[autofix.ci] apply automated fixes

dbaba64

vercel bot deployed to Preview – engineering October 30, 2024 11:58 View deployment

Merge branch 'main' into harshbhat/defaultByte-Number

897cdad

vercel bot deployed to Preview – engineering October 30, 2024 12:09 View deployment

vercel bot deployed to Preview – dashboard October 30, 2024 12:19 View deployment

perkinsjr self-requested a review October 30, 2024 12:29

perkinsjr approved these changes Oct 30, 2024

View reviewed changes

perkinsjr merged commit 7c76890 into unkeyed:main Oct 30, 2024
20 of 24 checks passed

coderabbitai bot mentioned this pull request Dec 6, 2024

fix: keys setting vulns #2718

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Default Bytes should only allow numbers #2380

fix: Default Bytes should only allow numbers #2380

harshsbhat commented Oct 13, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 13, 2024 •

edited

Loading

vercel bot commented Oct 13, 2024 •

edited

Loading

vercel bot commented Oct 13, 2024

coderabbitai bot commented Oct 13, 2024 •

edited

Loading

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

github-actions bot commented Oct 13, 2024 •

edited

Loading

coderabbitai bot left a comment

harsha-kidambi commented Oct 13, 2024

oss-gg bot commented Oct 13, 2024

perkinsjr left a comment

harshsbhat commented Oct 14, 2024

harshsbhat commented Oct 14, 2024

oss-gg bot commented Oct 30, 2024

fix: Default Bytes should only allow numbers #2380

fix: Default Bytes should only allow numbers #2380

Conversation

harshsbhat commented Oct 13, 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 Oct 13, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Oct 13, 2024 • edited Loading

vercel bot commented Oct 13, 2024

coderabbitai bot commented Oct 13, 2024 • edited Loading

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

github-actions bot commented Oct 13, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

harsha-kidambi commented Oct 13, 2024

oss-gg bot commented Oct 13, 2024

perkinsjr left a comment

Choose a reason for hiding this comment

harshsbhat commented Oct 14, 2024

harshsbhat commented Oct 14, 2024

oss-gg bot commented Oct 30, 2024

harshsbhat commented Oct 13, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 13, 2024 •

edited

Loading

vercel bot commented Oct 13, 2024 •

edited

Loading

coderabbitai bot commented Oct 13, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Oct 13, 2024 •

edited

Loading