Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: create key toggle issue #2711

Merged
merged 1 commit into from
Dec 6, 2024
Merged

fix: create key toggle issue #2711

merged 1 commit into from
Dec 6, 2024

Conversation

ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Dec 6, 2024

What does this PR do?

  • Fixes "Limited Use" toggle issue during key creation.
  • Moves schema to validation.ts file
  • Replaces date conversion with date-fns for better readability

Fixes #2702

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?

  • Go to apis/xxx/keys/xxx/new
  • Try to toggle Limited Use
  • Watch it fail

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

  • New Features

    • Introduced a new CreateKey component with enhanced form handling and error management.
    • Added a comprehensive validation schema for API key management, ensuring input conformity.
  • Bug Fixes

    • Improved error handling for form submissions and validation feedback.
  • Documentation

    • Updated descriptions and error messages in the form for better user guidance.

Copy link

changeset-bot bot commented Dec 6, 2024

⚠️ No Changeset found

Latest commit: 241a5aa

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

Copy link

vercel bot commented Dec 6, 2024

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 6, 2024 1:55pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 1:55pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 1:55pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 1:55pm

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to the CreateKey component in the new/client.tsx file, including the addition of a utility function for date management and the restructuring of form handling logic. A new validation schema has been established in a separate validation.ts file using the Zod library, ensuring comprehensive input validation for various fields related to API key management. These changes enhance the overall functionality and maintainability of the component while addressing specific issues related to form validation.

Changes

File Change Summary
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx - Added utility function getDatePlusTwoMinutes for date formatting.
- Updated CreateKey function signature to use TypeScript annotations directly.
- Adjusted form handling logic with shouldUnregister: true.
- Enhanced onSubmit function for better handling of form values and error messages.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/validation.ts - Introduced new file defining a validation schema for form inputs using Zod, including various fields with specific validation rules.

Assessment against linked issues

Objective Addressed Explanation
Form should remain valid when toggling limited use switch (#2702)

Possibly related PRs

Suggested labels

Bug, Feature, Dashboard, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

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 github-actions bot added Bug Something isn't working Needs Approval Needs approval from Unkey labels Dec 6, 2024
Copy link
Contributor

github-actions bot commented Dec 6, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (4)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (1)

62-62: Correct the grammatical error in the comment

The comment contains a grammatical error. It should read: "Required to unregister form elements when they are not rendered."

Apply this diff to correct the comment:

-// Should required to unregister form elements when they are not rendered.
+// Required to unregister form elements when they are not rendered.
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/validation.ts (3)

21-37: Add conditional validation for meta based on metaEnabled

Currently, the meta field is validated even when metaEnabled is false. To prevent unnecessary validation and potential user confusion, consider adding conditional logic to validate meta only when metaEnabled is true.

You can modify the schema as follows:

 export const formSchema = z.object({
   // ... other fields ...
   metaEnabled: z.boolean().default(false),
-  meta: z
-    .string()
-    .refine(
-      (s) => {
-        try {
-          JSON.parse(s);
-          return true;
-        } catch {
-          return false;
-        }
-      },
-      {
-        message: "Must be valid json",
-      },
-    )
-    .optional(),
+  meta: z.string().optional(),
 }).superRefine((data, ctx) => {
+  if (data.metaEnabled) {
+    if (!data.meta) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ['meta'],
+        message: 'Metadata is required when meta is enabled.',
+      });
+    } else {
+      try {
+        JSON.parse(data.meta);
+      } catch {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          path: ['meta'],
+          message: 'Must be valid JSON.',
+        });
+      }
+    }
+  }
   // ... other superRefine logic ...
 });

This ensures that meta is only required and validated when metaEnabled is true.


38-83: Add conditional validation for limit based on limitEnabled

The limit field should be validated only when limitEnabled is true. Adding conditional validation enhances form correctness and aligns with user expectations.

You can adjust the schema as follows:

 export const formSchema = z.object({
   // ... other fields ...
   limitEnabled: z.boolean().default(false),
-  limit: z
-    .object({
-      // limit fields ...
-    })
-    .optional(),
+  limit: z.object({
+    // limit fields ...
+  }).optional(),
 }).superRefine((data, ctx) => {
+  if (data.limitEnabled) {
+    if (!data.limit) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ['limit'],
+        message: 'Limit details are required when Limited Use is enabled.',
+      });
+    }
+    // Additional conditional validations can be added here
+  }
   // ... other superRefine logic ...
 });

This modification ensures limit is required and validated only when limitEnabled is true.


84-88: Add conditional validation for expires based on expireEnabled

To prevent unnecessary validation, ensure that the expires field is only validated when expireEnabled is true.

Modify the schema as follows:

 export const formSchema = z.object({
   // ... other fields ...
   expireEnabled: z.boolean().default(false),
-  expires: z.coerce
-    .date()
-    .min(new Date(new Date().getTime() + 2 * 60000))
-    .optional(),
+  expires: z.coerce.date().optional(),
 }).superRefine((data, ctx) => {
+  if (data.expireEnabled) {
+    if (!data.expires) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ['expires'],
+        message: 'Expiry date is required when Expiration is enabled.',
+      });
+    } else if (data.expires < new Date(Date.now() + 2 * 60000)) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ['expires'],
+        message: 'Expiry date must be at least 2 minutes in the future.',
+      });
+    }
+  }
   // ... other superRefine logic ...
 });

This ensures expires is validated only when expireEnabled is true.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b8517bc and 241a5aa.

📒 Files selected for processing (2)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (4 hunks)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/validation.ts (1 hunks)
🔇 Additional comments (3)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (3)

35-35: Good use of 'date-fns' for date manipulation

The addition of addMinutes and format from date-fns improves date handling and ensures consistency across date operations.


41-42: Enhancing modularity by importing the validation schema

Importing formSchema from './validation' and typing z from zod improves code organization by separating validation logic from the component.


53-53: Simplify component definition by removing React.FC

Great job simplifying the component definition. Removing the React.FC type annotation and directly typing props enhances readability and follows current TypeScript best practices.

@chronark chronark added this pull request to the merge queue Dec 6, 2024
Merged via the queue into main with commit e622204 Dec 6, 2024
28 checks passed
@chronark chronark deleted the fix-create-key-toggle-issue branch December 6, 2024 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Needs Approval Needs approval from Unkey
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Key creation toggle limited use switch bug
2 participants