fix: panics not being catched

[Flo4604]

What does this PR do?

catches panics in the api
fixes the panic we had in prod

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

• 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

  • Improved server stability with enhanced error handling that safely recovers from unexpected errors during request processing and returns a consistent error response to users.
  • Added monitoring for unexpected errors with new metrics tracking panic occurrences in request handling.

• Bug Fixes

  • Ensured consistent logging behavior for key retrieval operations, preventing potential issues when a key is not found.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8554f90

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

A new panic recovery middleware (WithPanicRecovery) is introduced to the HTTP middleware stack, ensuring panics are logged and converted to standardized error responses. This middleware is integrated into the route registration process. Additionally, the key retrieval service is updated to always return a non-nil logging function, improving consistency in its return values. A new Prometheus metric for tracking panics is also added.

Changes

Cohort / File(s)	Change Summary
Panic Recovery Middleware Introduction go/pkg/zen/middleware_panic_recovery.go	Adds WithPanicRecovery middleware to capture, log, and respond to panics during HTTP request handling.
Prometheus Panic Metric Addition go/pkg/prometheus/metrics/panic.go	Introduces a Prometheus counter vector PanicsTotal to track panic occurrences by caller and path.
Middleware Stack Update for Routes go/apps/api/routes/register.go	Integrates the new panic recovery middleware into the default, chproxy, reference, and openapi handler middleware chains.
Key Service Return Consistency go/internal/services/keys/get.go	Ensures the key retrieval service always returns a non-nil logging function by replacing nil with emptyLog in a specific return path.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant MiddlewareStack
    participant PanicRecovery
    participant Handler

    Client->>Server: HTTP Request
    Server->>MiddlewareStack: Pass request through middleware
    MiddlewareStack->>PanicRecovery: withPanicRecovery wraps handler
    alt No panic
        PanicRecovery->>Handler: Call handler
        Handler-->>PanicRecovery: Normal response
        PanicRecovery-->>MiddlewareStack: Pass response
    else Panic occurs
        Handler--xPanicRecovery: Panic thrown
        PanicRecovery->>PanicRecovery: Recover, log, build error response
        PanicRecovery-->>MiddlewareStack: 500 Internal Server Error JSON
    end
    MiddlewareStack-->>Client: HTTP Response

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

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

✨ 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/panic

---

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.
  • @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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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.
• @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! 🙏

