chore: dogfooding our ratelimiter before I make a PR to cal #3730

chronark · 2025-08-05T12:47:46Z

What does this PR do?

Updates package dependencies to newer versions:

@unkey/api from 2.0.0 to 2.0.3 in the API app
@unkey/ratelimit from 2.0.0 to 2.1.2 in the dashboard app

Fixes # (issue)

Type of change

Chore (refactoring code, technical debt, workflow improvements)

How should this be tested?

Verify that the API app works correctly with the updated @unkey/api package
Ensure that rate limiting functionality in the dashboard works properly with the updated @unkey/ratelimit package

Checklist

Required

Summary by CodeRabbit

Chores
- Updated internal package dependencies to newer versions for improved stability and compatibility. No user-facing changes.

changeset-bot · 2025-08-05T12:47:50Z

⚠️ No Changeset found

Latest commit: f977345

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-08-05T12:47:51Z

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	Aug 5, 2025 0:50am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 5, 2025 0:50am

coderabbitai · 2025-08-05T12:47:52Z

📝 Walkthrough

Walkthrough

This change updates the versions of two dependencies: @unkey/api in the API app and @unkey/ratelimit in the dashboard app. No other modifications to code, configuration, or exports are present.

Changes

Cohort / File(s)	Change Summary
API Dependency Update `apps/api/package.json`	Updated `@unkey/api` devDependency from `2.0.0` to `2.0.3`.
Dashboard Dependency Update `apps/dashboard/package.json`	Updated `@unkey/ratelimit` dependency from `^2.0.0` to `^2.1.2`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

feat: update ratelimit sdk to v2 #3236: Also updates @unkey/ratelimit in apps/dashboard/package.json, but to a different version and includes documentation changes.
chore: Radar prep #3269: Adds rate limiting using the @unkey/ratelimit package, which is updated in this PR.

Suggested reviewers

mcstepp
MichaelUnkey

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 67dcae0 and f977345.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (2)

apps/api/package.json (1 hunks)
apps/dashboard/package.json (1 hunks)

🧰 Additional context used

🧠 Learnings (8)

📓 Common learnings

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3321
File: apps/dashboard/lib/trpc/routers/authorization/roles/keys/schema-with-helpers.ts:5-8
Timestamp: 2025-06-18T12:28:10.449Z
Learning: In the unkey dashboard application, API validation for pagination limits is controlled at the UI level rather than requiring additional server-side validation, as the APIs are internal and protected by UI logic.

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3292
File: apps/dashboard/lib/vault.ts:60-78
Timestamp: 2025-06-02T11:09:05.843Z
Learning: The vault implementation in `apps/dashboard/lib/vault.ts` is a duplicate of the vault package from `api` and should be kept consistent with the original implementation.

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3292
File: apps/dashboard/lib/vault.ts:80-97
Timestamp: 2025-06-02T11:08:56.397Z
Learning: The vault.ts file in apps/dashboard/lib/vault.ts is a duplicate of the vault package from the `api` directory and should be kept consistent with that original implementation.

Learnt from: chronark
PR: unkeyed/unkey#2544
File: apps/api/src/pkg/env.ts:4-6
Timestamp: 2024-10-23T12:05:31.121Z
Learning: The `cloudflareRatelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interface changed; it should keep the `limit` method returning `Promise<{ success: boolean }>` without additional error properties.

📚 Learning: in the unkey codebase, openapi 3.1 is used, which allows sibling keys (such as `description`) alongs...

Learnt from: Flo4604
PR: unkeyed/unkey#3421
File: go/apps/api/openapi/openapi.yaml:196-200
Timestamp: 2025-07-03T05:58:10.699Z
Learning: In the Unkey codebase, OpenAPI 3.1 is used, which allows sibling keys (such as `description`) alongside `$ref` in schema objects. Do not flag this as an error in future reviews.

Applied to files:

apps/api/package.json

📚 Learning: applies to **/*.test.{ts,tsx} : use vitest for unit and integration tests in typescript projects...

Learnt from: CR
PR: unkeyed/unkey#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T07:44:39.438Z
Learning: Applies to **/*.test.{ts,tsx} : Use Vitest for unit and integration tests in TypeScript projects

Applied to files:

apps/api/package.json

📚 Learning: applies to **/vitest.{unit,integration}.ts : separate vitest configs: vitest.unit.ts and vitest.inte...

Learnt from: CR
PR: unkeyed/unkey#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T07:44:39.438Z
Learning: Applies to **/vitest.{unit,integration}.ts : Separate Vitest configs: vitest.unit.ts and vitest.integration.ts

Applied to files:

apps/api/package.json

📚 Learning: the `cloudflareratelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interfa...

