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: enable card correctly #2794

Merged
merged 1 commit into from
Jan 8, 2025
Merged

fix: enable card correctly #2794

merged 1 commit into from
Jan 8, 2025

Conversation

chronark
Copy link
Collaborator

@chronark chronark commented Jan 8, 2025

the card was disabled when the remaining reached 0,
which is a perfectly fine state, as long as the refill
is configured to be greater than 0 as well

Summary by CodeRabbit

  • Bug Fixes
    • Improved key limit settings logic to more accurately reflect API key remaining and refill configurations.
    • Enhanced form initialization to better handle key limit states.

the card was disabled when the remaining reached 0,
which is a perfectly fine state, as long as the refill
is configured to be greater than 0 as well
Copy link

vercel bot commented Jan 8, 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 Jan 8, 2025 5:43pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 5:43pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 5:43pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 5:43pm

Copy link

changeset-bot bot commented Jan 8, 2025

⚠️ No Changeset found

Latest commit: 16a4950

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

@chronark chronark marked this pull request as ready for review January 8, 2025 17:39
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the UpdateKeyRemaining component in the API keys settings page, specifically adjusting the logic for determining the limitEnabled field. The change expands the condition for enabling limits by checking both the remaining and refillAmount properties of an API key. This modification allows the limit to be considered enabled under a broader set of circumstances, potentially providing more flexibility in how key usage limits are configured.

Changes

File Change Summary
apps/dashboard/.../update-key-remaining.tsx Modified limitEnabled initialization logic to check both apiKey.remaining and apiKey.refillAmount

Sequence Diagram

sequenceDiagram
    participant User
    participant UpdateKeyRemaining
    participant APIKey

    User->>UpdateKeyRemaining: Open key settings
    UpdateKeyRemaining->>APIKey: Retrieve key details
    UpdateKeyRemaining->>UpdateKeyRemaining: Determine limitEnabled
    alt Limit Enabled
        UpdateKeyRemaining-->>User: Show limit configuration options
    else Limit Disabled
        UpdateKeyRemaining-->>User: Hide limit configuration
    end
Loading

The sequence diagram illustrates how the updated limitEnabled logic determines the visibility and configuration of key usage limits based on the API key's properties.


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.

Copy link
Contributor

github-actions bot commented Jan 8, 2025

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: 0

🧹 Nitpick comments (1)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-remaining.tsx (1)

Line range hint 70-77: Consider adding validation for consistent form state.

The form initialization allows for a potentially inconsistent state where limitEnabled is true but remaining is undefined. Consider adding validation in the form schema to ensure that when limitEnabled is true, remaining must be defined.

 const formSchema = z.object({
   keyId: z.string(),
   limitEnabled: z.boolean(),
-  remaining: z.coerce.number().positive({ message: "Please enter a positive number" }).optional(),
+  remaining: z.coerce
+    .number()
+    .positive({ message: "Please enter a positive number" })
+    .optional()
+    .superRefine((val, ctx) => {
+      const limitEnabled = ctx.parent.limitEnabled;
+      if (limitEnabled && val === undefined) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: "Remaining uses must be set when limit is enabled",
+        });
+      }
+    }),
   refill: z
     .object({
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb3b62 and 16a4950.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-remaining.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: Test Packages / Test ./packages/rbac
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Packages / Test ./internal/resend
  • GitHub Check: Test Packages / Test ./internal/keys
  • GitHub Check: Test Packages / Test ./internal/id
  • GitHub Check: Test Packages / Test ./internal/hash
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Test Packages / Test ./internal/billing
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Build / Build
  • GitHub Check: autofix
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/[keyId]/settings/update-key-remaining.tsx (1)

70-70: LGTM! The change correctly fixes the card enabling logic.

The updated condition Boolean(apiKey.remaining) || Boolean(apiKey.refillAmount) properly enables the card when either remaining uses or refill amount is configured, fixing the issue where the card was disabled when remaining balance reached zero but refill was configured.

Copy link
Collaborator

@perkinsjr perkinsjr left a comment

Choose a reason for hiding this comment

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

LGTM. Tested and works now.

@chronark chronark added this pull request to the merge queue Jan 8, 2025
Merged via the queue into main with commit 727ef7d Jan 8, 2025
28 checks passed
@chronark chronark deleted the remaining-greyed-out branch January 8, 2025 17:55
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