feat: allow setting a remaining cost when verifying keys

[chronark]

Summary by CodeRabbit

• New Features

  • Enhanced API key verification with customizable request cost.
  • Added ability to specify token deduction for API key usage.
  • Introduced more flexible usage limit tracking.

• Improvements

  • Allows zero-cost requests even when key usage is exhausted.
  • Supports granular control over API key request limits.

• Tests

  • Added new test cases for custom request cost scenarios.
  • Verified behavior of key verification with different usage costs.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2025 3:18pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2025 3:18pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 10, 2025 3:18pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Jan 10, 2025 3:18pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: d03fc38

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces two new constants for cost management and modifies the verifyKey and _verifyKey methods in the KeyService class to include an optional remaining property in their request parameters. Additionally, it updates the DurableObjectUsagelimiter class to handle request limits based on variable costs. The request and response schemas for the verifyKey operation are also updated to include the new remaining field, enhancing the flexibility of API key usage management.

Changes

File	Change Summary
apps/api/src/pkg/keys/service.ts	Added DEFAULT_REMAINING_COST and DEFAULT_RATELIMIT_COST constants; updated verifyKey and _verifyKey method signatures to include optional remaining property with cost.
apps/api/src/pkg/usagelimit/durable_object.ts	Modified request limit logic to check if req.cost is not zero and updated remaining requests decrement to use req.cost.
apps/api/src/pkg/usagelimit/interface.ts	Added cost property to limitRequestSchema.
apps/api/src/routes/v1_keys_verifyKey.test.ts	Introduced new test suite to validate behavior with custom costs and zero-cost requests.
apps/api/src/routes/v1_keys_verifyKey.ts	Updated request and response schemas to include remaining field, with default cost set to 1.

Sequence Diagram

sequenceDiagram
    participant Client
    participant KeyService
    participant UsageLimiter
    participant Database

    Client->>KeyService: Verify Key (with optional remaining)
    KeyService->>UsageLimiter: Check Usage Limit
    UsageLimiter->>Database: Validate Remaining Uses
    Database-->>UsageLimiter: Return Remaining Count
    UsageLimiter-->>KeyService: Confirm/Deny Request
    KeyService-->>Client: Return Verification Result

Loading

Possibly related PRs

• fix: default ratelimits #2103: The changes in the KeyService class regarding rate limits are related to the main PR's updates to the verifyKey method.
• feat: allow-developer-to-set-a-custom-refill-time-when-using-the #2114: This PR introduces a new optional field in the verifyKey request body schema, aligning with the main PR's addition of the remaining property.
• feat(keys/service.ts): enhance error message in KeyService for missing ratelimit #2130: Enhancements to error messages in the KeyService for missing rate limits are relevant to the changes made in the main PR.
• chore: more logging and retries #2475: Modifications in the verifyKey and _verifyKey methods to include retry logic and logging are directly related to the changes made in the main PR.
• fix: updating name does not affect ratelimits #2693: The test case verifying that updating a key's name does not affect its rate limits is relevant as it ensures that the rate limit configurations remain intact.
• fix: verification_v2 mvs are missing outcome in sort key #2724: Although primarily focused on SQL schema changes, the context of verification processes is relevant to the main PR's updates.
• feat: add more cloudflare ratelimits #2636: The addition of more Cloudflare rate limits is related to the overall theme of rate limit management present in the main PR's changes.

Suggested reviewers

• mcstepp
• perkinsjr
• MichaelUnkey

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3ad887d and d03fc38.

📒 Files selected for processing (2)

• apps/api/src/pkg/keys/service.ts (7 hunks)
• apps/api/src/routes/v1_keys_verifyKey.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• apps/api/src/routes/v1_keys_verifyKey.ts
• apps/api/src/pkg/keys/service.ts

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: Test Packages / Test ./packages/hono
• 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 Agent Local / test_agent_local
• GitHub Check: Build / Build
• GitHub Check: Test API / API Test Local
• GitHub Check: autofix
• GitHub Check: Analyze (javascript-typescript)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

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