Learnt from: chronark
PR: unkeyed/unkey#2544
File: apps/api/src/pkg/env.ts:4-6
Timestamp: 2024-10-23T12:05:31.121Z
Learning: The `cloudflareRatelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interface changed; it should keep the `limit` method returning `Promise<{ success: boolean }>` without additional error properties.

Applied to files:

apps/dashboard/package.json

📚 Learning: the vault.ts file in apps/dashboard/lib/vault.ts is a duplicate of the vault package from the `api` ...

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3292
File: apps/dashboard/lib/vault.ts:80-97
Timestamp: 2025-06-02T11:08:56.397Z
Learning: The vault.ts file in apps/dashboard/lib/vault.ts is a duplicate of the vault package from the `api` directory and should be kept consistent with that original implementation.

Applied to files:

apps/dashboard/package.json

📚 Learning: the vault implementation in `apps/dashboard/lib/vault.ts` is a duplicate of the vault package from `...

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3292
File: apps/dashboard/lib/vault.ts:60-78
Timestamp: 2025-06-02T11:09:05.843Z
Learning: The vault implementation in `apps/dashboard/lib/vault.ts` is a duplicate of the vault package from `api` and should be kept consistent with the original implementation.

Applied to files:

apps/dashboard/package.json

📚 Learning: in the unkey dashboard, when making database queries involving workspaces, use `ctx.workspace.id` di...

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#2872
File: apps/dashboard/lib/trpc/routers/ratelimit/createNamespace.ts:36-39
Timestamp: 2025-04-08T09:34:24.576Z
Learning: In the Unkey dashboard, when making database queries involving workspaces, use `ctx.workspace.id` directly instead of fetching the workspace separately for better performance and security.

Applied to files:

apps/dashboard/package.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Test API / API Test Local
GitHub Check: Build / Build
GitHub Check: Test Packages / Test
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

apps/api/package.json (1)

16-16: Confirm @unkey/api 2.0.3 bump

pnpm-lock.yaml has been updated and now includes @unkey/[email protected] ✅

No entries for v2.0.3 were found in any local CHANGELOG.md — please verify the upstream @unkey/api repo for any breaking or behavioural changes

Make sure the lockfile is committed and run pnpm test (unit + integration) end-to-end

Optional style nit: you could switch to a caret range ("^2.0.3") to match other dependencies, unless you’re intentionally pinning patch versions for reproducibility.

apps/dashboard/package.json (1)

55-55: Verify dashboard after minor bump to @unkey/ratelimit ^2.1.2

Going from 2.0.x → 2.1.x may introduce subtle API changes (e.g. new defaults or stricter typings).
• Smoke-test the dashboard’s rate-limited endpoints and run the existing Vitest suite.
• Make sure any server-side handling of the ratelimiter errors still matches expected shapes (see long-term learning about the limit() return type).

No further action needed if everything is green.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch 08-05-chore_dogfooding_our_ratelimiter_before_i_make_a_pr_to_cal

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
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 explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

chronark · 2025-08-05T12:48:05Z

chore: dogfooding our ratelimiter before I make a PR to cal #3730 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

github-actions · 2025-08-05T12:53:24Z

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

chore: dogfooding our ratelimiter before I make a PR to cal

f977345

chronark marked this pull request as ready for review August 5, 2025 12:48

chronark requested review from perkinsjr, mcstepp, ogzhanolguncu, MichaelUnkey and Flo4604 as code owners August 5, 2025 12:48

vercel bot deployed to Preview – engineering August 5, 2025 12:48 View deployment

Flo4604 approved these changes Aug 5, 2025

View reviewed changes

vercel bot deployed to Preview – dashboard August 5, 2025 12:50 View deployment

chronark merged commit ffa3c0c into main Aug 5, 2025
27 checks passed

chronark deleted the 08-05-chore_dogfooding_our_ratelimiter_before_i_make_a_pr_to_cal branch August 5, 2025 13:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: dogfooding our ratelimiter before I make a PR to cal #3730

chore: dogfooding our ratelimiter before I make a PR to cal #3730

Uh oh!

chronark commented Aug 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Aug 5, 2025

Uh oh!

vercel bot commented Aug 5, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 5, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

chronark commented Aug 5, 2025

Uh oh!

github-actions bot commented Aug 5, 2025

Uh oh!

Uh oh!

Uh oh!

chore: dogfooding our ratelimiter before I make a PR to cal #3730

chore: dogfooding our ratelimiter before I make a PR to cal #3730

Uh oh!

Conversation

chronark commented Aug 5, 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

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Aug 5, 2025

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

chronark commented Aug 5, 2025

Uh oh!

github-actions bot commented Aug 5, 2025

Uh oh!

Uh oh!

Uh oh!

chronark commented Aug 5, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 5, 2025 •

edited

Loading

coderabbitai bot commented Aug 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)