fix: catch error and return 403 by chronark · Pull Request #3856 · unkeyed/unkey

chronark · 2025-08-26T19:20:28Z

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

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?

Test A
Test B

Checklist

Required

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

Bug Fixes
- Key verification now returns clearer, consistent error responses:
  - 403 Forbidden when the associated workspace is disabled (“workspace is disabled”).
  - 400 Bad Request for validation or rate limit configuration issues.
  - Fallback to 500 Internal Server Error for unexpected cases.
Tests
- Added test coverage ensuring key verification returns 403 when the workspace is disabled.

changeset-bot · 2025-08-26T19:20:31Z

⚠️ No Changeset found

Latest commit: 5fee035

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-26T19:20:34Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
dashboard	Building	Preview	Comment	Aug 26, 2025 7:20pm
engineering	Building	Preview	Comment	Aug 26, 2025 7:20pm

coderabbitai · 2025-08-26T19:20:35Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Adds explicit error-to-HTTP mapping in legacy key verification to handle DisabledWorkspaceError (403), SchemaError and MissingRatelimitError (400), and a default 500 fallback. Introduces a test covering the disabled workspace scenario, updating imports accordingly.

Changes

Cohort / File(s)	Summary of Changes
Legacy key verification route `apps/api/src/routes/legacy_keys_verifyKey.ts`	Added error-type-aware handling: map SchemaError and MissingRatelimitError to 400, DisabledWorkspaceError to 403, else 500. Imported DisabledWorkspaceError, MissingRatelimitError, SchemaError.
Tests for legacy key verification `apps/api/src/routes/legacy_keys_verifyKey.test.ts`	Added “disabled workspace” test asserting 403 when workspace is disabled. Updated imports to include `eq` from `@unkey/db` for workspace update.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Client
  participant R as API Route /v1/keys/verify
  participant S as KeyService.verifyKey

  C->>R: POST /v1/keys/verify { key }
  R->>S: verifyKey(key)
  alt Success
    S-->>R: { valid, ... }
    R-->>C: 200 OK (verification result)
  else Error
    S-->>R: Error instance
    alt DisabledWorkspaceError
      note right of R: Map to 403
      R-->>C: 403 FORBIDDEN ("workspace is disabled")
    else SchemaError or MissingRatelimitError
      note right of R: Map to 400
      R-->>C: 400 BAD_REQUEST (message)
    else Other error
      note right of R: Fallback
      R-->>C: 500 INTERNAL_SERVER_ERROR (message)
    end
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

fix: ensure workspace is loaded #2470 — Adjusts service-layer behavior around DisabledWorkspaceError, complementing this PR’s route-level 403 handling and added test.

Suggested labels

Bug

Suggested reviewers

mcstepp
MichaelUnkey
perkinsjr

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 041591d and 5fee035.

📒 Files selected for processing (2)

apps/api/src/routes/legacy_keys_verifyKey.test.ts (2 hunks)
apps/api/src/routes/legacy_keys_verifyKey.ts (2 hunks)

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch 08-26-fix_catch_error_and_return_403

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.
- 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.
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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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-26T19:20:44Z

fix: catch error and return 403 #3856 👈 (View in Graphite)
main

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

github-actions · 2025-08-26T19:23:08Z

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

fix: catch error and return 403

5fee035

chronark marked this pull request as ready for review August 26, 2025 19:20

chronark requested review from Flo4604, MichaelUnkey, mcstepp, ogzhanolguncu and perkinsjr as code owners August 26, 2025 19:20

perkinsjr approved these changes Aug 26, 2025

View reviewed changes

chronark merged commit 9baa147 into main Aug 26, 2025
20 of 23 checks passed

chronark deleted the 08-26-fix_catch_error_and_return_403 branch August 26, 2025 19:21

vercel bot temporarily deployed to Preview – engineering August 26, 2025 19:21 Inactive

vercel bot temporarily deployed to Preview – dashboard August 26, 2025 19:21 Inactive

coderabbitai bot mentioned this pull request Oct 7, 2025

fix: panic when caling api with root key for disabled workspace #4083

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: catch error and return 403#3856

fix: catch error and return 403#3856
chronark merged 1 commit intomainfrom
08-26-fix_catch_error_and_return_403

chronark commented Aug 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Aug 26, 2025

Uh oh!

vercel bot commented Aug 26, 2025

Uh oh!

coderabbitai bot commented Aug 26, 2025 •

edited

Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

chronark commented Aug 26, 2025

Uh oh!

Uh oh!

github-actions bot commented Aug 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

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

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Aug 26, 2025

⚠️ No Changeset found

Uh oh!

vercel bot commented Aug 26, 2025

Uh oh!

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

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

chronark commented Aug 26, 2025

Uh oh!

Uh oh!

github-actions bot commented Aug 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chronark commented Aug 26, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)