fix: don't retry on 4XX

[chronark]

Summary by CodeRabbit

• Bug Fixes
  • Improved error management to prevent unnecessary retries when client-side errors occur.
  • Enhanced response validation now reliably recognizes successful responses only within the standard range.
  • Updated logging provides clearer details during error events for better tracking.

[vercel]

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	Feb 3, 2025 6:00pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 3, 2025 6:00pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 3, 2025 6:00pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 3, 2025 6:00pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 5f302c3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@unkey/api	Patch
@unkey/hono	Patch
@unkey/nextjs	Patch
@unkey/ratelimit	Patch
@unkey/dashboard	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the error handling in the Unkey API client. It modifies the dependency declaration for the API patch and refines the fetch method in the Unkey class. The changes enforce that only responses with status codes in the 200–299 range are treated as successful, while client-side errors (400–499) are explicitly handled without triggering retry logic. Additionally, the logging and error messaging within the retry flow have been updated for enhanced clarity.

Changes

File(s)	Change Summary
.changeset/violet-pianos-invent.md	Updated the dependency for @unkey/api to indicate a patch release; specifies that requests returning 4XX are not retried.
packages/api/.../client.ts	Modified the fetch method in the Unkey class to explicitly check for successful responses (200–299), handle client errors (400–499) with clear logging, and return an ErrorResponse for such errors.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant UnkeyAPI
    Client->>UnkeyAPI: fetch(request)
    UnkeyAPI->>UnkeyAPI: Make HTTP call
    alt Response status 200–299
        UnkeyAPI-->>Client: Return Successful Response
    else Response status 400–499
        UnkeyAPI-->>Client: Return ErrorResponse (no retry)
    else Other status codes
        UnkeyAPI-->>Client: Possibly trigger retry logic with detailed logging
    end

Loading

Possibly related PRs

• fix: changed return to match shape of error. #2744: Modifies error handling logic within the fetch method of the Unkey class.
• feat: override methods in sdk #2668: Introduces new methods related to rate limit overrides in the Unkey class, indicating a similar area of impact.
• fix: structure error returned without nested errors #2629: Updates the error structure returned by the fetch method, directly relating to modifications in error handling.

Suggested reviewers

• mcstepp
• perkinsjr
• MichaelUnkey
• ogzhanolguncu

---

📜 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 99eb9d9 and 5f302c3.

📒 Files selected for processing (2)

• .changeset/violet-pianos-invent.md (1 hunks)
• packages/api/src/client.ts (1 hunks)

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

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

🔇 Additional comments (2)

packages/api/src/client.ts (1)

180-187: LGTM! Improved error handling and retry logic.

The changes correctly implement the "don't retry on 4XX" requirement by:

1. Properly identifying successful responses (200-299)
2. Immediately returning client errors (400-499) without retrying
3. Enhancing debug logs with status code information

Also applies to: 189-194

.changeset/violet-pianos-invent.md (1)

1-5: LGTM! Appropriate changeset configuration.

The changeset correctly specifies a patch update with a clear description that matches the implementation.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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! 🙏