fix: region not showing and wrong rl id

[Flo4604]

What does this PR do?

Fixes #3720
Fixes #3718

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

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

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

• New Features

  • Rate limit response data now includes a unique identifier for each rate limit, improving clarity in key verification responses.
  • Added geographic region information to key service configurations and telemetry events.

• Style

  • Improved code readability through reorganization and spacing adjustments in internal structures.

• Chores

  • Minor cleanup of extraneous blank lines in internal files.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7bb1de0

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]

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Aug 4, 2025 7:58am
engineering	⬜️ Ignored (Inspect)	Visit Preview		Aug 4, 2025 7:58am

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update how ratelimit IDs are handled and returned in the key verification process, ensuring the actual ratelimit ID is used instead of the name. They also ensure the cloud region is set in telemetry logs by reading the Region from configuration and passing it through the key service and verifier layers. Additional changes include minor formatting and code organization improvements.

Changes

Cohort / File(s)	Change Summary
Ratelimit ID Handling go/apps/api/routes/v2_keys_verify_key/handler.go, go/internal/services/keys/validation.go, go/internal/services/keys/verifier.go	Updates the ratelimit response to use the actual ratelimit ID instead of the name, adds an ID field to the relevant struct, and ensures correct assignment based on ratelimit source.
Region Propagation in Key Service go/internal/services/keys/service.go, go/internal/services/keys/get.go, go/internal/services/keys/verifier.go, go/apps/api/run.go	Adds Region field to the key service config and service structs; propagates region value through service creation and key verification; updates telemetry event logging to include region.
Formatting and Organization go/apps/api/run.go, go/internal/services/keys/interface.go, go/internal/services/keys/verifier.go	Adjusts blank lines and field ordering for readability; no functional changes.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Handler as API Handler
    participant KeyVerifier
    participant RatelimitService
    participant Telemetry

    Client->>API_Handler: Verify Key Request
    API_Handler->>KeyVerifier: Verify Key (with Region)
    KeyVerifier->>RatelimitService: Fetch Ratelimit Configs (with IDs)
    RatelimitService-->>KeyVerifier: Ratelimit Configs (with IDs)
    KeyVerifier->>Telemetry: Log Event (Region from Config)
    KeyVerifier-->>API_Handler: Verification Result (ratelimit IDs)
    API_Handler-->>Client: Response (ratelimit array with IDs)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Show actual ratelimit ID instead of name in key verification response (#3720)	✅
Ensure cloud region is written in key verification telemetry logs (#3718)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Suggested labels

Bug, Core Team

Suggested reviewers

• perkinsjr
• mcstepp
• chronark

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 7f02cb9 and 7bb1de0.

📒 Files selected for processing (4)

• go/apps/api/run.go (1 hunks)
• go/internal/services/keys/get.go (2 hunks)
• go/internal/services/keys/service.go (3 hunks)
• go/internal/services/keys/verifier.go (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.go

📄 CodeRabbit Inference Engine (CLAUDE.md)

**/*.go: Follow comprehensive documentation guidelines for Go code as described in go/GO_DOCUMENTATION_GUIDELINES.md
Every public function/type in Go code must be documented
Prefer interfaces for testability in Go code
Use AIDEV-* comments for complex/important code in Go services

Files:

• go/internal/services/keys/service.go
• go/internal/services/keys/get.go
• go/internal/services/keys/verifier.go
• go/apps/api/run.go

**/*.{env,js,ts,go}

📄 CodeRabbit Inference Engine (CLAUDE.md)

All environment variables must follow the format: UNKEY_<SERVICE_NAME>_VARNAME

Files:

• go/internal/services/keys/service.go
• go/internal/services/keys/get.go
• go/internal/services/keys/verifier.go
• go/apps/api/run.go

🧠 Learnings (2)

📓 Common learnings

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#2866
File: apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/components/control-cloud/index.tsx:13-30
Timestamp: 2025-02-05T11:49:04.098Z
Learning: In the ratelimits logs context, "requestId" is used for single request IDs, while "requestIds" is used when dealing with multiple request IDs.

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.

Learnt from: chronark
PR: unkeyed/unkey#2294
File: apps/api/src/pkg/keys/service.ts:268-271
Timestamp: 2024-10-20T07:05:55.471Z
Learning: In `apps/api/src/pkg/keys/service.ts`, `ratelimitAsync` is a table relation, not a column selection. When querying, ensure that table relations are included appropriately, not as columns.

Learnt from: chronark
PR: unkeyed/unkey#3474
File: go/apps/api/routes/v2_keys_verify_key/200_test.go:380-380
Timestamp: 2025-07-14T08:15:56.747Z
Learning: In the Unkey codebase, there is a mechanism to set the server's time via a header for test control, which helps make ratelimit tests deterministic instead of time-dependent. This is useful for preventing flaky tests where the second request might hit a new ratelimit window.

📚 Learning: in the go/cmd/cli/commands/deploy/ directory, ogzhanolguncu prefers to keep potentially temporary fe...

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#3564
File: go/cmd/cli/commands/deploy/flags.go:17-20
Timestamp: 2025-07-15T14:45:18.920Z
Learning: In the go/cmd/cli/commands/deploy/ directory, ogzhanolguncu prefers to keep potentially temporary features (like UNKEY_DOCKER_REGISTRY environment variable) undocumented in help text if they might be deleted in the future, to avoid documentation churn.

Applied to files:

• go/internal/services/keys/verifier.go

🧬 Code Graph Analysis (1)

go/internal/services/keys/verifier.go (4)

go/pkg/db/key_find_for_verification.sql_generated.go (1)

• FindKeyForVerificationRow (92-119)

go/internal/services/keys/status.go (1)

• KeyStatus (12-12)

go/pkg/zen/session.go (1)

• Session (28-42)

go/pkg/rbac/rbac.go (1)

• RBAC (14-16)

⏰ 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). (3)

• GitHub Check: Test Agent Local / test_agent_local
• GitHub Check: Test Go API Local / Test
• GitHub Check: Test API / API Test Local

🔇 Additional comments (7)

go/internal/services/keys/service.go (2)

22-22: LGTM! Region field properly documented.

The addition of the Region field to the Config struct with proper documentation follows Go conventions and aligns with the PR objective to capture cloud region information.

---

34-34: LGTM! Region field properly initialized.

The region field is correctly added to the service struct and properly initialized from the configuration in the constructor.

Also applies to: 57-57

go/apps/api/run.go (1)

185-185: LGTM! Region properly passed to keys service.

The region configuration is correctly passed from the API config to the keys service, enabling region information to flow through the service layers as intended.

go/internal/services/keys/get.go (1)

108-108: LGTM! Region consistently set in KeyVerifier instances.

The region field is properly set in both KeyVerifier instances (workspace disabled and fully populated), ensuring region information is available for telemetry regardless of the verification outcome.

Also applies to: 156-156

go/internal/services/keys/verifier.go (3)

20-20: LGTM! ID field added to support ratelimit identification.

The addition of the ID field to RatelimitConfigAndResult addresses issue #3720 by providing a way to track the actual ratelimit ID instead of just the name.

---

33-55: LGTM! Improved struct organization and region field addition.

The reorganization of KeyVerifier struct fields with logical grouping and comments improves readability. The addition of the region field enables capturing cloud region information as required by issue #3718.

---

133-133: LGTM! Region information now properly included in telemetry.

This change fixes issue #3718 by using the actual region value (k.region) instead of an empty string in the telemetry data, ensuring the cloud region that accepted the request is properly recorded.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/missing-region

---

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

• 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.
  • 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.

[github-actions]

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

[Flo4604]

What do you think of having a globally available config so that we dont have to pass it down but can rather just access config.Region?

I can pass it down but then I have to embed it in each key verifier

[chronark]

not much tbh, that causes issues when running cluster tests.
it's slightly inconvenient to pass it down, but really not that bad imo

[graphite-app]

[graphite-app]

Graphite Automations

"Post a GIF when PR approved" took an action on this PR • (08/04/25)

1 gif was posted to this PR based on Andreas Thomas's automation.