[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		Jul 31, 2025 5:52pm
engineering	⬜️ Ignored (Inspect)	Visit Preview		Jul 31, 2025 5:52pm

[graphite-app]

[graphite-app]

Graphite Automations

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

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

"Notify author when CI fails" took an action on this PR • (07/31/25)

1 teammate was notified to this PR based on Andreas Thomas's automation.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ae733cb and 3f650a1.

📒 Files selected for processing (3)

• go/apps/api/routes/register.go (4 hunks)
• go/internal/services/keys/get.go (1 hunks)
• go/pkg/zen/middleware_panic_recovery.go (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: Flo4604
PR: unkeyed/unkey#3647
File: go/apps/api/openapi/openapi-generated.yaml:3569-3575
Timestamp: 2025-07-22T18:09:41.800Z
Learning: In the Unkey codebase, using non-standard HTTP status code 529 for internal-only endpoints is acceptable and should not be flagged as an issue in future reviews.

Learnt from: chronark
PR: unkeyed/unkey#2901
File: go/pkg/otel/metrics/metrics.go:11-22
Timestamp: 2025-02-26T15:07:05.646Z
Learning: In the metrics package init function, panicking on initialization errors is acceptable since it occurs during startup and indicates a fundamental issue that should be addressed immediately rather than allowing the application to continue with incorrect metrics setup.

📚 Learning: in the metrics package init function, panicking on initialization errors is acceptable since it occu...

Learnt from: chronark
PR: unkeyed/unkey#2901
File: go/pkg/otel/metrics/metrics.go:11-22
Timestamp: 2025-02-26T15:07:05.646Z
Learning: In the metrics package init function, panicking on initialization errors is acceptable since it occurs during startup and indicates a fundamental issue that should be addressed immediately rather than allowing the application to continue with incorrect metrics setup.

Applied to files:

• go/apps/api/routes/register.go

⏰ 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 (4)

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

17-59: Excellent panic recovery implementation with comprehensive logging.

The middleware correctly implements the defer/recover pattern and provides detailed logging including stack traces. The error response follows OpenAPI standards and maintains consistency with the existing error handling patterns.

go/apps/api/routes/register.go (2)

61-72: Perfect middleware positioning and integration.

The panic recovery middleware is correctly positioned in the middleware chain - after logging (to ensure request context is available) and before error handling (to convert panics to structured errors first). This ordering ensures optimal behavior.

---

80-85: Consistent application across all middleware chains.

Good to see panic recovery is consistently applied to chproxy internal endpoints as well, ensuring comprehensive panic protection across all API surfaces.

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

93-93: Good consistency improvement for logging function returns.

This change ensures that the logging function is always non-nil, preventing potential nil pointer dereferences and maintaining consistency with other return paths in the method.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

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

27-33: Consider potential sensitive data exposure in panic logs.

The current implementation logs the full request URL path and method, which could potentially expose sensitive information in URLs (query parameters, path segments containing tokens, etc.). Consider sanitizing the URL or limiting what gets logged.

You could add a helper function to sanitize sensitive parts of the path before logging:

				logger.Error("panic recovered",
					"panic", fmt.Sprintf("%v", r),
					"requestId", s.RequestID(),
					"method", s.r.Method,
-					"path", s.r.URL.Path,
+					"path", sanitizePath(s.r.URL.Path),
					"stack", string(stack),
				)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3f650a1 and 8554f90.

📒 Files selected for processing (2)

• go/pkg/prometheus/metrics/panic.go (1 hunks)
• go/pkg/zen/middleware_panic_recovery.go (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: Flo4604
PR: unkeyed/unkey#3647
File: go/apps/api/openapi/openapi-generated.yaml:3569-3575
Timestamp: 2025-07-22T18:09:41.800Z
Learning: In the Unkey codebase, using non-standard HTTP status code 529 for internal-only endpoints is acceptable and should not be flagged as an issue in future reviews.

Learnt from: chronark
PR: unkeyed/unkey#2901
File: go/pkg/otel/metrics/metrics.go:11-22
Timestamp: 2025-02-26T15:07:05.646Z
Learning: In the metrics package init function, panicking on initialization errors is acceptable since it occurs during startup and indicates a fundamental issue that should be addressed immediately rather than allowing the application to continue with incorrect metrics setup.

Learnt from: chronark
PR: unkeyed/unkey#2832
File: go/cmd/api/main.go:88-88
Timestamp: 2025-01-24T08:55:18.790Z
Learning: The metrics middleware in the API v2 implementation is intentionally initialized with nil configuration during development, with the understanding that proper configuration will be added before production deployment.

📚 Learning: in the metrics package init function, panicking on initialization errors is acceptable since it occu...

Learnt from: chronark
PR: unkeyed/unkey#2901
File: go/pkg/otel/metrics/metrics.go:11-22
Timestamp: 2025-02-26T15:07:05.646Z
Learning: In the metrics package init function, panicking on initialization errors is acceptable since it occurs during startup and indicates a fundamental issue that should be addressed immediately rather than allowing the application to continue with incorrect metrics setup.

Applied to files:

• go/pkg/zen/middleware_panic_recovery.go
• go/pkg/prometheus/metrics/panic.go

📚 Learning: sensitive data in logs is masked at the api layer (apps/api/src/pkg/middleware/metrics.ts) before be...

Learnt from: chronark
PR: unkeyed/unkey#2825
File: apps/dashboard/app/(app)/logs/components/table/logs-table.tsx:100-118
Timestamp: 2025-01-31T13:50:45.004Z
Learning: Sensitive data in logs is masked at the API layer (apps/api/src/pkg/middleware/metrics.ts) before being written to Clickhouse. This includes redacting API keys, plaintext values, and authorization headers using regex replacements.

Applied to files:

• go/pkg/zen/middleware_panic_recovery.go

📚 Learning: in go packages, variables defined in one file within a package (like `latencybuckets` and `constlabe...

Learnt from: Flo4604
PR: unkeyed/unkey#3606
File: go/pkg/prometheus/metrics/database.go:29-30
Timestamp: 2025-07-16T10:06:35.397Z
Learning: In Go packages, variables defined in one file within a package (like `latencyBuckets` and `constLabels` in go/pkg/prometheus/metrics/http.go) are accessible from other files in the same package without requiring imports. This is a common pattern for sharing configuration across multiple files within a package.

Applied to files:

• go/pkg/prometheus/metrics/panic.go

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

• GitHub Check: Test API / API Test Local
• GitHub Check: Test Go API Local / Test
• GitHub Check: Build / Build
• GitHub Check: Test Agent Local / test_agent_local
• GitHub Check: Test Packages / Test
• GitHub Check: autofix
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (2)

go/pkg/zen/middleware_panic_recovery.go (2)

37-55: LGTM! Excellent error handling and response structure.

The panic-to-error conversion is well-implemented:

• Uses the fault package for consistent error handling
• Provides both internal details for debugging and user-friendly public messages
• Returns a properly structured OpenAPI response with metadata
• Maintains request traceability through request ID

This follows the established patterns in the codebase for error handling.

---

16-62: Well-designed panic recovery middleware.

The middleware effectively addresses the production panic issues mentioned in the PR objectives by:

• Properly catching panics using defer/recover
• Comprehensive logging with stack traces for debugging
• Metrics collection for monitoring
• Graceful error responses to clients

The implementation follows Go best practices and integrates well with the existing middleware stack.